blob: 98f5070bcb5eeed57b70048b73cd3d2d9dcf8319 [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
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010025static void delbuf_msg(char_u *name);
Bram Moolenaareae1b912019-05-09 15:12:55 +020026static int help_compare(const void *s1, const void *s2);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010027static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
29/*
30 * ":ascii" and "ga".
31 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000032 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010033do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000034{
35 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000036 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000037 char buf1[20];
38 char buf2[20];
39 char_u buf3[7];
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010040#ifdef FEAT_DIGRAPHS
41 char_u *dig;
42#endif
Bram Moolenaar362e1a32006-03-06 23:29:24 +000043 int cc[MAX_MCO];
44 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000045 int len;
46
47 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000048 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000049 else
Bram Moolenaar071d4272004-06-13 20:20:40 +000050 c = gchar_cursor();
51 if (c == NUL)
52 {
Bram Moolenaar32526b32019-01-19 17:43:09 +010053 msg("NUL");
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 return;
55 }
56
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 IObuff[0] = NUL;
58 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 {
60 if (c == NL) /* NUL is stored as NL */
61 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000062 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
63 cval = NL; /* NL is stored as CR */
64 else
65 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000066 if (vim_isprintc_strict(c) && (c < ' '
67#ifndef EBCDIC
68 || c > '~'
69#endif
70 ))
71 {
72 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000073 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000074 }
75 else
76 buf1[0] = NUL;
77#ifndef EBCDIC
78 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000079 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
80 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 else
82#endif
83 buf2[0] = NUL;
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010084#ifdef FEAT_DIGRAPHS
85 dig = get_digraph_for_char(cval);
86 if (dig != NULL)
87 vim_snprintf((char *)IObuff, IOSIZE,
88 _("<%s>%s%s %d, Hex %02x, Oct %03o, Digr %s"),
89 transchar(c), buf1, buf2, cval, cval, cval, dig);
90 else
91#endif
92 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar555b2802005-05-19 21:08:39 +000093 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000094 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar1f788e72006-09-05 16:30:40 +000095 if (enc_utf8)
96 c = cc[ci++];
97 else
98 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000099 }
100
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 /* Repeat for combining characters. */
102 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
103 {
104 len = (int)STRLEN(IObuff);
105 /* This assumes every multi-byte char is printable... */
106 if (len > 0)
107 IObuff[len++] = ' ';
108 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000109 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000110# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000112# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113 )
114 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000115 len += (*mb_char2bytes)(c, IObuff + len);
Bram Moolenaar5f73ef82018-02-27 21:09:30 +0100116#ifdef FEAT_DIGRAPHS
117 dig = get_digraph_for_char(c);
118 if (dig != NULL)
119 vim_snprintf((char *)IObuff + len, IOSIZE - len,
120 c < 0x10000 ? _("> %d, Hex %04x, Oct %o, Digr %s")
121 : _("> %d, Hex %08x, Oct %o, Digr %s"),
122 c, c, c, dig);
123 else
124#endif
125 vim_snprintf((char *)IObuff + len, IOSIZE - len,
126 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
127 : _("> %d, Hex %08x, Octal %o"),
128 c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000129 if (ci == MAX_MCO)
130 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000131 if (enc_utf8)
132 c = cc[ci++];
133 else
134 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136
Bram Moolenaar32526b32019-01-19 17:43:09 +0100137 msg((char *)IObuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138}
139
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140/*
141 * ":left", ":center" and ":right": align text.
142 */
143 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100144ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145{
146 pos_T save_curpos;
147 int len;
148 int indent = 0;
149 int new_indent;
150 int has_tab;
151 int width;
152
153#ifdef FEAT_RIGHTLEFT
154 if (curwin->w_p_rl)
155 {
156 /* switch left and right aligning */
157 if (eap->cmdidx == CMD_right)
158 eap->cmdidx = CMD_left;
159 else if (eap->cmdidx == CMD_left)
160 eap->cmdidx = CMD_right;
161 }
162#endif
163
164 width = atoi((char *)eap->arg);
165 save_curpos = curwin->w_cursor;
166 if (eap->cmdidx == CMD_left) /* width is used for new indent */
167 {
168 if (width >= 0)
169 indent = width;
170 }
171 else
172 {
173 /*
174 * if 'textwidth' set, use it
175 * else if 'wrapmargin' set, use it
176 * if invalid value, use 80
177 */
178 if (width <= 0)
179 width = curbuf->b_p_tw;
180 if (width == 0 && curbuf->b_p_wm > 0)
Bram Moolenaar02631462017-09-22 15:20:32 +0200181 width = curwin->w_width - curbuf->b_p_wm;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182 if (width <= 0)
183 width = 80;
184 }
185
186 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
187 return;
188
189 for (curwin->w_cursor.lnum = eap->line1;
190 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
191 {
192 if (eap->cmdidx == CMD_left) /* left align */
193 new_indent = indent;
194 else
195 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000196 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 len = linelen(eap->cmdidx == CMD_right ? &has_tab
198 : NULL) - get_indent();
199
200 if (len <= 0) /* skip blank lines */
201 continue;
202
203 if (eap->cmdidx == CMD_center)
204 new_indent = (width - len) / 2;
205 else
206 {
207 new_indent = width - len; /* right align */
208
209 /*
210 * Make sure that embedded TABs don't make the text go too far
211 * to the right.
212 */
213 if (has_tab)
214 while (new_indent > 0)
215 {
216 (void)set_indent(new_indent, 0);
217 if (linelen(NULL) <= width)
218 {
219 /*
220 * Now try to move the line as much as possible to
221 * the right. Stop when it moves too far.
222 */
223 do
224 (void)set_indent(++new_indent, 0);
225 while (linelen(NULL) <= width);
226 --new_indent;
227 break;
228 }
229 --new_indent;
230 }
231 }
232 }
233 if (new_indent < 0)
234 new_indent = 0;
235 (void)set_indent(new_indent, 0); /* set indent */
236 }
237 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
238 curwin->w_cursor = save_curpos;
239 beginline(BL_WHITE | BL_FIX);
240}
241
242/*
243 * Get the length of the current line, excluding trailing white space.
244 */
245 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100246linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247{
248 char_u *line;
249 char_u *first;
250 char_u *last;
251 int save;
252 int len;
253
254 /* find the first non-blank character */
255 line = ml_get_curline();
256 first = skipwhite(line);
257
258 /* find the character after the last non-blank character */
259 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100260 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 ;
262 save = *last;
263 *last = NUL;
264 len = linetabsize(line); /* get line length */
265 if (has_tab != NULL) /* check for embedded TAB */
Bram Moolenaarb31a3ac2018-08-11 14:41:55 +0200266 *has_tab = (vim_strchr(first, TAB) != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267 *last = save;
268
269 return len;
270}
271
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000272/* Buffer for two lines used during sorting. They are allocated to
273 * contain the longest line being sorted. */
274static char_u *sortbuf1;
275static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000276
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100277static int sort_ic; /* ignore case */
278static int sort_nr; /* sort on number */
279static int sort_rx; /* sort on regex instead of skipping it */
280#ifdef FEAT_FLOAT
281static int sort_flt; /* sort on floating number */
282#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000283
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100284static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000285
286/* Struct to store info to be sorted. */
287typedef struct
288{
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100289 linenr_T lnum; // line number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100290 union {
291 struct
292 {
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100293 varnumber_T start_col_nr; // starting column number
294 varnumber_T end_col_nr; // ending column number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100295 } line;
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100296 struct
297 {
298 varnumber_T value; // value if sorting by integer
299 int is_number; // TRUE when line contains a number
300 } num;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100301#ifdef FEAT_FLOAT
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100302 float_T value_flt; // value if sorting by float
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100303#endif
304 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000305} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000306
Bram Moolenaareae1b912019-05-09 15:12:55 +0200307static int sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000308
309 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100310sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000311{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000312 sorti_T l1 = *(sorti_T *)s1;
313 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000314 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000315
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000316 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000317 * if we return 0 every time, qsort will assume it's done sorting and
318 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000319 if (sort_abort)
320 return 0;
321 fast_breakcheck();
322 if (got_int)
323 sort_abort = TRUE;
324
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000325 if (sort_nr)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100326 {
327 if (l1.st_u.num.is_number != l2.st_u.num.is_number)
328 result = l1.st_u.num.is_number - l2.st_u.num.is_number;
329 else
330 result = l1.st_u.num.value == l2.st_u.num.value ? 0
331 : l1.st_u.num.value > l2.st_u.num.value ? 1 : -1;
332 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100333#ifdef FEAT_FLOAT
334 else if (sort_flt)
335 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
336 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
337#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000338 else
339 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000340 /* We need to copy one line into "sortbuf1", because there is no
341 * guarantee that the first pointer becomes invalid when obtaining the
342 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100343 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
344 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
345 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
346 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
347 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
348 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000349
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000350 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
351 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000352 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000353
354 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000355 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000356 return (int)(l1.lnum - l2.lnum);
357 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000358}
359
360/*
361 * ":sort".
362 */
363 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100364ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000365{
366 regmatch_T regmatch;
367 int len;
368 linenr_T lnum;
369 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000370 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000371 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000372 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000373 char_u *p;
374 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000375 char_u *s2;
376 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000377 int unique = FALSE;
378 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000379 colnr_T start_col;
380 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100381 int sort_what = 0;
382 int format_found = 0;
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200383 int change_occurred = FALSE; // Buffer contents changed.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000384
Bram Moolenaar48c99162008-02-18 18:42:52 +0000385 /* Sorting one line is really quick! */
386 if (count <= 1)
387 return;
388
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000389 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
390 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000391 sortbuf1 = NULL;
392 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000393 regmatch.regprog = NULL;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200394 nrs = ALLOC_MULT(sorti_T, count);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000395 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000396 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000397
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100398 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100399#ifdef FEAT_FLOAT
400 sort_flt = 0;
401#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000402
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000403 for (p = eap->arg; *p != NUL; ++p)
404 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100405 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000406 ;
407 else if (*p == 'i')
408 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000409 else if (*p == 'r')
410 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000411 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100412 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100413 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100414 ++format_found;
415 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100416#ifdef FEAT_FLOAT
417 else if (*p == 'f')
418 {
419 sort_flt = 1;
420 ++format_found;
421 }
422#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100423 else if (*p == 'b')
424 {
425 sort_what = STR2NR_BIN + STR2NR_FORCE;
426 ++format_found;
427 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000428 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100429 {
430 sort_what = STR2NR_OCT + STR2NR_FORCE;
431 ++format_found;
432 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000433 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100434 {
435 sort_what = STR2NR_HEX + STR2NR_FORCE;
436 ++format_found;
437 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000438 else if (*p == 'u')
439 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000440 else if (*p == '"') /* comment start */
441 break;
442 else if (check_nextcmd(p) != NULL)
443 {
444 eap->nextcmd = check_nextcmd(p);
445 break;
446 }
447 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000448 {
449 s = skip_regexp(p + 1, *p, TRUE, NULL);
450 if (*s != *p)
451 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100452 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000453 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000454 }
455 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000456 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100457 if (s == p + 1)
458 {
459 if (last_search_pat() == NULL)
460 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100461 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100462 goto sortend;
463 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000464 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100465 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000466 else
467 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000468 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000469 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000470 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000471 regmatch.rm_ic = p_ic;
472 }
473 else
474 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100475 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000476 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000477 }
478 }
479
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100480 /* Can only have one of 'n', 'b', 'o' and 'x'. */
481 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000482 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100483 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000484 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000485 }
486
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100487 /* From here on "sort_nr" is used as a flag for any integer number
488 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100489 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000491 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000492 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000493 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000494 * When sorting on strings "start_col_nr" is the offset in the line, for
495 * numbers sorting it's the number to sort on. This means the pattern
496 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000497 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000498 */
499 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
500 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000501 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000502 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000503 if (maxlen < len)
504 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000505
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000506 start_col = 0;
507 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000508 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000509 {
510 if (sort_rx)
511 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000512 start_col = (colnr_T)(regmatch.startp[0] - s);
513 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000514 }
515 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000516 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000517 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000518 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000519 if (regmatch.regprog != NULL)
520 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000521
Bram Moolenaar937204a2016-01-30 23:37:38 +0100522 if (sort_nr
523#ifdef FEAT_FLOAT
524 || sort_flt
525#endif
526 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000527 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000528 /* Make sure vim_str2nr doesn't read any digits past the end
529 * of the match, by temporarily terminating the string there */
530 s2 = s + end_col;
531 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200532 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000533 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000534 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100535 if (sort_nr)
536 {
537 if (sort_what & STR2NR_HEX)
538 s = skiptohex(p);
539 else if (sort_what & STR2NR_BIN)
540 s = skiptobin(p);
541 else
542 s = skiptodigit(p);
543 if (s > p && s[-1] == '-')
544 --s; /* include preceding negative sign */
545 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100546 {
547 /* line without number should sort before any number */
548 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
549 nrs[lnum - eap->line1].st_u.num.value = 0;
550 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100551 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100552 {
553 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100554 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaar16e9b852019-05-19 19:59:35 +0200555 &nrs[lnum - eap->line1].st_u.num.value,
556 NULL, 0, FALSE);
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100557 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100558 }
559#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000560 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100561 {
562 s = skipwhite(p);
563 if (*s == '+')
564 s = skipwhite(s + 1);
565
566 if (*s == NUL)
567 /* empty line should sort before any number */
568 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
569 else
570 nrs[lnum - eap->line1].st_u.value_flt =
571 strtod((char *)s, NULL);
572 }
573#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200574 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000575 }
576 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000577 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000578 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100579 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
580 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000581 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000582
583 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000584
585 if (regmatch.regprog != NULL)
586 fast_breakcheck();
587 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000588 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000589 }
590
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar964b3742019-05-24 18:54:09 +0200592 sortbuf1 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 if (sortbuf1 == NULL)
594 goto sortend;
Bram Moolenaar964b3742019-05-24 18:54:09 +0200595 sortbuf2 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000596 if (sortbuf2 == NULL)
597 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000598
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000599 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000600 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000601
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000602 if (sort_abort)
603 goto sortend;
604
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000605 /* Insert the lines in the sorted order below the last one. */
606 lnum = eap->line2;
607 for (i = 0; i < count; ++i)
608 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200609 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
610
611 // If the original line number of the line being placed is not the same
612 // as "lnum" (accounting for offset), we know that the buffer changed.
613 if (get_lnum + ((linenr_T)count - 1) != lnum)
614 change_occurred = TRUE;
615
616 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000617 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000618 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000619 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200620 // Copy the line into a buffer, it may become invalid in
621 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100622 STRCPY(sortbuf1, s);
623 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000625 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000626 fast_breakcheck();
627 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000628 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000629 }
630
631 /* delete the original lines if appending worked */
632 if (i == count)
633 for (i = 0; i < count; ++i)
634 ml_delete(eap->line1, FALSE);
635 else
636 count = 0;
637
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000638 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000639 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200641 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000642 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200643 msgmore(-deleted);
644 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 else if (deleted < 0)
646 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200647
648 if (change_occurred || deleted != 0)
649 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000650
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000651 curwin->w_cursor.lnum = eap->line1;
652 beginline(BL_WHITE | BL_FIX);
653
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000654sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000655 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000656 vim_free(sortbuf1);
657 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200658 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000659 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100660 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000661}
662
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663/*
664 * ":retab".
665 */
666 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100667ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668{
669 linenr_T lnum;
670 int got_tab = FALSE;
671 long num_spaces = 0;
672 long num_tabs;
673 long len;
674 long col;
675 long vcol;
676 long start_col = 0; /* For start of white-space string */
677 long start_vcol = 0; /* For start of white-space string */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 long old_len;
679 char_u *ptr;
680 char_u *new_line = (char_u *)1; /* init to non-NULL */
681 int did_undo; /* called u_save for current line */
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200682#ifdef FEAT_VARTABS
Bram Moolenaar0119a592018-06-24 23:53:28 +0200683 int *new_vts_array = NULL;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200684 char_u *new_ts_str; /* string value of tab argument */
685#else
686 int temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 int new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200688#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 int save_list;
690 linenr_T first_line = 0; /* first changed line */
691 linenr_T last_line = 0; /* last changed line */
692
693 save_list = curwin->w_p_list;
694 curwin->w_p_list = 0; /* don't want list mode here */
695
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200696#ifdef FEAT_VARTABS
697 new_ts_str = eap->arg;
Bram Moolenaar0119a592018-06-24 23:53:28 +0200698 if (!tabstop_set(eap->arg, &new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200699 return;
700 while (vim_isdigit(*(eap->arg)) || *(eap->arg) == ',')
701 ++(eap->arg);
702
Bram Moolenaar0119a592018-06-24 23:53:28 +0200703 // This ensures that either new_vts_array and new_ts_str are freshly
704 // allocated, or new_vts_array points to an existing array and new_ts_str
705 // is null.
706 if (new_vts_array == NULL)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200707 {
Bram Moolenaar0119a592018-06-24 23:53:28 +0200708 new_vts_array = curbuf->b_p_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200709 new_ts_str = NULL;
710 }
711 else
712 new_ts_str = vim_strnsave(new_ts_str, eap->arg - new_ts_str);
713#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 new_ts = getdigits(&(eap->arg));
715 if (new_ts < 0)
716 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100717 emsg(_(e_positive));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 return;
719 }
720 if (new_ts == 0)
721 new_ts = curbuf->b_p_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200722#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
724 {
725 ptr = ml_get(lnum);
726 col = 0;
727 vcol = 0;
728 did_undo = FALSE;
729 for (;;)
730 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100731 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 {
733 if (!got_tab && num_spaces == 0)
734 {
735 /* First consecutive white-space */
736 start_vcol = vcol;
737 start_col = col;
738 }
739 if (ptr[col] == ' ')
740 num_spaces++;
741 else
742 got_tab = TRUE;
743 }
744 else
745 {
746 if (got_tab || (eap->forceit && num_spaces > 1))
747 {
748 /* Retabulate this string of white-space */
749
750 /* len is virtual length of white string */
751 len = num_spaces = vcol - start_vcol;
752 num_tabs = 0;
753 if (!curbuf->b_p_et)
754 {
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200755#ifdef FEAT_VARTABS
756 int t, s;
757
758 tabstop_fromto(start_vcol, vcol,
Bram Moolenaar0119a592018-06-24 23:53:28 +0200759 curbuf->b_p_ts, new_vts_array, &t, &s);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200760 num_tabs = t;
761 num_spaces = s;
762#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 temp = new_ts - (start_vcol % new_ts);
764 if (num_spaces >= temp)
765 {
766 num_spaces -= temp;
767 num_tabs++;
768 }
769 num_tabs += num_spaces / new_ts;
770 num_spaces -= (num_spaces / new_ts) * new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200771#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 }
773 if (curbuf->b_p_et || got_tab ||
774 (num_spaces + num_tabs < len))
775 {
776 if (did_undo == FALSE)
777 {
778 did_undo = TRUE;
779 if (u_save((linenr_T)(lnum - 1),
780 (linenr_T)(lnum + 1)) == FAIL)
781 {
782 new_line = NULL; /* flag out-of-memory */
783 break;
784 }
785 }
786
787 /* len is actual number of white characters used */
788 len = num_spaces + num_tabs;
789 old_len = (long)STRLEN(ptr);
Bram Moolenaar18a4ba22019-05-24 19:39:03 +0200790 new_line = alloc(old_len - col + start_col + len + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 if (new_line == NULL)
792 break;
793 if (start_col > 0)
794 mch_memmove(new_line, ptr, (size_t)start_col);
795 mch_memmove(new_line + start_col + len,
796 ptr + col, (size_t)(old_len - col + 1));
797 ptr = new_line + start_col;
798 for (col = 0; col < len; col++)
799 ptr[col] = (col < num_tabs) ? '\t' : ' ';
800 ml_replace(lnum, new_line, FALSE);
801 if (first_line == 0)
802 first_line = lnum;
803 last_line = lnum;
804 ptr = new_line;
805 col = start_col + len;
806 }
807 }
808 got_tab = FALSE;
809 num_spaces = 0;
810 }
811 if (ptr[col] == NUL)
812 break;
813 vcol += chartabsize(ptr + col, (colnr_T)vcol);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000815 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 ++col;
818 }
819 if (new_line == NULL) /* out of memory */
820 break;
821 line_breakcheck();
822 }
823 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100824 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200826#ifdef FEAT_VARTABS
827 // If a single value was given then it can be considered equal to
828 // either the value of 'tabstop' or the value of 'vartabstop'.
829 if (tabstop_count(curbuf->b_p_vts_array) == 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200830 && tabstop_count(new_vts_array) == 1
831 && curbuf->b_p_ts == tabstop_first(new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200832 ; /* not changed */
833 else if (tabstop_count(curbuf->b_p_vts_array) > 0
Bram Moolenaar0119a592018-06-24 23:53:28 +0200834 && tabstop_eq(curbuf->b_p_vts_array, new_vts_array))
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200835 ; /* not changed */
836 else
837 redraw_curbuf_later(NOT_VALID);
838#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 if (curbuf->b_p_ts != new_ts)
840 redraw_curbuf_later(NOT_VALID);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200841#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 if (first_line != 0)
843 changed_lines(first_line, 0, last_line + 1, 0L);
844
845 curwin->w_p_list = save_list; /* restore 'list' */
846
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200847#ifdef FEAT_VARTABS
848 if (new_ts_str != NULL) /* set the new tabstop */
849 {
850 // If 'vartabstop' is in use or if the value given to retab has more
851 // than one tabstop then update 'vartabstop'.
852 int *old_vts_ary = curbuf->b_p_vts_array;
853
Bram Moolenaar0119a592018-06-24 23:53:28 +0200854 if (tabstop_count(old_vts_ary) > 0 || tabstop_count(new_vts_array) > 1)
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200855 {
856 set_string_option_direct((char_u *)"vts", -1, new_ts_str,
857 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0119a592018-06-24 23:53:28 +0200858 curbuf->b_p_vts_array = new_vts_array;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200859 vim_free(old_vts_ary);
860 }
861 else
862 {
863 // 'vartabstop' wasn't in use and a single value was given to
864 // retab then update 'tabstop'.
Bram Moolenaar0119a592018-06-24 23:53:28 +0200865 curbuf->b_p_ts = tabstop_first(new_vts_array);
866 vim_free(new_vts_array);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200867 }
Bram Moolenaar307ac5c2018-06-28 22:23:00 +0200868 vim_free(new_ts_str);
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200869 }
870#else
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 curbuf->b_p_ts = new_ts;
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200872#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 coladvance(curwin->w_curswant);
874
875 u_clearline();
876}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877
878/*
879 * :move command - move lines line1-line2 to line dest
880 *
881 * return FAIL for failure, OK otherwise
882 */
883 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100884do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885{
886 char_u *str;
887 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100888 linenr_T extra; // Num lines added before line1
889 linenr_T num_lines; // Num lines moved
890 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200891#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100892 win_T *win;
893 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200894#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895
896 if (dest >= line1 && dest < line2)
897 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100898 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 return FAIL;
900 }
901
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100902 // Do nothing if we are not actually moving any lines. This will prevent
903 // the 'modified' flag from being set without cause.
904 if (dest == line1 - 1 || dest == line2)
905 {
906 // Move the cursor as if lines were moved (see below) to be backwards
907 // compatible.
908 if (dest >= line1)
909 curwin->w_cursor.lnum = dest;
910 else
911 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
912
913 return OK;
914 }
915
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 num_lines = line2 - line1 + 1;
917
918 /*
919 * First we copy the old text to its new location -- webb
920 * Also copy the flag that ":global" command uses.
921 */
922 if (u_save(dest, dest + 1) == FAIL)
923 return FAIL;
924 for (extra = 0, l = line1; l <= line2; l++)
925 {
926 str = vim_strsave(ml_get(l + extra));
927 if (str != NULL)
928 {
929 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
930 vim_free(str);
931 if (dest < line1)
932 extra++;
933 }
934 }
935
936 /*
937 * Now we must be careful adjusting our marks so that we don't overlap our
938 * mark_adjust() calls.
939 *
940 * We adjust the marks within the old text so that they refer to the
941 * last lines of the file (temporarily), because we know no other marks
942 * will be set there since these line numbers did not exist until we added
943 * our new lines.
944 *
945 * Then we adjust the marks on lines between the old and new text positions
946 * (either forwards or backwards).
947 *
948 * And Finally we adjust the marks we put at the end of the file back to
949 * their final destination at the new text position -- webb
950 */
951 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100952 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 if (dest >= line2)
954 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100955 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
956#ifdef FEAT_FOLDING
957 FOR_ALL_TAB_WINDOWS(tp, win) {
958 if (win->w_buffer == curbuf)
959 foldMoveRange(&win->w_folds, line1, line2, dest);
960 }
961#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 curbuf->b_op_start.lnum = dest - num_lines + 1;
963 curbuf->b_op_end.lnum = dest;
964 }
965 else
966 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100967 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
968#ifdef FEAT_FOLDING
969 FOR_ALL_TAB_WINDOWS(tp, win) {
970 if (win->w_buffer == curbuf)
971 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
972 }
973#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 curbuf->b_op_start.lnum = dest + 1;
975 curbuf->b_op_end.lnum = dest + num_lines;
976 }
977 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100978 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 -(last_line - dest - extra), 0L);
980
981 /*
982 * Now we delete the original text -- webb
983 */
984 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
985 return FAIL;
986
987 for (l = line1; l <= line2; l++)
988 ml_delete(line1 + extra, TRUE);
989
990 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100991 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +0200992 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993
994 /*
995 * Leave the cursor on the last of the moved lines.
996 */
997 if (dest >= line1)
998 curwin->w_cursor.lnum = dest;
999 else
1000 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
1001
1002 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +01001003 {
1004 dest += num_lines + 1;
1005 last_line = curbuf->b_ml.ml_line_count;
1006 if (dest > last_line + 1)
1007 dest = last_line + 1;
1008 changed_lines(line1, 0, dest, 0L);
1009 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 else
1011 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
1012
1013 return OK;
1014}
1015
1016/*
1017 * ":copy"
1018 */
1019 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001020ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021{
1022 linenr_T count;
1023 char_u *p;
1024
1025 count = line2 - line1 + 1;
1026 curbuf->b_op_start.lnum = n + 1;
1027 curbuf->b_op_end.lnum = n + count;
1028 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
1029
1030 /*
1031 * there are three situations:
1032 * 1. destination is above line1
1033 * 2. destination is between line1 and line2
1034 * 3. destination is below line2
1035 *
1036 * n = destination (when starting)
1037 * curwin->w_cursor.lnum = destination (while copying)
1038 * line1 = start of source (while copying)
1039 * line2 = end of source (while copying)
1040 */
1041 if (u_save(n, n + 1) == FAIL)
1042 return;
1043
1044 curwin->w_cursor.lnum = n;
1045 while (line1 <= line2)
1046 {
1047 /* need to use vim_strsave() because the line will be unlocked within
1048 * ml_append() */
1049 p = vim_strsave(ml_get(line1));
1050 if (p != NULL)
1051 {
1052 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
1053 vim_free(p);
1054 }
1055 /* situation 2: skip already copied lines */
1056 if (line1 == n)
1057 line1 = curwin->w_cursor.lnum;
1058 ++line1;
1059 if (curwin->w_cursor.lnum < line1)
1060 ++line1;
1061 if (curwin->w_cursor.lnum < line2)
1062 ++line2;
1063 ++curwin->w_cursor.lnum;
1064 }
1065
1066 appended_lines_mark(n, count);
1067
1068 msgmore((long)count);
1069}
1070
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001071static char_u *prevcmd = NULL; /* the previous command */
1072
1073#if defined(EXITFREE) || defined(PROTO)
1074 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001075free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001076{
1077 vim_free(prevcmd);
1078}
1079#endif
1080
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081/*
1082 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
1083 * Bangs in the argument are replaced with the previously entered command.
1084 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 */
1086 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001087do_bang(
1088 int addr_count,
1089 exarg_T *eap,
1090 int forceit,
1091 int do_in,
1092 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093{
1094 char_u *arg = eap->arg; /* command */
1095 linenr_T line1 = eap->line1; /* start of range */
1096 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 char_u *newcmd = NULL; /* the new command */
1098 int free_newcmd = FALSE; /* need to free() newcmd */
1099 int ins_prevcmd;
1100 char_u *t;
1101 char_u *p;
1102 char_u *trailarg;
1103 int len;
1104 int scroll_save = msg_scroll;
1105
1106 /*
1107 * Disallow shell commands for "rvim".
1108 * Disallow shell commands from .exrc and .vimrc in current directory for
1109 * security reasons.
1110 */
1111 if (check_restricted() || check_secure())
1112 return;
1113
1114 if (addr_count == 0) /* :! */
1115 {
1116 msg_scroll = FALSE; /* don't scroll here */
1117 autowrite_all();
1118 msg_scroll = scroll_save;
1119 }
1120
1121 /*
1122 * Try to find an embedded bang, like in :!<cmd> ! [args]
1123 * (:!! is indicated by the 'forceit' variable)
1124 */
1125 ins_prevcmd = forceit;
1126 trailarg = arg;
1127 do
1128 {
1129 len = (int)STRLEN(trailarg) + 1;
1130 if (newcmd != NULL)
1131 len += (int)STRLEN(newcmd);
1132 if (ins_prevcmd)
1133 {
1134 if (prevcmd == NULL)
1135 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001136 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 vim_free(newcmd);
1138 return;
1139 }
1140 len += (int)STRLEN(prevcmd);
1141 }
Bram Moolenaar964b3742019-05-24 18:54:09 +02001142 if ((t = alloc(len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 {
1144 vim_free(newcmd);
1145 return;
1146 }
1147 *t = NUL;
1148 if (newcmd != NULL)
1149 STRCAT(t, newcmd);
1150 if (ins_prevcmd)
1151 STRCAT(t, prevcmd);
1152 p = t + STRLEN(t);
1153 STRCAT(t, trailarg);
1154 vim_free(newcmd);
1155 newcmd = t;
1156
1157 /*
1158 * Scan the rest of the argument for '!', which is replaced by the
1159 * previous command. "\!" is replaced by "!" (this is vi compatible).
1160 */
1161 trailarg = NULL;
1162 while (*p)
1163 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001164 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 {
1166 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001167 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 else
1169 {
1170 trailarg = p;
1171 *trailarg++ = NUL;
1172 ins_prevcmd = TRUE;
1173 break;
1174 }
1175 }
1176 ++p;
1177 }
1178 } while (trailarg != NULL);
1179
1180 vim_free(prevcmd);
1181 prevcmd = newcmd;
1182
1183 if (bangredo) /* put cmd in redo buffer for ! command */
1184 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001185 /* If % or # appears in the command, it must have been escaped.
1186 * Reescape them, so that redoing them does not substitute them by the
1187 * buffername. */
1188 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1189
1190 if (cmd != NULL)
1191 {
1192 AppendToRedobuffLit(cmd, -1);
1193 vim_free(cmd);
1194 }
1195 else
1196 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 AppendToRedobuff((char_u *)"\n");
1198 bangredo = FALSE;
1199 }
1200 /*
1201 * Add quotes around the command, for shells that need them.
1202 */
1203 if (*p_shq != NUL)
1204 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001205 newcmd = alloc(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 if (newcmd == NULL)
1207 return;
1208 STRCPY(newcmd, p_shq);
1209 STRCAT(newcmd, prevcmd);
1210 STRCAT(newcmd, p_shq);
1211 free_newcmd = TRUE;
1212 }
1213 if (addr_count == 0) /* :! */
1214 {
1215 /* echo the command */
1216 msg_start();
1217 msg_putchar(':');
1218 msg_putchar('!');
1219 msg_outtrans(newcmd);
1220 msg_clr_eos();
1221 windgoto(msg_row, msg_col);
1222
1223 do_shell(newcmd, 0);
1224 }
1225 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001226 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 /* Careful: This may recursively call do_bang() again! (because of
1228 * autocommands) */
1229 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001230 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 if (free_newcmd)
1233 vim_free(newcmd);
1234}
1235
1236/*
1237 * do_filter: filter lines through a command given by the user
1238 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001239 * We mostly use temp files and the call_shell() routine here. This would
1240 * normally be done using pipes on a UNIX machine, but this is more portable
1241 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 * to deal with redirection somehow, and should handle things like looking
1243 * at the PATH env. variable, and adding reasonable extensions to the
1244 * command name given by the user. All reasonable versions of call_shell()
1245 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001246 * Alternatively, if on Unix and redirecting input or output, but not both,
1247 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 * We use input redirection if do_in is TRUE.
1249 * We use output redirection if do_out is TRUE.
1250 */
1251 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001252do_filter(
1253 linenr_T line1,
1254 linenr_T line2,
1255 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1256 char_u *cmd,
1257 int do_in,
1258 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259{
1260 char_u *itmp = NULL;
1261 char_u *otmp = NULL;
1262 linenr_T linecount;
1263 linenr_T read_linecount;
1264 pos_T cursor_save;
1265 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001267 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268
1269 if (*cmd == NUL) /* no filter command */
1270 return;
1271
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 cursor_save = curwin->w_cursor;
1273 linecount = line2 - line1 + 1;
1274 curwin->w_cursor.lnum = line1;
1275 curwin->w_cursor.col = 0;
1276 changed_line_abv_curs();
1277 invalidate_botline();
1278
1279 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001280 * When using temp files:
1281 * 1. * Form temp file names
1282 * 2. * Write the lines to a temp file
1283 * 3. Run the filter command on the temp file
1284 * 4. * Read the output of the command into the buffer
1285 * 5. * Delete the original lines to be filtered
1286 * 6. * Remove the temp files
1287 *
1288 * When writing the input with a pipe or when catching the output with a
1289 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 */
1291
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001292 if (do_out)
1293 shell_flags |= SHELL_DOOUT;
1294
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001295#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001296 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001298 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1299 shell_flags |= SHELL_READ;
1300 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001302 else if (do_in && !do_out && !p_stmp)
1303 {
1304 /* Use a pipe to write stdin of the command, do not use a temp file. */
1305 shell_flags |= SHELL_WRITE;
1306 curbuf->b_op_start.lnum = line1;
1307 curbuf->b_op_end.lnum = line2;
1308 }
1309 else if (do_in && do_out && !p_stmp)
1310 {
1311 /* Use a pipe to write stdin and fetch stdout of the command, do not
1312 * use a temp file. */
1313 shell_flags |= SHELL_READ|SHELL_WRITE;
1314 curbuf->b_op_start.lnum = line1;
1315 curbuf->b_op_end.lnum = line2;
1316 curwin->w_cursor.lnum = line2;
1317 }
1318 else
1319#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001320 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1321 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001322 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001323 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001324 goto filterend;
1325 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326
1327/*
1328 * The writing and reading of temp files will not be shown.
1329 * Vi also doesn't do this and the messages are not very informative.
1330 */
1331 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001332 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 FALSE, FALSE, FALSE, TRUE) == FAIL)
1334 {
1335 msg_putchar('\n'); /* keep message from buf_write() */
1336 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001337#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 if (!aborting())
1339#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001340 (void)semsg(_(e_notcreate), itmp); /* will call wait_return */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 goto filterend;
1342 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 if (curbuf != old_curbuf)
1344 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345
1346 if (!do_out)
1347 msg_putchar('\n');
1348
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001349 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1351 if (cmd_buf == NULL)
1352 goto filterend;
1353
1354 windgoto((int)Rows - 1, 0);
1355 cursor_on();
1356
1357 /*
1358 * When not redirecting the output the command can write anything to the
1359 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1360 * stderr output of external command. Clear the screen later.
1361 * If do_in is FALSE, this could be something like ":r !cat", which may
1362 * also mess up the screen, clear it later.
1363 */
1364 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1365 redraw_later_clear();
1366
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001367 if (do_out)
1368 {
1369 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001370 {
1371 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001372 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001373 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001374 redraw_curbuf_later(VALID);
1375 }
1376 read_linecount = curbuf->b_ml.ml_line_count;
1377
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 /*
1379 * When call_shell() fails wait_return() is called to give the user a
1380 * chance to read the error messages. Otherwise errors are ignored, so you
1381 * can see the error messages from the command that appear on stdout; use
1382 * 'u' to fix the text
1383 * Switch to cooked mode when not redirecting stdin, avoids that something
1384 * like ":r !cat" hangs.
1385 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1386 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001387 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 {
1389 redraw_later_clear();
1390 wait_return(FALSE);
1391 }
1392 vim_free(cmd_buf);
1393
1394 did_check_timestamps = FALSE;
1395 need_check_timestamps = TRUE;
1396
1397 /* When interrupting the shell command, it may still have produced some
1398 * useful output. Reset got_int here, so that readfile() won't cancel
1399 * reading. */
1400 ui_breakcheck();
1401 got_int = FALSE;
1402
1403 if (do_out)
1404 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001405 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001407 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001408 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001410#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001411 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001413 {
1414 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001415 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001416 }
1417 goto error;
1418 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001419 if (curbuf != old_curbuf)
1420 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001421 }
1422
1423 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1424
1425 if (shell_flags & SHELL_READ)
1426 {
1427 curbuf->b_op_start.lnum = line2 + 1;
1428 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1429 appended_lines_mark(line2, read_linecount);
1430 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431
1432 if (do_in)
1433 {
1434 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1435 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 if (read_linecount >= linecount)
1437 /* move all marks from old lines to new lines */
1438 mark_adjust(line1, line2, linecount, 0L);
1439 else
1440 {
1441 /* move marks from old lines to new lines, delete marks
1442 * that are in deleted lines */
1443 mark_adjust(line1, line1 + read_linecount - 1,
1444 linecount, 0L);
1445 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1446 }
1447 }
1448
1449 /*
1450 * Put cursor on first filtered line for ":range!cmd".
1451 * Adjust '[ and '] (set by buf_write()).
1452 */
1453 curwin->w_cursor.lnum = line1;
1454 del_lines(linecount, TRUE);
1455 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1456 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1457 write_lnum_adjust(-linecount); /* adjust last line
1458 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001459#ifdef FEAT_FOLDING
1460 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1461#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 }
1463 else
1464 {
1465 /*
1466 * Put cursor on last new line for ":r !cmd".
1467 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001469 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001471
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1473 --no_wait_return;
1474
1475 if (linecount > p_report)
1476 {
1477 if (do_in)
1478 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001479 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001480 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001483 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 }
1485 else
1486 msgmore((long)linecount);
1487 }
1488 }
1489 else
1490 {
1491error:
1492 /* put cursor back in same position for ":w !cmd" */
1493 curwin->w_cursor = cursor_save;
1494 --no_wait_return;
1495 wait_return(FALSE);
1496 }
1497
1498filterend:
1499
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 if (curbuf != old_curbuf)
1501 {
1502 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001503 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 if (itmp != NULL)
1506 mch_remove(itmp);
1507 if (otmp != NULL)
1508 mch_remove(otmp);
1509 vim_free(itmp);
1510 vim_free(otmp);
1511}
1512
1513/*
1514 * Call a shell to execute a command.
1515 * When "cmd" is NULL start an interactive shell.
1516 */
1517 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001518do_shell(
1519 char_u *cmd,
1520 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521{
1522 buf_T *buf;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001523#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001524 int save_nwr;
1525#endif
1526#ifdef MSWIN
1527 int winstart = FALSE;
Bram Moolenaar049ca592019-03-17 16:59:44 +01001528 int keep_termcap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529#endif
1530
1531 /*
1532 * Disallow shell commands for "rvim".
1533 * Disallow shell commands from .exrc and .vimrc in current directory for
1534 * security reasons.
1535 */
1536 if (check_restricted() || check_secure())
1537 {
1538 msg_end();
1539 return;
1540 }
1541
1542#ifdef MSWIN
1543 /*
Bram Moolenaar049ca592019-03-17 16:59:44 +01001544 * Check if ":!start" is used. This implies not stopping termcap mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 */
1546 if (cmd != NULL)
Bram Moolenaar049ca592019-03-17 16:59:44 +01001547 keep_termcap = winstart = (STRNICMP(cmd, "start ", 6) == 0);
1548
1549# if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
1550 // Don't stop termcap mode when using a terminal window for the shell.
1551 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
1552 keep_termcap = TRUE;
1553# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554#endif
1555
1556 /*
1557 * For autocommands we want to get the output on the current screen, to
1558 * avoid having to type return below.
1559 */
Bram Moolenaar049ca592019-03-17 16:59:44 +01001560 msg_putchar('\r'); // put cursor at start of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 {
1563#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001564 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565#endif
1566 stoptermcap();
1567 }
1568#ifdef MSWIN
1569 if (!winstart)
1570#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001571 msg_putchar('\n'); // may shift screen one line up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572
Bram Moolenaar049ca592019-03-17 16:59:44 +01001573 // warning message before calling the shell
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001574 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001575 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001576 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 {
1578#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001579 if (!keep_termcap)
1580 starttermcap(); // don't want a message box here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001582 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001584 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 stoptermcap();
1586#endif
1587 break;
1588 }
1589
Bram Moolenaar049ca592019-03-17 16:59:44 +01001590 // This windgoto is required for when the '\n' resulted in a "delete line
1591 // 1" command to the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 if (!swapping_screen())
1593 windgoto(msg_row, msg_col);
1594 cursor_on();
1595 (void)call_shell(cmd, SHELL_COOKED | flags);
1596 did_check_timestamps = FALSE;
1597 need_check_timestamps = TRUE;
1598
1599 /*
1600 * put the message cursor at the end of the screen, avoids wait_return()
1601 * to overwrite the text that the external command showed
1602 */
1603 if (!swapping_screen())
1604 {
1605 msg_row = Rows - 1;
1606 msg_col = 0;
1607 }
1608
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 if (autocmd_busy)
1610 {
1611 if (msg_silent == 0)
1612 redraw_later_clear();
1613 }
1614 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 {
1616 /*
1617 * For ":sh" there is no need to call wait_return(), just redraw.
1618 * Also for the Win32 GUI (the output is in a console window).
1619 * Otherwise there is probably text on the screen that the user wants
1620 * to read before redrawing, so call wait_return().
1621 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001622#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
1623# ifdef VIMDLL
1624 if (!gui.in_use)
1625# endif
1626 {
1627 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001628# ifdef MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001629 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001631 )
1632 {
1633 if (msg_silent == 0)
1634 redraw_later_clear();
1635 need_wait_return = FALSE;
1636 }
1637 else
1638 {
1639 /*
1640 * If we switch screens when starttermcap() is called, we
1641 * really want to wait for "hit return to continue".
1642 */
1643 save_nwr = no_wait_return;
1644 if (swapping_screen())
1645 no_wait_return = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646# ifdef AMIGA
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001647 wait_return(term_console ? -1 : msg_silent == 0); // see below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648# else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001649 wait_return(msg_silent == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001651 no_wait_return = save_nwr;
1652 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001654#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655
1656#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001657 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001659 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660
1661 /*
1662 * In an Amiga window redrawing is caused by asking the window size.
1663 * If we got an interrupt this will not work. The chance that the
1664 * window size is wrong is very small, but we need to redraw the
1665 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1666 * but it saves an extra redraw.
1667 */
1668#ifdef AMIGA
1669 if (skip_redraw) /* ':' hit in wait_return() */
1670 {
1671 if (msg_silent == 0)
1672 redraw_later_clear();
1673 }
1674 else if (term_console)
1675 {
1676 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1677 if (got_int && msg_silent == 0)
1678 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1679 else
1680 must_redraw = 0; /* no extra redraw needed */
1681 }
1682#endif
1683 }
1684
1685 /* display any error messages now */
1686 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001687
Bram Moolenaarade00832006-03-10 21:46:58 +00001688 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689}
1690
Bram Moolenaar06640892018-10-09 21:49:33 +02001691#if !defined(UNIX)
1692 static char_u *
1693find_pipe(char_u *cmd)
1694{
1695 char_u *p;
1696 int inquote = FALSE;
1697
1698 for (p = cmd; *p != NUL; ++p)
1699 {
1700 if (!inquote && *p == '|')
1701 return p;
1702 if (*p == '"')
1703 inquote = !inquote;
1704 else if (rem_backslash(p))
1705 ++p;
1706 }
1707 return NULL;
1708}
1709#endif
1710
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711/*
1712 * Create a shell command from a command string, input redirection file and
1713 * output redirection file.
1714 * Returns an allocated string with the shell command, or NULL for failure.
1715 */
1716 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001717make_filter_cmd(
1718 char_u *cmd, /* command */
1719 char_u *itmp, /* NULL or name of input file */
1720 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721{
1722 char_u *buf;
1723 long_u len;
1724
Bram Moolenaar53076832015-12-31 19:53:21 +01001725#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001726 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001727 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001728
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001729 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001730 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1731 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001732 if (is_fish_shell)
1733 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1734 else
1735#endif
1736 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 if (itmp != NULL)
1738 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1739 if (otmp != NULL)
1740 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02001741 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 if (buf == NULL)
1743 return NULL;
1744
Bram Moolenaar53076832015-12-31 19:53:21 +01001745#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001747 * Put braces around the command (for concatenated commands) when
1748 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001750 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001751 {
1752 if (is_fish_shell)
1753 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1754 else
1755 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1756 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001757 else
1758 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 if (itmp != NULL)
1760 {
1761 STRCAT(buf, " < ");
1762 STRCAT(buf, itmp);
1763 }
1764#else
1765 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001766 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 * the use of commands in a pipe.
1768 */
1769 STRCPY(buf, cmd);
1770 if (itmp != NULL)
1771 {
1772 char_u *p;
1773
1774 /*
1775 * If there is a pipe, we have to put the '<' in front of it.
1776 * Don't do this when 'shellquote' is not empty, otherwise the
1777 * redirection would be inside the quotes.
1778 */
1779 if (*p_shq == NUL)
1780 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001781 p = find_pipe(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 if (p != NULL)
1783 *p = NUL;
1784 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1786 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 if (*p_shq == NUL)
1788 {
Bram Moolenaar06640892018-10-09 21:49:33 +02001789 p = find_pipe(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 if (p != NULL)
1791 {
1792 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1793 STRCAT(buf, p);
1794 }
1795 }
1796 }
1797#endif
1798 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001799 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800
1801 return buf;
1802}
1803
1804/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001805 * Append output redirection for file "fname" to the end of string buffer
1806 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 * Works with the 'shellredir' and 'shellpipe' options.
1808 * The caller should make sure that there is enough room:
1809 * STRLEN(opt) + STRLEN(fname) + 3
1810 */
1811 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001812append_redir(
1813 char_u *buf,
1814 int buflen,
1815 char_u *opt,
1816 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817{
1818 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001819 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001821 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001822 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001824 {
1825 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001827 if (p[1] == '%') /* skip %% */
1828 ++p;
1829 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 if (p != NULL)
1831 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001832 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1833 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1834 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 }
1836 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001837 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 " %s %s",
1840#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842#endif
1843 (char *)opt, (char *)fname);
1844}
1845
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001846/*
1847 * Return the current time in seconds. Calls time(), unless test_settime()
1848 * was used.
1849 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001850 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001851vim_time(void)
1852{
1853# ifdef FEAT_EVAL
1854 return time_for_testing == 0 ? time(NULL) : time_for_testing;
1855# else
1856 return time(NULL);
1857# endif
1858}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001859
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860/*
1861 * Implementation of ":fixdel", also used by get_stty().
1862 * <BS> resulting <Del>
1863 * ^? ^H
1864 * not ^? ^?
1865 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001867do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868{
1869 char_u *p;
1870
1871 p = find_termcode((char_u *)"kb");
1872 add_termcode((char_u *)"kD", p != NULL
1873 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
1874}
1875
1876 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001877print_line_no_prefix(
1878 linenr_T lnum,
1879 int use_number,
1880 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001882 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883
1884 if (curwin->w_p_nu || use_number)
1885 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001886 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001887 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001888 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001890 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891}
1892
1893/*
1894 * Print a text line. Also in silent mode ("ex -s").
1895 */
1896 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001897print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898{
1899 int save_silent = silent_mode;
1900
Bram Moolenaard29459b2016-08-26 22:29:11 +02001901 /* apply :filter /pat/ */
1902 if (message_filtered(ml_get(lnum)))
1903 return;
1904
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001906 silent_mode = FALSE;
1907 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
1908 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 if (save_silent)
1910 {
1911 msg_putchar('\n');
1912 cursor_on(); /* msg_start() switches it off */
1913 out_flush();
1914 silent_mode = save_silent;
1915 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00001916 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917}
1918
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001919 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001920rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001921{
1922 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02001923 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001924
Bram Moolenaar7e283842013-05-30 11:43:15 +02001925 buf = curbuf;
1926 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001927 /* buffer changed, don't change name now */
1928 if (buf != curbuf)
1929 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001930#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001931 if (aborting()) /* autocmds may abort script processing */
1932 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001933#endif
1934 /*
1935 * The name of the current buffer will be changed.
1936 * A new (unlisted) buffer entry needs to be made to hold the old file
1937 * name, which will become the alternate file name.
1938 * But don't set the alternate file name if the buffer didn't have a
1939 * name.
1940 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02001941 fname = curbuf->b_ffname;
1942 sfname = curbuf->b_sfname;
1943 xfname = curbuf->b_fname;
1944 curbuf->b_ffname = NULL;
1945 curbuf->b_sfname = NULL;
1946 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001947 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02001948 curbuf->b_ffname = fname;
1949 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001950 return FAIL;
1951 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02001952 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001953 if (xfname != NULL && *xfname != NUL)
1954 {
1955 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
1956 if (buf != NULL && !cmdmod.keepalt)
1957 curwin->w_alt_fnum = buf->b_fnum;
1958 }
1959 vim_free(fname);
1960 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02001961 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001962
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001963 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02001964 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001965 return OK;
1966}
1967
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968/*
1969 * ":file[!] [fname]".
1970 */
1971 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001972ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001974 /* ":0file" removes the file name. Check for illegal uses ":3file",
1975 * "0file name", etc. */
1976 if (eap->addr_count > 0
1977 && (*eap->arg != NUL
1978 || eap->line2 > 0
1979 || eap->addr_count > 1))
1980 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001981 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001982 return;
1983 }
1984
1985 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001987 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02001989 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02001991
1992 // print file name if no argument or 'F' is not in 'shortmess'
1993 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01001994 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995}
1996
1997/*
1998 * ":update".
1999 */
2000 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002001ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002{
2003 if (curbufIsChanged())
2004 (void)do_write(eap);
2005}
2006
2007/*
2008 * ":write" and ":saveas".
2009 */
2010 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002011ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012{
Bram Moolenaarb7316892019-05-01 18:08:42 +02002013 if (eap->cmdidx == CMD_saveas)
2014 {
2015 // :saveas does not take a range, uses all lines.
2016 eap->line1 = 1;
2017 eap->line2 = curbuf->b_ml.ml_line_count;
2018 }
2019
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 if (eap->usefilter) /* input lines to shell command */
2021 do_bang(1, eap, FALSE, TRUE, FALSE);
2022 else
2023 (void)do_write(eap);
2024}
2025
2026/*
2027 * write current buffer to file 'eap->arg'
2028 * if 'eap->append' is TRUE, append to the file
2029 *
2030 * if *eap->arg == NUL write to current file
2031 *
2032 * return FAIL for failure, OK otherwise
2033 */
2034 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002035do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036{
2037 int other;
2038 char_u *fname = NULL; /* init to shut up gcc */
2039 char_u *ffname;
2040 int retval = FAIL;
2041 char_u *free_fname = NULL;
2042#ifdef FEAT_BROWSE
2043 char_u *browse_file = NULL;
2044#endif
2045 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02002046 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047
2048 if (not_writing()) /* check 'write' option */
2049 return FAIL;
2050
2051 ffname = eap->arg;
2052#ifdef FEAT_BROWSE
Bram Moolenaar5c381eb2019-06-25 06:50:31 +02002053 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002055 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 NULL, NULL, NULL, curbuf);
2057 if (browse_file == NULL)
2058 goto theend;
2059 ffname = browse_file;
2060 }
2061#endif
2062 if (*ffname == NUL)
2063 {
2064 if (eap->cmdidx == CMD_saveas)
2065 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002066 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 goto theend;
2068 }
2069 other = FALSE;
2070 }
2071 else
2072 {
2073 fname = ffname;
2074 free_fname = fix_fname(ffname);
2075 /*
2076 * When out-of-memory, keep unexpanded file name, because we MUST be
2077 * able to write the file in this situation.
2078 */
2079 if (free_fname != NULL)
2080 ffname = free_fname;
2081 other = otherfile(ffname);
2082 }
2083
2084 /*
2085 * If we have a new file, put its name in the list of alternate file names.
2086 */
2087 if (other)
2088 {
2089 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2090 || eap->cmdidx == CMD_saveas)
2091 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2092 else
2093 alt_buf = buflist_findname(ffname);
2094 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2095 {
2096 /* Overwriting a file that is loaded in another buffer is not a
2097 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002098 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 goto theend;
2100 }
2101 }
2102
2103 /*
2104 * Writing to the current file is not allowed in readonly mode
2105 * and a file name is required.
2106 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2107 */
2108 if (!other && (
2109#ifdef FEAT_QUICKFIX
2110 bt_dontwrite_msg(curbuf) ||
2111#endif
2112 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2113 goto theend;
2114
2115 if (!other)
2116 {
2117 ffname = curbuf->b_ffname;
2118 fname = curbuf->b_fname;
2119 /*
2120 * Not writing the whole file is only allowed with '!'.
2121 */
2122 if ( (eap->line1 != 1
2123 || eap->line2 != curbuf->b_ml.ml_line_count)
2124 && !eap->forceit
2125 && !eap->append
2126 && !p_wa)
2127 {
2128#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2129 if (p_confirm || cmdmod.confirm)
2130 {
2131 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2132 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2133 goto theend;
2134 eap->forceit = TRUE;
2135 }
2136 else
2137#endif
2138 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002139 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 goto theend;
2141 }
2142 }
2143 }
2144
2145 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2146 {
2147 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2148 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 buf_T *was_curbuf = curbuf;
2150
2151 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002152 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002153#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002155#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002157#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 {
2159 /* buffer changed, don't change name now */
2160 retval = FAIL;
2161 goto theend;
2162 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 /* Exchange the file names for the current and the alternate
2164 * buffer. This makes it look like we are now editing the buffer
2165 * under the new name. Must be done before buf_write(), because
2166 * if there is no file name and 'cpo' contains 'F', it will set
2167 * the file name. */
2168 fname = alt_buf->b_fname;
2169 alt_buf->b_fname = curbuf->b_fname;
2170 curbuf->b_fname = fname;
2171 fname = alt_buf->b_ffname;
2172 alt_buf->b_ffname = curbuf->b_ffname;
2173 curbuf->b_ffname = fname;
2174 fname = alt_buf->b_sfname;
2175 alt_buf->b_sfname = curbuf->b_sfname;
2176 curbuf->b_sfname = fname;
2177 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002178
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002180 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 if (!alt_buf->b_p_bl)
2182 {
2183 alt_buf->b_p_bl = TRUE;
2184 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2185 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002186#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002188#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002190#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 {
2192 /* buffer changed, don't write the file */
2193 retval = FAIL;
2194 goto theend;
2195 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002196
2197 /* If 'filetype' was empty try detecting it now. */
2198 if (*curbuf->b_p_ft == NUL)
2199 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002200 if (au_has_group((char_u *)"filetypedetect"))
2201 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02002202 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002203 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002204 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002205
2206 /* Autocommands may have changed buffer names, esp. when
2207 * 'autochdir' is set. */
2208 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 }
2210
Bram Moolenaar5c719942016-07-09 23:40:45 +02002211 name_was_missing = curbuf->b_ffname == NULL;
2212
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2214 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002215
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002216 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002217 if (eap->cmdidx == CMD_saveas)
2218 {
2219 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002220 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002221 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002222 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002223 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02002224 }
2225
2226 /* Change directories when the 'acd' option is set and the file name
2227 * got changed or set. */
2228 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02002229 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 }
2231
2232theend:
2233#ifdef FEAT_BROWSE
2234 vim_free(browse_file);
2235#endif
2236 vim_free(free_fname);
2237 return retval;
2238}
2239
2240/*
2241 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2242 * BF_NEW or BF_READERR, check for overwriting current file.
2243 * May set eap->forceit if a dialog says it's OK to overwrite.
2244 * Return OK if it's OK, FAIL if it is not.
2245 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002246 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002247check_overwrite(
2248 exarg_T *eap,
2249 buf_T *buf,
2250 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002252 char_u *ffname, /* full path version of fname */
2253 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254{
2255 /*
2256 * write to other file or b_flags set or not writing the whole file:
2257 * overwriting only allowed with '!'
2258 */
2259 if ( (other
2260 || (buf->b_flags & BF_NOTEDITED)
2261 || ((buf->b_flags & BF_NEW)
2262 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2263 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002265#ifdef FEAT_QUICKFIX
Bram Moolenaar26910de2019-06-15 19:37:15 +02002266 && !bt_nofilename(buf)
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002267#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 && vim_fexists(ffname))
2269 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002270 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002272#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002273 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002274 if (mch_isdir(ffname))
2275 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002276 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002277 return FAIL;
2278 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279#endif
2280#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002281 if (p_confirm || cmdmod.confirm)
2282 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002283 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002284
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002285 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2286 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2287 return FAIL;
2288 eap->forceit = TRUE;
2289 }
2290 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002292 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002293 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002294 return FAIL;
2295 }
2296 }
2297
2298 /* For ":w! filename" check that no swap file exists for "filename". */
2299 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002301 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002302 char_u *p;
2303 int r;
2304 char_u *swapname;
2305
2306 /* We only try the first entry in 'directory', without checking if
2307 * it's writable. If the "." directory is not writable the write
2308 * will probably fail anyway.
2309 * Use 'shortname' of the current buffer, since there is no buffer
2310 * for the written file. */
2311 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002312 {
2313 dir = alloc(5);
2314 if (dir == NULL)
2315 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002316 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002317 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002318 else
2319 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002320 dir = alloc(MAXPATHL);
2321 if (dir == NULL)
2322 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002323 p = p_dir;
2324 copy_option_part(&p, dir, MAXPATHL, ",");
2325 }
2326 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002327 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002328 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002329 if (r)
2330 {
2331#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2332 if (p_confirm || cmdmod.confirm)
2333 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002334 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002335
2336 dialog_msg(buff,
2337 _("Swap file \"%s\" exists, overwrite anyway?"),
2338 swapname);
2339 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2340 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002341 {
2342 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002343 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002344 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002345 eap->forceit = TRUE;
2346 }
2347 else
2348#endif
2349 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002350 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002351 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002352 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002353 return FAIL;
2354 }
2355 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002356 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 }
2358 }
2359 return OK;
2360}
2361
2362/*
2363 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2364 */
2365 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002366ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367{
2368 int i;
2369
2370 if (eap->cmd[1] == 'n')
2371 i = curwin->w_arg_idx + (int)eap->line2;
2372 else
2373 i = curwin->w_arg_idx - (int)eap->line2;
2374 eap->line1 = 1;
2375 eap->line2 = curbuf->b_ml.ml_line_count;
2376 if (do_write(eap) != FAIL)
2377 do_argfile(eap, i);
2378}
2379
2380/*
2381 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2382 */
2383 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002384do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385{
2386 buf_T *buf;
2387 int error = 0;
2388 int save_forceit = eap->forceit;
2389
2390 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2391 exiting = TRUE;
2392
Bram Moolenaar29323592016-07-24 22:04:11 +02002393 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01002395#ifdef FEAT_TERMINAL
2396 if (exiting && term_job_running(buf->b_term))
2397 {
2398 no_write_message_nobang(buf);
2399 ++error;
2400 }
2401 else
2402#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02002403 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 {
2405 /*
2406 * Check if there is a reason the buffer cannot be written:
2407 * 1. if the 'write' option is set
2408 * 2. if there is no file name (even after browsing)
2409 * 3. if the 'readonly' is set (even after a dialog)
2410 * 4. if overwriting is allowed (even after a dialog)
2411 */
2412 if (not_writing())
2413 {
2414 ++error;
2415 break;
2416 }
2417#ifdef FEAT_BROWSE
2418 /* ":browse wall": ask for file name if there isn't one */
2419 if (buf->b_ffname == NULL && cmdmod.browse)
2420 browse_save_fname(buf);
2421#endif
2422 if (buf->b_ffname == NULL)
2423 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002424 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 ++error;
2426 }
2427 else if (check_readonly(&eap->forceit, buf)
2428 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2429 FALSE) == FAIL)
2430 {
2431 ++error;
2432 }
2433 else
2434 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002435 bufref_T bufref;
2436
2437 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 if (buf_write_all(buf, eap->forceit) == FAIL)
2439 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002441 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 }
2444 eap->forceit = save_forceit; /* check_overwrite() may set it */
2445 }
2446 }
2447 if (exiting)
2448 {
2449 if (!error)
2450 getout(0); /* exit Vim */
2451 not_exiting();
2452 }
2453}
2454
2455/*
2456 * Check the 'write' option.
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002457 * Return TRUE and give a message when it's not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 */
2459 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002460not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461{
2462 if (p_write)
2463 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002464 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 return TRUE;
2466}
2467
2468/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002469 * Check if a buffer is read-only (either 'readonly' option is set or file is
2470 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2471 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 */
2473 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002474check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002476 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00002477
2478 /* Handle a file being readonly when the 'readonly' option is set or when
2479 * the file exists and permissions are read-only.
2480 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2481 * important for device checks but not here. */
2482 if (!*forceit && (buf->b_p_ro
2483 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2484 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 {
2486#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2487 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2488 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002489 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490
Bram Moolenaar5386a122007-06-28 20:02:32 +00002491 if (buf->b_p_ro)
2492 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2493 buf->b_fname);
2494 else
2495 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 +00002496 buf->b_fname);
2497
2498 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2499 {
2500 /* Set forceit, to force the writing of a readonly file */
2501 *forceit = TRUE;
2502 return FALSE;
2503 }
2504 else
2505 return TRUE;
2506 }
2507 else
2508#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002509 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002510 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002511 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002512 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00002513 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 return TRUE;
2515 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002516
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 return FALSE;
2518}
2519
2520/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002521 * Try to abandon the current file and edit a new or existing file.
2522 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002523 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002525 * Return:
2526 * GETFILE_ERROR for "normal" error,
2527 * GETFILE_NOT_WRITTEN for "not written" error,
2528 * GETFILE_SAME_FILE for success
2529 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 */
2531 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002532getfile(
2533 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002534 char_u *ffname_arg,
2535 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002536 int setpm,
2537 linenr_T lnum,
2538 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002540 char_u *ffname = ffname_arg;
2541 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 int other;
2543 int retval;
2544 char_u *free_me = NULL;
2545
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002546 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002547 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002548 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002549 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550
2551 if (fnum == 0)
2552 {
2553 /* make ffname full path, set sfname */
2554 fname_expand(curbuf, &ffname, &sfname);
2555 other = otherfile(ffname);
2556 free_me = ffname; /* has been allocated, free() later */
2557 }
2558 else
2559 other = (fnum != curbuf->b_fnum);
2560
2561 if (other)
2562 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002563 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
2565 {
2566#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2567 if (p_confirm && p_write)
2568 dialog_changed(curbuf, FALSE);
2569 if (curbufIsChanged())
2570#endif
2571 {
2572 if (other)
2573 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002574 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002575 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 goto theend;
2577 }
2578 }
2579 if (other)
2580 --no_wait_return;
2581 if (setpm)
2582 setpcmark();
2583 if (!other)
2584 {
2585 if (lnum != 0)
2586 curwin->w_cursor.lnum = lnum;
2587 check_cursor_lnum();
2588 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002589 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 }
2591 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002592 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002593 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002594 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002596 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597
2598theend:
2599 vim_free(free_me);
2600 return retval;
2601}
2602
2603/*
2604 * start editing a new file
2605 *
2606 * fnum: file number; if zero use ffname/sfname
2607 * ffname: the file name
2608 * - full path if sfname used,
2609 * - any file name if sfname is NULL
2610 * - empty string to re-edit with the same file name (but may be
2611 * in a different directory)
2612 * - NULL to start an empty buffer
2613 * sfname: the short file name (or NULL)
2614 * eap: contains the command to be executed after loading the file and
2615 * forced 'ff' and 'fenc'
2616 * newlnum: if > 0: put cursor on this line number (if possible)
2617 * if ECMD_LASTL: use last position in loaded file
2618 * if ECMD_LAST: use last position in all files
2619 * if ECMD_ONE: use first line
2620 * flags:
2621 * ECMD_HIDE: if TRUE don't free the current buffer
2622 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
2623 * ECMD_OLDBUF: use existing buffer if it exists
2624 * ECMD_FORCEIT: ! used for Ex command
2625 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002626 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02002627 * window, NULL when splitting the window first. When not NULL info
2628 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 *
2630 * return FAIL for failure, OK otherwise
2631 */
2632 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002633do_ecmd(
2634 int fnum,
2635 char_u *ffname,
2636 char_u *sfname,
2637 exarg_T *eap, /* can be NULL! */
2638 linenr_T newlnum,
2639 int flags,
2640 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641{
2642 int other_file; /* TRUE if editing another file */
2643 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 int auto_buf = FALSE; /* TRUE if autocommands brought us
2645 into the buffer unexpectedly */
2646 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002647#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002648 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649#endif
2650 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002651 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002652 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 char_u *free_fname = NULL;
2654#ifdef FEAT_BROWSE
2655 char_u *browse_file = NULL;
2656#endif
2657 int retval = FAIL;
2658 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01002659 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 linenr_T topline = 0;
2661 int newcol = -1;
2662 int solcol = -1;
2663 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002665#ifdef FEAT_SPELL
2666 int did_get_winopts = FALSE;
2667#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002668 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002669 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01002670 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
2672 if (eap != NULL)
2673 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002674 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675
2676 if (fnum != 0)
2677 {
2678 if (fnum == curbuf->b_fnum) /* file is already being edited */
2679 return OK; /* nothing to do */
2680 other_file = TRUE;
2681 }
2682 else
2683 {
2684#ifdef FEAT_BROWSE
Bram Moolenaar2eed9ba2019-06-25 23:40:29 +02002685 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002687 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002688# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002689 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002690# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002691 au_has_group((char_u *)"FileExplorer"))
2692 {
2693 /* No browsing supported but we do have the file explorer:
2694 * Edit the directory. */
2695 if (ffname == NULL || !mch_isdir(ffname))
2696 ffname = (char_u *)".";
2697 }
2698 else
2699 {
2700 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002702 if (browse_file == NULL)
2703 goto theend;
2704 ffname = browse_file;
2705 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 }
2707#endif
2708 /* if no short name given, use ffname for short name */
2709 if (sfname == NULL)
2710 sfname = ffname;
2711#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01002712 if (sfname != NULL)
2713 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714#endif
2715
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
2717 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718
2719 if (ffname == NULL)
2720 other_file = TRUE;
2721 /* there is no file name */
2722 else if (*ffname == NUL && curbuf->b_ffname == NULL)
2723 other_file = FALSE;
2724 else
2725 {
2726 if (*ffname == NUL) /* re-edit with same file name */
2727 {
2728 ffname = curbuf->b_ffname;
2729 sfname = curbuf->b_fname;
2730 }
2731 free_fname = fix_fname(ffname); /* may expand to full path name */
2732 if (free_fname != NULL)
2733 ffname = free_fname;
2734 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 }
2736 }
2737
2738 /*
2739 * if the file was changed we may not be allowed to abandon it
2740 * - if we are going to re-edit the same file
2741 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
2742 */
2743 if ( ((!other_file && !(flags & ECMD_OLDBUF))
2744 || (curbuf->b_nwindows == 1
2745 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002746 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
2747 | (other_file ? 0 : CCGD_MULTWIN)
2748 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
2749 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 {
2751 if (fnum == 0 && other_file && ffname != NULL)
2752 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
2753 goto theend;
2754 }
2755
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 /*
2757 * End Visual mode before switching to another buffer, so the text can be
2758 * copied into the GUI selection buffer.
2759 */
2760 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002762#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002763 if ((command != NULL || newlnum > (linenr_T)0)
2764 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
2765 {
2766 int len;
2767 char_u *p;
2768
2769 /* Set v:swapcommand for the SwapExists autocommands. */
2770 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002771 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002772 else
2773 len = 30;
Bram Moolenaar964b3742019-05-24 18:54:09 +02002774 p = alloc(len);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002775 if (p != NULL)
2776 {
2777 if (command != NULL)
2778 vim_snprintf((char *)p, len, ":%s\r", command);
2779 else
2780 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
2781 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
2782 did_set_swapcommand = TRUE;
2783 vim_free(p);
2784 }
2785 }
2786#endif
2787
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 /*
2789 * If we are starting to edit another file, open a (new) buffer.
2790 * Otherwise we re-use the current buffer.
2791 */
2792 if (other_file)
2793 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002796 if (!cmdmod.keepalt)
2797 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002798 if (oldwin != NULL)
2799 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 }
2801
2802 if (fnum)
2803 buf = buflist_findnr(fnum);
2804 else
2805 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 if (flags & ECMD_ADDBUF)
2807 {
2808 linenr_T tlnum = 1L;
2809
2810 if (command != NULL)
2811 {
2812 tlnum = atol((char *)command);
2813 if (tlnum <= 0)
2814 tlnum = 1L;
2815 }
2816 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
2817 goto theend;
2818 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 buf = buflist_new(ffname, sfname, 0L,
2820 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002821
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02002822 /* autocommands may change curwin and curbuf */
2823 if (oldwin != NULL)
2824 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002825 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 }
2827 if (buf == NULL)
2828 goto theend;
2829 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
2830 {
2831 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 }
2833 else /* existing memfile */
2834 {
2835 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002836 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002838 /* Check if autocommands made the buffer invalid or changed the
2839 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002840 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 goto theend;
2842#ifdef FEAT_EVAL
2843 if (aborting()) /* autocmds may abort script processing */
2844 goto theend;
2845#endif
2846 }
2847
2848 /* May jump to last used line number for a loaded buffer or when asked
2849 * for explicitly */
2850 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
2851 {
2852 pos = buflist_findfpos(buf);
2853 newlnum = pos->lnum;
2854 solcol = pos->col;
2855 }
2856
2857 /*
2858 * Make the (new) buffer the one used by the current window.
2859 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
2860 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01002861 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 */
2863 if (buf != curbuf)
2864 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 /*
2866 * Be careful: The autocommands may delete any buffer and change
2867 * the current buffer.
2868 * - If the buffer we are going to edit is deleted, give up.
2869 * - If the current buffer is deleted, prefer to load the new
2870 * buffer when loading a buffer is required. This avoids
2871 * loading another buffer which then must be closed again.
2872 * - If we ended up in the new buffer already, need to skip a few
2873 * things, set auto_buf.
2874 */
2875 if (buf->b_fname != NULL)
2876 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002877 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002879 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002881 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 delbuf_msg(new_name); /* frees new_name */
2883 goto theend;
2884 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002885#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 if (aborting()) /* autocmds may abort script processing */
2887 {
2888 vim_free(new_name);
2889 goto theend;
2890 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002891#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 if (buf == curbuf) /* already in new buffer */
2893 auto_buf = TRUE;
2894 else
2895 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02002896 win_T *the_curwin = curwin;
2897
2898 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002899 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02002900 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002901 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02002902
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002903 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 buf_copy_options(buf, BCO_ENTER);
2905
Bram Moolenaar5a497892016-09-03 16:29:04 +02002906 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02002907 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002908 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002909 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01002910 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911
Bram Moolenaar5a497892016-09-03 16:29:04 +02002912 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002913 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01002914
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002915#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02002916 /* autocmds may abort script processing */
2917 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 {
2919 vim_free(new_name);
2920 goto theend;
2921 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002922#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002924 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002926 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 delbuf_msg(new_name); /* frees new_name */
2928 goto theend;
2929 }
2930 if (buf == curbuf) /* already in new buffer */
2931 auto_buf = TRUE;
2932 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02002934#ifdef FEAT_SYN_HL
2935 /*
2936 * <VN> We could instead free the synblock
2937 * and re-attach to buffer, perhaps.
2938 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02002939 if (curwin->w_buffer == NULL
2940 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02002941 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02002942#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 curwin->w_buffer = buf;
2944 curbuf = buf;
2945 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02002946
2947 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
2948 if (!oldbuf && eap != NULL)
2949 {
2950 set_file_options(TRUE, eap);
2951 set_forced_fenc(eap);
2952 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 }
2954
2955 /* May get the window options from the last time this buffer
2956 * was in this window (or another window). If not used
2957 * before, reset the local window options to the global
2958 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00002959 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002960#ifdef FEAT_SPELL
2961 did_get_winopts = TRUE;
2962#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 }
2964 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002965 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02002966 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968
2969 curwin->w_pcmark.lnum = 1;
2970 curwin->w_pcmark.col = 0;
2971 }
2972 else /* !other_file */
2973 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002974 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01002976
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 oldbuf = (flags & ECMD_OLDBUF);
2978 }
2979
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002980 /* Don't redraw until the cursor is in the right line, otherwise
2981 * autocommands may cause ml_get errors. */
2982 ++RedrawingDisabled;
2983 did_inc_redrawing_disabled = TRUE;
2984
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002985 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 if ((flags & ECMD_SET_HELP) || keep_help_flag)
2987 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002988 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 }
2990 else
2991 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 /* Don't make a buffer listed if it's a help buffer. Useful when
2993 * using CTRL-O to go back to a help file. */
2994 if (!curbuf->b_help)
2995 set_buflisted(TRUE);
2996 }
2997
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 /* If autocommands change buffers under our fingers, forget about
2999 * editing the file. */
3000 if (buf != curbuf)
3001 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003002#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 if (aborting()) /* autocmds may abort script processing */
3004 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003005#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006
3007 /* Since we are starting to edit a file, consider the filetype to be
3008 * unset. Helps for when an autocommand changes files and expects syntax
3009 * highlighting to work in the other file. */
3010 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011
3012/*
3013 * other_file oldbuf
3014 * FALSE FALSE re-edit same file, buffer is re-used
3015 * FALSE TRUE re-edit same file, nothing changes
3016 * TRUE FALSE start editing new file, new buffer
3017 * TRUE TRUE start editing in existing buffer (nothing to do)
3018 */
3019 if (!other_file && !oldbuf) /* re-use the buffer */
3020 {
3021 set_last_cursor(curwin); /* may set b_last_cursor */
3022 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3023 {
3024 newlnum = curwin->w_cursor.lnum;
3025 solcol = curwin->w_cursor.col;
3026 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 buf = curbuf;
3028 if (buf->b_fname != NULL)
3029 new_name = vim_strsave(buf->b_fname);
3030 else
3031 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003032 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003033
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003034 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
3035 {
3036 /* Save all the text, so that the reload can be undone.
3037 * Sync first so that this is a separate undo-able action. */
3038 u_sync(FALSE);
3039 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
3040 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02003041 {
3042 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003043 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02003044 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003045 u_unchanged(curbuf);
3046 buf_freeall(curbuf, BFA_KEEP_UNDO);
3047
3048 /* tell readfile() not to clear or reload undo info */
3049 readfile_flags = READ_KEEP_UNDO;
3050 }
3051 else
3052 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003053
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 /* If autocommands deleted the buffer we were going to re-edit, give
3055 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003056 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 {
3058 delbuf_msg(new_name); /* frees new_name */
3059 goto theend;
3060 }
3061 vim_free(new_name);
3062
3063 /* If autocommands change buffers under our fingers, forget about
3064 * re-editing the file. Should do the buf_clear_file(), but perhaps
3065 * the autocommands changed the buffer... */
3066 if (buf != curbuf)
3067 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003068#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 if (aborting()) /* autocmds may abort script processing */
3070 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071#endif
3072 buf_clear_file(curbuf);
3073 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3074 curbuf->b_op_end.lnum = 0;
3075 }
3076
3077/*
3078 * If we get here we are sure to start editing
3079 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 /* Assume success now */
3081 retval = OK;
3082
3083 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 * Check if we are editing the w_arg_idx file in the argument list.
3085 */
3086 check_arg_idx(curwin);
3087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 {
3090 /*
3091 * Set cursor and init window before reading the file and executing
3092 * autocommands. This allows for the autocommands to position the
3093 * cursor.
3094 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003095 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096
3097#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003098 /* It's possible that all lines in the buffer changed. Need to update
3099 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003100 {
3101 win_T *win;
3102 tabpage_T *tp;
3103
3104 FOR_ALL_TAB_WINDOWS(tp, win)
3105 if (win->w_buffer == curbuf)
3106 foldUpdateAll(win);
3107 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108#endif
3109
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003110 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02003111 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 /*
3114 * Careful: open_buffer() and apply_autocmds() may change the current
3115 * buffer and window.
3116 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01003117 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 topline = curwin->w_topline;
3119 if (!oldbuf) /* need to read the file */
3120 {
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02003121#ifdef FEAT_TEXT_PROP
3122 // Don't use the swap-exists dialog for a popup window, can't edit
3123 // the buffer.
3124 if (WIN_IS_POPUP(curwin))
3125 curbuf->b_flags |= BF_NO_SEA;
3126#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 swap_exists_action = SEA_DIALOG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3129
3130 /*
3131 * Open the buffer and read the file.
3132 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003133#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003134 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 retval = FAIL;
3136#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003137 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138#endif
3139
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02003140#ifdef FEAT_TEXT_PROP
3141 curbuf->b_flags &= ~BF_NO_SEA;
3142#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 if (swap_exists_action == SEA_QUIT)
3144 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003145 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 else
3148 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003149 /* Read the modelines, but only to set window-local options. Any
3150 * buffer-local options have already been set and may have been
3151 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003152 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003153
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3155 &retval);
3156 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3157 &retval);
3158 }
3159 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160
Bram Moolenaareab316b2015-03-24 11:46:30 +01003161 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02003162 * keep it. Also when it moves within a line. But not when it moves
3163 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01003164 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02003166 char_u *text = ml_get_curline();
3167
3168 if (curwin->w_cursor.lnum != orig_pos.lnum
3169 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
3170 {
3171 newlnum = curwin->w_cursor.lnum;
3172 newcol = curwin->w_cursor.col;
3173 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 }
3175 if (curwin->w_topline == topline)
3176 topline = 0;
3177
3178 /* Even when cursor didn't move we need to recompute topline. */
3179 changed_line_abv_curs();
3180
3181#ifdef FEAT_TITLE
3182 maketitle();
3183#endif
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02003184#ifdef FEAT_TEXT_PROP
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02003185 if (WIN_IS_POPUP(curwin) && curwin->w_p_pvw && retval != FAIL)
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02003186 popup_set_title(curwin);
3187#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 }
3189
3190#ifdef FEAT_DIFF
3191 /* Tell the diff stuff that this buffer is new and/or needs updating.
3192 * Also needed when re-editing the same buffer, because unloading will
3193 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003194 if (curwin->w_p_diff)
3195 {
3196 diff_buf_add(curbuf);
3197 diff_invalidate(curbuf);
3198 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199#endif
3200
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003201#ifdef FEAT_SPELL
3202 /* If the window options were changed may need to set the spell language.
3203 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003204 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3205 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003206#endif
3207
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 if (command == NULL)
3209 {
3210 if (newcol >= 0) /* position set by autocommands */
3211 {
3212 curwin->w_cursor.lnum = newlnum;
3213 curwin->w_cursor.col = newcol;
3214 check_cursor();
3215 }
3216 else if (newlnum > 0) /* line number from caller or old position */
3217 {
3218 curwin->w_cursor.lnum = newlnum;
3219 check_cursor_lnum();
3220 if (solcol >= 0 && !p_sol)
3221 {
3222 /* 'sol' is off: Use last known column. */
3223 curwin->w_cursor.col = solcol;
3224 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 curwin->w_set_curswant = TRUE;
3227 }
3228 else
3229 beginline(BL_SOL | BL_FIX);
3230 }
3231 else /* no line number, go to last line in Ex mode */
3232 {
3233 if (exmode_active)
3234 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3235 beginline(BL_WHITE | BL_FIX);
3236 }
3237 }
3238
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 /* Check if cursors in other windows on the same buffer are still valid */
3240 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241
3242 /*
3243 * Did not read the file, need to show some info about the file.
3244 * Do this after setting the cursor.
3245 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003246 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 {
3248 int msg_scroll_save = msg_scroll;
3249
3250 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3251 * message. */
3252 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3253 msg_scroll = FALSE;
3254 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3255 check_for_delay(FALSE);
3256 msg_start();
3257 msg_scroll = msg_scroll_save;
3258 msg_scrolled_ign = TRUE;
3259
Bram Moolenaar426dd022016-03-15 15:09:29 +01003260 if (!shortmess(SHM_FILEINFO))
3261 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
3263 msg_scrolled_ign = FALSE;
3264 }
3265
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02003266#ifdef FEAT_VIMINFO
3267 curbuf->b_last_used = vim_time();
3268#endif
3269
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 if (command != NULL)
3271 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3272
3273#ifdef FEAT_KEYMAP
3274 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003275 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276#endif
3277
3278 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003279 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 if (!skip_redraw)
3281 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01003282 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01003284 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003287 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3289 }
3290
3291 if (p_im)
3292 need_start_insertmode = TRUE;
3293
Bram Moolenaar15833232018-02-03 18:33:17 +01003294#ifdef FEAT_AUTOCHDIR
3295 /* Change directories when the 'acd' option is set and we aren't already in
3296 * that directory (should already be done above). Expect getcwd() to be
3297 * faster than calling shorten_fnames() unnecessarily. */
3298 if (p_acd && curbuf->b_ffname != NULL)
3299 {
3300 char_u curdir[MAXPATHL];
3301 char_u filedir[MAXPATHL];
3302
3303 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
3304 *gettail_sep(filedir) = NUL;
3305 if (mch_dirname(curdir, MAXPATHL) != FAIL
3306 && vim_fnamecmp(curdir, filedir) != 0)
3307 do_autochdir();
3308 }
3309#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01003311#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003312 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003315 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003316 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317# endif
3318 }
3319#endif
3320
3321theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003322 if (did_inc_redrawing_disabled)
3323 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003324#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003325 if (did_set_swapcommand)
3326 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3327#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328#ifdef FEAT_BROWSE
3329 vim_free(browse_file);
3330#endif
3331 vim_free(free_fname);
3332 return retval;
3333}
3334
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003336delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003338 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 name == NULL ? (char_u *)"" : name);
3340 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003341 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02003342 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003345static int append_indent = 0; /* autoindent for first line */
3346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347/*
3348 * ":insert" and ":append", also used by ":change"
3349 */
3350 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003351ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352{
3353 char_u *theline;
3354 int did_undo = FALSE;
3355 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003356 int indent = 0;
3357 char_u *p;
3358 int vcol;
3359 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003361 /* the ! flag toggles autoindent */
3362 if (eap->forceit)
3363 curbuf->b_p_ai = !curbuf->b_p_ai;
3364
3365 /* First autoindent comes from the line we start on */
3366 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3367 append_indent = get_indent_lnum(lnum);
3368
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 if (eap->cmdidx != CMD_append)
3370 --lnum;
3371
Bram Moolenaar70e136e2016-07-01 14:04:51 +02003372 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003373 if (empty && lnum == 1)
3374 lnum = 0;
3375
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 State = INSERT; /* behave like in Insert mode */
3377 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3378 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003379
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003380 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 {
3382 msg_scroll = TRUE;
3383 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003384 if (curbuf->b_p_ai)
3385 {
3386 if (append_indent >= 0)
3387 {
3388 indent = append_indent;
3389 append_indent = -1;
3390 }
3391 else if (lnum > 0)
3392 indent = get_indent_lnum(lnum);
3393 }
3394 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003396 {
3397 /* No getline() function, use the lines that follow. This ends
3398 * when there is no more. */
3399 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3400 break;
3401 p = vim_strchr(eap->nextcmd, NL);
3402 if (p == NULL)
3403 p = eap->nextcmd + STRLEN(eap->nextcmd);
3404 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3405 if (*p != NUL)
3406 ++p;
3407 eap->nextcmd = p;
3408 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003410 {
3411 int save_State = State;
3412
3413 /* Set State to avoid the cursor shape to be set to INSERT mode
3414 * when getline() returns. */
3415 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 theline = eap->getline(
3417#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003418 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419#endif
Bram Moolenaare96a2492019-06-25 04:12:16 +02003420 NUL, eap->cookie, indent, TRUE);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003421 State = save_State;
3422 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003424 if (theline == NULL)
3425 break;
3426
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003427 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3428 if (ex_keep_indent)
3429 append_indent = indent;
3430
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003431 /* Look for the "." after automatic indent. */
3432 vcol = 0;
3433 for (p = theline; indent > vcol; ++p)
3434 {
3435 if (*p == ' ')
3436 ++vcol;
3437 else if (*p == TAB)
3438 vcol += 8 - vcol % 8;
3439 else
3440 break;
3441 }
3442 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003443 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3444 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 {
3446 vim_free(theline);
3447 break;
3448 }
3449
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003450 /* don't use autoindent if nothing was typed. */
3451 if (p[0] == NUL)
3452 theline[0] = NUL;
3453
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 did_undo = TRUE;
3455 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02003456 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457
3458 vim_free(theline);
3459 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003460
3461 if (empty)
3462 {
3463 ml_delete(2L, FALSE);
3464 empty = FALSE;
3465 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 }
3467 State = NORMAL;
3468
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003469 if (eap->forceit)
3470 curbuf->b_p_ai = !curbuf->b_p_ai;
3471
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00003473 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 * "end" is set to lnum when something has been appended, otherwise
3475 * it is the same than "start" -- Acevedo */
3476 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3477 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3478 if (eap->cmdidx != CMD_append)
3479 --curbuf->b_op_start.lnum;
3480 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3481 ? lnum : curbuf->b_op_start.lnum;
3482 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3483 curwin->w_cursor.lnum = lnum;
3484 check_cursor_lnum();
3485 beginline(BL_SOL | BL_FIX);
3486
3487 need_wait_return = FALSE; /* don't use wait_return() now */
3488 ex_no_reprint = TRUE;
3489}
3490
3491/*
3492 * ":change"
3493 */
3494 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003495ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496{
3497 linenr_T lnum;
3498
3499 if (eap->line2 >= eap->line1
3500 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3501 return;
3502
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003503 /* the ! flag toggles autoindent */
3504 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3505 append_indent = get_indent_lnum(eap->line1);
3506
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3508 {
3509 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3510 break;
3511 ml_delete(eap->line1, FALSE);
3512 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00003513
3514 /* make sure the cursor is not beyond the end of the file now */
3515 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3517
3518 /* ":append" on the line above the deleted lines. */
3519 eap->line2 = eap->line1;
3520 ex_append(eap);
3521}
3522
3523 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003524ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525{
3526 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003527 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003528 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 int minus = 0;
3530 linenr_T start, end, curs, i;
3531 int j;
3532 linenr_T lnum = eap->line2;
3533
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003534 /* Vi compatible: ":z!" uses display height, without a count uses
3535 * 'scroll' */
3536 if (eap->forceit)
3537 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01003538 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003539 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01003540 else
3541 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 if (bigness < 1)
3543 bigness = 1;
3544
3545 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003546 kind = x;
3547 if (*kind == '-' || *kind == '+' || *kind == '='
3548 || *kind == '^' || *kind == '.')
3549 ++x;
3550 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 ++x;
3552
3553 if (*x != 0)
3554 {
3555 if (!VIM_ISDIGIT(*x))
3556 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003557 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 return;
3559 }
3560 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003561 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003562 bigness = atol((char *)x);
3563
3564 /* bigness could be < 0 if atol(x) overflows. */
3565 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
3566 bigness = 2 * curbuf->b_ml.ml_line_count;
3567
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003568 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003569 if (*kind == '=')
3570 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003571 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 }
3573
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003574 /* the number of '-' and '+' multiplies the distance */
3575 if (*kind == '-' || *kind == '+')
3576 for (x = kind + 1; *x == *kind; ++x)
3577 ;
3578
3579 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 {
3581 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02003582 start = lnum - bigness * (linenr_T)(x - kind) + 1;
3583 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003584 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 break;
3586
3587 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003588 start = lnum - (bigness + 1) / 2 + 1;
3589 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 curs = lnum;
3591 minus = 1;
3592 break;
3593
3594 case '^':
3595 start = lnum - bigness * 2;
3596 end = lnum - bigness;
3597 curs = lnum - bigness;
3598 break;
3599
3600 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003601 start = lnum - (bigness + 1) / 2 + 1;
3602 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 curs = end;
3604 break;
3605
3606 default: /* '+' */
3607 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003608 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003609 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003610 else if (eap->addr_count == 0)
3611 ++start;
3612 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 curs = end;
3614 break;
3615 }
3616
3617 if (start < 1)
3618 start = 1;
3619
3620 if (end > curbuf->b_ml.ml_line_count)
3621 end = curbuf->b_ml.ml_line_count;
3622
3623 if (curs > curbuf->b_ml.ml_line_count)
3624 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003625 else if (curs < 1)
3626 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627
3628 for (i = start; i <= end; i++)
3629 {
3630 if (minus && i == lnum)
3631 {
3632 msg_putchar('\n');
3633
3634 for (j = 1; j < Columns; j++)
3635 msg_putchar('-');
3636 }
3637
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003638 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639
3640 if (minus && i == lnum)
3641 {
3642 msg_putchar('\n');
3643
3644 for (j = 1; j < Columns; j++)
3645 msg_putchar('-');
3646 }
3647 }
3648
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003649 if (curwin->w_cursor.lnum != curs)
3650 {
3651 curwin->w_cursor.lnum = curs;
3652 curwin->w_cursor.col = 0;
3653 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 ex_no_reprint = TRUE;
3655}
3656
3657/*
3658 * Check if the restricted flag is set.
3659 * If so, give an error message and return TRUE.
3660 * Otherwise, return FALSE.
3661 */
3662 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003663check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664{
3665 if (restricted)
3666 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01003667 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 return TRUE;
3669 }
3670 return FALSE;
3671}
3672
3673/*
3674 * Check if the secure flag is set (.exrc or .vimrc in current directory).
3675 * If so, give an error message and return TRUE.
3676 * Otherwise, return FALSE.
3677 */
3678 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003679check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680{
3681 if (secure)
3682 {
3683 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003684 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 return TRUE;
3686 }
3687#ifdef HAVE_SANDBOX
3688 /*
3689 * In the sandbox more things are not allowed, including the things
3690 * disallowed in secure mode.
3691 */
3692 if (sandbox != 0)
3693 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003694 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 return TRUE;
3696 }
3697#endif
3698 return FALSE;
3699}
3700
3701static char_u *old_sub = NULL; /* previous substitute pattern */
3702static int global_need_beginline; /* call beginline() after ":g" */
3703
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003704/*
3705 * Flags that are kept between calls to :substitute.
3706 */
3707typedef struct {
3708 int do_all; /* do multiple substitutions per line */
3709 int do_ask; /* ask for confirmation */
3710 int do_count; /* count only */
3711 int do_error; /* if false, ignore errors */
3712 int do_print; /* print last line with subs. */
3713 int do_list; /* list last line with subs. */
3714 int do_number; /* list last line with line nr*/
3715 int do_ic; /* ignore case flag */
3716} subflags_T;
3717
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718/* do_sub()
3719 *
3720 * Perform a substitution from line eap->line1 to line eap->line2 using the
3721 * command pointed to by eap->arg which should be of the form:
3722 *
3723 * /pattern/substitution/{flags}
3724 *
3725 * The usual escapes are supported as described in the regexp docs.
3726 */
3727 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003728do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729{
3730 linenr_T lnum;
3731 long i = 0;
3732 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003733 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
3734 FALSE, FALSE, 0};
3735#ifdef FEAT_EVAL
3736 subflags_T subflags_save;
3737#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02003738 int save_do_all; /* remember user specified 'g' flag */
3739 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 char_u *pat = NULL, *sub = NULL; /* init for GCC */
3741 int delimiter;
3742 int sublen;
3743 int got_quit = FALSE;
3744 int got_match = FALSE;
3745 int temp;
3746 int which_pat;
3747 char_u *cmd;
3748 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003749 linenr_T first_line = 0; /* first changed line */
3750 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 * change */
3752 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
3753 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003754 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003755 char_u *sub_firstline; /* allocated copy of first sub line */
3756 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00003757 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01003758 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003759#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02003760 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003761#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762
3763 cmd = eap->arg;
3764 if (!global_busy)
3765 {
3766 sub_nsubs = 0;
3767 sub_nlines = 0;
3768 }
Bram Moolenaar46475522010-03-23 17:36:29 +01003769 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 if (eap->cmdidx == CMD_tilde)
3772 which_pat = RE_LAST; /* use last used regexp */
3773 else
3774 which_pat = RE_SUBST; /* use last substitute regexp */
3775
3776 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01003777 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
3779 {
3780 /* don't accept alphanumeric for separator */
3781 if (isalpha(*cmd))
3782 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003783 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 return;
3785 }
3786 /*
3787 * undocumented vi feature:
3788 * "\/sub/" and "\?sub?" use last used search pattern (almost like
3789 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
3790 */
3791 if (*cmd == '\\')
3792 {
3793 ++cmd;
3794 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
3795 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003796 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 return;
3798 }
3799 if (*cmd != '&')
3800 which_pat = RE_SEARCH; /* use last '/' pattern */
3801 pat = (char_u *)""; /* empty search pattern */
3802 delimiter = *cmd++; /* remember delimiter character */
3803 }
3804 else /* find the end of the regexp */
3805 {
3806 which_pat = RE_LAST; /* use last used regexp */
3807 delimiter = *cmd++; /* remember delimiter character */
3808 pat = cmd; /* remember start of search pat */
3809 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
3810 if (cmd[0] == delimiter) /* end delimiter found */
3811 *cmd++ = NUL; /* replace it with a NUL */
3812 }
3813
3814 /*
3815 * Small incompatibility: vi sees '\n' as end of the command, but in
3816 * Vim we want to use '\n' to find/substitute a NUL.
3817 */
3818 sub = cmd; /* remember the start of the substitution */
3819
3820 while (cmd[0])
3821 {
3822 if (cmd[0] == delimiter) /* end delimiter found */
3823 {
3824 *cmd++ = NUL; /* replace it with a NUL */
3825 break;
3826 }
3827 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
3828 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003829 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 }
3831
3832 if (!eap->skip)
3833 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003834 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
3835 if (STRCMP(sub, "%") == 0
3836 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
3837 {
3838 if (old_sub == NULL) /* there is no previous command */
3839 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003840 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003841 return;
3842 }
3843 sub = old_sub;
3844 }
3845 else
3846 {
3847 vim_free(old_sub);
3848 old_sub = vim_strsave(sub);
3849 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 }
3851 }
3852 else if (!eap->skip) /* use previous pattern and substitution */
3853 {
3854 if (old_sub == NULL) /* there is no previous command */
3855 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003856 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 return;
3858 }
3859 pat = NULL; /* search_regcomp() will use previous pattern */
3860 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003861
3862 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
3863 * last column after using "$". */
3864 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 }
3866
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003867 /* Recognize ":%s/\n//" and turn it into a join command, which is much
3868 * more efficient.
3869 * TODO: find a generic solution to make line-joining operations more
3870 * efficient, avoid allocating a string that grows in size.
3871 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02003872 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003873 && *sub == NUL
3874 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
3875 || *cmd == 'p' || *cmd == '#'))))
3876 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003877 linenr_T joined_lines_count;
3878
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003879 curwin->w_cursor.lnum = eap->line1;
3880 if (*cmd == 'l')
3881 eap->flags = EXFLAG_LIST;
3882 else if (*cmd == '#')
3883 eap->flags = EXFLAG_NR;
3884 else if (*cmd == 'p')
3885 eap->flags = EXFLAG_PRINT;
3886
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003887 /* The number of lines joined is the number of lines in the range plus
3888 * one. One less when the last line is included. */
3889 joined_lines_count = eap->line2 - eap->line1 + 1;
3890 if (eap->line2 < curbuf->b_ml.ml_line_count)
3891 ++joined_lines_count;
3892 if (joined_lines_count > 1)
3893 {
3894 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
3895 sub_nsubs = joined_lines_count - 1;
3896 sub_nlines = 1;
3897 (void)do_sub_msg(FALSE);
3898 ex_may_print(eap);
3899 }
3900
3901 if (!cmdmod.keeppatterns)
3902 save_re_pat(RE_SUBST, pat, p_magic);
3903#ifdef FEAT_CMDHIST
3904 /* put pattern in history */
3905 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
3906#endif
3907
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003908 return;
3909 }
3910
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 /*
3912 * Find trailing options. When '&' is used, keep old options.
3913 */
3914 if (*cmd == '&')
3915 ++cmd;
3916 else
3917 {
3918 if (!p_ed)
3919 {
3920 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003921 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003923 subflags.do_all = FALSE;
3924 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003926 subflags.do_error = TRUE;
3927 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01003928 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003929 subflags.do_count = FALSE;
3930 subflags.do_number = FALSE;
3931 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 }
3933 while (*cmd)
3934 {
3935 /*
3936 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
3937 * 'r' is never inverted.
3938 */
3939 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003940 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003942 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003943 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003944 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003946 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 else if (*cmd == 'r') /* use last used regexp */
3948 which_pat = RE_LAST;
3949 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003950 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003951 else if (*cmd == '#')
3952 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003953 subflags.do_print = TRUE;
3954 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003955 }
3956 else if (*cmd == 'l')
3957 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003958 subflags.do_print = TRUE;
3959 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003960 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003962 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003964 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 else
3966 break;
3967 ++cmd;
3968 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003969 if (subflags.do_count)
3970 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003972 save_do_all = subflags.do_all;
3973 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02003974
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 /*
3976 * check for a trailing count
3977 */
3978 cmd = skipwhite(cmd);
3979 if (VIM_ISDIGIT(*cmd))
3980 {
3981 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003982 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003984 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 return;
3986 }
3987 eap->line1 = eap->line2;
3988 eap->line2 += i - 1;
3989 if (eap->line2 > curbuf->b_ml.ml_line_count)
3990 eap->line2 = curbuf->b_ml.ml_line_count;
3991 }
3992
3993 /*
3994 * check for trailing command or garbage
3995 */
3996 cmd = skipwhite(cmd);
3997 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
3998 {
3999 eap->nextcmd = check_nextcmd(cmd);
4000 if (eap->nextcmd == NULL)
4001 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004002 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 return;
4004 }
4005 }
4006
4007 if (eap->skip) /* not executing commands, only parsing */
4008 return;
4009
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004010 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004011 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004012 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004013 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004014 return;
4015 }
4016
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4018 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004019 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004020 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 return;
4022 }
4023
4024 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004025 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004027 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 regmatch.rmm_ic = FALSE;
4029
4030 sub_firstline = NULL;
4031
4032 /*
4033 * ~ in the substitute pattern is replaced with the old pattern.
4034 * We do it here once to avoid it to be replaced over and over again.
4035 * But don't do it when it starts with "\=", then it's an expression.
4036 */
4037 if (!(sub[0] == '\\' && sub[1] == '='))
4038 sub = regtilde(sub, p_magic);
4039
4040 /*
4041 * Check for a match on each line.
4042 */
4043 line2 = eap->line2;
4044 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004045#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 || aborting()
4047#endif
4048 ); ++lnum)
4049 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004050 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004051 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 if (nmatch)
4053 {
4054 colnr_T copycol;
4055 colnr_T matchcol;
4056 colnr_T prev_matchcol = MAXCOL;
4057 char_u *new_end, *new_start = NULL;
4058 unsigned new_start_len = 0;
4059 char_u *p1;
4060 int did_sub = FALSE;
4061 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004062 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 long nmatch_tl = 0; /* nr of lines matched below lnum */
4064 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004065 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004066 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004067#ifdef FEAT_TEXT_PROP
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004068 int apc_flags = APC_SAVE_FOR_UNDO | APC_SUBSTITUTE;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004069#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070
4071 /*
4072 * The new text is build up step by step, to avoid too much
4073 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004074 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 * copycol Column in the old text where we started
4076 * looking for a match; from here old text still
4077 * needs to be copied to the new text.
4078 * matchcol Column number of the old text where to look
4079 * for the next match. It's just after the
4080 * previous match or one further.
4081 * prev_matchcol Column just after the previous match (if any).
4082 * Mostly equal to matchcol, except for the first
4083 * match and after skipping an empty match.
4084 * regmatch.*pos Where the pattern matched in the old text.
4085 * new_start The new text, all that has been produced so
4086 * far.
4087 * new_end The new text, where to append new text.
4088 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004089 * lnum The line number where we found the start of
4090 * the match. Can be below the line we searched
4091 * when there is a \n before a \zs in the
4092 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 * sub_firstlnum The line number in the buffer where to look
4094 * for a match. Can be different from "lnum"
4095 * when the pattern or substitute string contains
4096 * line breaks.
4097 *
4098 * Special situations:
4099 * - When the substitute string contains a line break, the part up
4100 * to the line break is inserted in the text, but the copy of
4101 * the original line is kept. "sub_firstlnum" is adjusted for
4102 * the inserted lines.
4103 * - When the matched pattern contains a line break, the old line
4104 * is taken from the line at the end of the pattern. The lines
4105 * in the match are deleted later, "sub_firstlnum" is adjusted
4106 * accordingly.
4107 *
4108 * The new text is built up in new_start[]. It has some extra
4109 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004110 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 *
4112 * Make a copy of the old line, so it won't be taken away when
4113 * updating the screen or handling a multi-line match. The "old_"
4114 * pointers point into this copy.
4115 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004116 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 copycol = 0;
4118 matchcol = 0;
4119
4120 /* At first match, remember current cursor position. */
4121 if (!got_match)
4122 {
4123 setpcmark();
4124 got_match = TRUE;
4125 }
4126
4127 /*
4128 * Loop until nothing more to replace in this line.
4129 * 1. Handle match with empty string.
4130 * 2. If do_ask is set, ask for confirmation.
4131 * 3. substitute the string.
4132 * 4. if do_all is set, find next match
4133 * 5. break if there isn't another match in this line
4134 */
4135 for (;;)
4136 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004137 /* Advance "lnum" to the line where the match starts. The
4138 * match does not start in the first line when there is a line
4139 * break before \zs. */
4140 if (regmatch.startpos[0].lnum > 0)
4141 {
4142 lnum += regmatch.startpos[0].lnum;
4143 sub_firstlnum += regmatch.startpos[0].lnum;
4144 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01004145 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004146 }
4147
4148 if (sub_firstline == NULL)
4149 {
4150 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4151 if (sub_firstline == NULL)
4152 {
4153 vim_free(new_start);
4154 goto outofmem;
4155 }
4156 }
4157
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 /* Save the line number of the last change for the final
4159 * cursor position (just like Vi). */
4160 curwin->w_cursor.lnum = lnum;
4161 do_again = FALSE;
4162
4163 /*
4164 * 1. Match empty string does not count, except for first
4165 * match. This reproduces the strange vi behaviour.
4166 * This also catches endless loops.
4167 */
4168 if (matchcol == prev_matchcol
4169 && regmatch.endpos[0].lnum == 0
4170 && matchcol == regmatch.endpos[0].col)
4171 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004172 if (sub_firstline[matchcol] == NUL)
4173 /* We already were at the end of the line. Don't look
4174 * for a match in this line again. */
4175 skip_match = TRUE;
4176 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004177 {
4178 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02004179 if (has_mbyte)
4180 matchcol += mb_ptr2len(sub_firstline + matchcol);
4181 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004182 ++matchcol;
4183 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 goto skip;
4185 }
4186
4187 /* Normally we continue searching for a match just after the
4188 * previous match. */
4189 matchcol = regmatch.endpos[0].col;
4190 prev_matchcol = matchcol;
4191
4192 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004193 * 2. If do_count is set only increase the counter.
4194 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004196 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004197 {
4198 /* For a multi-line match, put matchcol at the NUL at
4199 * the end of the line and set nmatch to one, so that
4200 * we continue looking for a match on the next line.
4201 * Avoids that ":s/\nB\@=//gc" get stuck. */
4202 if (nmatch > 1)
4203 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004204 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004205 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004206 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004207 }
4208 sub_nsubs++;
4209 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004210#ifdef FEAT_EVAL
4211 /* Skip the substitution, unless an expression is used,
4212 * then it is evaluated in the sandbox. */
4213 if (!(sub[0] == '\\' && sub[1] == '='))
4214#endif
4215 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004216 }
4217
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004218 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004220 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004221
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 /* change State to CONFIRM, so that the mouse works
4223 * properly */
4224 save_State = State;
4225 State = CONFIRM;
4226#ifdef FEAT_MOUSE
4227 setmouse(); /* disable mouse in xterm */
4228#endif
4229 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01004230 if (curwin->w_p_crb)
4231 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232
4233 /* When 'cpoptions' contains "u" don't sync undo when
4234 * asking for confirmation. */
4235 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4236 ++no_u_sync;
4237
4238 /*
4239 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4240 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004241 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004243 if (exmode_active)
4244 {
4245 char_u *resp;
4246 colnr_T sc, ec;
4247
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004248 print_line_no_prefix(lnum,
4249 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004250
4251 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4252 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01004253 if (curwin->w_cursor.col < 0)
4254 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004255 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004256 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02004257 {
4258 int numw = number_width(curwin) + 1;
4259 sc += numw;
4260 ec += numw;
4261 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004262 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004263 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004264 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004265 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004266 msg_putchar('^');
4267
Bram Moolenaare96a2492019-06-25 04:12:16 +02004268 resp = getexmodeline('?', NULL, 0, TRUE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004269 if (resp != NULL)
4270 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004271 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004272 vim_free(resp);
4273 }
4274 }
4275 else
4276 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004277 char_u *orig_line = NULL;
4278 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004280 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004282 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004284 /* Invert the matched string.
4285 * Remove the inversion afterwards. */
4286 temp = RedrawingDisabled;
4287 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004289 if (new_start != NULL)
4290 {
4291 /* There already was a substitution, we would
4292 * like to show this to the user. We cannot
4293 * really update the line, it would change
4294 * what matches. Temporarily replace the line
4295 * and change it back afterwards. */
4296 orig_line = vim_strsave(ml_get(lnum));
4297 if (orig_line != NULL)
4298 {
4299 char_u *new_line = concat_str(new_start,
4300 sub_firstline + copycol);
4301
4302 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01004303 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004304 else
4305 {
4306 /* Position the cursor relative to the
4307 * end of the line, the previous
4308 * substitute may have inserted or
4309 * deleted characters before the
4310 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004311 len_change = (int)STRLEN(new_line)
4312 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004313 curwin->w_cursor.col += len_change;
4314 ml_replace(lnum, new_line, FALSE);
4315 }
4316 }
4317 }
4318
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004319 search_match_lines = regmatch.endpos[0].lnum
4320 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004321 search_match_endcol = regmatch.endpos[0].col
4322 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004323 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004325 update_topline();
4326 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004327 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004328 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004329 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330
4331#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004332 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004334 if (msg_row == Rows - 1)
4335 msg_didout = FALSE; /* avoid a scroll-up */
4336 msg_starthere();
4337 i = msg_scroll;
4338 msg_scroll = 0; /* truncate msg when
4339 needed */
4340 msg_no_more = TRUE;
4341 /* write message same highlighting as for
4342 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01004343 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004344 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004345 msg_no_more = FALSE;
4346 msg_scroll = i;
4347 showruler(TRUE);
4348 windgoto(msg_row, msg_col);
4349 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350
4351#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004352 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004354 ++no_mapping; /* don't map this key */
4355 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004356 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004357 --allow_keys;
4358 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004360 /* clear the question */
4361 msg_didout = FALSE; /* don't scroll up */
4362 msg_col = 0;
4363 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004364
4365 /* restore the line */
4366 if (orig_line != NULL)
4367 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004368 }
4369
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004371 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004373 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374#endif
4375 )
4376 {
4377 got_quit = TRUE;
4378 break;
4379 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004380 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004382 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004384 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 {
4386 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004387 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 line2 = lnum;
4389 break;
4390 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004391 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004393 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 break;
4395 }
4396#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004397 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004399 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 scrolldown_clamp();
4401#endif
4402 }
4403 State = save_State;
4404#ifdef FEAT_MOUSE
4405 setmouse();
4406#endif
4407 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4408 --no_u_sync;
4409
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004410 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 {
4412 /* For a multi-line match, put matchcol at the NUL at
4413 * the end of the line and set nmatch to one, so that
4414 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004415 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4416 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 if (nmatch > 1)
4418 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004419 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004420 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 }
4422 goto skip;
4423 }
4424 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004425 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 }
4427
4428 /* Move the cursor to the start of the match, so that we can
4429 * use "\=col("."). */
4430 curwin->w_cursor.col = regmatch.startpos[0].col;
4431
4432 /*
4433 * 3. substitute the string.
4434 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004435#ifdef FEAT_EVAL
Bram Moolenaar80341bc2019-05-20 20:34:51 +02004436 save_ma = curbuf->b_p_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004437 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004438 {
Bram Moolenaar6349e942019-05-18 13:41:22 +02004439 // prevent accidentally changing the buffer by a function
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004440 curbuf->b_p_ma = FALSE;
4441 sandbox++;
4442 }
Bram Moolenaar6349e942019-05-18 13:41:22 +02004443 // Save flags for recursion. They can change for e.g.
4444 // :s/^/\=execute("s#^##gn")
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004445 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004446#endif
Bram Moolenaar6349e942019-05-18 13:41:22 +02004447 // get length of substitution part
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004448 sublen = vim_regsub_multi(&regmatch,
4449 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004451#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004452 // If getting the substitute string caused an error, don't do
4453 // the replacement.
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004454 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004455 subflags = subflags_save;
Bram Moolenaar6349e942019-05-18 13:41:22 +02004456 if (aborting() || subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004457 {
4458 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004459 if (sandbox > 0)
4460 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004461 goto skip;
4462 }
4463#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464
Bram Moolenaar4463f292005-09-25 22:20:24 +00004465 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004466 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004467 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4468 {
4469 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4470 skip_match = TRUE;
4471 }
4472
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 /* Need room for:
4474 * - result so far in new_start (not for first sub in line)
4475 * - original text up to match
4476 * - length of substituted part
4477 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004478 * Adjust text properties here, since we have all information
4479 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 */
4481 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004482 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004484#ifdef FEAT_TEXT_PROP
4485 if (curbuf->b_has_textprop)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004486 {
4487 // When text properties are changed, need to save for
4488 // undo first, unless done already.
4489 if (adjust_prop_columns(lnum, regmatch.startpos[0].col,
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004490 sublen - 1 - (regmatch.endpos[0].col
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004491 - regmatch.startpos[0].col),
4492 apc_flags))
4493 apc_flags &= ~APC_SAVE_FOR_UNDO;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004494 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004495#endif
4496 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 else
4498 {
4499 p1 = ml_get(sub_firstlnum + nmatch - 1);
4500 nmatch_tl += nmatch - 1;
4501 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004502 copy_len = regmatch.startpos[0].col - copycol;
4503 needed_len = copy_len + ((unsigned)STRLEN(p1)
4504 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 if (new_start == NULL)
4506 {
4507 /*
4508 * Get some space for a temporary buffer to do the
4509 * substitution into (and some extra space to avoid
4510 * too many calls to alloc()/free()).
4511 */
4512 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004513 if ((new_start = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 goto outofmem;
4515 *new_start = NUL;
4516 new_end = new_start;
4517 }
4518 else
4519 {
4520 /*
4521 * Check if the temporary buffer is long enough to do the
4522 * substitution into. If not, make it larger (with a bit
4523 * extra to avoid too many calls to alloc()/free()).
4524 */
4525 len = (unsigned)STRLEN(new_start);
4526 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004527 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 {
4529 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004530 if ((p1 = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 {
4532 vim_free(new_start);
4533 goto outofmem;
4534 }
4535 mch_memmove(p1, new_start, (size_t)(len + 1));
4536 vim_free(new_start);
4537 new_start = p1;
4538 }
4539 new_end = new_start + len;
4540 }
4541
4542 /*
4543 * copy the text up to the part that matched
4544 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004545 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4546 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004548 (void)vim_regsub_multi(&regmatch,
4549 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 sub, new_end, TRUE, p_magic, TRUE);
4551 sub_nsubs++;
4552 did_sub = TRUE;
4553
4554 /* Move the cursor to the start of the line, to avoid that it
4555 * is beyond the end of the line after the substitution. */
4556 curwin->w_cursor.col = 0;
4557
4558 /* For a multi-line match, make a copy of the last matched
4559 * line and continue in that one. */
4560 if (nmatch > 1)
4561 {
4562 sub_firstlnum += nmatch - 1;
4563 vim_free(sub_firstline);
4564 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4565 /* When going beyond the last line, stop substituting. */
4566 if (sub_firstlnum <= line2)
4567 do_again = TRUE;
4568 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004569 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 }
4571
4572 /* Remember next character to be copied. */
4573 copycol = regmatch.endpos[0].col;
4574
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004575 if (skip_match)
4576 {
4577 /* Already hit end of the buffer, sub_firstlnum is one
4578 * less than what it ought to be. */
4579 vim_free(sub_firstline);
4580 sub_firstline = vim_strsave((char_u *)"");
4581 copycol = 0;
4582 }
4583
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 /*
4585 * Now the trick is to replace CTRL-M chars with a real line
4586 * break. This would make it impossible to insert a CTRL-M in
4587 * the text. The line break can be avoided by preceding the
4588 * CTRL-M with a backslash. To be able to insert a backslash,
4589 * they must be doubled in the string and are halved here.
4590 * That is Vi compatible.
4591 */
4592 for (p1 = new_end; *p1; ++p1)
4593 {
4594 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004595 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004596 STRMOVE(p1, p1 + 1);
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004597#ifdef FEAT_TEXT_PROP
4598 if (curbuf->b_has_textprop)
4599 {
4600 // When text properties are changed, need to save
4601 // for undo first, unless done already.
4602 if (adjust_prop_columns(lnum,
4603 (colnr_T)(p1 - new_start), -1,
4604 apc_flags))
4605 apc_flags &= ~APC_SAVE_FOR_UNDO;
4606 }
4607#endif
4608 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 else if (*p1 == CAR)
4610 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004611 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004613 colnr_T plen = (colnr_T)(p1 - new_start + 1);
4614
4615 *p1 = NUL; // truncate up to the CR
4616 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004618 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 appended_lines(lnum - 1, 1L);
4620 else
4621 {
4622 if (first_line == 0)
4623 first_line = lnum;
4624 last_line = lnum + 1;
4625 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004626#ifdef FEAT_TEXT_PROP
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02004627 adjust_props_for_split(lnum + 1, lnum, plen, 1);
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004628#endif
4629 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 ++sub_firstlnum;
4631 ++lnum;
4632 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004633 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004635 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004636 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 p1 = new_start - 1;
4638 }
4639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004641 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 }
4643
4644 /*
4645 * 4. If do_all is set, find next match.
4646 * Prevent endless loop with patterns that match empty
4647 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4648 * But ":s/\n/#/" is OK.
4649 */
4650skip:
4651 /* We already know that we did the last subst when we are at
4652 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004653 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4654 * "line2" when there is a \zs in the pattern after a line
4655 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004656 lastone = (skip_match
4657 || got_int
4658 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004659 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004660 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00004661 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4662 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 nmatch = -1;
4664
4665 /*
4666 * Replace the line in the buffer when needed. This is
4667 * skipped when there are more matches.
4668 * The check for nmatch_tl is needed for when multi-line
4669 * matching must replace the lines before trying to do another
4670 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004671 * When the match starts below where we start searching also
4672 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 */
4674 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 || nmatch_tl > 0
4676 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004677 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004678 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004679 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 {
4681 if (new_start != NULL)
4682 {
4683 /*
4684 * Copy the rest of the line, that didn't match.
4685 * "matchcol" has to be adjusted, we use the end of
4686 * the line as reference, because the substitute may
4687 * have changed the number of characters. Same for
4688 * "prev_matchcol".
4689 */
4690 STRCAT(new_start, sub_firstline + copycol);
4691 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4692 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4693 - prev_matchcol;
4694
4695 if (u_savesub(lnum) != OK)
4696 break;
4697 ml_replace(lnum, new_start, TRUE);
4698
4699 if (nmatch_tl > 0)
4700 {
4701 /*
4702 * Matched lines have now been substituted and are
4703 * useless, delete them. The part after the match
4704 * has been appended to new_start, we don't need
4705 * it in the buffer.
4706 */
4707 ++lnum;
4708 if (u_savedel(lnum, nmatch_tl) != OK)
4709 break;
4710 for (i = 0; i < nmatch_tl; ++i)
4711 ml_delete(lnum, (int)FALSE);
4712 mark_adjust(lnum, lnum + nmatch_tl - 1,
4713 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004714 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 deleted_lines(lnum, nmatch_tl);
4716 --lnum;
4717 line2 -= nmatch_tl; /* nr of lines decreases */
4718 nmatch_tl = 0;
4719 }
4720
4721 /* When asking, undo is saved each time, must also set
4722 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004723 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 changed_bytes(lnum, 0);
4725 else
4726 {
4727 if (first_line == 0)
4728 first_line = lnum;
4729 last_line = lnum + 1;
4730 }
4731
4732 sub_firstlnum = lnum;
4733 vim_free(sub_firstline); /* free the temp buffer */
4734 sub_firstline = new_start;
4735 new_start = NULL;
4736 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4737 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4738 - prev_matchcol;
4739 copycol = 0;
4740 }
4741 if (nmatch == -1 && !lastone)
4742 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004743 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
4745 /*
4746 * 5. break if there isn't another match in this line
4747 */
4748 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004749 {
4750 /* If the match found didn't start where we were
4751 * searching, do the next search in the line where we
4752 * found the match. */
4753 if (nmatch == -1)
4754 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004756 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 }
4758
4759 line_breakcheck();
4760 }
4761
4762 if (did_sub)
4763 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00004764 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01004765 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766 }
4767
4768 line_breakcheck();
4769 }
4770
4771 if (first_line != 0)
4772 {
4773 /* Need to subtract the number of added lines from "last_line" to get
4774 * the line number before the change (same as adding the number of
4775 * deleted lines). */
4776 i = curbuf->b_ml.ml_line_count - old_line_count;
4777 changed_lines(first_line, 0, last_line - i, i);
4778 }
4779
4780outofmem:
4781 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004782
4783 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004784 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004785 curwin->w_cursor = old_cursor;
4786
Bram Moolenaar46475522010-03-23 17:36:29 +01004787 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 {
4789 /* Set the '[ and '] marks. */
4790 curbuf->b_op_start.lnum = eap->line1;
4791 curbuf->b_op_end.lnum = line2;
4792 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4793
4794 if (!global_busy)
4795 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004796 /* when interactive leave cursor on the match */
4797 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01004798 {
4799 if (endcolumn)
4800 coladvance((colnr_T)MAXCOL);
4801 else
4802 beginline(BL_WHITE | BL_FIX);
4803 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004804 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004805 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 }
4807 else
4808 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004809 if (subflags.do_print)
4810 print_line(curwin->w_cursor.lnum,
4811 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 }
4813 else if (!global_busy)
4814 {
4815 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004816 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01004818 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004819 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004820 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 }
4822
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004823#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004824 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004825 /* Cursor position may require updating */
4826 changed_window_setting();
4827#endif
4828
Bram Moolenaar473de612013-06-08 18:19:48 +02004829 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004830
4831 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004832 subflags.do_all = save_do_all;
4833 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834}
4835
4836/*
4837 * Give message for number of substitutions.
4838 * Can also be used after a ":global" command.
4839 * Return TRUE if a message was given.
4840 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004841 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004842do_sub_msg(
4843 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844{
4845 /*
4846 * Only report substitutions when:
4847 * - more than 'report' substitutions
4848 * - command was typed by user, or number of changed lines > 'report'
4849 * - giving messages is not disabled by 'lazyredraw'
4850 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004851 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
4852 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 && messaging())
4854 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004855 char *msg_single;
4856 char *msg_plural;
4857
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 if (got_int)
4859 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004860 else
4861 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004862
4863 msg_single = count_only
4864 ? NGETTEXT("%ld match on %ld line",
4865 "%ld matches on %ld line", sub_nsubs)
4866 : NGETTEXT("%ld substitution on %ld line",
4867 "%ld substitutions on %ld line", sub_nsubs);
4868 msg_plural = count_only
4869 ? NGETTEXT("%ld match on %ld lines",
4870 "%ld matches on %ld lines", sub_nsubs)
4871 : NGETTEXT("%ld substitution on %ld lines",
4872 "%ld substitutions on %ld lines", sub_nsubs);
4873
Bram Moolenaar32526b32019-01-19 17:43:09 +01004874 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004875 NGETTEXT(msg_single, msg_plural, sub_nlines),
4876 sub_nsubs, (long)sub_nlines);
4877
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01004880 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 return TRUE;
4882 }
4883 if (got_int)
4884 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004885 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 return TRUE;
4887 }
4888 return FALSE;
4889}
4890
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004891 static void
4892global_exe_one(char_u *cmd, linenr_T lnum)
4893{
4894 curwin->w_cursor.lnum = lnum;
4895 curwin->w_cursor.col = 0;
4896 if (*cmd == NUL || *cmd == '\n')
4897 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
4898 else
4899 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
4900}
4901
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902/*
4903 * Execute a global command of the form:
4904 *
4905 * g/pattern/X : execute X on all lines where pattern matches
4906 * v/pattern/X : execute X on all lines where pattern does not match
4907 *
4908 * where 'X' is an EX command
4909 *
4910 * The command character (as well as the trailing slash) is optional, and
4911 * is assumed to be 'p' if missing.
4912 *
4913 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004914 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 * for each line that has a mark. This is required because after deleting
4916 * lines we do not know where to search for the next match.
4917 */
4918 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004919ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920{
4921 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004922 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 int type; /* first char of cmd: 'v' or 'g' */
4924 char_u *cmd; /* command argument */
4925
4926 char_u delim; /* delimiter, normally '/' */
4927 char_u *pat;
4928 regmmatch_T regmatch;
4929 int match;
4930 int which_pat;
4931
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004932 /* When nesting the command works on one line. This allows for
4933 * ":g/found/v/notfound/command". */
4934 if (global_busy && (eap->line1 != 1
4935 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004937 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004938 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 return;
4940 }
4941
4942 if (eap->forceit) /* ":global!" is like ":vglobal" */
4943 type = 'v';
4944 else
4945 type = *eap->cmd;
4946 cmd = eap->arg;
4947 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948
4949 /*
4950 * undocumented vi feature:
4951 * "\/" and "\?": use previous search pattern.
4952 * "\&": use previous substitute pattern.
4953 */
4954 if (*cmd == '\\')
4955 {
4956 ++cmd;
4957 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4958 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004959 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 return;
4961 }
4962 if (*cmd == '&')
4963 which_pat = RE_SUBST; /* use previous substitute pattern */
4964 else
4965 which_pat = RE_SEARCH; /* use previous search pattern */
4966 ++cmd;
4967 pat = (char_u *)"";
4968 }
4969 else if (*cmd == NUL)
4970 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004971 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 return;
4973 }
4974 else
4975 {
4976 delim = *cmd; /* get the delimiter */
4977 if (delim)
4978 ++cmd; /* skip delimiter if there is one */
4979 pat = cmd; /* remember start of pattern */
4980 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
4981 if (cmd[0] == delim) /* end delimiter found */
4982 *cmd++ = NUL; /* replace it with a NUL */
4983 }
4984
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4986 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004987 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 return;
4989 }
4990
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004991 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004993 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004994 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004995 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004997 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 }
4999 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005000 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005001 /*
5002 * pass 1: set marks for each (not) matching line
5003 */
5004 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5005 {
5006 /* a match on this line? */
5007 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005008 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005009 if ((type == 'g' && match) || (type == 'v' && !match))
5010 {
5011 ml_setmarked(lnum);
5012 ndone++;
5013 }
5014 line_breakcheck();
5015 }
5016
5017 /*
5018 * pass 2: execute the command for each line that has been marked
5019 */
5020 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01005021 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005022 else if (ndone == 0)
5023 {
5024 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005025 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005026 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005027 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005028 }
5029 else
5030 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005031#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005032 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005033#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005034 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005035#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005036 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005037#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005038 }
5039
5040 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005041 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
Bram Moolenaar473de612013-06-08 18:19:48 +02005043 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044}
5045
5046/*
5047 * Execute "cmd" on lines marked with ml_setmarked().
5048 */
5049 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005050global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051{
Bram Moolenaarbb993222011-05-10 16:00:47 +02005052 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5053 buf_T *old_buf = curbuf; /* remember what buffer we started in */
5054 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055
5056 /*
5057 * Set current position only once for a global command.
5058 * If global_busy is set, setpcmark() will not do anything.
5059 * If there is an error, global_busy will be incremented.
5060 */
5061 setpcmark();
5062
5063 /* When the command writes a message, don't overwrite the command. */
5064 msg_didout = TRUE;
5065
Bram Moolenaard25bc232010-03-23 17:49:24 +01005066 sub_nsubs = 0;
5067 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 global_need_beginline = FALSE;
5069 global_busy = 1;
5070 old_lcount = curbuf->b_ml.ml_line_count;
5071 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5072 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005073 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 ui_breakcheck();
5075 }
5076
5077 global_busy = 0;
5078 if (global_need_beginline)
5079 beginline(BL_WHITE | BL_FIX);
5080 else
5081 check_cursor(); /* cursor may be beyond the end of the line */
5082
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005083 /* the cursor may not have moved in the text but a change in a previous
5084 * line may move it on the screen */
5085 changed_line_abv_curs();
5086
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 /* If it looks like no message was written, allow overwriting the
5088 * command with the report for number of changes. */
5089 if (msg_col == 0 && msg_scrolled == 0)
5090 msg_didout = FALSE;
5091
Bram Moolenaar45667512007-05-10 19:24:43 +00005092 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02005093 * number of extra or deleted lines.
5094 * Don't report extra or deleted lines in the edge case where the buffer
5095 * we are in after execution is different from the buffer we started in. */
5096 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5098}
5099
5100#ifdef FEAT_VIMINFO
Bram Moolenaarc3328162019-07-23 22:15:25 +02005101/*
5102 * Get the previous substitute pattern.
5103 */
5104 char_u *
5105get_old_sub(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106{
Bram Moolenaarc3328162019-07-23 22:15:25 +02005107 return old_sub;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108}
5109
Bram Moolenaarc3328162019-07-23 22:15:25 +02005110/*
5111 * Set the previous substitute pattern. "val" must be allocated.
5112 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 void
Bram Moolenaarc3328162019-07-23 22:15:25 +02005114set_old_sub(char_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115{
Bram Moolenaarc3328162019-07-23 22:15:25 +02005116 vim_free(old_sub);
5117 old_sub = val;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118}
Bram Moolenaardefa0672019-07-21 19:25:37 +02005119#endif // FEAT_VIMINFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005121#if defined(EXITFREE) || defined(PROTO)
5122 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005123free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005124{
5125 vim_free(old_sub);
5126}
5127#endif
5128
Bram Moolenaar4033c552017-09-16 20:54:51 +02005129#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130/*
5131 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005132 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005134 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005135prepare_tagpreview(
5136 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137{
5138 win_T *wp;
5139
5140# ifdef FEAT_GUI
5141 need_mouse_correct = TRUE;
5142# endif
5143
5144 /*
5145 * If there is already a preview window open, use that one.
5146 */
5147 if (!curwin->w_p_pvw)
5148 {
Bram Moolenaar79648732019-07-18 21:43:07 +02005149# ifdef FEAT_TEXT_PROP
5150 if (*p_pvp != NUL)
5151 {
5152 wp = popup_find_preview_window();
5153 if (wp != NULL)
Bram Moolenaar13d5c3f2019-07-28 21:42:38 +02005154 popup_set_wantpos(wp, wp->w_minwidth);
Bram Moolenaar79648732019-07-18 21:43:07 +02005155 }
5156 else
5157# endif
5158 {
5159 FOR_ALL_WINDOWS(wp)
5160 if (wp->w_p_pvw)
5161 break;
5162 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005164 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 else
5166 {
5167 /*
5168 * There is no preview window open yet. Create one.
5169 */
Bram Moolenaar79648732019-07-18 21:43:07 +02005170# ifdef FEAT_TEXT_PROP
5171 if (*p_pvp != NUL)
5172 return popup_create_preview_window();
5173# endif
5174 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0) == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005175 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 curwin->w_p_pvw = TRUE;
5177 curwin->w_p_wfh = TRUE;
Bram Moolenaar79648732019-07-18 21:43:07 +02005178 RESET_BINDING(curwin); // don't take over 'scrollbind'
5179 // and 'cursorbind'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180# ifdef FEAT_DIFF
Bram Moolenaar79648732019-07-18 21:43:07 +02005181 curwin->w_p_diff = FALSE; // no 'diff'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182# endif
5183# ifdef FEAT_FOLDING
Bram Moolenaar79648732019-07-18 21:43:07 +02005184 curwin->w_p_fdc = 0; // no 'foldcolumn'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005186 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 }
5188 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005189 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190}
5191
5192#endif
5193
5194
5195/*
5196 * ":help": open a read-only window on a help file
5197 */
5198 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005199ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200{
5201 char_u *arg;
5202 char_u *tag;
5203 FILE *helpfd; /* file descriptor of help file */
5204 int n;
5205 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 int num_matches;
5208 char_u **matches;
5209 char_u *p;
5210 int empty_fnum = 0;
5211 int alt_fnum = 0;
5212 buf_T *buf;
5213#ifdef FEAT_MULTI_LANG
5214 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005215 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005217#ifdef FEAT_FOLDING
5218 int old_KeyTyped = KeyTyped;
5219#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220
5221 if (eap != NULL)
5222 {
5223 /*
5224 * A ":help" command ends at the first LF, or at a '|' that is
5225 * followed by some text. Set nextcmd to the following command.
5226 */
5227 for (arg = eap->arg; *arg; ++arg)
5228 {
5229 if (*arg == '\n' || *arg == '\r'
5230 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5231 {
5232 *arg++ = NUL;
5233 eap->nextcmd = arg;
5234 break;
5235 }
5236 }
5237 arg = eap->arg;
5238
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005239 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005241 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 return;
5243 }
5244
5245 if (eap->skip) /* not executing commands */
5246 return;
5247 }
5248 else
5249 arg = (char_u *)"";
5250
5251 /* remove trailing blanks */
5252 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01005253 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 *p-- = NUL;
5255
5256#ifdef FEAT_MULTI_LANG
5257 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005258 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259#endif
5260
5261 /* When no argument given go to the index. */
5262 if (*arg == NUL)
5263 arg = (char_u *)"help.txt";
5264
5265 /*
5266 * Check if there is a match for the argument.
5267 */
5268 n = find_help_tags(arg, &num_matches, &matches,
5269 eap != NULL && eap->forceit);
5270
5271 i = 0;
5272#ifdef FEAT_MULTI_LANG
5273 if (n != FAIL && lang != NULL)
5274 /* Find first item with the requested language. */
5275 for (i = 0; i < num_matches; ++i)
5276 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005277 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 if (len > 3 && matches[i][len - 3] == '@'
5279 && STRICMP(matches[i] + len - 2, lang) == 0)
5280 break;
5281 }
5282#endif
5283 if (i >= num_matches || n == FAIL)
5284 {
5285#ifdef FEAT_MULTI_LANG
5286 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005287 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 else
5289#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005290 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 if (n != FAIL)
5292 FreeWild(num_matches, matches);
5293 return;
5294 }
5295
5296 /* The first match (in the requested language) is the best match. */
5297 tag = vim_strsave(matches[i]);
5298 FreeWild(num_matches, matches);
5299
5300#ifdef FEAT_GUI
5301 need_mouse_correct = TRUE;
5302#endif
5303
5304 /*
5305 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005306 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02005308 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005310 if (cmdmod.tab != 0)
5311 wp = NULL;
5312 else
Bram Moolenaar29323592016-07-24 22:04:11 +02005313 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005314 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005315 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5317 win_enter(wp, TRUE);
5318 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 {
5320 /*
5321 * There is no help window yet.
5322 * Try to open the file specified by the "helpfile" option.
5323 */
5324 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5325 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005326 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 goto erret;
5328 }
5329 fclose(helpfd);
5330
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005332 * specified, the current window is vertically split and
5333 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005336 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005339 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 if (curwin->w_height < p_hh)
5342 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343
5344 /*
5345 * Open help file (do_ecmd() will set b_help flag, readfile() will
5346 * set b_p_ro flag).
5347 * Set the alternate file to the previously edited file.
5348 */
5349 alt_fnum = curbuf->b_fnum;
5350 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005351 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02005352 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005353 if (!cmdmod.keepalt)
5354 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 empty_fnum = curbuf->b_fnum;
5356 }
5357 }
5358
5359 if (!p_im)
5360 restart_edit = 0; /* don't want insert mode in help file */
5361
Bram Moolenaar8f535582011-09-30 17:30:31 +02005362#ifdef FEAT_FOLDING
5363 /* Restore KeyTyped, setting 'filetype=help' may reset it.
5364 * It is needed for do_tag top open folds under the cursor. */
5365 KeyTyped = old_KeyTyped;
5366#endif
5367
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 if (tag != NULL)
5369 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5370
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005371 /* Delete the empty buffer if we're not using it. Careful: autocommands
5372 * may have jumped to another window, check that the buffer is not in a
5373 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5375 {
5376 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005377 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 wipe_buffer(buf, TRUE);
5379 }
5380
5381 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005382 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 curwin->w_alt_fnum = alt_fnum;
5384
5385erret:
5386 vim_free(tag);
5387}
5388
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005389/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005390 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005391 */
5392 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005393ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005394{
5395 win_T *win;
5396
5397 FOR_ALL_WINDOWS(win)
5398 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005399 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005400 {
5401 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005402 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005403 }
5404 }
5405}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005407#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5408/*
5409 * In an argument search for a language specifiers in the form "@xx".
5410 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5411 * Returns NULL if not found.
5412 */
5413 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005414check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005415{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005416 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005417
5418 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5419 && ASCII_ISALPHA(arg[len - 1]))
5420 {
5421 arg[len - 3] = NUL; /* remove the '@' */
5422 return arg + len - 2;
5423 }
5424 return NULL;
5425}
5426#endif
5427
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428/*
5429 * Return a heuristic indicating how well the given string matches. The
5430 * smaller the number, the better the match. This is the order of priorities,
5431 * from best match to worst match:
5432 * - Match with least alpha-numeric characters is better.
5433 * - Match with least total characters is better.
5434 * - Match towards the start is better.
5435 * - Match starting with "+" is worse (feature instead of command)
5436 * Assumption is made that the matched_string passed has already been found to
5437 * match some string for which help is requested. webb.
5438 */
5439 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005440help_heuristic(
5441 char_u *matched_string,
5442 int offset, /* offset for match */
5443 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444{
5445 int num_letters;
5446 char_u *p;
5447
5448 num_letters = 0;
5449 for (p = matched_string; *p; p++)
5450 if (ASCII_ISALNUM(*p))
5451 num_letters++;
5452
5453 /*
5454 * Multiply the number of letters by 100 to give it a much bigger
5455 * weighting than the number of characters.
5456 * If there only is a match while ignoring case, add 5000.
5457 * If the match starts in the middle of a word, add 10000 to put it
5458 * somewhere in the last half.
5459 * If the match is more than 2 chars from the start, multiply by 200 to
5460 * put it after matches at the start.
5461 */
5462 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5463 && ASCII_ISALNUM(matched_string[offset - 1]))
5464 offset += 10000;
5465 else if (offset > 2)
5466 offset *= 200;
5467 if (wrong_case)
5468 offset += 5000;
5469 /* Features are less interesting than the subjects themselves, but "+"
5470 * alone is not a feature. */
5471 if (matched_string[0] == '+' && matched_string[1] != NUL)
5472 offset += 100;
5473 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5474}
5475
5476/*
5477 * Compare functions for qsort() below, that checks the help heuristics number
5478 * that has been put after the tagname by find_tags().
5479 */
5480 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005481help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482{
5483 char *p1;
5484 char *p2;
5485
5486 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5487 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5488 return strcmp(p1, p2);
5489}
5490
5491/*
5492 * Find all help tags matching "arg", sort them and return in matches[], with
5493 * the number of matches in num_matches.
5494 * The matches will be sorted with a "best" match algorithm.
5495 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5496 */
5497 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005498find_help_tags(
5499 char_u *arg,
5500 int *num_matches,
5501 char_u ***matches,
5502 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503{
5504 char_u *s, *d;
5505 int i;
5506 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005507 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005508 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005509 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5510 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005511 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005512 "[count]", "[quotex]",
5513 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005514 "[pattern]", "\\|", "\\%$",
5515 "s/\\~", "s/\\U", "s/\\L",
5516 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005518 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005519 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005520 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5521 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005522 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005523 "\\[count]", "\\[quotex]",
5524 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005525 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02005526 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005527 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005528 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
5529 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 int flags;
5531
5532 d = IObuff; /* assume IObuff is long enough! */
5533
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005534 if (STRNICMP(arg, "expr-", 5) == 0)
5535 {
5536 // When the string starting with "expr-" and containing '?' and matches
5537 // the table, it is taken literally. Otherwise '?' is recognized as a
5538 // wildcard.
5539 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
5540 if (STRCMP(arg + 5, expr_table[i]) == 0)
5541 {
5542 STRCPY(d, arg);
5543 break;
5544 }
5545 }
5546 else
5547 {
5548 // Recognize a few exceptions to the rule. Some strings that contain
5549 // '*' with "star". Otherwise '*' is recognized as a wildcard.
5550 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
5551 if (STRCMP(arg, mtable[i]) == 0)
5552 {
5553 STRCPY(d, rtable[i]);
5554 break;
5555 }
5556 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557
5558 if (i < 0) /* no match in table */
5559 {
5560 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5561 * Also replace "\%^" and "\%(", they match every tag too.
5562 * Also "\zs", "\z1", etc.
5563 * Also "\@<", "\@=", "\@<=", etc.
5564 * And also "\_$" and "\_^". */
5565 if (arg[0] == '\\'
5566 && ((arg[1] != NUL && arg[2] == NUL)
5567 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5568 && arg[2] != NUL)))
5569 {
5570 STRCPY(d, "/\\\\");
5571 STRCPY(d + 3, arg + 1);
5572 /* Check for "/\\_$", should be "/\\_\$" */
5573 if (d[3] == '_' && d[4] == '$')
5574 STRCPY(d + 4, "\\$");
5575 }
5576 else
5577 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005578 /* Replace:
5579 * "[:...:]" with "\[:...:]"
5580 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02005581 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005582 */
5583 if ((arg[0] == '[' && (arg[1] == ':'
5584 || (arg[1] == '+' && arg[2] == '+')))
5585 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 *d++ = '\\';
5587
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01005588 /*
5589 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
5590 */
5591 if (*arg == '(' && arg[1] == '\'')
5592 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 for (s = arg; *s; ++s)
5594 {
5595 /*
5596 * Replace "|" with "bar" and '"' with "quote" to match the name of
5597 * the tags for these commands.
5598 * Replace "*" with ".*" and "?" with "." to match command line
5599 * completion.
5600 * Insert a backslash before '~', '$' and '.' to avoid their
5601 * special meaning.
5602 */
5603 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5604 break;
5605 switch (*s)
5606 {
5607 case '|': STRCPY(d, "bar");
5608 d += 3;
5609 continue;
5610 case '"': STRCPY(d, "quote");
5611 d += 5;
5612 continue;
5613 case '*': *d++ = '.';
5614 break;
5615 case '?': *d++ = '.';
5616 continue;
5617 case '$':
5618 case '.':
5619 case '~': *d++ = '\\';
5620 break;
5621 }
5622
5623 /*
5624 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5625 * ":help i_^_CTRL-D" work.
5626 * Insert '-' before and after "CTRL-X" when applicable.
5627 */
5628 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5629 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5630 {
Bram Moolenaard82db602013-08-07 15:24:41 +02005631 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
5632 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 STRCPY(d, "CTRL-");
5634 d += 5;
5635 if (*s < ' ')
5636 {
5637#ifdef EBCDIC
5638 *d++ = CtrlChar(*s);
5639#else
5640 *d++ = *s + '@';
5641#endif
5642 if (d[-1] == '\\')
5643 *d++ = '\\'; /* double a backslash */
5644 }
5645 else
5646 *d++ = *++s;
5647 if (s[1] != NUL && s[1] != '_')
5648 *d++ = '_'; /* append a '_' */
5649 continue;
5650 }
5651 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5652 *d++ = '\\';
5653
5654 /*
5655 * Insert a backslash before a backslash after a slash, for search
5656 * pattern tags: "/\|" --> "/\\|".
5657 */
5658 else if (s[0] == '\\' && s[1] != '\\'
5659 && *arg == '/' && s == arg + 1)
5660 *d++ = '\\';
5661
5662 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5663 * "CTRL-\_CTRL-N" */
5664 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5665 {
5666 STRCPY(d, "CTRL-\\\\");
5667 d += 7;
5668 s += 6;
5669 }
5670
5671 *d++ = *s;
5672
5673 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02005674 * If tag contains "({" or "([", tag terminates at the "(".
5675 * This is for help on functions, e.g.: abs({expr}).
5676 */
5677 if (*s == '(' && (s[1] == '{' || s[1] =='['))
5678 break;
5679
5680 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 * If tag starts with ', toss everything after a second '. Fixes
5682 * CTRL-] on 'option'. (would include the trailing '.').
5683 */
5684 if (*s == '\'' && s > arg && *arg == '\'')
5685 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02005686 /* Also '{' and '}'. */
5687 if (*s == '}' && s > arg && *arg == '{')
5688 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 }
5690 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02005691
5692 if (*IObuff == '`')
5693 {
5694 if (d > IObuff + 2 && d[-1] == '`')
5695 {
5696 /* remove the backticks from `command` */
5697 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5698 d[-2] = NUL;
5699 }
5700 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
5701 {
5702 /* remove the backticks and comma from `command`, */
5703 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5704 d[-3] = NUL;
5705 }
5706 else if (d > IObuff + 4 && d[-3] == '`'
5707 && d[-2] == '\\' && d[-1] == '.')
5708 {
5709 /* remove the backticks and dot from `command`\. */
5710 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5711 d[-4] = NUL;
5712 }
5713 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 }
5715 }
5716
5717 *matches = (char_u **)"";
5718 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02005719 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 if (keep_lang)
5721 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005722 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005724 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 /* Sort the matches found on the heuristic number that is after the
5726 * tag name. */
5727 qsort((void *)*matches, (size_t)*num_matches,
5728 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005729 /* Delete more than TAG_MANY to reduce the size of the listing. */
5730 while (*num_matches > TAG_MANY)
5731 vim_free((*matches)[--*num_matches]);
5732 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 return OK;
5734}
5735
5736/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005737 * Called when starting to edit a buffer for a help file.
5738 */
5739 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005740prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005741{
5742 char_u *p;
5743
5744 curbuf->b_help = TRUE;
5745#ifdef FEAT_QUICKFIX
5746 set_string_option_direct((char_u *)"buftype", -1,
5747 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
5748#endif
5749
5750 /*
5751 * Always set these options after jumping to a help tag, because the
5752 * user may have an autocommand that gets in the way.
5753 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
5754 * latin1 word characters (for translated help files).
5755 * Only set it when needed, buf_init_chartab() is some work.
5756 */
5757 p =
5758#ifdef EBCDIC
5759 (char_u *)"65-255,^*,^|,^\"";
5760#else
5761 (char_u *)"!-~,^*,^|,^\",192-255";
5762#endif
5763 if (STRCMP(curbuf->b_p_isk, p) != 0)
5764 {
5765 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
5766 check_buf_options(curbuf);
5767 (void)buf_init_chartab(curbuf, FALSE);
5768 }
5769
Bram Moolenaar0b105412014-11-30 13:34:23 +01005770#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005771 /* Don't use the global foldmethod.*/
5772 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
5773 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01005774#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005775
5776 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
5777 curwin->w_p_list = FALSE; /* no list mode */
5778
5779 curbuf->b_p_ma = FALSE; /* not modifiable */
5780 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
5781 curwin->w_p_nu = 0; /* no line numbers */
5782 curwin->w_p_rnu = 0; /* no relative line numbers */
5783 RESET_BINDING(curwin); /* no scroll or cursor binding */
5784#ifdef FEAT_ARABIC
5785 curwin->w_p_arab = FALSE; /* no arabic mode */
5786#endif
5787#ifdef FEAT_RIGHTLEFT
5788 curwin->w_p_rl = FALSE; /* help window is left-to-right */
5789#endif
5790#ifdef FEAT_FOLDING
5791 curwin->w_p_fen = FALSE; /* No folding in the help window */
5792#endif
5793#ifdef FEAT_DIFF
5794 curwin->w_p_diff = FALSE; /* No 'diff' */
5795#endif
5796#ifdef FEAT_SPELL
5797 curwin->w_p_spell = FALSE; /* No spell checking */
5798#endif
5799
5800 set_buflisted(FALSE);
5801}
5802
5803/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 * After reading a help file: May cleanup a help buffer when syntax
5805 * highlighting is not used.
5806 */
5807 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005808fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809{
5810 linenr_T lnum;
5811 char_u *line;
5812 int in_example = FALSE;
5813 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005814 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 char_u *p;
5816 char_u *rt;
5817 int mustfree;
5818
Bram Moolenaar90492982017-06-22 14:16:31 +02005819 /* Set filetype to "help" if still needed. */
5820 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02005821 {
5822 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02005823 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02005824 --curbuf_lock;
5825 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826
5827#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02005828 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829#endif
5830 {
5831 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5832 {
5833 line = ml_get_buf(curbuf, lnum, FALSE);
5834 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005835 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 {
5837 /* End of example: non-white or '<' in first column. */
5838 if (line[0] == '<')
5839 {
5840 /* blank-out a '<' in the first column */
5841 line = ml_get_buf(curbuf, lnum, TRUE);
5842 line[0] = ' ';
5843 }
5844 in_example = FALSE;
5845 }
5846 if (!in_example && len > 0)
5847 {
5848 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5849 {
5850 /* blank-out a '>' in the last column (start of example) */
5851 line = ml_get_buf(curbuf, lnum, TRUE);
5852 line[len - 1] = ' ';
5853 in_example = TRUE;
5854 }
5855 else if (line[len - 1] == '~')
5856 {
5857 /* blank-out a '~' at the end of line (header marker) */
5858 line = ml_get_buf(curbuf, lnum, TRUE);
5859 line[len - 1] = ' ';
5860 }
5861 }
5862 }
5863 }
5864
5865 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005866 * In the "help.txt" and "help.abx" file, add the locally added help
5867 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005869 fname = gettail(curbuf->b_fname);
5870 if (fnamecmp(fname, "help.txt") == 0
5871#ifdef FEAT_MULTI_LANG
5872 || (fnamencmp(fname, "help.", 5) == 0
5873 && ASCII_ISALPHA(fname[5])
5874 && ASCII_ISALPHA(fname[6])
5875 && TOLOWER_ASC(fname[7]) == 'x'
5876 && fname[8] == NUL)
5877#endif
5878 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 {
5880 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5881 {
5882 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005883 if (strstr((char *)line, "*local-additions*") == NULL)
5884 continue;
5885
5886 /* Go through all directories in 'runtimepath', skipping
5887 * $VIMRUNTIME. */
5888 p = p_rtp;
5889 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005891 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5892 mustfree = FALSE;
5893 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaar99499b12019-05-23 21:35:48 +02005894 if (rt != NULL &&
5895 fullpathcmp(rt, NameBuff, FALSE, TRUE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005897 int fcount;
5898 char_u **fnames;
5899 FILE *fd;
5900 char_u *s;
5901 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005902 vimconv_T vc;
5903 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005905 /* Find all "doc/ *.txt" files in this directory. */
5906 add_pathsep(NameBuff);
5907#ifdef FEAT_MULTI_LANG
5908 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005910 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005912 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5913 &fnames, EW_FILE|EW_SILENT) == OK
5914 && fcount > 0)
5915 {
5916#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005917 int i1, i2;
5918 char_u *f1, *f2;
5919 char_u *t1, *t2;
5920 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005921
5922 /* If foo.abx is found use it instead of foo.txt in
5923 * the same directory. */
5924 for (i1 = 0; i1 < fcount; ++i1)
5925 {
5926 for (i2 = 0; i2 < fcount; ++i2)
5927 {
5928 if (i1 == i2)
5929 continue;
5930 if (fnames[i1] == NULL || fnames[i2] == NULL)
5931 continue;
5932 f1 = fnames[i1];
5933 f2 = fnames[i2];
5934 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005935 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005936 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005937 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02005938 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005939 continue;
5940 if (fnamecmp(e1, ".txt") != 0
5941 && fnamecmp(e1, fname + 4) != 0)
5942 {
5943 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005944 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005945 continue;
5946 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005947 if (e1 - f1 != e2 - f2
5948 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005949 continue;
5950 if (fnamecmp(e1, ".txt") == 0
5951 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005952 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005953 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005956#endif
5957 for (fi = 0; fi < fcount; ++fi)
5958 {
5959 if (fnames[fi] == NULL)
5960 continue;
5961 fd = mch_fopen((char *)fnames[fi], "r");
5962 if (fd != NULL)
5963 {
5964 vim_fgets(IObuff, IOSIZE, fd);
5965 if (IObuff[0] == '*'
5966 && (s = vim_strchr(IObuff + 1, '*'))
5967 != NULL)
5968 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005969 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01005970
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005971 /* Change tag definition to a
5972 * reference and remove <CR>/<NL>. */
5973 IObuff[0] = '|';
5974 *s = '|';
5975 while (*s != NUL)
5976 {
5977 if (*s == '\r' || *s == '\n')
5978 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005979 /* The text is utf-8 when a byte
5980 * above 127 is found and no
5981 * illegal byte sequence is found.
5982 */
5983 if (*s >= 0x80 && this_utf != FALSE)
5984 {
5985 int l;
5986
5987 this_utf = TRUE;
5988 l = utf_ptr2len(s);
5989 if (l == 1)
5990 this_utf = FALSE;
5991 s += l - 1;
5992 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005993 ++s;
5994 }
Bram Moolenaar13505972019-01-24 15:04:48 +01005995
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005996 /* The help file is latin1 or utf-8;
5997 * conversion to the current
5998 * 'encoding' may be required. */
5999 vc.vc_type = CONV_NONE;
6000 convert_setup(&vc, (char_u *)(
6001 this_utf == TRUE ? "utf-8"
6002 : "latin1"), p_enc);
6003 if (vc.vc_type == CONV_NONE)
6004 /* No conversion needed. */
6005 cp = IObuff;
6006 else
6007 {
6008 /* Do the conversion. If it fails
6009 * use the unconverted text. */
6010 cp = string_convert(&vc, IObuff,
6011 NULL);
6012 if (cp == NULL)
6013 cp = IObuff;
6014 }
6015 convert_setup(&vc, NULL, NULL);
6016
6017 ml_append(lnum, cp, (colnr_T)0, FALSE);
6018 if (cp != IObuff)
6019 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006020 ++lnum;
6021 }
6022 fclose(fd);
6023 }
6024 }
6025 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006028 if (mustfree)
6029 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006031 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 }
6033 }
6034}
6035
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006036/*
6037 * ":exusage"
6038 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006039 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006040ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006041{
6042 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6043}
6044
6045/*
6046 * ":viusage"
6047 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006048 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006049ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006050{
6051 do_cmdline_cmd((char_u *)"help normal-index");
6052}
6053
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006055 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006058helptags_one(
6059 char_u *dir, /* doc directory */
6060 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
6061 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
6062 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063{
6064 FILE *fd_tags;
6065 FILE *fd;
6066 garray_T ga;
6067 int filecount;
6068 char_u **files;
6069 char_u *p1, *p2;
6070 int fi;
6071 char_u *s;
6072 int i;
6073 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006074 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 int utf8 = MAYBE;
6076 int this_utf8;
6077 int firstline;
6078 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079
6080 /*
6081 * Find all *.txt files.
6082 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01006083 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006085 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 STRCAT(NameBuff, ext);
6087 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6088 EW_FILE|EW_SILENT) == FAIL
6089 || filecount == 0)
6090 {
6091 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006092 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 return;
6094 }
6095
6096 /*
6097 * Open the tags file for writing.
6098 * Do this before scanning through all the files.
6099 */
6100 STRCPY(NameBuff, dir);
6101 add_pathsep(NameBuff);
6102 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006103 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 if (fd_tags == NULL)
6105 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006106 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 FreeWild(filecount, files);
6108 return;
6109 }
6110
6111 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006112 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6113 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 */
6115 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006116 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
Bram Moolenaar99499b12019-05-23 21:35:48 +02006117 dir, FALSE, TRUE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 {
6119 if (ga_grow(&ga, 1) == FAIL)
6120 got_int = TRUE;
6121 else
6122 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006123 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124 if (s == NULL)
6125 got_int = TRUE;
6126 else
6127 {
6128 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6129 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6130 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 }
6132 }
6133 }
6134
6135 /*
6136 * Go over all the files and extract the tags.
6137 */
6138 for (fi = 0; fi < filecount && !got_int; ++fi)
6139 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006140 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 if (fd == NULL)
6142 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006143 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 continue;
6145 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006146 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6150 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 if (firstline)
6152 {
6153 /* Detect utf-8 file by a non-ASCII char in the first line. */
6154 this_utf8 = MAYBE;
6155 for (s = IObuff; *s != NUL; ++s)
6156 if (*s >= 0x80)
6157 {
6158 int l;
6159
6160 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006161 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 if (l == 1)
6163 {
6164 /* Illegal UTF-8 byte sequence. */
6165 this_utf8 = FALSE;
6166 break;
6167 }
6168 s += l - 1;
6169 }
6170 if (this_utf8 == MAYBE) /* only ASCII characters found */
6171 this_utf8 = FALSE;
6172 if (utf8 == MAYBE) /* first file */
6173 utf8 = this_utf8;
6174 else if (utf8 != this_utf8)
6175 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006176 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 mix = !got_int;
6178 got_int = TRUE;
6179 }
6180 firstline = FALSE;
6181 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6183 while (p1 != NULL)
6184 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02006185 /* Use vim_strbyte() instead of vim_strchr() so that when
6186 * 'encoding' is dbcs it still works, don't find '*' in the
6187 * second byte. */
6188 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6190 {
6191 for (s = p1 + 1; s < p2; ++s)
6192 if (*s == ' ' || *s == '\t' || *s == '|')
6193 break;
6194
6195 /*
6196 * Only accept a *tag* when it consists of valid
6197 * characters, there is white space before it and is
6198 * followed by a white character or end-of-line.
6199 */
6200 if (s == p2
6201 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6202 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6203 || s[1] == '\0'))
6204 {
6205 *p2 = '\0';
6206 ++p1;
6207 if (ga_grow(&ga, 1) == FAIL)
6208 {
6209 got_int = TRUE;
6210 break;
6211 }
Bram Moolenaar964b3742019-05-24 18:54:09 +02006212 s = alloc(p2 - p1 + STRLEN(fname) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 if (s == NULL)
6214 {
6215 got_int = TRUE;
6216 break;
6217 }
6218 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6219 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 sprintf((char *)s, "%s\t%s", p1, fname);
6221
6222 /* find next '*' */
6223 p2 = vim_strchr(p2 + 1, '*');
6224 }
6225 }
6226 p1 = p2;
6227 }
6228 line_breakcheck();
6229 }
6230
6231 fclose(fd);
6232 }
6233
6234 FreeWild(filecount, files);
6235
6236 if (!got_int)
6237 {
6238 /*
6239 * Sort the tags.
6240 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02006241 if (ga.ga_data != NULL)
6242 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243
6244 /*
6245 * Check for duplicates.
6246 */
6247 for (i = 1; i < ga.ga_len; ++i)
6248 {
6249 p1 = ((char_u **)ga.ga_data)[i - 1];
6250 p2 = ((char_u **)ga.ga_data)[i];
6251 while (*p1 == *p2)
6252 {
6253 if (*p2 == '\t')
6254 {
6255 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006256 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6258 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006259 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 *p2 = '\t';
6261 break;
6262 }
6263 ++p1;
6264 ++p2;
6265 }
6266 }
6267
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 if (utf8 == TRUE)
6269 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270
6271 /*
6272 * Write the tags into the file.
6273 */
6274 for (i = 0; i < ga.ga_len; ++i)
6275 {
6276 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006277 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006279 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 else
6281 {
6282 fprintf(fd_tags, "%s\t/*", s);
6283 for (p1 = s; *p1 != '\t'; ++p1)
6284 {
6285 /* insert backslash before '\\' and '/' */
6286 if (*p1 == '\\' || *p1 == '/')
6287 putc('\\', fd_tags);
6288 putc(*p1, fd_tags);
6289 }
6290 fprintf(fd_tags, "*\n");
6291 }
6292 }
6293 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 if (mix)
6295 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296
6297 for (i = 0; i < ga.ga_len; ++i)
6298 vim_free(((char_u **)ga.ga_data)[i]);
6299 ga_clear(&ga);
6300 fclose(fd_tags); /* there is no check for an error... */
6301}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006303/*
6304 * Generate tags in one help directory, taking care of translations.
6305 */
6306 static void
6307do_helptags(char_u *dirname, int add_help_tags)
6308{
6309#ifdef FEAT_MULTI_LANG
6310 int len;
6311 int i, j;
6312 garray_T ga;
6313 char_u lang[2];
6314 char_u ext[5];
6315 char_u fname[8];
6316 int filecount;
6317 char_u **files;
6318
6319 /* Get a list of all files in the help directory and in subdirectories. */
6320 STRCPY(NameBuff, dirname);
6321 add_pathsep(NameBuff);
6322 STRCAT(NameBuff, "**");
6323 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6324 EW_FILE|EW_SILENT) == FAIL
6325 || filecount == 0)
6326 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006327 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006328 return;
6329 }
6330
6331 /* Go over all files in the directory to find out what languages are
6332 * present. */
6333 ga_init2(&ga, 1, 10);
6334 for (i = 0; i < filecount; ++i)
6335 {
6336 len = (int)STRLEN(files[i]);
6337 if (len > 4)
6338 {
6339 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6340 {
6341 /* ".txt" -> language "en" */
6342 lang[0] = 'e';
6343 lang[1] = 'n';
6344 }
6345 else if (files[i][len - 4] == '.'
6346 && ASCII_ISALPHA(files[i][len - 3])
6347 && ASCII_ISALPHA(files[i][len - 2])
6348 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6349 {
6350 /* ".abx" -> language "ab" */
6351 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6352 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6353 }
6354 else
6355 continue;
6356
6357 /* Did we find this language already? */
6358 for (j = 0; j < ga.ga_len; j += 2)
6359 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6360 break;
6361 if (j == ga.ga_len)
6362 {
6363 /* New language, add it. */
6364 if (ga_grow(&ga, 2) == FAIL)
6365 break;
6366 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6367 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6368 }
6369 }
6370 }
6371
6372 /*
6373 * Loop over the found languages to generate a tags file for each one.
6374 */
6375 for (j = 0; j < ga.ga_len; j += 2)
6376 {
6377 STRCPY(fname, "tags-xx");
6378 fname[5] = ((char_u *)ga.ga_data)[j];
6379 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6380 if (fname[5] == 'e' && fname[6] == 'n')
6381 {
6382 /* English is an exception: use ".txt" and "tags". */
6383 fname[4] = NUL;
6384 STRCPY(ext, ".txt");
6385 }
6386 else
6387 {
6388 /* Language "ab" uses ".abx" and "tags-ab". */
6389 STRCPY(ext, ".xxx");
6390 ext[1] = fname[5];
6391 ext[2] = fname[6];
6392 }
6393 helptags_one(dirname, ext, fname, add_help_tags);
6394 }
6395
6396 ga_clear(&ga);
6397 FreeWild(filecount, files);
6398
6399#else
6400 /* No language support, just use "*.txt" and "tags". */
6401 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6402#endif
6403}
6404
6405 static void
6406helptags_cb(char_u *fname, void *cookie)
6407{
6408 do_helptags(fname, *(int *)cookie);
6409}
6410
6411/*
6412 * ":helptags"
6413 */
6414 void
6415ex_helptags(exarg_T *eap)
6416{
6417 expand_T xpc;
6418 char_u *dirname;
6419 int add_help_tags = FALSE;
6420
6421 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01006422 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006423 {
6424 add_help_tags = TRUE;
6425 eap->arg = skipwhite(eap->arg + 3);
6426 }
6427
6428 if (STRCMP(eap->arg, "ALL") == 0)
6429 {
6430 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
6431 helptags_cb, &add_help_tags);
6432 }
6433 else
6434 {
6435 ExpandInit(&xpc);
6436 xpc.xp_context = EXPAND_DIRECTORIES;
6437 dirname = ExpandOne(&xpc, eap->arg, NULL,
6438 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6439 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006440 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006441 else
6442 do_helptags(dirname, add_help_tags);
6443 vim_free(dirname);
6444 }
6445}
6446
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006447/*
6448 * Make the user happy.
6449 */
6450 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006451ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006452{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006453 static char *code[] = {
6454 "\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$",
6455 "\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"
6456 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006457 char *p;
6458 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006459 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006460
6461 msg_start();
6462 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006463 for (i = 0; i < 2; ++i)
6464 for (p = code[i]; *p != NUL; ++p)
6465 if (*p == 'x')
6466 msg_putchar('\n');
6467 else
6468 for (n = *p++; n > 0; --n)
6469 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01006470 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006471 else
6472 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006473 msg_clr_eos();
6474}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476/*
6477 * ":drop"
6478 * Opens the first argument in a window. When there are two or more arguments
6479 * the argument list is redefined.
6480 */
6481 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006482ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483{
6484 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 win_T *wp;
6486 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006487 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488
6489 /*
6490 * Check if the first argument is already being edited in a window. If
6491 * so, jump to that window.
6492 * We would actually need to check all arguments, but that's complicated
6493 * and mostly only one file is dropped.
6494 * This also ignores wildcards, since it is very unlikely the user is
6495 * editing a file name with a wildcard character.
6496 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006497 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00006499 /*
6500 * Expanding wildcards may result in an empty argument list. E.g. when
6501 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
6502 * already did an error message for this.
6503 */
6504 if (ARGCOUNT == 0)
6505 return;
6506
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006507 if (cmdmod.tab)
6508 {
6509 /* ":tab drop file ...": open a tab for each argument that isn't
6510 * edited in a window yet. It's like ":tab all" but without closing
6511 * windows or tabs. */
6512 ex_all(eap);
6513 }
6514 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006515 {
6516 /* ":drop file ...": Edit the first argument. Jump to an existing
6517 * window if possible, edit in current window if the current buffer
6518 * can be abandoned, otherwise open a new window. */
6519 buf = buflist_findnr(ARGLIST[0].ae_fnum);
6520
6521 FOR_ALL_TAB_WINDOWS(tp, wp)
6522 {
6523 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006525 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 return;
6528 }
6529 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006531 /*
6532 * Check whether the current buffer is changed. If so, we will need
6533 * to split the current window or data could be lost.
6534 * Skip the check if the 'hidden' option is set, as in this case the
6535 * buffer won't be lost.
6536 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02006537 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006538 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006539 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01006540 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006541 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006542 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006544 /* Fake a ":sfirst" or ":first" command edit the first argument. */
6545 if (split)
6546 {
6547 eap->cmdidx = CMD_sfirst;
6548 eap->cmd[0] = 's';
6549 }
6550 else
6551 eap->cmdidx = CMD_first;
6552 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006555
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006556/*
6557 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
6558 * Put the start of the pattern in "*s", unless "s" is NULL.
6559 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
6560 * If "s" is not NULL terminate the pattern with a NUL.
6561 * Return a pointer to the char just past the pattern plus flags.
6562 */
6563 char_u *
6564skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
6565{
6566 int c;
6567
6568 if (vim_isIDc(*p))
6569 {
6570 /* ":vimgrep pattern fname" */
6571 if (s != NULL)
6572 *s = p;
6573 p = skiptowhite(p);
6574 if (s != NULL && *p != NUL)
6575 *p++ = NUL;
6576 }
6577 else
6578 {
6579 /* ":vimgrep /pattern/[g][j] fname" */
6580 if (s != NULL)
6581 *s = p + 1;
6582 c = *p;
6583 p = skip_regexp(p + 1, c, TRUE, NULL);
6584 if (*p != c)
6585 return NULL;
6586
6587 /* Truncate the pattern. */
6588 if (s != NULL)
6589 *p = NUL;
6590 ++p;
6591
6592 /* Find the flags */
6593 while (*p == 'g' || *p == 'j')
6594 {
6595 if (flags != NULL)
6596 {
6597 if (*p == 'g')
6598 *flags |= VGR_GLOBAL;
6599 else
6600 *flags |= VGR_NOJUMP;
6601 }
6602 ++p;
6603 }
6604 }
6605 return p;
6606}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006607
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006608#if defined(FEAT_EVAL) || defined(PROTO)
6609/*
6610 * List v:oldfiles in a nice way.
6611 */
6612 void
6613ex_oldfiles(exarg_T *eap UNUSED)
6614{
6615 list_T *l = get_vim_var_list(VV_OLDFILES);
6616 listitem_T *li;
6617 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006618 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006619
6620 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006621 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006622 else
6623 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006624 msg_start();
6625 msg_scroll = TRUE;
6626 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
6627 {
6628 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006629 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02006630 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006631 {
6632 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01006633 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006634 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02006635 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006636 msg_putchar('\n');
6637 out_flush(); /* output one line at a time */
6638 ui_breakcheck();
6639 }
6640 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006641
6642 /* Assume "got_int" was set to truncate the listing. */
6643 got_int = FALSE;
6644
6645# ifdef FEAT_BROWSE_CMD
6646 if (cmdmod.browse)
6647 {
6648 quit_more = FALSE;
6649 nr = prompt_for_number(FALSE);
6650 msg_starthere();
6651 if (nr > 0)
6652 {
6653 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
6654 (long)nr);
6655
6656 if (p != NULL)
6657 {
6658 p = expand_env_save(p);
6659 eap->arg = p;
6660 eap->cmdidx = CMD_edit;
6661 cmdmod.browse = FALSE;
6662 do_exedit(eap, NULL);
6663 vim_free(p);
6664 }
6665 }
6666 }
6667# endif
6668 }
6669}
6670#endif