blob: 7153606282a2287dfb1ac208a44c47db5ae2e791 [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 Moolenaar5843f5f2019-08-20 20:13:45 +020023static int not_writing(void);
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
Bram Moolenaar396b7c72019-10-21 23:08:59 +0200254 // Get the line. If it's empty bail out early (could be the empty string
255 // for an unloaded buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256 line = ml_get_curline();
Bram Moolenaar396b7c72019-10-21 23:08:59 +0200257 if (*line == NUL)
258 return 0;
259
260 // find the first non-blank character
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 first = skipwhite(line);
262
Bram Moolenaar396b7c72019-10-21 23:08:59 +0200263 // find the character after the last non-blank character
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100265 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266 ;
267 save = *last;
268 *last = NUL;
Bram Moolenaar396b7c72019-10-21 23:08:59 +0200269 len = linetabsize(line); // get line length
270 if (has_tab != NULL) // check for embedded TAB
Bram Moolenaarb31a3ac2018-08-11 14:41:55 +0200271 *has_tab = (vim_strchr(first, TAB) != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 *last = save;
273
274 return len;
275}
276
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000277/* Buffer for two lines used during sorting. They are allocated to
278 * contain the longest line being sorted. */
279static char_u *sortbuf1;
280static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000281
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100282static int sort_ic; /* ignore case */
283static int sort_nr; /* sort on number */
284static int sort_rx; /* sort on regex instead of skipping it */
285#ifdef FEAT_FLOAT
286static int sort_flt; /* sort on floating number */
287#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000288
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100289static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000290
291/* Struct to store info to be sorted. */
292typedef struct
293{
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100294 linenr_T lnum; // line number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100295 union {
296 struct
297 {
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100298 varnumber_T start_col_nr; // starting column number
299 varnumber_T end_col_nr; // ending column number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100300 } line;
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100301 struct
302 {
303 varnumber_T value; // value if sorting by integer
304 int is_number; // TRUE when line contains a number
305 } num;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100306#ifdef FEAT_FLOAT
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100307 float_T value_flt; // value if sorting by float
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100308#endif
309 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000310} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000311
Bram Moolenaareae1b912019-05-09 15:12:55 +0200312static int sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000313
314 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100315sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000316{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000317 sorti_T l1 = *(sorti_T *)s1;
318 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000319 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000320
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000321 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000322 * if we return 0 every time, qsort will assume it's done sorting and
323 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000324 if (sort_abort)
325 return 0;
326 fast_breakcheck();
327 if (got_int)
328 sort_abort = TRUE;
329
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000330 if (sort_nr)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100331 {
332 if (l1.st_u.num.is_number != l2.st_u.num.is_number)
333 result = l1.st_u.num.is_number - l2.st_u.num.is_number;
334 else
335 result = l1.st_u.num.value == l2.st_u.num.value ? 0
336 : l1.st_u.num.value > l2.st_u.num.value ? 1 : -1;
337 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100338#ifdef FEAT_FLOAT
339 else if (sort_flt)
340 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
341 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
342#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000343 else
344 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000345 /* We need to copy one line into "sortbuf1", because there is no
346 * guarantee that the first pointer becomes invalid when obtaining the
347 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100348 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
349 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
350 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
351 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
352 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
353 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000354
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000355 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
356 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000357 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000358
359 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000360 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000361 return (int)(l1.lnum - l2.lnum);
362 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000363}
364
365/*
366 * ":sort".
367 */
368 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100369ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000370{
371 regmatch_T regmatch;
372 int len;
373 linenr_T lnum;
374 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000375 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000376 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000377 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000378 char_u *p;
379 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000380 char_u *s2;
381 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382 int unique = FALSE;
383 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000384 colnr_T start_col;
385 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100386 int sort_what = 0;
387 int format_found = 0;
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200388 int change_occurred = FALSE; // Buffer contents changed.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000389
Bram Moolenaar48c99162008-02-18 18:42:52 +0000390 /* Sorting one line is really quick! */
391 if (count <= 1)
392 return;
393
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000394 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
395 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000396 sortbuf1 = NULL;
397 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000398 regmatch.regprog = NULL;
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200399 nrs = ALLOC_MULT(sorti_T, count);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000400 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000401 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000402
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100403 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100404#ifdef FEAT_FLOAT
405 sort_flt = 0;
406#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000407
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000408 for (p = eap->arg; *p != NUL; ++p)
409 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100410 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000411 ;
412 else if (*p == 'i')
413 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000414 else if (*p == 'r')
415 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000416 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100417 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100418 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100419 ++format_found;
420 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100421#ifdef FEAT_FLOAT
422 else if (*p == 'f')
423 {
424 sort_flt = 1;
425 ++format_found;
426 }
427#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100428 else if (*p == 'b')
429 {
430 sort_what = STR2NR_BIN + STR2NR_FORCE;
431 ++format_found;
432 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000433 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100434 {
435 sort_what = STR2NR_OCT + STR2NR_FORCE;
436 ++format_found;
437 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000438 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100439 {
440 sort_what = STR2NR_HEX + STR2NR_FORCE;
441 ++format_found;
442 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000443 else if (*p == 'u')
444 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000445 else if (*p == '"') /* comment start */
446 break;
447 else if (check_nextcmd(p) != NULL)
448 {
449 eap->nextcmd = check_nextcmd(p);
450 break;
451 }
452 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000453 {
454 s = skip_regexp(p + 1, *p, TRUE, NULL);
455 if (*s != *p)
456 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100457 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000458 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000459 }
460 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000461 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100462 if (s == p + 1)
463 {
464 if (last_search_pat() == NULL)
465 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100466 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100467 goto sortend;
468 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000469 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100470 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000471 else
472 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000473 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000475 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000476 regmatch.rm_ic = p_ic;
477 }
478 else
479 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100480 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000481 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000482 }
483 }
484
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100485 /* Can only have one of 'n', 'b', 'o' and 'x'. */
486 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000487 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100488 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000489 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 }
491
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100492 /* From here on "sort_nr" is used as a flag for any integer number
493 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100494 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000496 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000497 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000498 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000499 * When sorting on strings "start_col_nr" is the offset in the line, for
500 * numbers sorting it's the number to sort on. This means the pattern
501 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000503 */
504 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
505 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000506 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000507 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 if (maxlen < len)
509 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000510
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 start_col = 0;
512 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000513 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000514 {
515 if (sort_rx)
516 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000517 start_col = (colnr_T)(regmatch.startp[0] - s);
518 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000519 }
520 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000521 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000522 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000523 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000524 if (regmatch.regprog != NULL)
525 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000526
Bram Moolenaar937204a2016-01-30 23:37:38 +0100527 if (sort_nr
528#ifdef FEAT_FLOAT
529 || sort_flt
530#endif
531 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000532 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000533 /* Make sure vim_str2nr doesn't read any digits past the end
534 * of the match, by temporarily terminating the string there */
535 s2 = s + end_col;
536 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200537 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000538 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000539 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100540 if (sort_nr)
541 {
542 if (sort_what & STR2NR_HEX)
543 s = skiptohex(p);
544 else if (sort_what & STR2NR_BIN)
545 s = skiptobin(p);
546 else
547 s = skiptodigit(p);
548 if (s > p && s[-1] == '-')
549 --s; /* include preceding negative sign */
550 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100551 {
552 /* line without number should sort before any number */
553 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
554 nrs[lnum - eap->line1].st_u.num.value = 0;
555 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100556 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100557 {
558 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100559 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaar16e9b852019-05-19 19:59:35 +0200560 &nrs[lnum - eap->line1].st_u.num.value,
561 NULL, 0, FALSE);
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100562 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100563 }
564#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000565 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100566 {
567 s = skipwhite(p);
568 if (*s == '+')
569 s = skipwhite(s + 1);
570
571 if (*s == NUL)
572 /* empty line should sort before any number */
573 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
574 else
575 nrs[lnum - eap->line1].st_u.value_flt =
576 strtod((char *)s, NULL);
577 }
578#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200579 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000580 }
581 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000582 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000583 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100584 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
585 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000586 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000587
588 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000589
590 if (regmatch.regprog != NULL)
591 fast_breakcheck();
592 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000594 }
595
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000596 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar964b3742019-05-24 18:54:09 +0200597 sortbuf1 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000598 if (sortbuf1 == NULL)
599 goto sortend;
Bram Moolenaar964b3742019-05-24 18:54:09 +0200600 sortbuf2 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000601 if (sortbuf2 == NULL)
602 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000604 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000605 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000606
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000607 if (sort_abort)
608 goto sortend;
609
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000610 /* Insert the lines in the sorted order below the last one. */
611 lnum = eap->line2;
612 for (i = 0; i < count; ++i)
613 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200614 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
615
616 // If the original line number of the line being placed is not the same
617 // as "lnum" (accounting for offset), we know that the buffer changed.
618 if (get_lnum + ((linenr_T)count - 1) != lnum)
619 change_occurred = TRUE;
620
621 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000622 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000623 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200625 // Copy the line into a buffer, it may become invalid in
626 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100627 STRCPY(sortbuf1, s);
628 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000629 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000630 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000631 fast_breakcheck();
632 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000633 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 }
635
636 /* delete the original lines if appending worked */
637 if (i == count)
638 for (i = 0; i < count; ++i)
639 ml_delete(eap->line1, FALSE);
640 else
641 count = 0;
642
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000643 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000644 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200646 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000647 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200648 msgmore(-deleted);
649 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000650 else if (deleted < 0)
651 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200652
653 if (change_occurred || deleted != 0)
654 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000655
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000656 curwin->w_cursor.lnum = eap->line1;
657 beginline(BL_WHITE | BL_FIX);
658
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000659sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000660 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000661 vim_free(sortbuf1);
662 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200663 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000664 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100665 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000666}
667
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 * :move command - move lines line1-line2 to line dest
670 *
671 * return FAIL for failure, OK otherwise
672 */
673 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100674do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675{
676 char_u *str;
677 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100678 linenr_T extra; // Num lines added before line1
679 linenr_T num_lines; // Num lines moved
680 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200681#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100682 win_T *win;
683 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200684#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
686 if (dest >= line1 && dest < line2)
687 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100688 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 return FAIL;
690 }
691
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100692 // Do nothing if we are not actually moving any lines. This will prevent
693 // the 'modified' flag from being set without cause.
694 if (dest == line1 - 1 || dest == line2)
695 {
696 // Move the cursor as if lines were moved (see below) to be backwards
697 // compatible.
698 if (dest >= line1)
699 curwin->w_cursor.lnum = dest;
700 else
701 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
702
703 return OK;
704 }
705
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 num_lines = line2 - line1 + 1;
707
708 /*
709 * First we copy the old text to its new location -- webb
710 * Also copy the flag that ":global" command uses.
711 */
712 if (u_save(dest, dest + 1) == FAIL)
713 return FAIL;
714 for (extra = 0, l = line1; l <= line2; l++)
715 {
716 str = vim_strsave(ml_get(l + extra));
717 if (str != NULL)
718 {
719 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
720 vim_free(str);
721 if (dest < line1)
722 extra++;
723 }
724 }
725
726 /*
727 * Now we must be careful adjusting our marks so that we don't overlap our
728 * mark_adjust() calls.
729 *
730 * We adjust the marks within the old text so that they refer to the
731 * last lines of the file (temporarily), because we know no other marks
732 * will be set there since these line numbers did not exist until we added
733 * our new lines.
734 *
735 * Then we adjust the marks on lines between the old and new text positions
736 * (either forwards or backwards).
737 *
738 * And Finally we adjust the marks we put at the end of the file back to
739 * their final destination at the new text position -- webb
740 */
741 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100742 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 if (dest >= line2)
744 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100745 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
746#ifdef FEAT_FOLDING
747 FOR_ALL_TAB_WINDOWS(tp, win) {
748 if (win->w_buffer == curbuf)
749 foldMoveRange(&win->w_folds, line1, line2, dest);
750 }
751#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 curbuf->b_op_start.lnum = dest - num_lines + 1;
753 curbuf->b_op_end.lnum = dest;
754 }
755 else
756 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100757 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
758#ifdef FEAT_FOLDING
759 FOR_ALL_TAB_WINDOWS(tp, win) {
760 if (win->w_buffer == curbuf)
761 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
762 }
763#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 curbuf->b_op_start.lnum = dest + 1;
765 curbuf->b_op_end.lnum = dest + num_lines;
766 }
767 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100768 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 -(last_line - dest - extra), 0L);
770
771 /*
772 * Now we delete the original text -- webb
773 */
774 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
775 return FAIL;
776
777 for (l = line1; l <= line2; l++)
778 ml_delete(line1 + extra, TRUE);
779
780 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100781 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +0200782 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783
784 /*
785 * Leave the cursor on the last of the moved lines.
786 */
787 if (dest >= line1)
788 curwin->w_cursor.lnum = dest;
789 else
790 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
791
792 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100793 {
794 dest += num_lines + 1;
795 last_line = curbuf->b_ml.ml_line_count;
796 if (dest > last_line + 1)
797 dest = last_line + 1;
798 changed_lines(line1, 0, dest, 0L);
799 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 else
801 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
802
803 return OK;
804}
805
806/*
807 * ":copy"
808 */
809 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100810ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811{
812 linenr_T count;
813 char_u *p;
814
815 count = line2 - line1 + 1;
816 curbuf->b_op_start.lnum = n + 1;
817 curbuf->b_op_end.lnum = n + count;
818 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
819
820 /*
821 * there are three situations:
822 * 1. destination is above line1
823 * 2. destination is between line1 and line2
824 * 3. destination is below line2
825 *
826 * n = destination (when starting)
827 * curwin->w_cursor.lnum = destination (while copying)
828 * line1 = start of source (while copying)
829 * line2 = end of source (while copying)
830 */
831 if (u_save(n, n + 1) == FAIL)
832 return;
833
834 curwin->w_cursor.lnum = n;
835 while (line1 <= line2)
836 {
837 /* need to use vim_strsave() because the line will be unlocked within
838 * ml_append() */
839 p = vim_strsave(ml_get(line1));
840 if (p != NULL)
841 {
842 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
843 vim_free(p);
844 }
845 /* situation 2: skip already copied lines */
846 if (line1 == n)
847 line1 = curwin->w_cursor.lnum;
848 ++line1;
849 if (curwin->w_cursor.lnum < line1)
850 ++line1;
851 if (curwin->w_cursor.lnum < line2)
852 ++line2;
853 ++curwin->w_cursor.lnum;
854 }
855
856 appended_lines_mark(n, count);
857
858 msgmore((long)count);
859}
860
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000861static char_u *prevcmd = NULL; /* the previous command */
862
863#if defined(EXITFREE) || defined(PROTO)
864 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100865free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000866{
867 vim_free(prevcmd);
868}
869#endif
870
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871/*
872 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
873 * Bangs in the argument are replaced with the previously entered command.
874 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 */
876 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100877do_bang(
878 int addr_count,
879 exarg_T *eap,
880 int forceit,
881 int do_in,
882 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883{
884 char_u *arg = eap->arg; /* command */
885 linenr_T line1 = eap->line1; /* start of range */
886 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 char_u *newcmd = NULL; /* the new command */
888 int free_newcmd = FALSE; /* need to free() newcmd */
889 int ins_prevcmd;
890 char_u *t;
891 char_u *p;
892 char_u *trailarg;
893 int len;
894 int scroll_save = msg_scroll;
895
896 /*
897 * Disallow shell commands for "rvim".
898 * Disallow shell commands from .exrc and .vimrc in current directory for
899 * security reasons.
900 */
901 if (check_restricted() || check_secure())
902 return;
903
904 if (addr_count == 0) /* :! */
905 {
906 msg_scroll = FALSE; /* don't scroll here */
907 autowrite_all();
908 msg_scroll = scroll_save;
909 }
910
911 /*
912 * Try to find an embedded bang, like in :!<cmd> ! [args]
913 * (:!! is indicated by the 'forceit' variable)
914 */
915 ins_prevcmd = forceit;
916 trailarg = arg;
917 do
918 {
919 len = (int)STRLEN(trailarg) + 1;
920 if (newcmd != NULL)
921 len += (int)STRLEN(newcmd);
922 if (ins_prevcmd)
923 {
924 if (prevcmd == NULL)
925 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100926 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 vim_free(newcmd);
928 return;
929 }
930 len += (int)STRLEN(prevcmd);
931 }
Bram Moolenaar964b3742019-05-24 18:54:09 +0200932 if ((t = alloc(len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 {
934 vim_free(newcmd);
935 return;
936 }
937 *t = NUL;
938 if (newcmd != NULL)
939 STRCAT(t, newcmd);
940 if (ins_prevcmd)
941 STRCAT(t, prevcmd);
942 p = t + STRLEN(t);
943 STRCAT(t, trailarg);
944 vim_free(newcmd);
945 newcmd = t;
946
947 /*
948 * Scan the rest of the argument for '!', which is replaced by the
949 * previous command. "\!" is replaced by "!" (this is vi compatible).
950 */
951 trailarg = NULL;
952 while (*p)
953 {
Bram Moolenaare60acc12011-05-10 16:41:25 +0200954 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 {
956 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000957 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 else
959 {
960 trailarg = p;
961 *trailarg++ = NUL;
962 ins_prevcmd = TRUE;
963 break;
964 }
965 }
966 ++p;
967 }
968 } while (trailarg != NULL);
969
970 vim_free(prevcmd);
971 prevcmd = newcmd;
972
973 if (bangredo) /* put cmd in redo buffer for ! command */
974 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +0100975 /* If % or # appears in the command, it must have been escaped.
976 * Reescape them, so that redoing them does not substitute them by the
977 * buffername. */
978 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
979
980 if (cmd != NULL)
981 {
982 AppendToRedobuffLit(cmd, -1);
983 vim_free(cmd);
984 }
985 else
986 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 AppendToRedobuff((char_u *)"\n");
988 bangredo = FALSE;
989 }
990 /*
991 * Add quotes around the command, for shells that need them.
992 */
993 if (*p_shq != NUL)
994 {
Bram Moolenaar964b3742019-05-24 18:54:09 +0200995 newcmd = alloc(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 if (newcmd == NULL)
997 return;
998 STRCPY(newcmd, p_shq);
999 STRCAT(newcmd, prevcmd);
1000 STRCAT(newcmd, p_shq);
1001 free_newcmd = TRUE;
1002 }
1003 if (addr_count == 0) /* :! */
1004 {
1005 /* echo the command */
1006 msg_start();
1007 msg_putchar(':');
1008 msg_putchar('!');
1009 msg_outtrans(newcmd);
1010 msg_clr_eos();
1011 windgoto(msg_row, msg_col);
1012
1013 do_shell(newcmd, 0);
1014 }
1015 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001016 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 /* Careful: This may recursively call do_bang() again! (because of
1018 * autocommands) */
1019 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001020 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001021 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 if (free_newcmd)
1023 vim_free(newcmd);
1024}
1025
1026/*
1027 * do_filter: filter lines through a command given by the user
1028 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001029 * We mostly use temp files and the call_shell() routine here. This would
1030 * normally be done using pipes on a UNIX machine, but this is more portable
1031 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 * to deal with redirection somehow, and should handle things like looking
1033 * at the PATH env. variable, and adding reasonable extensions to the
1034 * command name given by the user. All reasonable versions of call_shell()
1035 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001036 * Alternatively, if on Unix and redirecting input or output, but not both,
1037 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 * We use input redirection if do_in is TRUE.
1039 * We use output redirection if do_out is TRUE.
1040 */
1041 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001042do_filter(
1043 linenr_T line1,
1044 linenr_T line2,
1045 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1046 char_u *cmd,
1047 int do_in,
1048 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049{
1050 char_u *itmp = NULL;
1051 char_u *otmp = NULL;
1052 linenr_T linecount;
1053 linenr_T read_linecount;
1054 pos_T cursor_save;
1055 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001057 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058
1059 if (*cmd == NUL) /* no filter command */
1060 return;
1061
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 cursor_save = curwin->w_cursor;
1063 linecount = line2 - line1 + 1;
1064 curwin->w_cursor.lnum = line1;
1065 curwin->w_cursor.col = 0;
1066 changed_line_abv_curs();
1067 invalidate_botline();
1068
1069 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001070 * When using temp files:
1071 * 1. * Form temp file names
1072 * 2. * Write the lines to a temp file
1073 * 3. Run the filter command on the temp file
1074 * 4. * Read the output of the command into the buffer
1075 * 5. * Delete the original lines to be filtered
1076 * 6. * Remove the temp files
1077 *
1078 * When writing the input with a pipe or when catching the output with a
1079 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 */
1081
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001082 if (do_out)
1083 shell_flags |= SHELL_DOOUT;
1084
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001085#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001086 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001088 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1089 shell_flags |= SHELL_READ;
1090 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001092 else if (do_in && !do_out && !p_stmp)
1093 {
1094 /* Use a pipe to write stdin of the command, do not use a temp file. */
1095 shell_flags |= SHELL_WRITE;
1096 curbuf->b_op_start.lnum = line1;
1097 curbuf->b_op_end.lnum = line2;
1098 }
1099 else if (do_in && do_out && !p_stmp)
1100 {
1101 /* Use a pipe to write stdin and fetch stdout of the command, do not
1102 * use a temp file. */
1103 shell_flags |= SHELL_READ|SHELL_WRITE;
1104 curbuf->b_op_start.lnum = line1;
1105 curbuf->b_op_end.lnum = line2;
1106 curwin->w_cursor.lnum = line2;
1107 }
1108 else
1109#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001110 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1111 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001112 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001113 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001114 goto filterend;
1115 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
1117/*
1118 * The writing and reading of temp files will not be shown.
1119 * Vi also doesn't do this and the messages are not very informative.
1120 */
1121 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001122 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 FALSE, FALSE, FALSE, TRUE) == FAIL)
1124 {
1125 msg_putchar('\n'); /* keep message from buf_write() */
1126 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001127#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 if (!aborting())
1129#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001130 (void)semsg(_(e_notcreate), itmp); /* will call wait_return */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 goto filterend;
1132 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 if (curbuf != old_curbuf)
1134 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
1136 if (!do_out)
1137 msg_putchar('\n');
1138
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001139 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1141 if (cmd_buf == NULL)
1142 goto filterend;
1143
1144 windgoto((int)Rows - 1, 0);
1145 cursor_on();
1146
1147 /*
1148 * When not redirecting the output the command can write anything to the
1149 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1150 * stderr output of external command. Clear the screen later.
1151 * If do_in is FALSE, this could be something like ":r !cat", which may
1152 * also mess up the screen, clear it later.
1153 */
1154 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1155 redraw_later_clear();
1156
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001157 if (do_out)
1158 {
1159 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001160 {
1161 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001162 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001163 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001164 redraw_curbuf_later(VALID);
1165 }
1166 read_linecount = curbuf->b_ml.ml_line_count;
1167
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 /*
1169 * When call_shell() fails wait_return() is called to give the user a
1170 * chance to read the error messages. Otherwise errors are ignored, so you
1171 * can see the error messages from the command that appear on stdout; use
1172 * 'u' to fix the text
1173 * Switch to cooked mode when not redirecting stdin, avoids that something
1174 * like ":r !cat" hangs.
1175 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1176 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001177 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 {
1179 redraw_later_clear();
1180 wait_return(FALSE);
1181 }
1182 vim_free(cmd_buf);
1183
1184 did_check_timestamps = FALSE;
1185 need_check_timestamps = TRUE;
1186
1187 /* When interrupting the shell command, it may still have produced some
1188 * useful output. Reset got_int here, so that readfile() won't cancel
1189 * reading. */
1190 ui_breakcheck();
1191 got_int = FALSE;
1192
1193 if (do_out)
1194 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001195 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001197 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001198 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001200#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001201 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001203 {
1204 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001205 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001206 }
1207 goto error;
1208 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001209 if (curbuf != old_curbuf)
1210 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001211 }
1212
1213 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1214
1215 if (shell_flags & SHELL_READ)
1216 {
1217 curbuf->b_op_start.lnum = line2 + 1;
1218 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1219 appended_lines_mark(line2, read_linecount);
1220 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221
1222 if (do_in)
1223 {
1224 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1225 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 if (read_linecount >= linecount)
1227 /* move all marks from old lines to new lines */
1228 mark_adjust(line1, line2, linecount, 0L);
1229 else
1230 {
1231 /* move marks from old lines to new lines, delete marks
1232 * that are in deleted lines */
1233 mark_adjust(line1, line1 + read_linecount - 1,
1234 linecount, 0L);
1235 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1236 }
1237 }
1238
1239 /*
1240 * Put cursor on first filtered line for ":range!cmd".
1241 * Adjust '[ and '] (set by buf_write()).
1242 */
1243 curwin->w_cursor.lnum = line1;
1244 del_lines(linecount, TRUE);
1245 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1246 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1247 write_lnum_adjust(-linecount); /* adjust last line
1248 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001249#ifdef FEAT_FOLDING
1250 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1251#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 }
1253 else
1254 {
1255 /*
1256 * Put cursor on last new line for ":r !cmd".
1257 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001259 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001261
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1263 --no_wait_return;
1264
1265 if (linecount > p_report)
1266 {
1267 if (do_in)
1268 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001269 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001270 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01001273 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 }
1275 else
1276 msgmore((long)linecount);
1277 }
1278 }
1279 else
1280 {
1281error:
1282 /* put cursor back in same position for ":w !cmd" */
1283 curwin->w_cursor = cursor_save;
1284 --no_wait_return;
1285 wait_return(FALSE);
1286 }
1287
1288filterend:
1289
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 if (curbuf != old_curbuf)
1291 {
1292 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001293 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 if (itmp != NULL)
1296 mch_remove(itmp);
1297 if (otmp != NULL)
1298 mch_remove(otmp);
1299 vim_free(itmp);
1300 vim_free(otmp);
1301}
1302
1303/*
1304 * Call a shell to execute a command.
1305 * When "cmd" is NULL start an interactive shell.
1306 */
1307 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001308do_shell(
1309 char_u *cmd,
1310 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311{
1312 buf_T *buf;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001313#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 int save_nwr;
1315#endif
1316#ifdef MSWIN
1317 int winstart = FALSE;
Bram Moolenaar049ca592019-03-17 16:59:44 +01001318 int keep_termcap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319#endif
1320
1321 /*
1322 * Disallow shell commands for "rvim".
1323 * Disallow shell commands from .exrc and .vimrc in current directory for
1324 * security reasons.
1325 */
1326 if (check_restricted() || check_secure())
1327 {
1328 msg_end();
1329 return;
1330 }
1331
1332#ifdef MSWIN
1333 /*
Bram Moolenaar049ca592019-03-17 16:59:44 +01001334 * Check if ":!start" is used. This implies not stopping termcap mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 */
1336 if (cmd != NULL)
Bram Moolenaar049ca592019-03-17 16:59:44 +01001337 keep_termcap = winstart = (STRNICMP(cmd, "start ", 6) == 0);
1338
1339# if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
1340 // Don't stop termcap mode when using a terminal window for the shell.
1341 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
1342 keep_termcap = TRUE;
1343# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344#endif
1345
1346 /*
1347 * For autocommands we want to get the output on the current screen, to
1348 * avoid having to type return below.
1349 */
Bram Moolenaar049ca592019-03-17 16:59:44 +01001350 msg_putchar('\r'); // put cursor at start of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 {
1353#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001354 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355#endif
1356 stoptermcap();
1357 }
1358#ifdef MSWIN
1359 if (!winstart)
1360#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001361 msg_putchar('\n'); // may shift screen one line up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
Bram Moolenaar049ca592019-03-17 16:59:44 +01001363 // warning message before calling the shell
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001364 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001365 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001366 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 {
1368#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001369 if (!keep_termcap)
1370 starttermcap(); // don't want a message box here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001372 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001374 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375 stoptermcap();
1376#endif
1377 break;
1378 }
1379
Bram Moolenaar049ca592019-03-17 16:59:44 +01001380 // This windgoto is required for when the '\n' resulted in a "delete line
1381 // 1" command to the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 if (!swapping_screen())
1383 windgoto(msg_row, msg_col);
1384 cursor_on();
1385 (void)call_shell(cmd, SHELL_COOKED | flags);
1386 did_check_timestamps = FALSE;
1387 need_check_timestamps = TRUE;
1388
1389 /*
1390 * put the message cursor at the end of the screen, avoids wait_return()
1391 * to overwrite the text that the external command showed
1392 */
1393 if (!swapping_screen())
1394 {
1395 msg_row = Rows - 1;
1396 msg_col = 0;
1397 }
1398
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 if (autocmd_busy)
1400 {
1401 if (msg_silent == 0)
1402 redraw_later_clear();
1403 }
1404 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 {
1406 /*
1407 * For ":sh" there is no need to call wait_return(), just redraw.
1408 * Also for the Win32 GUI (the output is in a console window).
1409 * Otherwise there is probably text on the screen that the user wants
1410 * to read before redrawing, so call wait_return().
1411 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001412#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
1413# ifdef VIMDLL
1414 if (!gui.in_use)
1415# endif
1416 {
1417 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001418# ifdef MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001419 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001421 )
1422 {
1423 if (msg_silent == 0)
1424 redraw_later_clear();
1425 need_wait_return = FALSE;
1426 }
1427 else
1428 {
1429 /*
1430 * If we switch screens when starttermcap() is called, we
1431 * really want to wait for "hit return to continue".
1432 */
1433 save_nwr = no_wait_return;
1434 if (swapping_screen())
1435 no_wait_return = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436# ifdef AMIGA
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001437 wait_return(term_console ? -1 : msg_silent == 0); // see below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438# else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001439 wait_return(msg_silent == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001441 no_wait_return = save_nwr;
1442 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 }
Bram Moolenaar4f974752019-02-17 17:44:42 +01001444#endif /* FEAT_GUI_MSWIN */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445
1446#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001447 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001449 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450
1451 /*
1452 * In an Amiga window redrawing is caused by asking the window size.
1453 * If we got an interrupt this will not work. The chance that the
1454 * window size is wrong is very small, but we need to redraw the
1455 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1456 * but it saves an extra redraw.
1457 */
1458#ifdef AMIGA
1459 if (skip_redraw) /* ':' hit in wait_return() */
1460 {
1461 if (msg_silent == 0)
1462 redraw_later_clear();
1463 }
1464 else if (term_console)
1465 {
1466 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1467 if (got_int && msg_silent == 0)
1468 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1469 else
1470 must_redraw = 0; /* no extra redraw needed */
1471 }
1472#endif
1473 }
1474
1475 /* display any error messages now */
1476 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001477
Bram Moolenaarade00832006-03-10 21:46:58 +00001478 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479}
1480
Bram Moolenaar06640892018-10-09 21:49:33 +02001481#if !defined(UNIX)
1482 static char_u *
1483find_pipe(char_u *cmd)
1484{
1485 char_u *p;
1486 int inquote = FALSE;
1487
1488 for (p = cmd; *p != NUL; ++p)
1489 {
1490 if (!inquote && *p == '|')
1491 return p;
1492 if (*p == '"')
1493 inquote = !inquote;
1494 else if (rem_backslash(p))
1495 ++p;
1496 }
1497 return NULL;
1498}
1499#endif
1500
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501/*
1502 * Create a shell command from a command string, input redirection file and
1503 * output redirection file.
1504 * Returns an allocated string with the shell command, or NULL for failure.
1505 */
1506 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001507make_filter_cmd(
1508 char_u *cmd, /* command */
1509 char_u *itmp, /* NULL or name of input file */
1510 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511{
1512 char_u *buf;
1513 long_u len;
1514
Bram Moolenaar53076832015-12-31 19:53:21 +01001515#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001516 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001517 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001518
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001519 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001520 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1521 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001522 if (is_fish_shell)
1523 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1524 else
1525#endif
1526 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 if (itmp != NULL)
1528 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1529 if (otmp != NULL)
1530 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02001531 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 if (buf == NULL)
1533 return NULL;
1534
Bram Moolenaar53076832015-12-31 19:53:21 +01001535#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001537 * Put braces around the command (for concatenated commands) when
1538 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001540 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001541 {
1542 if (is_fish_shell)
1543 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1544 else
1545 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1546 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001547 else
1548 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 if (itmp != NULL)
1550 {
1551 STRCAT(buf, " < ");
1552 STRCAT(buf, itmp);
1553 }
1554#else
Bram Moolenaar1a613392019-09-28 15:51:37 +02001555 // For shells that don't understand braces around commands, at least allow
1556 // the use of commands in a pipe.
1557 if (*p_sxe != NUL && *p_sxq == '(')
1558 {
1559 if (itmp != NULL || otmp != NULL)
1560 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1561 else
1562 STRCPY(buf, cmd);
1563 if (itmp != NULL)
1564 {
1565 STRCAT(buf, " < ");
1566 STRCAT(buf, itmp);
1567 }
1568 }
1569 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 {
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001571 STRCPY(buf, cmd);
1572 if (itmp != NULL)
1573 {
1574 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001576 // If there is a pipe, we have to put the '<' in front of it.
1577 // Don't do this when 'shellquote' is not empty, otherwise the
1578 // redirection would be inside the quotes.
1579 if (*p_shq == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 {
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001581 p = find_pipe(buf);
1582 if (p != NULL)
1583 *p = NUL;
1584 }
1585 STRCAT(buf, " <"); // " < " causes problems on Amiga
1586 STRCAT(buf, itmp);
1587 if (*p_shq == NUL)
1588 {
1589 p = find_pipe(cmd);
1590 if (p != NULL)
1591 {
1592 STRCAT(buf, " "); // insert a space before the '|' for DOS
1593 STRCAT(buf, p);
1594 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 }
1596 }
1597 }
1598#endif
1599 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001600 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601
1602 return buf;
1603}
1604
1605/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001606 * Append output redirection for file "fname" to the end of string buffer
1607 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 * Works with the 'shellredir' and 'shellpipe' options.
1609 * The caller should make sure that there is enough room:
1610 * STRLEN(opt) + STRLEN(fname) + 3
1611 */
1612 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001613append_redir(
1614 char_u *buf,
1615 int buflen,
1616 char_u *opt,
1617 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618{
1619 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001620 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001622 end = buf + STRLEN(buf);
Bram Moolenaar1a613392019-09-28 15:51:37 +02001623 // find "%s"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001625 {
Bram Moolenaar1a613392019-09-28 15:51:37 +02001626 if (p[1] == 's') // found %s
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 break;
Bram Moolenaar1a613392019-09-28 15:51:37 +02001628 if (p[1] == '%') // skip %%
Bram Moolenaar542805a2013-08-02 14:15:13 +02001629 ++p;
1630 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 if (p != NULL)
1632 {
Bram Moolenaar1a613392019-09-28 15:51:37 +02001633#ifdef MSWIN
1634 *end++ = ' '; // not really needed? Not with sh, ksh or bash
1635#endif
1636 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001637 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 }
1639 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001640 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642 " %s %s",
1643#else
Bram Moolenaar1a613392019-09-28 15:51:37 +02001644 " %s%s", // " > %s" causes problems on Amiga
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645#endif
1646 (char *)opt, (char *)fname);
1647}
1648
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001649/*
1650 * Return the current time in seconds. Calls time(), unless test_settime()
1651 * was used.
1652 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02001653 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001654vim_time(void)
1655{
1656# ifdef FEAT_EVAL
1657 return time_for_testing == 0 ? time(NULL) : time_for_testing;
1658# else
1659 return time(NULL);
1660# endif
1661}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001662
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663/*
1664 * Implementation of ":fixdel", also used by get_stty().
1665 * <BS> resulting <Del>
1666 * ^? ^H
1667 * not ^? ^?
1668 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001670do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671{
1672 char_u *p;
1673
1674 p = find_termcode((char_u *)"kb");
1675 add_termcode((char_u *)"kD", p != NULL
1676 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
1677}
1678
1679 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001680print_line_no_prefix(
1681 linenr_T lnum,
1682 int use_number,
1683 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001685 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686
1687 if (curwin->w_p_nu || use_number)
1688 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001689 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001690 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01001691 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001693 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694}
1695
1696/*
1697 * Print a text line. Also in silent mode ("ex -s").
1698 */
1699 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001700print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701{
1702 int save_silent = silent_mode;
1703
Bram Moolenaard29459b2016-08-26 22:29:11 +02001704 /* apply :filter /pat/ */
1705 if (message_filtered(ml_get(lnum)))
1706 return;
1707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001709 silent_mode = FALSE;
1710 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
1711 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 if (save_silent)
1713 {
1714 msg_putchar('\n');
1715 cursor_on(); /* msg_start() switches it off */
1716 out_flush();
1717 silent_mode = save_silent;
1718 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00001719 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720}
1721
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001722 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001723rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001724{
1725 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02001726 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001727
Bram Moolenaar7e283842013-05-30 11:43:15 +02001728 buf = curbuf;
1729 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001730 /* buffer changed, don't change name now */
1731 if (buf != curbuf)
1732 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001733#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001734 if (aborting()) /* autocmds may abort script processing */
1735 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001736#endif
1737 /*
1738 * The name of the current buffer will be changed.
1739 * A new (unlisted) buffer entry needs to be made to hold the old file
1740 * name, which will become the alternate file name.
1741 * But don't set the alternate file name if the buffer didn't have a
1742 * name.
1743 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02001744 fname = curbuf->b_ffname;
1745 sfname = curbuf->b_sfname;
1746 xfname = curbuf->b_fname;
1747 curbuf->b_ffname = NULL;
1748 curbuf->b_sfname = NULL;
1749 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001750 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02001751 curbuf->b_ffname = fname;
1752 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001753 return FAIL;
1754 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02001755 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001756 if (xfname != NULL && *xfname != NUL)
1757 {
1758 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
1759 if (buf != NULL && !cmdmod.keepalt)
1760 curwin->w_alt_fnum = buf->b_fnum;
1761 }
1762 vim_free(fname);
1763 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02001764 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001765
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001766 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02001767 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001768 return OK;
1769}
1770
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771/*
1772 * ":file[!] [fname]".
1773 */
1774 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001775ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001777 /* ":0file" removes the file name. Check for illegal uses ":3file",
1778 * "0file name", etc. */
1779 if (eap->addr_count > 0
1780 && (*eap->arg != NUL
1781 || eap->line2 > 0
1782 || eap->addr_count > 1))
1783 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001784 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001785 return;
1786 }
1787
1788 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001790 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02001792 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02001794
1795 // print file name if no argument or 'F' is not in 'shortmess'
1796 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01001797 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798}
1799
1800/*
1801 * ":update".
1802 */
1803 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001804ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805{
1806 if (curbufIsChanged())
1807 (void)do_write(eap);
1808}
1809
1810/*
1811 * ":write" and ":saveas".
1812 */
1813 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001814ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815{
Bram Moolenaarb7316892019-05-01 18:08:42 +02001816 if (eap->cmdidx == CMD_saveas)
1817 {
1818 // :saveas does not take a range, uses all lines.
1819 eap->line1 = 1;
1820 eap->line2 = curbuf->b_ml.ml_line_count;
1821 }
1822
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 if (eap->usefilter) /* input lines to shell command */
1824 do_bang(1, eap, FALSE, TRUE, FALSE);
1825 else
1826 (void)do_write(eap);
1827}
1828
1829/*
1830 * write current buffer to file 'eap->arg'
1831 * if 'eap->append' is TRUE, append to the file
1832 *
1833 * if *eap->arg == NUL write to current file
1834 *
1835 * return FAIL for failure, OK otherwise
1836 */
1837 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001838do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839{
1840 int other;
1841 char_u *fname = NULL; /* init to shut up gcc */
1842 char_u *ffname;
1843 int retval = FAIL;
1844 char_u *free_fname = NULL;
1845#ifdef FEAT_BROWSE
1846 char_u *browse_file = NULL;
1847#endif
1848 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02001849 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850
1851 if (not_writing()) /* check 'write' option */
1852 return FAIL;
1853
1854 ffname = eap->arg;
1855#ifdef FEAT_BROWSE
Bram Moolenaar5c381eb2019-06-25 06:50:31 +02001856 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001858 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 NULL, NULL, NULL, curbuf);
1860 if (browse_file == NULL)
1861 goto theend;
1862 ffname = browse_file;
1863 }
1864#endif
1865 if (*ffname == NUL)
1866 {
1867 if (eap->cmdidx == CMD_saveas)
1868 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001869 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 goto theend;
1871 }
1872 other = FALSE;
1873 }
1874 else
1875 {
1876 fname = ffname;
1877 free_fname = fix_fname(ffname);
1878 /*
1879 * When out-of-memory, keep unexpanded file name, because we MUST be
1880 * able to write the file in this situation.
1881 */
1882 if (free_fname != NULL)
1883 ffname = free_fname;
1884 other = otherfile(ffname);
1885 }
1886
1887 /*
1888 * If we have a new file, put its name in the list of alternate file names.
1889 */
1890 if (other)
1891 {
1892 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
1893 || eap->cmdidx == CMD_saveas)
1894 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
1895 else
1896 alt_buf = buflist_findname(ffname);
1897 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
1898 {
1899 /* Overwriting a file that is loaded in another buffer is not a
1900 * good idea. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001901 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 goto theend;
1903 }
1904 }
1905
1906 /*
1907 * Writing to the current file is not allowed in readonly mode
1908 * and a file name is required.
1909 * "nofile" and "nowrite" buffers cannot be written implicitly either.
1910 */
1911 if (!other && (
1912#ifdef FEAT_QUICKFIX
1913 bt_dontwrite_msg(curbuf) ||
1914#endif
1915 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
1916 goto theend;
1917
1918 if (!other)
1919 {
1920 ffname = curbuf->b_ffname;
1921 fname = curbuf->b_fname;
1922 /*
1923 * Not writing the whole file is only allowed with '!'.
1924 */
1925 if ( (eap->line1 != 1
1926 || eap->line2 != curbuf->b_ml.ml_line_count)
1927 && !eap->forceit
1928 && !eap->append
1929 && !p_wa)
1930 {
1931#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1932 if (p_confirm || cmdmod.confirm)
1933 {
1934 if (vim_dialog_yesno(VIM_QUESTION, NULL,
1935 (char_u *)_("Write partial file?"), 2) != VIM_YES)
1936 goto theend;
1937 eap->forceit = TRUE;
1938 }
1939 else
1940#endif
1941 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001942 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 goto theend;
1944 }
1945 }
1946 }
1947
1948 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
1949 {
1950 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
1951 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 buf_T *was_curbuf = curbuf;
1953
1954 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00001955 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001956#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001958#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001960#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 {
1962 /* buffer changed, don't change name now */
1963 retval = FAIL;
1964 goto theend;
1965 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 /* Exchange the file names for the current and the alternate
1967 * buffer. This makes it look like we are now editing the buffer
1968 * under the new name. Must be done before buf_write(), because
1969 * if there is no file name and 'cpo' contains 'F', it will set
1970 * the file name. */
1971 fname = alt_buf->b_fname;
1972 alt_buf->b_fname = curbuf->b_fname;
1973 curbuf->b_fname = fname;
1974 fname = alt_buf->b_ffname;
1975 alt_buf->b_ffname = curbuf->b_ffname;
1976 curbuf->b_ffname = fname;
1977 fname = alt_buf->b_sfname;
1978 alt_buf->b_sfname = curbuf->b_sfname;
1979 curbuf->b_sfname = fname;
1980 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001981
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00001983 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 if (!alt_buf->b_p_bl)
1985 {
1986 alt_buf->b_p_bl = TRUE;
1987 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
1988 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001989#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001991#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001993#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 {
1995 /* buffer changed, don't write the file */
1996 retval = FAIL;
1997 goto theend;
1998 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001999
2000 /* If 'filetype' was empty try detecting it now. */
2001 if (*curbuf->b_p_ft == NUL)
2002 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002003 if (au_has_group((char_u *)"filetypedetect"))
2004 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02002005 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002006 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002007 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002008
2009 /* Autocommands may have changed buffer names, esp. when
2010 * 'autochdir' is set. */
2011 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 }
2013
Bram Moolenaar5c719942016-07-09 23:40:45 +02002014 name_was_missing = curbuf->b_ffname == NULL;
2015
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2017 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002018
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002019 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002020 if (eap->cmdidx == CMD_saveas)
2021 {
2022 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002023 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002024 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002025 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002026 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02002027 }
2028
2029 /* Change directories when the 'acd' option is set and the file name
2030 * got changed or set. */
2031 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02002032 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 }
2034
2035theend:
2036#ifdef FEAT_BROWSE
2037 vim_free(browse_file);
2038#endif
2039 vim_free(free_fname);
2040 return retval;
2041}
2042
2043/*
2044 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2045 * BF_NEW or BF_READERR, check for overwriting current file.
2046 * May set eap->forceit if a dialog says it's OK to overwrite.
2047 * Return OK if it's OK, FAIL if it is not.
2048 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002049 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002050check_overwrite(
2051 exarg_T *eap,
2052 buf_T *buf,
2053 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002055 char_u *ffname, /* full path version of fname */
2056 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057{
2058 /*
2059 * write to other file or b_flags set or not writing the whole file:
2060 * overwriting only allowed with '!'
2061 */
2062 if ( (other
2063 || (buf->b_flags & BF_NOTEDITED)
2064 || ((buf->b_flags & BF_NEW)
2065 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2066 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002068#ifdef FEAT_QUICKFIX
Bram Moolenaar26910de2019-06-15 19:37:15 +02002069 && !bt_nofilename(buf)
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002070#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 && vim_fexists(ffname))
2072 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002073 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002075#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002076 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002077 if (mch_isdir(ffname))
2078 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002079 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002080 return FAIL;
2081 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082#endif
2083#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002084 if (p_confirm || cmdmod.confirm)
2085 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002086 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002088 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2089 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2090 return FAIL;
2091 eap->forceit = TRUE;
2092 }
2093 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002095 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002096 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002097 return FAIL;
2098 }
2099 }
2100
2101 /* For ":w! filename" check that no swap file exists for "filename". */
2102 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002104 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002105 char_u *p;
2106 int r;
2107 char_u *swapname;
2108
2109 /* We only try the first entry in 'directory', without checking if
2110 * it's writable. If the "." directory is not writable the write
2111 * will probably fail anyway.
2112 * Use 'shortname' of the current buffer, since there is no buffer
2113 * for the written file. */
2114 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002115 {
2116 dir = alloc(5);
2117 if (dir == NULL)
2118 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002119 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002120 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002121 else
2122 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002123 dir = alloc(MAXPATHL);
2124 if (dir == NULL)
2125 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002126 p = p_dir;
2127 copy_option_part(&p, dir, MAXPATHL, ",");
2128 }
2129 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002130 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002131 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002132 if (r)
2133 {
2134#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2135 if (p_confirm || cmdmod.confirm)
2136 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002137 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002138
2139 dialog_msg(buff,
2140 _("Swap file \"%s\" exists, overwrite anyway?"),
2141 swapname);
2142 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2143 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002144 {
2145 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002146 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002147 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002148 eap->forceit = TRUE;
2149 }
2150 else
2151#endif
2152 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002153 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002154 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002155 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002156 return FAIL;
2157 }
2158 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002159 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 }
2161 }
2162 return OK;
2163}
2164
2165/*
2166 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2167 */
2168 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002169ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170{
2171 int i;
2172
2173 if (eap->cmd[1] == 'n')
2174 i = curwin->w_arg_idx + (int)eap->line2;
2175 else
2176 i = curwin->w_arg_idx - (int)eap->line2;
2177 eap->line1 = 1;
2178 eap->line2 = curbuf->b_ml.ml_line_count;
2179 if (do_write(eap) != FAIL)
2180 do_argfile(eap, i);
2181}
2182
2183/*
2184 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2185 */
2186 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002187do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188{
2189 buf_T *buf;
2190 int error = 0;
2191 int save_forceit = eap->forceit;
2192
2193 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2194 exiting = TRUE;
2195
Bram Moolenaar29323592016-07-24 22:04:11 +02002196 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01002198#ifdef FEAT_TERMINAL
2199 if (exiting && term_job_running(buf->b_term))
2200 {
2201 no_write_message_nobang(buf);
2202 ++error;
2203 }
2204 else
2205#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02002206 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 {
2208 /*
2209 * Check if there is a reason the buffer cannot be written:
2210 * 1. if the 'write' option is set
2211 * 2. if there is no file name (even after browsing)
2212 * 3. if the 'readonly' is set (even after a dialog)
2213 * 4. if overwriting is allowed (even after a dialog)
2214 */
2215 if (not_writing())
2216 {
2217 ++error;
2218 break;
2219 }
2220#ifdef FEAT_BROWSE
2221 /* ":browse wall": ask for file name if there isn't one */
2222 if (buf->b_ffname == NULL && cmdmod.browse)
2223 browse_save_fname(buf);
2224#endif
2225 if (buf->b_ffname == NULL)
2226 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002227 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 ++error;
2229 }
2230 else if (check_readonly(&eap->forceit, buf)
2231 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2232 FALSE) == FAIL)
2233 {
2234 ++error;
2235 }
2236 else
2237 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002238 bufref_T bufref;
2239
2240 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 if (buf_write_all(buf, eap->forceit) == FAIL)
2242 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002244 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 }
2247 eap->forceit = save_forceit; /* check_overwrite() may set it */
2248 }
2249 }
2250 if (exiting)
2251 {
2252 if (!error)
2253 getout(0); /* exit Vim */
2254 not_exiting();
2255 }
2256}
2257
2258/*
2259 * Check the 'write' option.
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002260 * Return TRUE and give a message when it's not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02002262 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002263not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264{
2265 if (p_write)
2266 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002267 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 return TRUE;
2269}
2270
2271/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002272 * Check if a buffer is read-only (either 'readonly' option is set or file is
2273 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2274 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 */
2276 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002277check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002279 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00002280
2281 /* Handle a file being readonly when the 'readonly' option is set or when
2282 * the file exists and permissions are read-only.
2283 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2284 * important for device checks but not here. */
2285 if (!*forceit && (buf->b_p_ro
2286 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2287 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 {
2289#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2290 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2291 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002292 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293
Bram Moolenaar5386a122007-06-28 20:02:32 +00002294 if (buf->b_p_ro)
2295 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2296 buf->b_fname);
2297 else
2298 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 +00002299 buf->b_fname);
2300
2301 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2302 {
2303 /* Set forceit, to force the writing of a readonly file */
2304 *forceit = TRUE;
2305 return FALSE;
2306 }
2307 else
2308 return TRUE;
2309 }
2310 else
2311#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002312 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002313 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002314 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002315 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00002316 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 return TRUE;
2318 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002319
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 return FALSE;
2321}
2322
2323/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002324 * Try to abandon the current file and edit a new or existing file.
2325 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002326 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002328 * Return:
2329 * GETFILE_ERROR for "normal" error,
2330 * GETFILE_NOT_WRITTEN for "not written" error,
2331 * GETFILE_SAME_FILE for success
2332 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 */
2334 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002335getfile(
2336 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002337 char_u *ffname_arg,
2338 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002339 int setpm,
2340 linenr_T lnum,
2341 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002343 char_u *ffname = ffname_arg;
2344 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 int other;
2346 int retval;
2347 char_u *free_me = NULL;
2348
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002349 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002350 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002351 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002352 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353
2354 if (fnum == 0)
2355 {
2356 /* make ffname full path, set sfname */
2357 fname_expand(curbuf, &ffname, &sfname);
2358 other = otherfile(ffname);
2359 free_me = ffname; /* has been allocated, free() later */
2360 }
2361 else
2362 other = (fnum != curbuf->b_fnum);
2363
2364 if (other)
2365 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002366 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
2368 {
2369#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2370 if (p_confirm && p_write)
2371 dialog_changed(curbuf, FALSE);
2372 if (curbufIsChanged())
2373#endif
2374 {
2375 if (other)
2376 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002377 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002378 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 goto theend;
2380 }
2381 }
2382 if (other)
2383 --no_wait_return;
2384 if (setpm)
2385 setpcmark();
2386 if (!other)
2387 {
2388 if (lnum != 0)
2389 curwin->w_cursor.lnum = lnum;
2390 check_cursor_lnum();
2391 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002392 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 }
2394 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002395 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002396 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002397 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002399 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400
2401theend:
2402 vim_free(free_me);
2403 return retval;
2404}
2405
2406/*
2407 * start editing a new file
2408 *
2409 * fnum: file number; if zero use ffname/sfname
2410 * ffname: the file name
2411 * - full path if sfname used,
2412 * - any file name if sfname is NULL
2413 * - empty string to re-edit with the same file name (but may be
2414 * in a different directory)
2415 * - NULL to start an empty buffer
2416 * sfname: the short file name (or NULL)
2417 * eap: contains the command to be executed after loading the file and
2418 * forced 'ff' and 'fenc'
2419 * newlnum: if > 0: put cursor on this line number (if possible)
2420 * if ECMD_LASTL: use last position in loaded file
2421 * if ECMD_LAST: use last position in all files
2422 * if ECMD_ONE: use first line
2423 * flags:
2424 * ECMD_HIDE: if TRUE don't free the current buffer
2425 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
2426 * ECMD_OLDBUF: use existing buffer if it exists
2427 * ECMD_FORCEIT: ! used for Ex command
2428 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002429 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02002430 * window, NULL when splitting the window first. When not NULL info
2431 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 *
2433 * return FAIL for failure, OK otherwise
2434 */
2435 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002436do_ecmd(
2437 int fnum,
2438 char_u *ffname,
2439 char_u *sfname,
2440 exarg_T *eap, /* can be NULL! */
2441 linenr_T newlnum,
2442 int flags,
2443 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444{
2445 int other_file; /* TRUE if editing another file */
2446 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 int auto_buf = FALSE; /* TRUE if autocommands brought us
2448 into the buffer unexpectedly */
2449 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002450#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002451 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452#endif
2453 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002454 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002455 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 char_u *free_fname = NULL;
2457#ifdef FEAT_BROWSE
2458 char_u *browse_file = NULL;
2459#endif
2460 int retval = FAIL;
2461 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01002462 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 linenr_T topline = 0;
2464 int newcol = -1;
2465 int solcol = -1;
2466 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002468#ifdef FEAT_SPELL
2469 int did_get_winopts = FALSE;
2470#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002471 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002472 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01002473 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474
2475 if (eap != NULL)
2476 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002477 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478
2479 if (fnum != 0)
2480 {
2481 if (fnum == curbuf->b_fnum) /* file is already being edited */
2482 return OK; /* nothing to do */
2483 other_file = TRUE;
2484 }
2485 else
2486 {
2487#ifdef FEAT_BROWSE
Bram Moolenaar2eed9ba2019-06-25 23:40:29 +02002488 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002490 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002491# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002492 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002493# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002494 au_has_group((char_u *)"FileExplorer"))
2495 {
2496 /* No browsing supported but we do have the file explorer:
2497 * Edit the directory. */
2498 if (ffname == NULL || !mch_isdir(ffname))
2499 ffname = (char_u *)".";
2500 }
2501 else
2502 {
2503 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002505 if (browse_file == NULL)
2506 goto theend;
2507 ffname = browse_file;
2508 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 }
2510#endif
2511 /* if no short name given, use ffname for short name */
2512 if (sfname == NULL)
2513 sfname = ffname;
2514#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01002515 if (sfname != NULL)
2516 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517#endif
2518
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
2520 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521
2522 if (ffname == NULL)
2523 other_file = TRUE;
2524 /* there is no file name */
2525 else if (*ffname == NUL && curbuf->b_ffname == NULL)
2526 other_file = FALSE;
2527 else
2528 {
2529 if (*ffname == NUL) /* re-edit with same file name */
2530 {
2531 ffname = curbuf->b_ffname;
2532 sfname = curbuf->b_fname;
2533 }
2534 free_fname = fix_fname(ffname); /* may expand to full path name */
2535 if (free_fname != NULL)
2536 ffname = free_fname;
2537 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 }
2539 }
2540
2541 /*
2542 * if the file was changed we may not be allowed to abandon it
2543 * - if we are going to re-edit the same file
2544 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
2545 */
2546 if ( ((!other_file && !(flags & ECMD_OLDBUF))
2547 || (curbuf->b_nwindows == 1
2548 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002549 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
2550 | (other_file ? 0 : CCGD_MULTWIN)
2551 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
2552 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 {
2554 if (fnum == 0 && other_file && ffname != NULL)
2555 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
2556 goto theend;
2557 }
2558
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 /*
2560 * End Visual mode before switching to another buffer, so the text can be
2561 * copied into the GUI selection buffer.
2562 */
2563 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002565#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002566 if ((command != NULL || newlnum > (linenr_T)0)
2567 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
2568 {
2569 int len;
2570 char_u *p;
2571
2572 /* Set v:swapcommand for the SwapExists autocommands. */
2573 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002574 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002575 else
2576 len = 30;
Bram Moolenaar964b3742019-05-24 18:54:09 +02002577 p = alloc(len);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002578 if (p != NULL)
2579 {
2580 if (command != NULL)
2581 vim_snprintf((char *)p, len, ":%s\r", command);
2582 else
2583 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
2584 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
2585 did_set_swapcommand = TRUE;
2586 vim_free(p);
2587 }
2588 }
2589#endif
2590
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 /*
2592 * If we are starting to edit another file, open a (new) buffer.
2593 * Otherwise we re-use the current buffer.
2594 */
2595 if (other_file)
2596 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002599 if (!cmdmod.keepalt)
2600 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002601 if (oldwin != NULL)
2602 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 }
2604
2605 if (fnum)
2606 buf = buflist_findnr(fnum);
2607 else
2608 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 if (flags & ECMD_ADDBUF)
2610 {
2611 linenr_T tlnum = 1L;
2612
2613 if (command != NULL)
2614 {
2615 tlnum = atol((char *)command);
2616 if (tlnum <= 0)
2617 tlnum = 1L;
2618 }
2619 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
2620 goto theend;
2621 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 buf = buflist_new(ffname, sfname, 0L,
2623 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002624
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02002625 /* autocommands may change curwin and curbuf */
2626 if (oldwin != NULL)
2627 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002628 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 }
2630 if (buf == NULL)
2631 goto theend;
2632 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
2633 {
2634 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 }
2636 else /* existing memfile */
2637 {
2638 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002639 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002641 /* Check if autocommands made the buffer invalid or changed the
2642 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002643 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 goto theend;
2645#ifdef FEAT_EVAL
2646 if (aborting()) /* autocmds may abort script processing */
2647 goto theend;
2648#endif
2649 }
2650
2651 /* May jump to last used line number for a loaded buffer or when asked
2652 * for explicitly */
2653 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
2654 {
2655 pos = buflist_findfpos(buf);
2656 newlnum = pos->lnum;
2657 solcol = pos->col;
2658 }
2659
2660 /*
2661 * Make the (new) buffer the one used by the current window.
2662 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
2663 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01002664 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 */
2666 if (buf != curbuf)
2667 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 /*
2669 * Be careful: The autocommands may delete any buffer and change
2670 * the current buffer.
2671 * - If the buffer we are going to edit is deleted, give up.
2672 * - If the current buffer is deleted, prefer to load the new
2673 * buffer when loading a buffer is required. This avoids
2674 * loading another buffer which then must be closed again.
2675 * - If we ended up in the new buffer already, need to skip a few
2676 * things, set auto_buf.
2677 */
2678 if (buf->b_fname != NULL)
2679 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002680 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002682 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002684 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 delbuf_msg(new_name); /* frees new_name */
2686 goto theend;
2687 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002688#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 if (aborting()) /* autocmds may abort script processing */
2690 {
2691 vim_free(new_name);
2692 goto theend;
2693 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002694#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 if (buf == curbuf) /* already in new buffer */
2696 auto_buf = TRUE;
2697 else
2698 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02002699 win_T *the_curwin = curwin;
2700
2701 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002702 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02002703 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002704 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02002705
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002706 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 buf_copy_options(buf, BCO_ENTER);
2708
Bram Moolenaar5a497892016-09-03 16:29:04 +02002709 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02002710 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002711 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002712 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01002713 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714
Bram Moolenaar5a497892016-09-03 16:29:04 +02002715 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002716 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01002717
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002718#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02002719 /* autocmds may abort script processing */
2720 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 {
2722 vim_free(new_name);
2723 goto theend;
2724 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002725#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002727 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002729 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 delbuf_msg(new_name); /* frees new_name */
2731 goto theend;
2732 }
2733 if (buf == curbuf) /* already in new buffer */
2734 auto_buf = TRUE;
2735 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02002737#ifdef FEAT_SYN_HL
2738 /*
2739 * <VN> We could instead free the synblock
2740 * and re-attach to buffer, perhaps.
2741 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02002742 if (curwin->w_buffer == NULL
2743 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02002744 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02002745#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 curwin->w_buffer = buf;
2747 curbuf = buf;
2748 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02002749
2750 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
2751 if (!oldbuf && eap != NULL)
2752 {
2753 set_file_options(TRUE, eap);
2754 set_forced_fenc(eap);
2755 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 }
2757
2758 /* May get the window options from the last time this buffer
2759 * was in this window (or another window). If not used
2760 * before, reset the local window options to the global
2761 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00002762 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002763#ifdef FEAT_SPELL
2764 did_get_winopts = TRUE;
2765#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 }
2767 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002768 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02002769 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771
2772 curwin->w_pcmark.lnum = 1;
2773 curwin->w_pcmark.col = 0;
2774 }
2775 else /* !other_file */
2776 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002777 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01002779
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 oldbuf = (flags & ECMD_OLDBUF);
2781 }
2782
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002783 /* Don't redraw until the cursor is in the right line, otherwise
2784 * autocommands may cause ml_get errors. */
2785 ++RedrawingDisabled;
2786 did_inc_redrawing_disabled = TRUE;
2787
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002788 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 if ((flags & ECMD_SET_HELP) || keep_help_flag)
2790 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002791 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 }
2793 else
2794 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 /* Don't make a buffer listed if it's a help buffer. Useful when
2796 * using CTRL-O to go back to a help file. */
2797 if (!curbuf->b_help)
2798 set_buflisted(TRUE);
2799 }
2800
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 /* If autocommands change buffers under our fingers, forget about
2802 * editing the file. */
2803 if (buf != curbuf)
2804 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002805#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 if (aborting()) /* autocmds may abort script processing */
2807 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002808#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809
2810 /* Since we are starting to edit a file, consider the filetype to be
2811 * unset. Helps for when an autocommand changes files and expects syntax
2812 * highlighting to work in the other file. */
2813 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814
2815/*
2816 * other_file oldbuf
2817 * FALSE FALSE re-edit same file, buffer is re-used
2818 * FALSE TRUE re-edit same file, nothing changes
2819 * TRUE FALSE start editing new file, new buffer
2820 * TRUE TRUE start editing in existing buffer (nothing to do)
2821 */
2822 if (!other_file && !oldbuf) /* re-use the buffer */
2823 {
2824 set_last_cursor(curwin); /* may set b_last_cursor */
2825 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
2826 {
2827 newlnum = curwin->w_cursor.lnum;
2828 solcol = curwin->w_cursor.col;
2829 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 buf = curbuf;
2831 if (buf->b_fname != NULL)
2832 new_name = vim_strsave(buf->b_fname);
2833 else
2834 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002835 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002836
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002837 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
2838 {
2839 /* Save all the text, so that the reload can be undone.
2840 * Sync first so that this is a separate undo-able action. */
2841 u_sync(FALSE);
2842 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
2843 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02002844 {
2845 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002846 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02002847 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002848 u_unchanged(curbuf);
2849 buf_freeall(curbuf, BFA_KEEP_UNDO);
2850
2851 /* tell readfile() not to clear or reload undo info */
2852 readfile_flags = READ_KEEP_UNDO;
2853 }
2854 else
2855 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002856
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 /* If autocommands deleted the buffer we were going to re-edit, give
2858 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002859 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 {
2861 delbuf_msg(new_name); /* frees new_name */
2862 goto theend;
2863 }
2864 vim_free(new_name);
2865
2866 /* If autocommands change buffers under our fingers, forget about
2867 * re-editing the file. Should do the buf_clear_file(), but perhaps
2868 * the autocommands changed the buffer... */
2869 if (buf != curbuf)
2870 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002871#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 if (aborting()) /* autocmds may abort script processing */
2873 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874#endif
2875 buf_clear_file(curbuf);
2876 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
2877 curbuf->b_op_end.lnum = 0;
2878 }
2879
2880/*
2881 * If we get here we are sure to start editing
2882 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 /* Assume success now */
2884 retval = OK;
2885
2886 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 * Check if we are editing the w_arg_idx file in the argument list.
2888 */
2889 check_arg_idx(curwin);
2890
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 {
2893 /*
2894 * Set cursor and init window before reading the file and executing
2895 * autocommands. This allows for the autocommands to position the
2896 * cursor.
2897 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00002898 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899
2900#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00002901 /* It's possible that all lines in the buffer changed. Need to update
2902 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00002903 {
2904 win_T *win;
2905 tabpage_T *tp;
2906
2907 FOR_ALL_TAB_WINDOWS(tp, win)
2908 if (win->w_buffer == curbuf)
2909 foldUpdateAll(win);
2910 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911#endif
2912
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002913 /* Change directories when the 'acd' option is set. */
Bram Moolenaar6f470022018-04-10 18:47:20 +02002914 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002915
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 /*
2917 * Careful: open_buffer() and apply_autocmds() may change the current
2918 * buffer and window.
2919 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01002920 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 topline = curwin->w_topline;
2922 if (!oldbuf) /* need to read the file */
2923 {
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002924#ifdef FEAT_TEXT_PROP
2925 // Don't use the swap-exists dialog for a popup window, can't edit
2926 // the buffer.
2927 if (WIN_IS_POPUP(curwin))
2928 curbuf->b_flags |= BF_NO_SEA;
2929#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 swap_exists_action = SEA_DIALOG;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
2932
2933 /*
2934 * Open the buffer and read the file.
2935 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002936#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002937 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 retval = FAIL;
2939#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002940 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941#endif
2942
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002943#ifdef FEAT_TEXT_PROP
2944 curbuf->b_flags &= ~BF_NO_SEA;
2945#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 if (swap_exists_action == SEA_QUIT)
2947 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002948 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 else
2951 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00002952 /* Read the modelines, but only to set window-local options. Any
2953 * buffer-local options have already been set and may have been
2954 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00002955 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00002956
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
2958 &retval);
2959 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
2960 &retval);
2961 }
2962 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963
Bram Moolenaareab316b2015-03-24 11:46:30 +01002964 /* If autocommands change the cursor position or topline, we should
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02002965 * keep it. Also when it moves within a line. But not when it moves
2966 * to the first non-blank. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01002967 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02002969 char_u *text = ml_get_curline();
2970
2971 if (curwin->w_cursor.lnum != orig_pos.lnum
2972 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
2973 {
2974 newlnum = curwin->w_cursor.lnum;
2975 newcol = curwin->w_cursor.col;
2976 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 }
2978 if (curwin->w_topline == topline)
2979 topline = 0;
2980
2981 /* Even when cursor didn't move we need to recompute topline. */
2982 changed_line_abv_curs();
2983
2984#ifdef FEAT_TITLE
2985 maketitle();
2986#endif
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02002987#ifdef FEAT_TEXT_PROP
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002988 if (WIN_IS_POPUP(curwin) && curwin->w_p_pvw && retval != FAIL)
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02002989 popup_set_title(curwin);
2990#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 }
2992
2993#ifdef FEAT_DIFF
2994 /* Tell the diff stuff that this buffer is new and/or needs updating.
2995 * Also needed when re-editing the same buffer, because unloading will
2996 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002997 if (curwin->w_p_diff)
2998 {
2999 diff_buf_add(curbuf);
3000 diff_invalidate(curbuf);
3001 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002#endif
3003
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003004#ifdef FEAT_SPELL
3005 /* If the window options were changed may need to set the spell language.
3006 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003007 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3008 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003009#endif
3010
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 if (command == NULL)
3012 {
3013 if (newcol >= 0) /* position set by autocommands */
3014 {
3015 curwin->w_cursor.lnum = newlnum;
3016 curwin->w_cursor.col = newcol;
3017 check_cursor();
3018 }
3019 else if (newlnum > 0) /* line number from caller or old position */
3020 {
3021 curwin->w_cursor.lnum = newlnum;
3022 check_cursor_lnum();
3023 if (solcol >= 0 && !p_sol)
3024 {
3025 /* 'sol' is off: Use last known column. */
3026 curwin->w_cursor.col = solcol;
3027 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 curwin->w_set_curswant = TRUE;
3030 }
3031 else
3032 beginline(BL_SOL | BL_FIX);
3033 }
3034 else /* no line number, go to last line in Ex mode */
3035 {
3036 if (exmode_active)
3037 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3038 beginline(BL_WHITE | BL_FIX);
3039 }
3040 }
3041
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 /* Check if cursors in other windows on the same buffer are still valid */
3043 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044
3045 /*
3046 * Did not read the file, need to show some info about the file.
3047 * Do this after setting the cursor.
3048 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003049 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 {
3051 int msg_scroll_save = msg_scroll;
3052
3053 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3054 * message. */
3055 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3056 msg_scroll = FALSE;
3057 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3058 check_for_delay(FALSE);
3059 msg_start();
3060 msg_scroll = msg_scroll_save;
3061 msg_scrolled_ign = TRUE;
3062
Bram Moolenaar426dd022016-03-15 15:09:29 +01003063 if (!shortmess(SHM_FILEINFO))
3064 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065
3066 msg_scrolled_ign = FALSE;
3067 }
3068
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02003069#ifdef FEAT_VIMINFO
3070 curbuf->b_last_used = vim_time();
3071#endif
3072
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 if (command != NULL)
3074 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3075
3076#ifdef FEAT_KEYMAP
3077 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003078 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079#endif
3080
3081 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003082 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 if (!skip_redraw)
3084 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01003085 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01003087 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003090 *so_ptr = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3092 }
3093
3094 if (p_im)
3095 need_start_insertmode = TRUE;
3096
Bram Moolenaar15833232018-02-03 18:33:17 +01003097#ifdef FEAT_AUTOCHDIR
3098 /* Change directories when the 'acd' option is set and we aren't already in
3099 * that directory (should already be done above). Expect getcwd() to be
3100 * faster than calling shorten_fnames() unnecessarily. */
3101 if (p_acd && curbuf->b_ffname != NULL)
3102 {
3103 char_u curdir[MAXPATHL];
3104 char_u filedir[MAXPATHL];
3105
3106 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
3107 *gettail_sep(filedir) = NUL;
3108 if (mch_dirname(curdir, MAXPATHL) != FAIL
3109 && vim_fnamecmp(curdir, filedir) != 0)
3110 do_autochdir();
3111 }
3112#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01003114#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003115 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003118 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003119 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120# endif
3121 }
3122#endif
3123
3124theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003125 if (did_inc_redrawing_disabled)
3126 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003127#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003128 if (did_set_swapcommand)
3129 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3130#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131#ifdef FEAT_BROWSE
3132 vim_free(browse_file);
3133#endif
3134 vim_free(free_fname);
3135 return retval;
3136}
3137
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003139delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003141 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 name == NULL ? (char_u *)"" : name);
3143 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003144 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02003145 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003148static int append_indent = 0; /* autoindent for first line */
3149
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150/*
3151 * ":insert" and ":append", also used by ":change"
3152 */
3153 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003154ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155{
3156 char_u *theline;
3157 int did_undo = FALSE;
3158 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003159 int indent = 0;
3160 char_u *p;
3161 int vcol;
3162 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003164 /* the ! flag toggles autoindent */
3165 if (eap->forceit)
3166 curbuf->b_p_ai = !curbuf->b_p_ai;
3167
3168 /* First autoindent comes from the line we start on */
3169 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3170 append_indent = get_indent_lnum(lnum);
3171
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 if (eap->cmdidx != CMD_append)
3173 --lnum;
3174
Bram Moolenaar70e136e2016-07-01 14:04:51 +02003175 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003176 if (empty && lnum == 1)
3177 lnum = 0;
3178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 State = INSERT; /* behave like in Insert mode */
3180 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3181 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003182
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003183 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 {
3185 msg_scroll = TRUE;
3186 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003187 if (curbuf->b_p_ai)
3188 {
3189 if (append_indent >= 0)
3190 {
3191 indent = append_indent;
3192 append_indent = -1;
3193 }
3194 else if (lnum > 0)
3195 indent = get_indent_lnum(lnum);
3196 }
3197 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003199 {
3200 /* No getline() function, use the lines that follow. This ends
3201 * when there is no more. */
3202 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3203 break;
3204 p = vim_strchr(eap->nextcmd, NL);
3205 if (p == NULL)
3206 p = eap->nextcmd + STRLEN(eap->nextcmd);
3207 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3208 if (*p != NUL)
3209 ++p;
3210 eap->nextcmd = p;
3211 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003213 {
3214 int save_State = State;
3215
3216 /* Set State to avoid the cursor shape to be set to INSERT mode
3217 * when getline() returns. */
3218 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 theline = eap->getline(
3220#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003221 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222#endif
Bram Moolenaare96a2492019-06-25 04:12:16 +02003223 NUL, eap->cookie, indent, TRUE);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003224 State = save_State;
3225 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003227 if (theline == NULL)
3228 break;
3229
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003230 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3231 if (ex_keep_indent)
3232 append_indent = indent;
3233
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003234 /* Look for the "." after automatic indent. */
3235 vcol = 0;
3236 for (p = theline; indent > vcol; ++p)
3237 {
3238 if (*p == ' ')
3239 ++vcol;
3240 else if (*p == TAB)
3241 vcol += 8 - vcol % 8;
3242 else
3243 break;
3244 }
3245 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003246 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3247 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 {
3249 vim_free(theline);
3250 break;
3251 }
3252
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003253 /* don't use autoindent if nothing was typed. */
3254 if (p[0] == NUL)
3255 theline[0] = NUL;
3256
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 did_undo = TRUE;
3258 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02003259 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260
3261 vim_free(theline);
3262 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003263
3264 if (empty)
3265 {
3266 ml_delete(2L, FALSE);
3267 empty = FALSE;
3268 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 }
3270 State = NORMAL;
3271
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003272 if (eap->forceit)
3273 curbuf->b_p_ai = !curbuf->b_p_ai;
3274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00003276 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 * "end" is set to lnum when something has been appended, otherwise
3278 * it is the same than "start" -- Acevedo */
3279 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3280 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3281 if (eap->cmdidx != CMD_append)
3282 --curbuf->b_op_start.lnum;
3283 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3284 ? lnum : curbuf->b_op_start.lnum;
3285 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3286 curwin->w_cursor.lnum = lnum;
3287 check_cursor_lnum();
3288 beginline(BL_SOL | BL_FIX);
3289
3290 need_wait_return = FALSE; /* don't use wait_return() now */
3291 ex_no_reprint = TRUE;
3292}
3293
3294/*
3295 * ":change"
3296 */
3297 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003298ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299{
3300 linenr_T lnum;
3301
3302 if (eap->line2 >= eap->line1
3303 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3304 return;
3305
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003306 /* the ! flag toggles autoindent */
3307 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3308 append_indent = get_indent_lnum(eap->line1);
3309
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3311 {
3312 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3313 break;
3314 ml_delete(eap->line1, FALSE);
3315 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00003316
3317 /* make sure the cursor is not beyond the end of the file now */
3318 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3320
3321 /* ":append" on the line above the deleted lines. */
3322 eap->line2 = eap->line1;
3323 ex_append(eap);
3324}
3325
3326 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003327ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328{
3329 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003330 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003331 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 int minus = 0;
3333 linenr_T start, end, curs, i;
3334 int j;
3335 linenr_T lnum = eap->line2;
3336
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003337 /* Vi compatible: ":z!" uses display height, without a count uses
3338 * 'scroll' */
3339 if (eap->forceit)
3340 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01003341 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003342 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01003343 else
3344 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 if (bigness < 1)
3346 bigness = 1;
3347
3348 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003349 kind = x;
3350 if (*kind == '-' || *kind == '+' || *kind == '='
3351 || *kind == '^' || *kind == '.')
3352 ++x;
3353 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 ++x;
3355
3356 if (*x != 0)
3357 {
3358 if (!VIM_ISDIGIT(*x))
3359 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003360 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 return;
3362 }
3363 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003364 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003365 bigness = atol((char *)x);
3366
3367 /* bigness could be < 0 if atol(x) overflows. */
3368 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
3369 bigness = 2 * curbuf->b_ml.ml_line_count;
3370
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003371 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003372 if (*kind == '=')
3373 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003374 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 }
3376
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003377 /* the number of '-' and '+' multiplies the distance */
3378 if (*kind == '-' || *kind == '+')
3379 for (x = kind + 1; *x == *kind; ++x)
3380 ;
3381
3382 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 {
3384 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02003385 start = lnum - bigness * (linenr_T)(x - kind) + 1;
3386 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003387 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 break;
3389
3390 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003391 start = lnum - (bigness + 1) / 2 + 1;
3392 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 curs = lnum;
3394 minus = 1;
3395 break;
3396
3397 case '^':
3398 start = lnum - bigness * 2;
3399 end = lnum - bigness;
3400 curs = lnum - bigness;
3401 break;
3402
3403 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003404 start = lnum - (bigness + 1) / 2 + 1;
3405 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 curs = end;
3407 break;
3408
3409 default: /* '+' */
3410 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003411 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003412 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003413 else if (eap->addr_count == 0)
3414 ++start;
3415 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 curs = end;
3417 break;
3418 }
3419
3420 if (start < 1)
3421 start = 1;
3422
3423 if (end > curbuf->b_ml.ml_line_count)
3424 end = curbuf->b_ml.ml_line_count;
3425
3426 if (curs > curbuf->b_ml.ml_line_count)
3427 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003428 else if (curs < 1)
3429 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430
3431 for (i = start; i <= end; i++)
3432 {
3433 if (minus && i == lnum)
3434 {
3435 msg_putchar('\n');
3436
3437 for (j = 1; j < Columns; j++)
3438 msg_putchar('-');
3439 }
3440
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003441 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442
3443 if (minus && i == lnum)
3444 {
3445 msg_putchar('\n');
3446
3447 for (j = 1; j < Columns; j++)
3448 msg_putchar('-');
3449 }
3450 }
3451
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003452 if (curwin->w_cursor.lnum != curs)
3453 {
3454 curwin->w_cursor.lnum = curs;
3455 curwin->w_cursor.col = 0;
3456 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 ex_no_reprint = TRUE;
3458}
3459
3460/*
3461 * Check if the restricted flag is set.
3462 * If so, give an error message and return TRUE.
3463 * Otherwise, return FALSE.
3464 */
3465 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003466check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467{
3468 if (restricted)
3469 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01003470 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 return TRUE;
3472 }
3473 return FALSE;
3474}
3475
3476/*
3477 * Check if the secure flag is set (.exrc or .vimrc in current directory).
3478 * If so, give an error message and return TRUE.
3479 * Otherwise, return FALSE.
3480 */
3481 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003482check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483{
3484 if (secure)
3485 {
3486 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003487 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 return TRUE;
3489 }
3490#ifdef HAVE_SANDBOX
3491 /*
3492 * In the sandbox more things are not allowed, including the things
3493 * disallowed in secure mode.
3494 */
3495 if (sandbox != 0)
3496 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003497 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 return TRUE;
3499 }
3500#endif
3501 return FALSE;
3502}
3503
3504static char_u *old_sub = NULL; /* previous substitute pattern */
3505static int global_need_beginline; /* call beginline() after ":g" */
3506
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003507/*
3508 * Flags that are kept between calls to :substitute.
3509 */
3510typedef struct {
3511 int do_all; /* do multiple substitutions per line */
3512 int do_ask; /* ask for confirmation */
3513 int do_count; /* count only */
3514 int do_error; /* if false, ignore errors */
3515 int do_print; /* print last line with subs. */
3516 int do_list; /* list last line with subs. */
3517 int do_number; /* list last line with line nr*/
3518 int do_ic; /* ignore case flag */
3519} subflags_T;
3520
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521/* do_sub()
3522 *
3523 * Perform a substitution from line eap->line1 to line eap->line2 using the
3524 * command pointed to by eap->arg which should be of the form:
3525 *
3526 * /pattern/substitution/{flags}
3527 *
3528 * The usual escapes are supported as described in the regexp docs.
3529 */
3530 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003531do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532{
3533 linenr_T lnum;
3534 long i = 0;
3535 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003536 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
3537 FALSE, FALSE, 0};
3538#ifdef FEAT_EVAL
3539 subflags_T subflags_save;
3540#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02003541 int save_do_all; /* remember user specified 'g' flag */
3542 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 char_u *pat = NULL, *sub = NULL; /* init for GCC */
3544 int delimiter;
3545 int sublen;
3546 int got_quit = FALSE;
3547 int got_match = FALSE;
3548 int temp;
3549 int which_pat;
3550 char_u *cmd;
3551 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003552 linenr_T first_line = 0; /* first changed line */
3553 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 * change */
3555 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
3556 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003557 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003558 char_u *sub_firstline; /* allocated copy of first sub line */
3559 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00003560 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01003561 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003562#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02003563 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003564#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565
3566 cmd = eap->arg;
3567 if (!global_busy)
3568 {
3569 sub_nsubs = 0;
3570 sub_nlines = 0;
3571 }
Bram Moolenaar46475522010-03-23 17:36:29 +01003572 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 if (eap->cmdidx == CMD_tilde)
3575 which_pat = RE_LAST; /* use last used regexp */
3576 else
3577 which_pat = RE_SUBST; /* use last substitute regexp */
3578
3579 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01003580 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
3582 {
3583 /* don't accept alphanumeric for separator */
3584 if (isalpha(*cmd))
3585 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003586 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 return;
3588 }
3589 /*
3590 * undocumented vi feature:
3591 * "\/sub/" and "\?sub?" use last used search pattern (almost like
3592 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
3593 */
3594 if (*cmd == '\\')
3595 {
3596 ++cmd;
3597 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
3598 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003599 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 return;
3601 }
3602 if (*cmd != '&')
3603 which_pat = RE_SEARCH; /* use last '/' pattern */
3604 pat = (char_u *)""; /* empty search pattern */
3605 delimiter = *cmd++; /* remember delimiter character */
3606 }
3607 else /* find the end of the regexp */
3608 {
3609 which_pat = RE_LAST; /* use last used regexp */
3610 delimiter = *cmd++; /* remember delimiter character */
3611 pat = cmd; /* remember start of search pat */
3612 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
3613 if (cmd[0] == delimiter) /* end delimiter found */
3614 *cmd++ = NUL; /* replace it with a NUL */
3615 }
3616
3617 /*
3618 * Small incompatibility: vi sees '\n' as end of the command, but in
3619 * Vim we want to use '\n' to find/substitute a NUL.
3620 */
3621 sub = cmd; /* remember the start of the substitution */
3622
3623 while (cmd[0])
3624 {
3625 if (cmd[0] == delimiter) /* end delimiter found */
3626 {
3627 *cmd++ = NUL; /* replace it with a NUL */
3628 break;
3629 }
3630 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
3631 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003632 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 }
3634
3635 if (!eap->skip)
3636 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003637 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
3638 if (STRCMP(sub, "%") == 0
3639 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
3640 {
3641 if (old_sub == NULL) /* there is no previous command */
3642 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003643 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003644 return;
3645 }
3646 sub = old_sub;
3647 }
3648 else
3649 {
3650 vim_free(old_sub);
3651 old_sub = vim_strsave(sub);
3652 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 }
3654 }
3655 else if (!eap->skip) /* use previous pattern and substitution */
3656 {
3657 if (old_sub == NULL) /* there is no previous command */
3658 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003659 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 return;
3661 }
3662 pat = NULL; /* search_regcomp() will use previous pattern */
3663 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003664
3665 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
3666 * last column after using "$". */
3667 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 }
3669
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003670 /* Recognize ":%s/\n//" and turn it into a join command, which is much
3671 * more efficient.
3672 * TODO: find a generic solution to make line-joining operations more
3673 * efficient, avoid allocating a string that grows in size.
3674 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02003675 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003676 && *sub == NUL
3677 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
3678 || *cmd == 'p' || *cmd == '#'))))
3679 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003680 linenr_T joined_lines_count;
3681
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003682 curwin->w_cursor.lnum = eap->line1;
3683 if (*cmd == 'l')
3684 eap->flags = EXFLAG_LIST;
3685 else if (*cmd == '#')
3686 eap->flags = EXFLAG_NR;
3687 else if (*cmd == 'p')
3688 eap->flags = EXFLAG_PRINT;
3689
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003690 /* The number of lines joined is the number of lines in the range plus
3691 * one. One less when the last line is included. */
3692 joined_lines_count = eap->line2 - eap->line1 + 1;
3693 if (eap->line2 < curbuf->b_ml.ml_line_count)
3694 ++joined_lines_count;
3695 if (joined_lines_count > 1)
3696 {
3697 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
3698 sub_nsubs = joined_lines_count - 1;
3699 sub_nlines = 1;
3700 (void)do_sub_msg(FALSE);
3701 ex_may_print(eap);
3702 }
3703
3704 if (!cmdmod.keeppatterns)
3705 save_re_pat(RE_SUBST, pat, p_magic);
Bram Moolenaard7663c22019-08-06 21:59:57 +02003706 // put pattern in history
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003707 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003708
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003709 return;
3710 }
3711
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 /*
3713 * Find trailing options. When '&' is used, keep old options.
3714 */
3715 if (*cmd == '&')
3716 ++cmd;
3717 else
3718 {
3719 if (!p_ed)
3720 {
3721 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003722 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003724 subflags.do_all = FALSE;
3725 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003727 subflags.do_error = TRUE;
3728 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01003729 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003730 subflags.do_count = FALSE;
3731 subflags.do_number = FALSE;
3732 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 }
3734 while (*cmd)
3735 {
3736 /*
3737 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
3738 * 'r' is never inverted.
3739 */
3740 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003741 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003743 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003744 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003745 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003747 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 else if (*cmd == 'r') /* use last used regexp */
3749 which_pat = RE_LAST;
3750 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003751 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003752 else if (*cmd == '#')
3753 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003754 subflags.do_print = TRUE;
3755 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003756 }
3757 else if (*cmd == 'l')
3758 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003759 subflags.do_print = TRUE;
3760 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003761 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003763 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003765 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 else
3767 break;
3768 ++cmd;
3769 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003770 if (subflags.do_count)
3771 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003773 save_do_all = subflags.do_all;
3774 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02003775
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 /*
3777 * check for a trailing count
3778 */
3779 cmd = skipwhite(cmd);
3780 if (VIM_ISDIGIT(*cmd))
3781 {
3782 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003783 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003785 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 return;
3787 }
3788 eap->line1 = eap->line2;
3789 eap->line2 += i - 1;
3790 if (eap->line2 > curbuf->b_ml.ml_line_count)
3791 eap->line2 = curbuf->b_ml.ml_line_count;
3792 }
3793
3794 /*
3795 * check for trailing command or garbage
3796 */
3797 cmd = skipwhite(cmd);
3798 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
3799 {
3800 eap->nextcmd = check_nextcmd(cmd);
3801 if (eap->nextcmd == NULL)
3802 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003803 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 return;
3805 }
3806 }
3807
3808 if (eap->skip) /* not executing commands, only parsing */
3809 return;
3810
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003811 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003812 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003813 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003814 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003815 return;
3816 }
3817
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
3819 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003820 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003821 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 return;
3823 }
3824
3825 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003826 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003828 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 regmatch.rmm_ic = FALSE;
3830
3831 sub_firstline = NULL;
3832
3833 /*
3834 * ~ in the substitute pattern is replaced with the old pattern.
3835 * We do it here once to avoid it to be replaced over and over again.
3836 * But don't do it when it starts with "\=", then it's an expression.
3837 */
3838 if (!(sub[0] == '\\' && sub[1] == '='))
3839 sub = regtilde(sub, p_magic);
3840
3841 /*
3842 * Check for a match on each line.
3843 */
3844 line2 = eap->line2;
3845 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003846#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 || aborting()
3848#endif
3849 ); ++lnum)
3850 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003851 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02003852 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 if (nmatch)
3854 {
3855 colnr_T copycol;
3856 colnr_T matchcol;
3857 colnr_T prev_matchcol = MAXCOL;
3858 char_u *new_end, *new_start = NULL;
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02003859 colnr_T total_added = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 unsigned new_start_len = 0;
3861 char_u *p1;
3862 int did_sub = FALSE;
3863 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003864 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 long nmatch_tl = 0; /* nr of lines matched below lnum */
3866 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00003867 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003868 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar338dfda2019-05-19 15:19:57 +02003869#ifdef FEAT_TEXT_PROP
Bram Moolenaarf3333b02019-05-19 22:53:40 +02003870 int apc_flags = APC_SAVE_FOR_UNDO | APC_SUBSTITUTE;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02003871#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
3873 /*
3874 * The new text is build up step by step, to avoid too much
3875 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00003876 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 * copycol Column in the old text where we started
3878 * looking for a match; from here old text still
3879 * needs to be copied to the new text.
3880 * matchcol Column number of the old text where to look
3881 * for the next match. It's just after the
3882 * previous match or one further.
3883 * prev_matchcol Column just after the previous match (if any).
3884 * Mostly equal to matchcol, except for the first
3885 * match and after skipping an empty match.
3886 * regmatch.*pos Where the pattern matched in the old text.
3887 * new_start The new text, all that has been produced so
3888 * far.
3889 * new_end The new text, where to append new text.
3890 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003891 * lnum The line number where we found the start of
3892 * the match. Can be below the line we searched
3893 * when there is a \n before a \zs in the
3894 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 * sub_firstlnum The line number in the buffer where to look
3896 * for a match. Can be different from "lnum"
3897 * when the pattern or substitute string contains
3898 * line breaks.
3899 *
3900 * Special situations:
3901 * - When the substitute string contains a line break, the part up
3902 * to the line break is inserted in the text, but the copy of
3903 * the original line is kept. "sub_firstlnum" is adjusted for
3904 * the inserted lines.
3905 * - When the matched pattern contains a line break, the old line
3906 * is taken from the line at the end of the pattern. The lines
3907 * in the match are deleted later, "sub_firstlnum" is adjusted
3908 * accordingly.
3909 *
3910 * The new text is built up in new_start[]. It has some extra
3911 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00003912 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 *
3914 * Make a copy of the old line, so it won't be taken away when
3915 * updating the screen or handling a multi-line match. The "old_"
3916 * pointers point into this copy.
3917 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003918 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 copycol = 0;
3920 matchcol = 0;
3921
3922 /* At first match, remember current cursor position. */
3923 if (!got_match)
3924 {
3925 setpcmark();
3926 got_match = TRUE;
3927 }
3928
3929 /*
3930 * Loop until nothing more to replace in this line.
3931 * 1. Handle match with empty string.
3932 * 2. If do_ask is set, ask for confirmation.
3933 * 3. substitute the string.
3934 * 4. if do_all is set, find next match
3935 * 5. break if there isn't another match in this line
3936 */
3937 for (;;)
3938 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003939 /* Advance "lnum" to the line where the match starts. The
3940 * match does not start in the first line when there is a line
3941 * break before \zs. */
3942 if (regmatch.startpos[0].lnum > 0)
3943 {
3944 lnum += regmatch.startpos[0].lnum;
3945 sub_firstlnum += regmatch.startpos[0].lnum;
3946 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01003947 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003948 }
3949
3950 if (sub_firstline == NULL)
3951 {
3952 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
3953 if (sub_firstline == NULL)
3954 {
3955 vim_free(new_start);
3956 goto outofmem;
3957 }
3958 }
3959
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 /* Save the line number of the last change for the final
3961 * cursor position (just like Vi). */
3962 curwin->w_cursor.lnum = lnum;
3963 do_again = FALSE;
3964
3965 /*
3966 * 1. Match empty string does not count, except for first
3967 * match. This reproduces the strange vi behaviour.
3968 * This also catches endless loops.
3969 */
3970 if (matchcol == prev_matchcol
3971 && regmatch.endpos[0].lnum == 0
3972 && matchcol == regmatch.endpos[0].col)
3973 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00003974 if (sub_firstline[matchcol] == NUL)
3975 /* We already were at the end of the line. Don't look
3976 * for a match in this line again. */
3977 skip_match = TRUE;
3978 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02003979 {
3980 /* search for a match at next column */
Bram Moolenaar0df11022011-05-19 14:30:16 +02003981 if (has_mbyte)
3982 matchcol += mb_ptr2len(sub_firstline + matchcol);
3983 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02003984 ++matchcol;
3985 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 goto skip;
3987 }
3988
3989 /* Normally we continue searching for a match just after the
3990 * previous match. */
3991 matchcol = regmatch.endpos[0].col;
3992 prev_matchcol = matchcol;
3993
3994 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00003995 * 2. If do_count is set only increase the counter.
3996 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003998 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003999 {
4000 /* For a multi-line match, put matchcol at the NUL at
4001 * the end of the line and set nmatch to one, so that
4002 * we continue looking for a match on the next line.
4003 * Avoids that ":s/\nB\@=//gc" get stuck. */
4004 if (nmatch > 1)
4005 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004006 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004007 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004008 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004009 }
4010 sub_nsubs++;
4011 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004012#ifdef FEAT_EVAL
4013 /* Skip the substitution, unless an expression is used,
4014 * then it is evaluated in the sandbox. */
4015 if (!(sub[0] == '\\' && sub[1] == '='))
4016#endif
4017 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004018 }
4019
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004020 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004022 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004023
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 /* change State to CONFIRM, so that the mouse works
4025 * properly */
4026 save_State = State;
4027 State = CONFIRM;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02004028 setmouse(); // disable mouse in xterm
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01004030 if (curwin->w_p_crb)
4031 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032
4033 /* When 'cpoptions' contains "u" don't sync undo when
4034 * asking for confirmation. */
4035 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4036 ++no_u_sync;
4037
4038 /*
4039 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4040 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004041 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004043 if (exmode_active)
4044 {
4045 char_u *resp;
4046 colnr_T sc, ec;
4047
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004048 print_line_no_prefix(lnum,
4049 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004050
4051 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4052 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01004053 if (curwin->w_cursor.col < 0)
4054 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004055 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004056 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02004057 {
4058 int numw = number_width(curwin) + 1;
4059 sc += numw;
4060 ec += numw;
4061 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004062 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004063 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004064 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004065 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004066 msg_putchar('^');
4067
Bram Moolenaare96a2492019-06-25 04:12:16 +02004068 resp = getexmodeline('?', NULL, 0, TRUE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004069 if (resp != NULL)
4070 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004071 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004072 vim_free(resp);
4073 }
4074 }
4075 else
4076 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004077 char_u *orig_line = NULL;
4078 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004080 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004082 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004084 /* Invert the matched string.
4085 * Remove the inversion afterwards. */
4086 temp = RedrawingDisabled;
4087 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004089 if (new_start != NULL)
4090 {
4091 /* There already was a substitution, we would
4092 * like to show this to the user. We cannot
4093 * really update the line, it would change
4094 * what matches. Temporarily replace the line
4095 * and change it back afterwards. */
4096 orig_line = vim_strsave(ml_get(lnum));
4097 if (orig_line != NULL)
4098 {
4099 char_u *new_line = concat_str(new_start,
4100 sub_firstline + copycol);
4101
4102 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01004103 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004104 else
4105 {
4106 /* Position the cursor relative to the
4107 * end of the line, the previous
4108 * substitute may have inserted or
4109 * deleted characters before the
4110 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004111 len_change = (int)STRLEN(new_line)
4112 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004113 curwin->w_cursor.col += len_change;
4114 ml_replace(lnum, new_line, FALSE);
4115 }
4116 }
4117 }
4118
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004119 search_match_lines = regmatch.endpos[0].lnum
4120 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004121 search_match_endcol = regmatch.endpos[0].col
4122 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004123 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004125 update_topline();
4126 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004127 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004128 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004129 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130
4131#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004132 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004134 if (msg_row == Rows - 1)
4135 msg_didout = FALSE; /* avoid a scroll-up */
4136 msg_starthere();
4137 i = msg_scroll;
4138 msg_scroll = 0; /* truncate msg when
4139 needed */
4140 msg_no_more = TRUE;
4141 /* write message same highlighting as for
4142 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01004143 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004144 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004145 msg_no_more = FALSE;
4146 msg_scroll = i;
4147 showruler(TRUE);
4148 windgoto(msg_row, msg_col);
4149 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150
4151#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004152 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004154 ++no_mapping; /* don't map this key */
4155 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004156 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004157 --allow_keys;
4158 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004160 /* clear the question */
4161 msg_didout = FALSE; /* don't scroll up */
4162 msg_col = 0;
4163 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004164
4165 /* restore the line */
4166 if (orig_line != NULL)
4167 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004168 }
4169
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004171 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004173 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174#endif
4175 )
4176 {
4177 got_quit = TRUE;
4178 break;
4179 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004180 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004182 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004184 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 {
4186 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004187 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 line2 = lnum;
4189 break;
4190 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004191 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004193 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 break;
4195 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004196 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004198 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 scrolldown_clamp();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 }
4201 State = save_State;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4204 --no_u_sync;
4205
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004206 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 {
4208 /* For a multi-line match, put matchcol at the NUL at
4209 * the end of the line and set nmatch to one, so that
4210 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004211 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4212 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 if (nmatch > 1)
4214 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004215 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004216 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 }
4218 goto skip;
4219 }
4220 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004221 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 }
4223
4224 /* Move the cursor to the start of the match, so that we can
4225 * use "\=col("."). */
4226 curwin->w_cursor.col = regmatch.startpos[0].col;
4227
4228 /*
4229 * 3. substitute the string.
4230 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004231#ifdef FEAT_EVAL
Bram Moolenaar80341bc2019-05-20 20:34:51 +02004232 save_ma = curbuf->b_p_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004233 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004234 {
Bram Moolenaar6349e942019-05-18 13:41:22 +02004235 // prevent accidentally changing the buffer by a function
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004236 curbuf->b_p_ma = FALSE;
4237 sandbox++;
4238 }
Bram Moolenaar6349e942019-05-18 13:41:22 +02004239 // Save flags for recursion. They can change for e.g.
4240 // :s/^/\=execute("s#^##gn")
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004241 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004242#endif
Bram Moolenaar6349e942019-05-18 13:41:22 +02004243 // get length of substitution part
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004244 sublen = vim_regsub_multi(&regmatch,
4245 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004247#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004248 // If getting the substitute string caused an error, don't do
4249 // the replacement.
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004250 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004251 subflags = subflags_save;
Bram Moolenaar6349e942019-05-18 13:41:22 +02004252 if (aborting() || subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004253 {
4254 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004255 if (sandbox > 0)
4256 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004257 goto skip;
4258 }
4259#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260
Bram Moolenaar4463f292005-09-25 22:20:24 +00004261 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004262 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004263 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4264 {
4265 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4266 skip_match = TRUE;
4267 }
4268
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 /* Need room for:
4270 * - result so far in new_start (not for first sub in line)
4271 * - original text up to match
4272 * - length of substituted part
4273 * - original text after match
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004274 * Adjust text properties here, since we have all information
4275 * needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 */
4277 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004278 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 p1 = sub_firstline;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004280#ifdef FEAT_TEXT_PROP
4281 if (curbuf->b_has_textprop)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004282 {
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004283 int bytes_added = sublen - 1 - (regmatch.endpos[0].col
4284 - regmatch.startpos[0].col);
4285
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004286 // When text properties are changed, need to save for
4287 // undo first, unless done already.
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004288 if (adjust_prop_columns(lnum,
4289 total_added + regmatch.startpos[0].col,
4290 bytes_added, apc_flags))
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004291 apc_flags &= ~APC_SAVE_FOR_UNDO;
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004292 // Offset for column byte number of the text property
4293 // in the resulting buffer afterwards.
4294 total_added += bytes_added;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004295 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004296#endif
4297 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 else
4299 {
4300 p1 = ml_get(sub_firstlnum + nmatch - 1);
4301 nmatch_tl += nmatch - 1;
4302 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004303 copy_len = regmatch.startpos[0].col - copycol;
4304 needed_len = copy_len + ((unsigned)STRLEN(p1)
4305 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 if (new_start == NULL)
4307 {
4308 /*
4309 * Get some space for a temporary buffer to do the
4310 * substitution into (and some extra space to avoid
4311 * too many calls to alloc()/free()).
4312 */
4313 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004314 if ((new_start = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 goto outofmem;
4316 *new_start = NUL;
4317 new_end = new_start;
4318 }
4319 else
4320 {
4321 /*
4322 * Check if the temporary buffer is long enough to do the
4323 * substitution into. If not, make it larger (with a bit
4324 * extra to avoid too many calls to alloc()/free()).
4325 */
4326 len = (unsigned)STRLEN(new_start);
4327 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004328 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 {
4330 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004331 if ((p1 = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 {
4333 vim_free(new_start);
4334 goto outofmem;
4335 }
4336 mch_memmove(p1, new_start, (size_t)(len + 1));
4337 vim_free(new_start);
4338 new_start = p1;
4339 }
4340 new_end = new_start + len;
4341 }
4342
4343 /*
4344 * copy the text up to the part that matched
4345 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004346 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4347 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004349 (void)vim_regsub_multi(&regmatch,
4350 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 sub, new_end, TRUE, p_magic, TRUE);
4352 sub_nsubs++;
4353 did_sub = TRUE;
4354
4355 /* Move the cursor to the start of the line, to avoid that it
4356 * is beyond the end of the line after the substitution. */
4357 curwin->w_cursor.col = 0;
4358
4359 /* For a multi-line match, make a copy of the last matched
4360 * line and continue in that one. */
4361 if (nmatch > 1)
4362 {
4363 sub_firstlnum += nmatch - 1;
4364 vim_free(sub_firstline);
4365 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4366 /* When going beyond the last line, stop substituting. */
4367 if (sub_firstlnum <= line2)
4368 do_again = TRUE;
4369 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004370 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 }
4372
4373 /* Remember next character to be copied. */
4374 copycol = regmatch.endpos[0].col;
4375
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004376 if (skip_match)
4377 {
4378 /* Already hit end of the buffer, sub_firstlnum is one
4379 * less than what it ought to be. */
4380 vim_free(sub_firstline);
4381 sub_firstline = vim_strsave((char_u *)"");
4382 copycol = 0;
4383 }
4384
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 /*
4386 * Now the trick is to replace CTRL-M chars with a real line
4387 * break. This would make it impossible to insert a CTRL-M in
4388 * the text. The line break can be avoided by preceding the
4389 * CTRL-M with a backslash. To be able to insert a backslash,
4390 * they must be doubled in the string and are halved here.
4391 * That is Vi compatible.
4392 */
4393 for (p1 = new_end; *p1; ++p1)
4394 {
4395 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004396 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004397 STRMOVE(p1, p1 + 1);
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004398#ifdef FEAT_TEXT_PROP
4399 if (curbuf->b_has_textprop)
4400 {
4401 // When text properties are changed, need to save
4402 // for undo first, unless done already.
4403 if (adjust_prop_columns(lnum,
4404 (colnr_T)(p1 - new_start), -1,
4405 apc_flags))
4406 apc_flags &= ~APC_SAVE_FOR_UNDO;
4407 }
4408#endif
4409 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 else if (*p1 == CAR)
4411 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004412 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004414 colnr_T plen = (colnr_T)(p1 - new_start + 1);
4415
4416 *p1 = NUL; // truncate up to the CR
4417 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004419 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 appended_lines(lnum - 1, 1L);
4421 else
4422 {
4423 if (first_line == 0)
4424 first_line = lnum;
4425 last_line = lnum + 1;
4426 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004427#ifdef FEAT_TEXT_PROP
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02004428 adjust_props_for_split(lnum + 1, lnum, plen, 1);
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004429#endif
4430 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 ++sub_firstlnum;
4432 ++lnum;
4433 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004434 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004436 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004437 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 p1 = new_start - 1;
4439 }
4440 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004442 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 }
4444
4445 /*
4446 * 4. If do_all is set, find next match.
4447 * Prevent endless loop with patterns that match empty
4448 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4449 * But ":s/\n/#/" is OK.
4450 */
4451skip:
4452 /* We already know that we did the last subst when we are at
4453 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004454 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4455 * "line2" when there is a \zs in the pattern after a line
4456 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004457 lastone = (skip_match
4458 || got_int
4459 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004460 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004461 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00004462 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4463 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 nmatch = -1;
4465
4466 /*
4467 * Replace the line in the buffer when needed. This is
4468 * skipped when there are more matches.
4469 * The check for nmatch_tl is needed for when multi-line
4470 * matching must replace the lines before trying to do another
4471 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004472 * When the match starts below where we start searching also
4473 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 */
4475 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 || nmatch_tl > 0
4477 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004478 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004479 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004480 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 {
4482 if (new_start != NULL)
4483 {
4484 /*
4485 * Copy the rest of the line, that didn't match.
4486 * "matchcol" has to be adjusted, we use the end of
4487 * the line as reference, because the substitute may
4488 * have changed the number of characters. Same for
4489 * "prev_matchcol".
4490 */
4491 STRCAT(new_start, sub_firstline + copycol);
4492 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4493 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4494 - prev_matchcol;
4495
4496 if (u_savesub(lnum) != OK)
4497 break;
4498 ml_replace(lnum, new_start, TRUE);
4499
4500 if (nmatch_tl > 0)
4501 {
4502 /*
4503 * Matched lines have now been substituted and are
4504 * useless, delete them. The part after the match
4505 * has been appended to new_start, we don't need
4506 * it in the buffer.
4507 */
4508 ++lnum;
4509 if (u_savedel(lnum, nmatch_tl) != OK)
4510 break;
4511 for (i = 0; i < nmatch_tl; ++i)
4512 ml_delete(lnum, (int)FALSE);
4513 mark_adjust(lnum, lnum + nmatch_tl - 1,
4514 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004515 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 deleted_lines(lnum, nmatch_tl);
4517 --lnum;
4518 line2 -= nmatch_tl; /* nr of lines decreases */
4519 nmatch_tl = 0;
4520 }
4521
4522 /* When asking, undo is saved each time, must also set
4523 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004524 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 changed_bytes(lnum, 0);
4526 else
4527 {
4528 if (first_line == 0)
4529 first_line = lnum;
4530 last_line = lnum + 1;
4531 }
4532
4533 sub_firstlnum = lnum;
4534 vim_free(sub_firstline); /* free the temp buffer */
4535 sub_firstline = new_start;
4536 new_start = NULL;
4537 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4538 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4539 - prev_matchcol;
4540 copycol = 0;
4541 }
4542 if (nmatch == -1 && !lastone)
4543 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004544 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545
4546 /*
4547 * 5. break if there isn't another match in this line
4548 */
4549 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004550 {
4551 /* If the match found didn't start where we were
4552 * searching, do the next search in the line where we
4553 * found the match. */
4554 if (nmatch == -1)
4555 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004557 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 }
4559
4560 line_breakcheck();
4561 }
4562
4563 if (did_sub)
4564 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00004565 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01004566 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 }
4568
4569 line_breakcheck();
4570 }
4571
4572 if (first_line != 0)
4573 {
4574 /* Need to subtract the number of added lines from "last_line" to get
4575 * the line number before the change (same as adding the number of
4576 * deleted lines). */
4577 i = curbuf->b_ml.ml_line_count - old_line_count;
4578 changed_lines(first_line, 0, last_line - i, i);
4579 }
4580
4581outofmem:
4582 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004583
4584 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004585 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004586 curwin->w_cursor = old_cursor;
4587
Bram Moolenaar46475522010-03-23 17:36:29 +01004588 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 {
4590 /* Set the '[ and '] marks. */
4591 curbuf->b_op_start.lnum = eap->line1;
4592 curbuf->b_op_end.lnum = line2;
4593 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4594
4595 if (!global_busy)
4596 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004597 /* when interactive leave cursor on the match */
4598 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01004599 {
4600 if (endcolumn)
4601 coladvance((colnr_T)MAXCOL);
4602 else
4603 beginline(BL_WHITE | BL_FIX);
4604 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004605 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004606 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 }
4608 else
4609 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004610 if (subflags.do_print)
4611 print_line(curwin->w_cursor.lnum,
4612 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 }
4614 else if (!global_busy)
4615 {
4616 if (got_int) /* interrupted */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004617 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 else if (got_match) /* did find something but nothing substituted */
Bram Moolenaar32526b32019-01-19 17:43:09 +01004619 msg("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004620 else if (subflags.do_error) /* nothing found */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004621 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 }
4623
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004624#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004625 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004626 /* Cursor position may require updating */
4627 changed_window_setting();
4628#endif
4629
Bram Moolenaar473de612013-06-08 18:19:48 +02004630 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004631
4632 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004633 subflags.do_all = save_do_all;
4634 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635}
4636
4637/*
4638 * Give message for number of substitutions.
4639 * Can also be used after a ":global" command.
4640 * Return TRUE if a message was given.
4641 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004642 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004643do_sub_msg(
4644 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645{
4646 /*
4647 * Only report substitutions when:
4648 * - more than 'report' substitutions
4649 * - command was typed by user, or number of changed lines > 'report'
4650 * - giving messages is not disabled by 'lazyredraw'
4651 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004652 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
4653 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 && messaging())
4655 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004656 char *msg_single;
4657 char *msg_plural;
4658
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 if (got_int)
4660 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004661 else
4662 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004663
4664 msg_single = count_only
4665 ? NGETTEXT("%ld match on %ld line",
4666 "%ld matches on %ld line", sub_nsubs)
4667 : NGETTEXT("%ld substitution on %ld line",
4668 "%ld substitutions on %ld line", sub_nsubs);
4669 msg_plural = count_only
4670 ? NGETTEXT("%ld match on %ld lines",
4671 "%ld matches on %ld lines", sub_nsubs)
4672 : NGETTEXT("%ld substitution on %ld lines",
4673 "%ld substitutions on %ld lines", sub_nsubs);
4674
Bram Moolenaar32526b32019-01-19 17:43:09 +01004675 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004676 NGETTEXT(msg_single, msg_plural, sub_nlines),
4677 sub_nsubs, (long)sub_nlines);
4678
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 /* save message to display it after redraw */
Bram Moolenaar32526b32019-01-19 17:43:09 +01004681 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 return TRUE;
4683 }
4684 if (got_int)
4685 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004686 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 return TRUE;
4688 }
4689 return FALSE;
4690}
4691
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004692 static void
4693global_exe_one(char_u *cmd, linenr_T lnum)
4694{
4695 curwin->w_cursor.lnum = lnum;
4696 curwin->w_cursor.col = 0;
4697 if (*cmd == NUL || *cmd == '\n')
4698 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
4699 else
4700 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
4701}
4702
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703/*
4704 * Execute a global command of the form:
4705 *
4706 * g/pattern/X : execute X on all lines where pattern matches
4707 * v/pattern/X : execute X on all lines where pattern does not match
4708 *
4709 * where 'X' is an EX command
4710 *
4711 * The command character (as well as the trailing slash) is optional, and
4712 * is assumed to be 'p' if missing.
4713 *
4714 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004715 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 * for each line that has a mark. This is required because after deleting
4717 * lines we do not know where to search for the next match.
4718 */
4719 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004720ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721{
4722 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004723 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 int type; /* first char of cmd: 'v' or 'g' */
4725 char_u *cmd; /* command argument */
4726
4727 char_u delim; /* delimiter, normally '/' */
4728 char_u *pat;
4729 regmmatch_T regmatch;
4730 int match;
4731 int which_pat;
4732
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004733 /* When nesting the command works on one line. This allows for
4734 * ":g/found/v/notfound/command". */
4735 if (global_busy && (eap->line1 != 1
4736 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004738 /* will increment global_busy to break out of the loop */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004739 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 return;
4741 }
4742
4743 if (eap->forceit) /* ":global!" is like ":vglobal" */
4744 type = 'v';
4745 else
4746 type = *eap->cmd;
4747 cmd = eap->arg;
4748 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749
4750 /*
4751 * undocumented vi feature:
4752 * "\/" and "\?": use previous search pattern.
4753 * "\&": use previous substitute pattern.
4754 */
4755 if (*cmd == '\\')
4756 {
4757 ++cmd;
4758 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4759 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004760 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 return;
4762 }
4763 if (*cmd == '&')
4764 which_pat = RE_SUBST; /* use previous substitute pattern */
4765 else
4766 which_pat = RE_SEARCH; /* use previous search pattern */
4767 ++cmd;
4768 pat = (char_u *)"";
4769 }
4770 else if (*cmd == NUL)
4771 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004772 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 return;
4774 }
4775 else
4776 {
4777 delim = *cmd; /* get the delimiter */
4778 if (delim)
4779 ++cmd; /* skip delimiter if there is one */
4780 pat = cmd; /* remember start of pattern */
4781 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
4782 if (cmd[0] == delim) /* end delimiter found */
4783 *cmd++ = NUL; /* replace it with a NUL */
4784 }
4785
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4787 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004788 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 return;
4790 }
4791
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004792 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004794 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004795 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004796 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004798 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 }
4800 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004801 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004802 /*
4803 * pass 1: set marks for each (not) matching line
4804 */
4805 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
4806 {
4807 /* a match on this line? */
4808 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004809 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004810 if ((type == 'g' && match) || (type == 'v' && !match))
4811 {
4812 ml_setmarked(lnum);
4813 ndone++;
4814 }
4815 line_breakcheck();
4816 }
4817
4818 /*
4819 * pass 2: execute the command for each line that has been marked
4820 */
4821 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004822 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004823 else if (ndone == 0)
4824 {
4825 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004826 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004827 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004828 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004829 }
4830 else
4831 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004832#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004833 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004834#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004835 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004836#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004837 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004838#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004839 }
4840
4841 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004842 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843
Bram Moolenaar473de612013-06-08 18:19:48 +02004844 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845}
4846
4847/*
4848 * Execute "cmd" on lines marked with ml_setmarked().
4849 */
4850 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004851global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852{
Bram Moolenaarbb993222011-05-10 16:00:47 +02004853 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
4854 buf_T *old_buf = curbuf; /* remember what buffer we started in */
4855 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856
4857 /*
4858 * Set current position only once for a global command.
4859 * If global_busy is set, setpcmark() will not do anything.
4860 * If there is an error, global_busy will be incremented.
4861 */
4862 setpcmark();
4863
4864 /* When the command writes a message, don't overwrite the command. */
4865 msg_didout = TRUE;
4866
Bram Moolenaard25bc232010-03-23 17:49:24 +01004867 sub_nsubs = 0;
4868 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 global_need_beginline = FALSE;
4870 global_busy = 1;
4871 old_lcount = curbuf->b_ml.ml_line_count;
4872 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
4873 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004874 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 ui_breakcheck();
4876 }
4877
4878 global_busy = 0;
4879 if (global_need_beginline)
4880 beginline(BL_WHITE | BL_FIX);
4881 else
4882 check_cursor(); /* cursor may be beyond the end of the line */
4883
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004884 /* the cursor may not have moved in the text but a change in a previous
4885 * line may move it on the screen */
4886 changed_line_abv_curs();
4887
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 /* If it looks like no message was written, allow overwriting the
4889 * command with the report for number of changes. */
4890 if (msg_col == 0 && msg_scrolled == 0)
4891 msg_didout = FALSE;
4892
Bram Moolenaar45667512007-05-10 19:24:43 +00004893 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02004894 * number of extra or deleted lines.
4895 * Don't report extra or deleted lines in the edge case where the buffer
4896 * we are in after execution is different from the buffer we started in. */
4897 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
4899}
4900
4901#ifdef FEAT_VIMINFO
Bram Moolenaarc3328162019-07-23 22:15:25 +02004902/*
4903 * Get the previous substitute pattern.
4904 */
4905 char_u *
4906get_old_sub(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907{
Bram Moolenaarc3328162019-07-23 22:15:25 +02004908 return old_sub;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909}
4910
Bram Moolenaarc3328162019-07-23 22:15:25 +02004911/*
4912 * Set the previous substitute pattern. "val" must be allocated.
4913 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 void
Bram Moolenaarc3328162019-07-23 22:15:25 +02004915set_old_sub(char_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916{
Bram Moolenaarc3328162019-07-23 22:15:25 +02004917 vim_free(old_sub);
4918 old_sub = val;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919}
Bram Moolenaardefa0672019-07-21 19:25:37 +02004920#endif // FEAT_VIMINFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00004922#if defined(EXITFREE) || defined(PROTO)
4923 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004924free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00004925{
4926 vim_free(old_sub);
4927}
4928#endif
4929
Bram Moolenaar4033c552017-09-16 20:54:51 +02004930#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931/*
4932 * Set up for a tagpreview.
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004933 * Makes the preview window the current window.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004934 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004936 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004937prepare_tagpreview(
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004938 int undo_sync, // sync undo when leaving the window
4939 int use_previewpopup, // use popup if 'previewpopup' set
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004940 use_popup_T use_popup) // use other popup window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941{
4942 win_T *wp;
4943
4944# ifdef FEAT_GUI
4945 need_mouse_correct = TRUE;
4946# endif
4947
4948 /*
4949 * If there is already a preview window open, use that one.
4950 */
4951 if (!curwin->w_p_pvw)
4952 {
Bram Moolenaar79648732019-07-18 21:43:07 +02004953# ifdef FEAT_TEXT_PROP
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004954 if (use_previewpopup && *p_pvp != NUL)
Bram Moolenaar79648732019-07-18 21:43:07 +02004955 {
4956 wp = popup_find_preview_window();
4957 if (wp != NULL)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004958 popup_set_wantpos_cursor(wp, wp->w_minwidth);
4959 }
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004960 else if (use_popup != USEPOPUP_NONE)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004961 {
4962 wp = popup_find_info_window();
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004963 if (wp != NULL)
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004964 {
4965 if (use_popup == USEPOPUP_NORMAL)
4966 popup_show(wp);
4967 else
4968 popup_hide(wp);
4969 }
Bram Moolenaar79648732019-07-18 21:43:07 +02004970 }
4971 else
4972# endif
4973 {
4974 FOR_ALL_WINDOWS(wp)
4975 if (wp->w_p_pvw)
4976 break;
4977 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00004979 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 else
4981 {
4982 /*
4983 * There is no preview window open yet. Create one.
4984 */
Bram Moolenaar79648732019-07-18 21:43:07 +02004985# ifdef FEAT_TEXT_PROP
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004986 if ((use_previewpopup && *p_pvp != NUL)
4987 || use_popup != USEPOPUP_NONE)
4988 return popup_create_preview_window(use_popup != USEPOPUP_NONE);
Bram Moolenaar79648732019-07-18 21:43:07 +02004989# endif
4990 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0) == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004991 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 curwin->w_p_pvw = TRUE;
4993 curwin->w_p_wfh = TRUE;
Bram Moolenaar79648732019-07-18 21:43:07 +02004994 RESET_BINDING(curwin); // don't take over 'scrollbind'
4995 // and 'cursorbind'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996# ifdef FEAT_DIFF
Bram Moolenaar79648732019-07-18 21:43:07 +02004997 curwin->w_p_diff = FALSE; // no 'diff'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998# endif
4999# ifdef FEAT_FOLDING
Bram Moolenaar79648732019-07-18 21:43:07 +02005000 curwin->w_p_fdc = 0; // no 'foldcolumn'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005002 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 }
5004 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005005 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006}
5007
5008#endif
5009
5010
5011/*
5012 * ":help": open a read-only window on a help file
5013 */
5014 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005015ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016{
5017 char_u *arg;
5018 char_u *tag;
5019 FILE *helpfd; /* file descriptor of help file */
5020 int n;
5021 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 int num_matches;
5024 char_u **matches;
5025 char_u *p;
5026 int empty_fnum = 0;
5027 int alt_fnum = 0;
5028 buf_T *buf;
5029#ifdef FEAT_MULTI_LANG
5030 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005031 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005033#ifdef FEAT_FOLDING
5034 int old_KeyTyped = KeyTyped;
5035#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
5037 if (eap != NULL)
5038 {
5039 /*
5040 * A ":help" command ends at the first LF, or at a '|' that is
5041 * followed by some text. Set nextcmd to the following command.
5042 */
5043 for (arg = eap->arg; *arg; ++arg)
5044 {
5045 if (*arg == '\n' || *arg == '\r'
5046 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5047 {
5048 *arg++ = NUL;
5049 eap->nextcmd = arg;
5050 break;
5051 }
5052 }
5053 arg = eap->arg;
5054
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005055 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005057 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 return;
5059 }
5060
5061 if (eap->skip) /* not executing commands */
5062 return;
5063 }
5064 else
5065 arg = (char_u *)"";
5066
5067 /* remove trailing blanks */
5068 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01005069 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 *p-- = NUL;
5071
5072#ifdef FEAT_MULTI_LANG
5073 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005074 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075#endif
5076
5077 /* When no argument given go to the index. */
5078 if (*arg == NUL)
5079 arg = (char_u *)"help.txt";
5080
5081 /*
5082 * Check if there is a match for the argument.
5083 */
5084 n = find_help_tags(arg, &num_matches, &matches,
5085 eap != NULL && eap->forceit);
5086
5087 i = 0;
5088#ifdef FEAT_MULTI_LANG
5089 if (n != FAIL && lang != NULL)
5090 /* Find first item with the requested language. */
5091 for (i = 0; i < num_matches; ++i)
5092 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005093 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 if (len > 3 && matches[i][len - 3] == '@'
5095 && STRICMP(matches[i] + len - 2, lang) == 0)
5096 break;
5097 }
5098#endif
5099 if (i >= num_matches || n == FAIL)
5100 {
5101#ifdef FEAT_MULTI_LANG
5102 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005103 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 else
5105#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005106 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 if (n != FAIL)
5108 FreeWild(num_matches, matches);
5109 return;
5110 }
5111
5112 /* The first match (in the requested language) is the best match. */
5113 tag = vim_strsave(matches[i]);
5114 FreeWild(num_matches, matches);
5115
5116#ifdef FEAT_GUI
5117 need_mouse_correct = TRUE;
5118#endif
5119
5120 /*
5121 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005122 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02005124 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005126 if (cmdmod.tab != 0)
5127 wp = NULL;
5128 else
Bram Moolenaar29323592016-07-24 22:04:11 +02005129 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005130 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005131 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5133 win_enter(wp, TRUE);
5134 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 {
5136 /*
5137 * There is no help window yet.
5138 * Try to open the file specified by the "helpfile" option.
5139 */
5140 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5141 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005142 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 goto erret;
5144 }
5145 fclose(helpfd);
5146
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005148 * specified, the current window is vertically split and
5149 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005152 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005155 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 if (curwin->w_height < p_hh)
5158 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159
5160 /*
5161 * Open help file (do_ecmd() will set b_help flag, readfile() will
5162 * set b_p_ro flag).
5163 * Set the alternate file to the previously edited file.
5164 */
5165 alt_fnum = curbuf->b_fnum;
5166 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005167 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02005168 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005169 if (!cmdmod.keepalt)
5170 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 empty_fnum = curbuf->b_fnum;
5172 }
5173 }
5174
5175 if (!p_im)
5176 restart_edit = 0; /* don't want insert mode in help file */
5177
Bram Moolenaar8f535582011-09-30 17:30:31 +02005178#ifdef FEAT_FOLDING
5179 /* Restore KeyTyped, setting 'filetype=help' may reset it.
5180 * It is needed for do_tag top open folds under the cursor. */
5181 KeyTyped = old_KeyTyped;
5182#endif
5183
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 if (tag != NULL)
5185 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5186
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005187 /* Delete the empty buffer if we're not using it. Careful: autocommands
5188 * may have jumped to another window, check that the buffer is not in a
5189 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5191 {
5192 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005193 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 wipe_buffer(buf, TRUE);
5195 }
5196
5197 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005198 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 curwin->w_alt_fnum = alt_fnum;
5200
5201erret:
5202 vim_free(tag);
5203}
5204
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005205/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005206 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005207 */
5208 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005209ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005210{
5211 win_T *win;
5212
5213 FOR_ALL_WINDOWS(win)
5214 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005215 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005216 {
5217 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005218 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005219 }
5220 }
5221}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005223#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5224/*
5225 * In an argument search for a language specifiers in the form "@xx".
5226 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5227 * Returns NULL if not found.
5228 */
5229 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005230check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005231{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005232 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005233
5234 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5235 && ASCII_ISALPHA(arg[len - 1]))
5236 {
5237 arg[len - 3] = NUL; /* remove the '@' */
5238 return arg + len - 2;
5239 }
5240 return NULL;
5241}
5242#endif
5243
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244/*
5245 * Return a heuristic indicating how well the given string matches. The
5246 * smaller the number, the better the match. This is the order of priorities,
5247 * from best match to worst match:
5248 * - Match with least alpha-numeric characters is better.
5249 * - Match with least total characters is better.
5250 * - Match towards the start is better.
5251 * - Match starting with "+" is worse (feature instead of command)
5252 * Assumption is made that the matched_string passed has already been found to
5253 * match some string for which help is requested. webb.
5254 */
5255 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005256help_heuristic(
5257 char_u *matched_string,
5258 int offset, /* offset for match */
5259 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260{
5261 int num_letters;
5262 char_u *p;
5263
5264 num_letters = 0;
5265 for (p = matched_string; *p; p++)
5266 if (ASCII_ISALNUM(*p))
5267 num_letters++;
5268
5269 /*
5270 * Multiply the number of letters by 100 to give it a much bigger
5271 * weighting than the number of characters.
5272 * If there only is a match while ignoring case, add 5000.
5273 * If the match starts in the middle of a word, add 10000 to put it
5274 * somewhere in the last half.
5275 * If the match is more than 2 chars from the start, multiply by 200 to
5276 * put it after matches at the start.
5277 */
5278 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5279 && ASCII_ISALNUM(matched_string[offset - 1]))
5280 offset += 10000;
5281 else if (offset > 2)
5282 offset *= 200;
5283 if (wrong_case)
5284 offset += 5000;
5285 /* Features are less interesting than the subjects themselves, but "+"
5286 * alone is not a feature. */
5287 if (matched_string[0] == '+' && matched_string[1] != NUL)
5288 offset += 100;
5289 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5290}
5291
5292/*
5293 * Compare functions for qsort() below, that checks the help heuristics number
5294 * that has been put after the tagname by find_tags().
5295 */
5296 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005297help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298{
5299 char *p1;
5300 char *p2;
5301
5302 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5303 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5304 return strcmp(p1, p2);
5305}
5306
5307/*
5308 * Find all help tags matching "arg", sort them and return in matches[], with
5309 * the number of matches in num_matches.
5310 * The matches will be sorted with a "best" match algorithm.
5311 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5312 */
5313 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005314find_help_tags(
5315 char_u *arg,
5316 int *num_matches,
5317 char_u ***matches,
5318 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319{
5320 char_u *s, *d;
5321 int i;
5322 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005323 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005324 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005325 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5326 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005327 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005328 "[count]", "[quotex]",
5329 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005330 "[pattern]", "\\|", "\\%$",
5331 "s/\\~", "s/\\U", "s/\\L",
5332 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005334 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005335 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005336 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5337 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005338 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005339 "\\[count]", "\\[quotex]",
5340 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005341 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02005342 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005343 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005344 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
5345 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 int flags;
5347
5348 d = IObuff; /* assume IObuff is long enough! */
5349
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005350 if (STRNICMP(arg, "expr-", 5) == 0)
5351 {
5352 // When the string starting with "expr-" and containing '?' and matches
Bram Moolenaar9ca25082019-10-05 11:30:09 +02005353 // the table, it is taken literally (but ~ is escaped). Otherwise '?'
5354 // is recognized as a wildcard.
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005355 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
5356 if (STRCMP(arg + 5, expr_table[i]) == 0)
5357 {
Bram Moolenaar9ca25082019-10-05 11:30:09 +02005358 int si = 0, di = 0;
5359
5360 for (;;)
5361 {
5362 if (arg[si] == '~')
5363 d[di++] = '\\';
5364 d[di++] = arg[si];
5365 if (arg[si] == NUL)
5366 break;
5367 ++si;
5368 }
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005369 break;
5370 }
5371 }
5372 else
5373 {
5374 // Recognize a few exceptions to the rule. Some strings that contain
5375 // '*' with "star". Otherwise '*' is recognized as a wildcard.
5376 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
5377 if (STRCMP(arg, mtable[i]) == 0)
5378 {
5379 STRCPY(d, rtable[i]);
5380 break;
5381 }
5382 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383
5384 if (i < 0) /* no match in table */
5385 {
5386 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5387 * Also replace "\%^" and "\%(", they match every tag too.
5388 * Also "\zs", "\z1", etc.
5389 * Also "\@<", "\@=", "\@<=", etc.
5390 * And also "\_$" and "\_^". */
5391 if (arg[0] == '\\'
5392 && ((arg[1] != NUL && arg[2] == NUL)
5393 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5394 && arg[2] != NUL)))
5395 {
5396 STRCPY(d, "/\\\\");
5397 STRCPY(d + 3, arg + 1);
5398 /* Check for "/\\_$", should be "/\\_\$" */
5399 if (d[3] == '_' && d[4] == '$')
5400 STRCPY(d + 4, "\\$");
5401 }
5402 else
5403 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005404 /* Replace:
5405 * "[:...:]" with "\[:...:]"
5406 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02005407 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005408 */
5409 if ((arg[0] == '[' && (arg[1] == ':'
5410 || (arg[1] == '+' && arg[2] == '+')))
5411 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 *d++ = '\\';
5413
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01005414 /*
5415 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
5416 */
5417 if (*arg == '(' && arg[1] == '\'')
5418 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 for (s = arg; *s; ++s)
5420 {
5421 /*
5422 * Replace "|" with "bar" and '"' with "quote" to match the name of
5423 * the tags for these commands.
5424 * Replace "*" with ".*" and "?" with "." to match command line
5425 * completion.
5426 * Insert a backslash before '~', '$' and '.' to avoid their
5427 * special meaning.
5428 */
5429 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5430 break;
5431 switch (*s)
5432 {
5433 case '|': STRCPY(d, "bar");
5434 d += 3;
5435 continue;
5436 case '"': STRCPY(d, "quote");
5437 d += 5;
5438 continue;
5439 case '*': *d++ = '.';
5440 break;
5441 case '?': *d++ = '.';
5442 continue;
5443 case '$':
5444 case '.':
5445 case '~': *d++ = '\\';
5446 break;
5447 }
5448
5449 /*
5450 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5451 * ":help i_^_CTRL-D" work.
5452 * Insert '-' before and after "CTRL-X" when applicable.
5453 */
5454 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5455 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5456 {
Bram Moolenaard82db602013-08-07 15:24:41 +02005457 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
5458 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 STRCPY(d, "CTRL-");
5460 d += 5;
5461 if (*s < ' ')
5462 {
5463#ifdef EBCDIC
5464 *d++ = CtrlChar(*s);
5465#else
5466 *d++ = *s + '@';
5467#endif
5468 if (d[-1] == '\\')
5469 *d++ = '\\'; /* double a backslash */
5470 }
5471 else
5472 *d++ = *++s;
5473 if (s[1] != NUL && s[1] != '_')
5474 *d++ = '_'; /* append a '_' */
5475 continue;
5476 }
5477 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5478 *d++ = '\\';
5479
5480 /*
5481 * Insert a backslash before a backslash after a slash, for search
5482 * pattern tags: "/\|" --> "/\\|".
5483 */
5484 else if (s[0] == '\\' && s[1] != '\\'
5485 && *arg == '/' && s == arg + 1)
5486 *d++ = '\\';
5487
5488 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5489 * "CTRL-\_CTRL-N" */
5490 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5491 {
5492 STRCPY(d, "CTRL-\\\\");
5493 d += 7;
5494 s += 6;
5495 }
5496
5497 *d++ = *s;
5498
5499 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02005500 * If tag contains "({" or "([", tag terminates at the "(".
5501 * This is for help on functions, e.g.: abs({expr}).
5502 */
5503 if (*s == '(' && (s[1] == '{' || s[1] =='['))
5504 break;
5505
5506 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 * If tag starts with ', toss everything after a second '. Fixes
5508 * CTRL-] on 'option'. (would include the trailing '.').
5509 */
5510 if (*s == '\'' && s > arg && *arg == '\'')
5511 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02005512 /* Also '{' and '}'. */
5513 if (*s == '}' && s > arg && *arg == '{')
5514 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 }
5516 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02005517
5518 if (*IObuff == '`')
5519 {
5520 if (d > IObuff + 2 && d[-1] == '`')
5521 {
5522 /* remove the backticks from `command` */
5523 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5524 d[-2] = NUL;
5525 }
5526 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
5527 {
5528 /* remove the backticks and comma from `command`, */
5529 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5530 d[-3] = NUL;
5531 }
5532 else if (d > IObuff + 4 && d[-3] == '`'
5533 && d[-2] == '\\' && d[-1] == '.')
5534 {
5535 /* remove the backticks and dot from `command`\. */
5536 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5537 d[-4] = NUL;
5538 }
5539 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 }
5541 }
5542
5543 *matches = (char_u **)"";
5544 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02005545 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 if (keep_lang)
5547 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005548 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005550 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 /* Sort the matches found on the heuristic number that is after the
5552 * tag name. */
5553 qsort((void *)*matches, (size_t)*num_matches,
5554 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005555 /* Delete more than TAG_MANY to reduce the size of the listing. */
5556 while (*num_matches > TAG_MANY)
5557 vim_free((*matches)[--*num_matches]);
5558 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 return OK;
5560}
5561
5562/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005563 * Called when starting to edit a buffer for a help file.
5564 */
5565 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005566prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005567{
5568 char_u *p;
5569
5570 curbuf->b_help = TRUE;
5571#ifdef FEAT_QUICKFIX
5572 set_string_option_direct((char_u *)"buftype", -1,
5573 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
5574#endif
5575
5576 /*
5577 * Always set these options after jumping to a help tag, because the
5578 * user may have an autocommand that gets in the way.
5579 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
5580 * latin1 word characters (for translated help files).
5581 * Only set it when needed, buf_init_chartab() is some work.
5582 */
5583 p =
5584#ifdef EBCDIC
5585 (char_u *)"65-255,^*,^|,^\"";
5586#else
5587 (char_u *)"!-~,^*,^|,^\",192-255";
5588#endif
5589 if (STRCMP(curbuf->b_p_isk, p) != 0)
5590 {
5591 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
5592 check_buf_options(curbuf);
5593 (void)buf_init_chartab(curbuf, FALSE);
5594 }
5595
Bram Moolenaar0b105412014-11-30 13:34:23 +01005596#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005597 /* Don't use the global foldmethod.*/
5598 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
5599 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01005600#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005601
5602 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
5603 curwin->w_p_list = FALSE; /* no list mode */
5604
5605 curbuf->b_p_ma = FALSE; /* not modifiable */
5606 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
5607 curwin->w_p_nu = 0; /* no line numbers */
5608 curwin->w_p_rnu = 0; /* no relative line numbers */
5609 RESET_BINDING(curwin); /* no scroll or cursor binding */
5610#ifdef FEAT_ARABIC
5611 curwin->w_p_arab = FALSE; /* no arabic mode */
5612#endif
5613#ifdef FEAT_RIGHTLEFT
5614 curwin->w_p_rl = FALSE; /* help window is left-to-right */
5615#endif
5616#ifdef FEAT_FOLDING
5617 curwin->w_p_fen = FALSE; /* No folding in the help window */
5618#endif
5619#ifdef FEAT_DIFF
5620 curwin->w_p_diff = FALSE; /* No 'diff' */
5621#endif
5622#ifdef FEAT_SPELL
5623 curwin->w_p_spell = FALSE; /* No spell checking */
5624#endif
5625
5626 set_buflisted(FALSE);
5627}
5628
5629/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 * After reading a help file: May cleanup a help buffer when syntax
5631 * highlighting is not used.
5632 */
5633 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005634fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635{
5636 linenr_T lnum;
5637 char_u *line;
5638 int in_example = FALSE;
5639 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005640 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 char_u *p;
5642 char_u *rt;
5643 int mustfree;
5644
Bram Moolenaar90492982017-06-22 14:16:31 +02005645 /* Set filetype to "help" if still needed. */
5646 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02005647 {
5648 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02005649 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02005650 --curbuf_lock;
5651 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652
5653#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02005654 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655#endif
5656 {
5657 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5658 {
5659 line = ml_get_buf(curbuf, lnum, FALSE);
5660 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005661 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 {
5663 /* End of example: non-white or '<' in first column. */
5664 if (line[0] == '<')
5665 {
5666 /* blank-out a '<' in the first column */
5667 line = ml_get_buf(curbuf, lnum, TRUE);
5668 line[0] = ' ';
5669 }
5670 in_example = FALSE;
5671 }
5672 if (!in_example && len > 0)
5673 {
5674 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5675 {
5676 /* blank-out a '>' in the last column (start of example) */
5677 line = ml_get_buf(curbuf, lnum, TRUE);
5678 line[len - 1] = ' ';
5679 in_example = TRUE;
5680 }
5681 else if (line[len - 1] == '~')
5682 {
5683 /* blank-out a '~' at the end of line (header marker) */
5684 line = ml_get_buf(curbuf, lnum, TRUE);
5685 line[len - 1] = ' ';
5686 }
5687 }
5688 }
5689 }
5690
5691 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005692 * In the "help.txt" and "help.abx" file, add the locally added help
5693 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005695 fname = gettail(curbuf->b_fname);
5696 if (fnamecmp(fname, "help.txt") == 0
5697#ifdef FEAT_MULTI_LANG
5698 || (fnamencmp(fname, "help.", 5) == 0
5699 && ASCII_ISALPHA(fname[5])
5700 && ASCII_ISALPHA(fname[6])
5701 && TOLOWER_ASC(fname[7]) == 'x'
5702 && fname[8] == NUL)
5703#endif
5704 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 {
5706 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5707 {
5708 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005709 if (strstr((char *)line, "*local-additions*") == NULL)
5710 continue;
5711
5712 /* Go through all directories in 'runtimepath', skipping
5713 * $VIMRUNTIME. */
5714 p = p_rtp;
5715 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005717 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5718 mustfree = FALSE;
5719 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaar99499b12019-05-23 21:35:48 +02005720 if (rt != NULL &&
5721 fullpathcmp(rt, NameBuff, FALSE, TRUE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005723 int fcount;
5724 char_u **fnames;
5725 FILE *fd;
5726 char_u *s;
5727 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005728 vimconv_T vc;
5729 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005731 /* Find all "doc/ *.txt" files in this directory. */
5732 add_pathsep(NameBuff);
5733#ifdef FEAT_MULTI_LANG
5734 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005736 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005738 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5739 &fnames, EW_FILE|EW_SILENT) == OK
5740 && fcount > 0)
5741 {
5742#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005743 int i1, i2;
5744 char_u *f1, *f2;
5745 char_u *t1, *t2;
5746 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005747
5748 /* If foo.abx is found use it instead of foo.txt in
5749 * the same directory. */
5750 for (i1 = 0; i1 < fcount; ++i1)
5751 {
5752 for (i2 = 0; i2 < fcount; ++i2)
5753 {
5754 if (i1 == i2)
5755 continue;
5756 if (fnames[i1] == NULL || fnames[i2] == NULL)
5757 continue;
5758 f1 = fnames[i1];
5759 f2 = fnames[i2];
5760 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005761 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005762 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005763 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02005764 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005765 continue;
5766 if (fnamecmp(e1, ".txt") != 0
5767 && fnamecmp(e1, fname + 4) != 0)
5768 {
5769 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005770 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005771 continue;
5772 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005773 if (e1 - f1 != e2 - f2
5774 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005775 continue;
5776 if (fnamecmp(e1, ".txt") == 0
5777 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005778 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005779 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005782#endif
5783 for (fi = 0; fi < fcount; ++fi)
5784 {
5785 if (fnames[fi] == NULL)
5786 continue;
5787 fd = mch_fopen((char *)fnames[fi], "r");
5788 if (fd != NULL)
5789 {
5790 vim_fgets(IObuff, IOSIZE, fd);
5791 if (IObuff[0] == '*'
5792 && (s = vim_strchr(IObuff + 1, '*'))
5793 != NULL)
5794 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005795 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01005796
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005797 /* Change tag definition to a
5798 * reference and remove <CR>/<NL>. */
5799 IObuff[0] = '|';
5800 *s = '|';
5801 while (*s != NUL)
5802 {
5803 if (*s == '\r' || *s == '\n')
5804 *s = NUL;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005805 /* The text is utf-8 when a byte
5806 * above 127 is found and no
5807 * illegal byte sequence is found.
5808 */
5809 if (*s >= 0x80 && this_utf != FALSE)
5810 {
5811 int l;
5812
5813 this_utf = TRUE;
5814 l = utf_ptr2len(s);
5815 if (l == 1)
5816 this_utf = FALSE;
5817 s += l - 1;
5818 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005819 ++s;
5820 }
Bram Moolenaar13505972019-01-24 15:04:48 +01005821
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005822 /* The help file is latin1 or utf-8;
5823 * conversion to the current
5824 * 'encoding' may be required. */
5825 vc.vc_type = CONV_NONE;
5826 convert_setup(&vc, (char_u *)(
5827 this_utf == TRUE ? "utf-8"
5828 : "latin1"), p_enc);
5829 if (vc.vc_type == CONV_NONE)
5830 /* No conversion needed. */
5831 cp = IObuff;
5832 else
5833 {
5834 /* Do the conversion. If it fails
5835 * use the unconverted text. */
5836 cp = string_convert(&vc, IObuff,
5837 NULL);
5838 if (cp == NULL)
5839 cp = IObuff;
5840 }
5841 convert_setup(&vc, NULL, NULL);
5842
5843 ml_append(lnum, cp, (colnr_T)0, FALSE);
5844 if (cp != IObuff)
5845 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005846 ++lnum;
5847 }
5848 fclose(fd);
5849 }
5850 }
5851 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005854 if (mustfree)
5855 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005857 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 }
5859 }
5860}
5861
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005862/*
5863 * ":exusage"
5864 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005865 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005866ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005867{
5868 do_cmdline_cmd((char_u *)"help ex-cmd-index");
5869}
5870
5871/*
5872 * ":viusage"
5873 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005874 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005875ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005876{
5877 do_cmdline_cmd((char_u *)"help normal-index");
5878}
5879
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01005881 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005884helptags_one(
5885 char_u *dir, /* doc directory */
5886 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
5887 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
5888 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889{
5890 FILE *fd_tags;
5891 FILE *fd;
5892 garray_T ga;
5893 int filecount;
5894 char_u **files;
5895 char_u *p1, *p2;
5896 int fi;
5897 char_u *s;
5898 int i;
5899 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01005900 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 int utf8 = MAYBE;
5902 int this_utf8;
5903 int firstline;
5904 int mix = FALSE; /* detected mixed encodings */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905
5906 /*
5907 * Find all *.txt files.
5908 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01005909 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01005911 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 STRCAT(NameBuff, ext);
5913 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
5914 EW_FILE|EW_SILENT) == FAIL
5915 || filecount == 0)
5916 {
5917 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005918 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 return;
5920 }
5921
5922 /*
5923 * Open the tags file for writing.
5924 * Do this before scanning through all the files.
5925 */
5926 STRCPY(NameBuff, dir);
5927 add_pathsep(NameBuff);
5928 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005929 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 if (fd_tags == NULL)
5931 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005932 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 FreeWild(filecount, files);
5934 return;
5935 }
5936
5937 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00005938 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
5939 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 */
5941 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00005942 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
Bram Moolenaar99499b12019-05-23 21:35:48 +02005943 dir, FALSE, TRUE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 {
5945 if (ga_grow(&ga, 1) == FAIL)
5946 got_int = TRUE;
5947 else
5948 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005949 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 if (s == NULL)
5951 got_int = TRUE;
5952 else
5953 {
5954 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
5955 ((char_u **)ga.ga_data)[ga.ga_len] = s;
5956 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 }
5958 }
5959 }
5960
5961 /*
5962 * Go over all the files and extract the tags.
5963 */
5964 for (fi = 0; fi < filecount && !got_int; ++fi)
5965 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005966 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 if (fd == NULL)
5968 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005969 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 continue;
5971 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01005972 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
5976 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 if (firstline)
5978 {
5979 /* Detect utf-8 file by a non-ASCII char in the first line. */
5980 this_utf8 = MAYBE;
5981 for (s = IObuff; *s != NUL; ++s)
5982 if (*s >= 0x80)
5983 {
5984 int l;
5985
5986 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005987 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 if (l == 1)
5989 {
5990 /* Illegal UTF-8 byte sequence. */
5991 this_utf8 = FALSE;
5992 break;
5993 }
5994 s += l - 1;
5995 }
5996 if (this_utf8 == MAYBE) /* only ASCII characters found */
5997 this_utf8 = FALSE;
5998 if (utf8 == MAYBE) /* first file */
5999 utf8 = this_utf8;
6000 else if (utf8 != this_utf8)
6001 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006002 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 mix = !got_int;
6004 got_int = TRUE;
6005 }
6006 firstline = FALSE;
6007 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6009 while (p1 != NULL)
6010 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02006011 /* Use vim_strbyte() instead of vim_strchr() so that when
6012 * 'encoding' is dbcs it still works, don't find '*' in the
6013 * second byte. */
6014 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6016 {
6017 for (s = p1 + 1; s < p2; ++s)
6018 if (*s == ' ' || *s == '\t' || *s == '|')
6019 break;
6020
6021 /*
6022 * Only accept a *tag* when it consists of valid
6023 * characters, there is white space before it and is
6024 * followed by a white character or end-of-line.
6025 */
6026 if (s == p2
6027 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6028 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6029 || s[1] == '\0'))
6030 {
6031 *p2 = '\0';
6032 ++p1;
6033 if (ga_grow(&ga, 1) == FAIL)
6034 {
6035 got_int = TRUE;
6036 break;
6037 }
Bram Moolenaar964b3742019-05-24 18:54:09 +02006038 s = alloc(p2 - p1 + STRLEN(fname) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 if (s == NULL)
6040 {
6041 got_int = TRUE;
6042 break;
6043 }
6044 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6045 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 sprintf((char *)s, "%s\t%s", p1, fname);
6047
6048 /* find next '*' */
6049 p2 = vim_strchr(p2 + 1, '*');
6050 }
6051 }
6052 p1 = p2;
6053 }
6054 line_breakcheck();
6055 }
6056
6057 fclose(fd);
6058 }
6059
6060 FreeWild(filecount, files);
6061
6062 if (!got_int)
6063 {
6064 /*
6065 * Sort the tags.
6066 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02006067 if (ga.ga_data != NULL)
6068 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069
6070 /*
6071 * Check for duplicates.
6072 */
6073 for (i = 1; i < ga.ga_len; ++i)
6074 {
6075 p1 = ((char_u **)ga.ga_data)[i - 1];
6076 p2 = ((char_u **)ga.ga_data)[i];
6077 while (*p1 == *p2)
6078 {
6079 if (*p2 == '\t')
6080 {
6081 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006082 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6084 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006085 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 *p2 = '\t';
6087 break;
6088 }
6089 ++p1;
6090 ++p2;
6091 }
6092 }
6093
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 if (utf8 == TRUE)
6095 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096
6097 /*
6098 * Write the tags into the file.
6099 */
6100 for (i = 0; i < ga.ga_len; ++i)
6101 {
6102 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006103 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006105 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 else
6107 {
6108 fprintf(fd_tags, "%s\t/*", s);
6109 for (p1 = s; *p1 != '\t'; ++p1)
6110 {
6111 /* insert backslash before '\\' and '/' */
6112 if (*p1 == '\\' || *p1 == '/')
6113 putc('\\', fd_tags);
6114 putc(*p1, fd_tags);
6115 }
6116 fprintf(fd_tags, "*\n");
6117 }
6118 }
6119 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 if (mix)
6121 got_int = FALSE; /* continue with other languages */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122
6123 for (i = 0; i < ga.ga_len; ++i)
6124 vim_free(((char_u **)ga.ga_data)[i]);
6125 ga_clear(&ga);
6126 fclose(fd_tags); /* there is no check for an error... */
6127}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006129/*
6130 * Generate tags in one help directory, taking care of translations.
6131 */
6132 static void
6133do_helptags(char_u *dirname, int add_help_tags)
6134{
6135#ifdef FEAT_MULTI_LANG
6136 int len;
6137 int i, j;
6138 garray_T ga;
6139 char_u lang[2];
6140 char_u ext[5];
6141 char_u fname[8];
6142 int filecount;
6143 char_u **files;
6144
6145 /* Get a list of all files in the help directory and in subdirectories. */
6146 STRCPY(NameBuff, dirname);
6147 add_pathsep(NameBuff);
6148 STRCAT(NameBuff, "**");
6149 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6150 EW_FILE|EW_SILENT) == FAIL
6151 || filecount == 0)
6152 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006153 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006154 return;
6155 }
6156
6157 /* Go over all files in the directory to find out what languages are
6158 * present. */
6159 ga_init2(&ga, 1, 10);
6160 for (i = 0; i < filecount; ++i)
6161 {
6162 len = (int)STRLEN(files[i]);
6163 if (len > 4)
6164 {
6165 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6166 {
6167 /* ".txt" -> language "en" */
6168 lang[0] = 'e';
6169 lang[1] = 'n';
6170 }
6171 else if (files[i][len - 4] == '.'
6172 && ASCII_ISALPHA(files[i][len - 3])
6173 && ASCII_ISALPHA(files[i][len - 2])
6174 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6175 {
6176 /* ".abx" -> language "ab" */
6177 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6178 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6179 }
6180 else
6181 continue;
6182
6183 /* Did we find this language already? */
6184 for (j = 0; j < ga.ga_len; j += 2)
6185 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6186 break;
6187 if (j == ga.ga_len)
6188 {
6189 /* New language, add it. */
6190 if (ga_grow(&ga, 2) == FAIL)
6191 break;
6192 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6193 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6194 }
6195 }
6196 }
6197
6198 /*
6199 * Loop over the found languages to generate a tags file for each one.
6200 */
6201 for (j = 0; j < ga.ga_len; j += 2)
6202 {
6203 STRCPY(fname, "tags-xx");
6204 fname[5] = ((char_u *)ga.ga_data)[j];
6205 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6206 if (fname[5] == 'e' && fname[6] == 'n')
6207 {
6208 /* English is an exception: use ".txt" and "tags". */
6209 fname[4] = NUL;
6210 STRCPY(ext, ".txt");
6211 }
6212 else
6213 {
6214 /* Language "ab" uses ".abx" and "tags-ab". */
6215 STRCPY(ext, ".xxx");
6216 ext[1] = fname[5];
6217 ext[2] = fname[6];
6218 }
6219 helptags_one(dirname, ext, fname, add_help_tags);
6220 }
6221
6222 ga_clear(&ga);
6223 FreeWild(filecount, files);
6224
6225#else
6226 /* No language support, just use "*.txt" and "tags". */
6227 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6228#endif
6229}
6230
6231 static void
6232helptags_cb(char_u *fname, void *cookie)
6233{
6234 do_helptags(fname, *(int *)cookie);
6235}
6236
6237/*
6238 * ":helptags"
6239 */
6240 void
6241ex_helptags(exarg_T *eap)
6242{
6243 expand_T xpc;
6244 char_u *dirname;
6245 int add_help_tags = FALSE;
6246
6247 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01006248 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006249 {
6250 add_help_tags = TRUE;
6251 eap->arg = skipwhite(eap->arg + 3);
6252 }
6253
6254 if (STRCMP(eap->arg, "ALL") == 0)
6255 {
6256 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
6257 helptags_cb, &add_help_tags);
6258 }
6259 else
6260 {
6261 ExpandInit(&xpc);
6262 xpc.xp_context = EXPAND_DIRECTORIES;
6263 dirname = ExpandOne(&xpc, eap->arg, NULL,
6264 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6265 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006266 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006267 else
6268 do_helptags(dirname, add_help_tags);
6269 vim_free(dirname);
6270 }
6271}
6272
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006273/*
6274 * Make the user happy.
6275 */
6276 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006277ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006278{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006279 static char *code[] = {
6280 "\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$",
6281 "\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"
6282 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006283 char *p;
6284 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006285 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006286
6287 msg_start();
6288 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006289 for (i = 0; i < 2; ++i)
6290 for (p = code[i]; *p != NUL; ++p)
6291 if (*p == 'x')
6292 msg_putchar('\n');
6293 else
6294 for (n = *p++; n > 0; --n)
6295 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01006296 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006297 else
6298 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006299 msg_clr_eos();
6300}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302/*
6303 * ":drop"
6304 * Opens the first argument in a window. When there are two or more arguments
6305 * the argument list is redefined.
6306 */
6307 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006308ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309{
6310 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 win_T *wp;
6312 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006313 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314
6315 /*
6316 * Check if the first argument is already being edited in a window. If
6317 * so, jump to that window.
6318 * We would actually need to check all arguments, but that's complicated
6319 * and mostly only one file is dropped.
6320 * This also ignores wildcards, since it is very unlikely the user is
6321 * editing a file name with a wildcard character.
6322 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006323 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00006325 /*
6326 * Expanding wildcards may result in an empty argument list. E.g. when
6327 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
6328 * already did an error message for this.
6329 */
6330 if (ARGCOUNT == 0)
6331 return;
6332
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006333 if (cmdmod.tab)
6334 {
6335 /* ":tab drop file ...": open a tab for each argument that isn't
6336 * edited in a window yet. It's like ":tab all" but without closing
6337 * windows or tabs. */
6338 ex_all(eap);
6339 }
6340 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006341 {
6342 /* ":drop file ...": Edit the first argument. Jump to an existing
6343 * window if possible, edit in current window if the current buffer
6344 * can be abandoned, otherwise open a new window. */
6345 buf = buflist_findnr(ARGLIST[0].ae_fnum);
6346
6347 FOR_ALL_TAB_WINDOWS(tp, wp)
6348 {
6349 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006351 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 return;
6354 }
6355 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006357 /*
6358 * Check whether the current buffer is changed. If so, we will need
6359 * to split the current window or data could be lost.
6360 * Skip the check if the 'hidden' option is set, as in this case the
6361 * buffer won't be lost.
6362 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02006363 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006364 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006365 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01006366 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006367 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006368 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006370 /* Fake a ":sfirst" or ":first" command edit the first argument. */
6371 if (split)
6372 {
6373 eap->cmdidx = CMD_sfirst;
6374 eap->cmd[0] = 's';
6375 }
6376 else
6377 eap->cmdidx = CMD_first;
6378 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006381
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006382/*
6383 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
6384 * Put the start of the pattern in "*s", unless "s" is NULL.
6385 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
6386 * If "s" is not NULL terminate the pattern with a NUL.
6387 * Return a pointer to the char just past the pattern plus flags.
6388 */
6389 char_u *
6390skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
6391{
6392 int c;
6393
6394 if (vim_isIDc(*p))
6395 {
6396 /* ":vimgrep pattern fname" */
6397 if (s != NULL)
6398 *s = p;
6399 p = skiptowhite(p);
6400 if (s != NULL && *p != NUL)
6401 *p++ = NUL;
6402 }
6403 else
6404 {
6405 /* ":vimgrep /pattern/[g][j] fname" */
6406 if (s != NULL)
6407 *s = p + 1;
6408 c = *p;
6409 p = skip_regexp(p + 1, c, TRUE, NULL);
6410 if (*p != c)
6411 return NULL;
6412
6413 /* Truncate the pattern. */
6414 if (s != NULL)
6415 *p = NUL;
6416 ++p;
6417
6418 /* Find the flags */
6419 while (*p == 'g' || *p == 'j')
6420 {
6421 if (flags != NULL)
6422 {
6423 if (*p == 'g')
6424 *flags |= VGR_GLOBAL;
6425 else
6426 *flags |= VGR_NOJUMP;
6427 }
6428 ++p;
6429 }
6430 }
6431 return p;
6432}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006433
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006434#if defined(FEAT_EVAL) || defined(PROTO)
6435/*
6436 * List v:oldfiles in a nice way.
6437 */
6438 void
6439ex_oldfiles(exarg_T *eap UNUSED)
6440{
6441 list_T *l = get_vim_var_list(VV_OLDFILES);
6442 listitem_T *li;
6443 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006444 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006445
6446 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006447 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006448 else
6449 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006450 msg_start();
6451 msg_scroll = TRUE;
6452 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
6453 {
6454 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006455 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02006456 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006457 {
6458 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01006459 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006460 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02006461 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006462 msg_putchar('\n');
6463 out_flush(); /* output one line at a time */
6464 ui_breakcheck();
6465 }
6466 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006467
6468 /* Assume "got_int" was set to truncate the listing. */
6469 got_int = FALSE;
6470
6471# ifdef FEAT_BROWSE_CMD
6472 if (cmdmod.browse)
6473 {
6474 quit_more = FALSE;
6475 nr = prompt_for_number(FALSE);
6476 msg_starthere();
6477 if (nr > 0)
6478 {
6479 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
6480 (long)nr);
6481
6482 if (p != NULL)
6483 {
6484 p = expand_env_save(p);
6485 eap->arg = p;
6486 eap->cmdidx = CMD_edit;
6487 cmdmod.browse = FALSE;
6488 do_exedit(eap, NULL);
6489 vim_free(p);
6490 }
6491 }
6492 }
6493# endif
6494 }
6495}
6496#endif