blob: 777f1490cfd5e1da0064a7f7819b7e368b8c482d [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 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +010060 if (c == NL) // NUL is stored as NL
Bram Moolenaar071d4272004-06-13 20:20:40 +000061 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000062 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
Bram Moolenaar217e1b82019-12-01 21:41:28 +010063 cval = NL; // NL is stored as CR
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000064 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 Moolenaar217e1b82019-12-01 21:41:28 +0100101 // Repeat for combining characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
103 {
104 len = (int)STRLEN(IObuff);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100105 // This assumes every multi-byte char is printable...
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 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 )
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100114 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 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100156 // switch left and right aligning
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 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;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100166 if (eap->cmdidx == CMD_left) // width is used for new indent
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 {
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 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100192 if (eap->cmdidx == CMD_left) // left align
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193 new_indent = indent;
194 else
195 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100196 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100200 if (len <= 0) // skip blank lines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 continue;
202
203 if (eap->cmdidx == CMD_center)
204 new_indent = (width - len) / 2;
205 else
206 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100207 new_indent = width - len; // right align
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208
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;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100235 (void)set_indent(new_indent, 0); // set indent
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 }
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 Moolenaar217e1b82019-12-01 21:41:28 +0100277// Buffer for two lines used during sorting. They are allocated to
278// contain the longest line being sorted.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000279static char_u *sortbuf1;
280static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000281
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100282static int sort_ic; // ignore case
283static int sort_nr; // sort on number
284static int sort_rx; // sort on regex instead of skipping it
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100285#ifdef FEAT_FLOAT
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100286static int sort_flt; // sort on floating number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100287#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000288
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100289static int sort_abort; // flag to indicate if sorting has been interrupted
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000290
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100291// Struct to store info to be sorted.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000292typedef 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 Moolenaar217e1b82019-12-01 21:41:28 +0100321 // If the user interrupts, there's no way to stop qsort() immediately, but
322 // 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 Moolenaar217e1b82019-12-01 21:41:28 +0100345 // 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
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100359 // 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;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100381 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 Moolenaar217e1b82019-12-01 21:41:28 +0100390 // Sorting one line is really quick!
Bram Moolenaar48c99162008-02-18 18:42:52 +0000391 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 Moolenaar217e1b82019-12-01 21:41:28 +0100445 else if (*p == '"') // comment start
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000446 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 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +0200454 s = skip_regexp_err(p + 1, *p, TRUE);
455 if (s == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000456 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000457 *s = NUL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100458 // Use last search pattern if sort pattern is empty.
Bram Moolenaar210f3702013-03-07 16:41:30 +0100459 if (s == p + 1)
460 {
461 if (last_search_pat() == NULL)
462 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100463 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100464 goto sortend;
465 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000466 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100467 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000468 else
469 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000470 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000471 goto sortend;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100472 p = s; // continue after the regexp
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000473 regmatch.rm_ic = p_ic;
474 }
475 else
476 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100477 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000478 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000479 }
480 }
481
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100482 // Can only have one of 'n', 'b', 'o' and 'x'.
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100483 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000484 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100485 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000486 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000487 }
488
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100489 // From here on "sort_nr" is used as a flag for any integer number
490 // sorting.
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100491 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000492
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000493 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000494 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000495 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000496 * When sorting on strings "start_col_nr" is the offset in the line, for
497 * numbers sorting it's the number to sort on. This means the pattern
498 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000499 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000500 */
501 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
502 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000503 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000504 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000505 if (maxlen < len)
506 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000508 start_col = 0;
509 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000510 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 {
512 if (sort_rx)
513 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000514 start_col = (colnr_T)(regmatch.startp[0] - s);
515 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000516 }
517 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000518 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000519 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000520 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000521 if (regmatch.regprog != NULL)
522 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000523
Bram Moolenaar937204a2016-01-30 23:37:38 +0100524 if (sort_nr
525#ifdef FEAT_FLOAT
526 || sort_flt
527#endif
528 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000529 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100530 // Make sure vim_str2nr doesn't read any digits past the end
531 // of the match, by temporarily terminating the string there
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000532 s2 = s + end_col;
533 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200534 *s2 = NUL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100535 // Sorting on number: Store the number itself.
Bram Moolenaar1387a602008-07-24 19:31:11 +0000536 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100537 if (sort_nr)
538 {
539 if (sort_what & STR2NR_HEX)
540 s = skiptohex(p);
541 else if (sort_what & STR2NR_BIN)
542 s = skiptobin(p);
543 else
544 s = skiptodigit(p);
545 if (s > p && s[-1] == '-')
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100546 --s; // include preceding negative sign
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100547 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100548 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100549 // line without number should sort before any number
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100550 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
551 nrs[lnum - eap->line1].st_u.num.value = 0;
552 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100553 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100554 {
555 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100556 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaar16e9b852019-05-19 19:59:35 +0200557 &nrs[lnum - eap->line1].st_u.num.value,
558 NULL, 0, FALSE);
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100559 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100560 }
561#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000562 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100563 {
564 s = skipwhite(p);
565 if (*s == '+')
566 s = skipwhite(s + 1);
567
568 if (*s == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100569 // empty line should sort before any number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100570 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
571 else
572 nrs[lnum - eap->line1].st_u.value_flt =
573 strtod((char *)s, NULL);
574 }
575#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200576 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000577 }
578 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000579 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100580 // Store the column to sort at.
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100581 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
582 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000583 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000584
585 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000586
587 if (regmatch.regprog != NULL)
588 fast_breakcheck();
589 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000590 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000591 }
592
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100593 // Allocate a buffer that can hold the longest line.
Bram Moolenaar964b3742019-05-24 18:54:09 +0200594 sortbuf1 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000595 if (sortbuf1 == NULL)
596 goto sortend;
Bram Moolenaar964b3742019-05-24 18:54:09 +0200597 sortbuf2 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000598 if (sortbuf2 == NULL)
599 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000600
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100601 // Sort the array of line numbers. Note: can't be interrupted!
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000602 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000604 if (sort_abort)
605 goto sortend;
606
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100607 // Insert the lines in the sorted order below the last one.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608 lnum = eap->line2;
609 for (i = 0; i < count; ++i)
610 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200611 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
612
613 // If the original line number of the line being placed is not the same
614 // as "lnum" (accounting for offset), we know that the buffer changed.
615 if (get_lnum + ((linenr_T)count - 1) != lnum)
616 change_occurred = TRUE;
617
618 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000619 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000620 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000621 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200622 // Copy the line into a buffer, it may become invalid in
623 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100624 STRCPY(sortbuf1, s);
625 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000626 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000627 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000628 fast_breakcheck();
629 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000630 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000631 }
632
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100633 // delete the original lines if appending worked
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 if (i == count)
635 for (i = 0; i < count; ++i)
636 ml_delete(eap->line1, FALSE);
637 else
638 count = 0;
639
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100640 // Adjust marks for deleted (or added) lines and prepare for displaying.
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000641 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000642 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200643 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000644 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200645 msgmore(-deleted);
646 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000647 else if (deleted < 0)
648 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200649
650 if (change_occurred || deleted != 0)
651 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000652
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000653 curwin->w_cursor.lnum = eap->line1;
654 beginline(BL_WHITE | BL_FIX);
655
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000656sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000657 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000658 vim_free(sortbuf1);
659 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200660 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000661 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100662 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000663}
664
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 * :move command - move lines line1-line2 to line dest
667 *
668 * return FAIL for failure, OK otherwise
669 */
670 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100671do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672{
673 char_u *str;
674 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100675 linenr_T extra; // Num lines added before line1
676 linenr_T num_lines; // Num lines moved
677 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200678#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100679 win_T *win;
680 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200681#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682
683 if (dest >= line1 && dest < line2)
684 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100685 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 return FAIL;
687 }
688
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100689 // Do nothing if we are not actually moving any lines. This will prevent
690 // the 'modified' flag from being set without cause.
691 if (dest == line1 - 1 || dest == line2)
692 {
693 // Move the cursor as if lines were moved (see below) to be backwards
694 // compatible.
695 if (dest >= line1)
696 curwin->w_cursor.lnum = dest;
697 else
698 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
699
700 return OK;
701 }
702
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 num_lines = line2 - line1 + 1;
704
705 /*
706 * First we copy the old text to its new location -- webb
707 * Also copy the flag that ":global" command uses.
708 */
709 if (u_save(dest, dest + 1) == FAIL)
710 return FAIL;
711 for (extra = 0, l = line1; l <= line2; l++)
712 {
713 str = vim_strsave(ml_get(l + extra));
714 if (str != NULL)
715 {
716 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
717 vim_free(str);
718 if (dest < line1)
719 extra++;
720 }
721 }
722
723 /*
724 * Now we must be careful adjusting our marks so that we don't overlap our
725 * mark_adjust() calls.
726 *
727 * We adjust the marks within the old text so that they refer to the
728 * last lines of the file (temporarily), because we know no other marks
729 * will be set there since these line numbers did not exist until we added
730 * our new lines.
731 *
732 * Then we adjust the marks on lines between the old and new text positions
733 * (either forwards or backwards).
734 *
735 * And Finally we adjust the marks we put at the end of the file back to
736 * their final destination at the new text position -- webb
737 */
738 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100739 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740 if (dest >= line2)
741 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100742 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
743#ifdef FEAT_FOLDING
744 FOR_ALL_TAB_WINDOWS(tp, win) {
745 if (win->w_buffer == curbuf)
746 foldMoveRange(&win->w_folds, line1, line2, dest);
747 }
748#endif
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100749 if (!cmdmod.lockmarks)
750 {
751 curbuf->b_op_start.lnum = dest - num_lines + 1;
752 curbuf->b_op_end.lnum = dest;
753 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 }
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 Moolenaarf4a1d1c2019-11-16 13:50:25 +0100764 if (!cmdmod.lockmarks)
765 {
766 curbuf->b_op_start.lnum = dest + 1;
767 curbuf->b_op_end.lnum = dest + num_lines;
768 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 }
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100770 if (!cmdmod.lockmarks)
771 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100772 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 -(last_line - dest - extra), 0L);
774
775 /*
776 * Now we delete the original text -- webb
777 */
778 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
779 return FAIL;
780
781 for (l = line1; l <= line2; l++)
782 ml_delete(line1 + extra, TRUE);
783
784 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100785 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +0200786 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788 /*
789 * Leave the cursor on the last of the moved lines.
790 */
791 if (dest >= line1)
792 curwin->w_cursor.lnum = dest;
793 else
794 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
795
796 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100797 {
798 dest += num_lines + 1;
799 last_line = curbuf->b_ml.ml_line_count;
800 if (dest > last_line + 1)
801 dest = last_line + 1;
802 changed_lines(line1, 0, dest, 0L);
803 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 else
805 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
806
807 return OK;
808}
809
810/*
811 * ":copy"
812 */
813 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100814ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815{
816 linenr_T count;
817 char_u *p;
818
819 count = line2 - line1 + 1;
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100820 if (!cmdmod.lockmarks)
821 {
822 curbuf->b_op_start.lnum = n + 1;
823 curbuf->b_op_end.lnum = n + count;
824 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
825 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
827 /*
828 * there are three situations:
829 * 1. destination is above line1
830 * 2. destination is between line1 and line2
831 * 3. destination is below line2
832 *
833 * n = destination (when starting)
834 * curwin->w_cursor.lnum = destination (while copying)
835 * line1 = start of source (while copying)
836 * line2 = end of source (while copying)
837 */
838 if (u_save(n, n + 1) == FAIL)
839 return;
840
841 curwin->w_cursor.lnum = n;
842 while (line1 <= line2)
843 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100844 // need to use vim_strsave() because the line will be unlocked within
845 // ml_append()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 p = vim_strsave(ml_get(line1));
847 if (p != NULL)
848 {
849 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
850 vim_free(p);
851 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100852 // situation 2: skip already copied lines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 if (line1 == n)
854 line1 = curwin->w_cursor.lnum;
855 ++line1;
856 if (curwin->w_cursor.lnum < line1)
857 ++line1;
858 if (curwin->w_cursor.lnum < line2)
859 ++line2;
860 ++curwin->w_cursor.lnum;
861 }
862
863 appended_lines_mark(n, count);
864
865 msgmore((long)count);
866}
867
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100868static char_u *prevcmd = NULL; // the previous command
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000869
870#if defined(EXITFREE) || defined(PROTO)
871 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100872free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000873{
874 vim_free(prevcmd);
875}
876#endif
877
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878/*
879 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
880 * Bangs in the argument are replaced with the previously entered command.
881 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 */
883 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100884do_bang(
885 int addr_count,
886 exarg_T *eap,
887 int forceit,
888 int do_in,
889 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100891 char_u *arg = eap->arg; // command
892 linenr_T line1 = eap->line1; // start of range
893 linenr_T line2 = eap->line2; // end of range
894 char_u *newcmd = NULL; // the new command
895 int free_newcmd = FALSE; // need to free() newcmd
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 int ins_prevcmd;
897 char_u *t;
898 char_u *p;
899 char_u *trailarg;
900 int len;
901 int scroll_save = msg_scroll;
902
903 /*
904 * Disallow shell commands for "rvim".
905 * Disallow shell commands from .exrc and .vimrc in current directory for
906 * security reasons.
907 */
908 if (check_restricted() || check_secure())
909 return;
910
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100911 if (addr_count == 0) // :!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100913 msg_scroll = FALSE; // don't scroll here
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 autowrite_all();
915 msg_scroll = scroll_save;
916 }
917
918 /*
919 * Try to find an embedded bang, like in :!<cmd> ! [args]
920 * (:!! is indicated by the 'forceit' variable)
921 */
922 ins_prevcmd = forceit;
923 trailarg = arg;
924 do
925 {
926 len = (int)STRLEN(trailarg) + 1;
927 if (newcmd != NULL)
928 len += (int)STRLEN(newcmd);
929 if (ins_prevcmd)
930 {
931 if (prevcmd == NULL)
932 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100933 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 vim_free(newcmd);
935 return;
936 }
937 len += (int)STRLEN(prevcmd);
938 }
Bram Moolenaar964b3742019-05-24 18:54:09 +0200939 if ((t = alloc(len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 {
941 vim_free(newcmd);
942 return;
943 }
944 *t = NUL;
945 if (newcmd != NULL)
946 STRCAT(t, newcmd);
947 if (ins_prevcmd)
948 STRCAT(t, prevcmd);
949 p = t + STRLEN(t);
950 STRCAT(t, trailarg);
951 vim_free(newcmd);
952 newcmd = t;
953
954 /*
955 * Scan the rest of the argument for '!', which is replaced by the
956 * previous command. "\!" is replaced by "!" (this is vi compatible).
957 */
958 trailarg = NULL;
959 while (*p)
960 {
Bram Moolenaare60acc12011-05-10 16:41:25 +0200961 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 {
963 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000964 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 else
966 {
967 trailarg = p;
968 *trailarg++ = NUL;
969 ins_prevcmd = TRUE;
970 break;
971 }
972 }
973 ++p;
974 }
975 } while (trailarg != NULL);
976
977 vim_free(prevcmd);
978 prevcmd = newcmd;
979
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100980 if (bangredo) // put cmd in redo buffer for ! command
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100982 // If % or # appears in the command, it must have been escaped.
983 // Reescape them, so that redoing them does not substitute them by the
984 // buffername.
Bram Moolenaar529d2d62014-03-19 17:41:23 +0100985 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
986
987 if (cmd != NULL)
988 {
989 AppendToRedobuffLit(cmd, -1);
990 vim_free(cmd);
991 }
992 else
993 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 AppendToRedobuff((char_u *)"\n");
995 bangredo = FALSE;
996 }
997 /*
998 * Add quotes around the command, for shells that need them.
999 */
1000 if (*p_shq != NUL)
1001 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001002 newcmd = alloc(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 if (newcmd == NULL)
1004 return;
1005 STRCPY(newcmd, p_shq);
1006 STRCAT(newcmd, prevcmd);
1007 STRCAT(newcmd, p_shq);
1008 free_newcmd = TRUE;
1009 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001010 if (addr_count == 0) // :!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001012 // echo the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 msg_start();
1014 msg_putchar(':');
1015 msg_putchar('!');
1016 msg_outtrans(newcmd);
1017 msg_clr_eos();
1018 windgoto(msg_row, msg_col);
1019
1020 do_shell(newcmd, 0);
1021 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001022 else // :range!
Bram Moolenaarade00832006-03-10 21:46:58 +00001023 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001024 // Careful: This may recursively call do_bang() again! (because of
1025 // autocommands)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001027 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001028 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 if (free_newcmd)
1030 vim_free(newcmd);
1031}
1032
1033/*
1034 * do_filter: filter lines through a command given by the user
1035 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001036 * We mostly use temp files and the call_shell() routine here. This would
1037 * normally be done using pipes on a UNIX machine, but this is more portable
1038 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 * to deal with redirection somehow, and should handle things like looking
1040 * at the PATH env. variable, and adding reasonable extensions to the
1041 * command name given by the user. All reasonable versions of call_shell()
1042 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001043 * Alternatively, if on Unix and redirecting input or output, but not both,
1044 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 * We use input redirection if do_in is TRUE.
1046 * We use output redirection if do_out is TRUE.
1047 */
1048 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001049do_filter(
1050 linenr_T line1,
1051 linenr_T line2,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001052 exarg_T *eap, // for forced 'ff' and 'fenc'
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001053 char_u *cmd,
1054 int do_in,
1055 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056{
1057 char_u *itmp = NULL;
1058 char_u *otmp = NULL;
1059 linenr_T linecount;
1060 linenr_T read_linecount;
1061 pos_T cursor_save;
1062 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001064 int shell_flags = 0;
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001065 pos_T orig_start = curbuf->b_op_start;
1066 pos_T orig_end = curbuf->b_op_end;
1067 int save_lockmarks = cmdmod.lockmarks;
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001068#ifdef FEAT_FILTERPIPE
1069 int stmp = p_stmp;
1070#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001072 if (*cmd == NUL) // no filter command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 return;
1074
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001075 // Temporarily disable lockmarks since that's needed to propagate changed
1076 // regions of the buffer for foldUpdate(), linecount, etc.
1077 cmdmod.lockmarks = 0;
1078
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 cursor_save = curwin->w_cursor;
1080 linecount = line2 - line1 + 1;
1081 curwin->w_cursor.lnum = line1;
1082 curwin->w_cursor.col = 0;
1083 changed_line_abv_curs();
1084 invalidate_botline();
1085
1086 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001087 * When using temp files:
1088 * 1. * Form temp file names
1089 * 2. * Write the lines to a temp file
1090 * 3. Run the filter command on the temp file
1091 * 4. * Read the output of the command into the buffer
1092 * 5. * Delete the original lines to be filtered
1093 * 6. * Remove the temp files
1094 *
1095 * When writing the input with a pipe or when catching the output with a
1096 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 */
1098
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001099 if (do_out)
1100 shell_flags |= SHELL_DOOUT;
1101
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001102#ifdef FEAT_FILTERPIPE
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001103# ifdef VIMDLL
1104 if (!gui.in_use && !gui.starting)
1105 stmp = 1; // Console mode doesn't support filterpipe.
1106# endif
1107
1108 if (!do_in && do_out && !stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001110 // Use a pipe to fetch stdout of the command, do not use a temp file.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001111 shell_flags |= SHELL_READ;
1112 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 }
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001114 else if (do_in && !do_out && !stmp)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001115 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001116 // Use a pipe to write stdin of the command, do not use a temp file.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001117 shell_flags |= SHELL_WRITE;
1118 curbuf->b_op_start.lnum = line1;
1119 curbuf->b_op_end.lnum = line2;
1120 }
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001121 else if (do_in && do_out && !stmp)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001122 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001123 // Use a pipe to write stdin and fetch stdout of the command, do not
1124 // use a temp file.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001125 shell_flags |= SHELL_READ|SHELL_WRITE;
1126 curbuf->b_op_start.lnum = line1;
1127 curbuf->b_op_end.lnum = line2;
1128 curwin->w_cursor.lnum = line2;
1129 }
1130 else
1131#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001132 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1133 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001134 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001135 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001136 goto filterend;
1137 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138
1139/*
1140 * The writing and reading of temp files will not be shown.
1141 * Vi also doesn't do this and the messages are not very informative.
1142 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001143 ++no_wait_return; // don't call wait_return() while busy
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001144 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 FALSE, FALSE, FALSE, TRUE) == FAIL)
1146 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001147 msg_putchar('\n'); // keep message from buf_write()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001149#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 if (!aborting())
1151#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001152 (void)semsg(_(e_notcreate), itmp); // will call wait_return
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 goto filterend;
1154 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 if (curbuf != old_curbuf)
1156 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157
1158 if (!do_out)
1159 msg_putchar('\n');
1160
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001161 // Create the shell command in allocated memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1163 if (cmd_buf == NULL)
1164 goto filterend;
1165
1166 windgoto((int)Rows - 1, 0);
1167 cursor_on();
1168
1169 /*
1170 * When not redirecting the output the command can write anything to the
1171 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1172 * stderr output of external command. Clear the screen later.
1173 * If do_in is FALSE, this could be something like ":r !cat", which may
1174 * also mess up the screen, clear it later.
1175 */
1176 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1177 redraw_later_clear();
1178
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001179 if (do_out)
1180 {
1181 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001182 {
1183 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001184 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001185 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001186 redraw_curbuf_later(VALID);
1187 }
1188 read_linecount = curbuf->b_ml.ml_line_count;
1189
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 /*
1191 * When call_shell() fails wait_return() is called to give the user a
1192 * chance to read the error messages. Otherwise errors are ignored, so you
1193 * can see the error messages from the command that appear on stdout; use
1194 * 'u' to fix the text
1195 * Switch to cooked mode when not redirecting stdin, avoids that something
1196 * like ":r !cat" hangs.
1197 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1198 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001199 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 {
1201 redraw_later_clear();
1202 wait_return(FALSE);
1203 }
1204 vim_free(cmd_buf);
1205
1206 did_check_timestamps = FALSE;
1207 need_check_timestamps = TRUE;
1208
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001209 // When interrupting the shell command, it may still have produced some
1210 // useful output. Reset got_int here, so that readfile() won't cancel
1211 // reading.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001212 ui_breakcheck();
1213 got_int = FALSE;
1214
1215 if (do_out)
1216 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001217 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001219 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001220 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001222#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001223 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001225 {
1226 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001227 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001228 }
1229 goto error;
1230 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001231 if (curbuf != old_curbuf)
1232 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001233 }
1234
1235 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1236
1237 if (shell_flags & SHELL_READ)
1238 {
1239 curbuf->b_op_start.lnum = line2 + 1;
1240 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1241 appended_lines_mark(line2, read_linecount);
1242 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243
1244 if (do_in)
1245 {
1246 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1247 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 if (read_linecount >= linecount)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001249 // move all marks from old lines to new lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 mark_adjust(line1, line2, linecount, 0L);
1251 else
1252 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001253 // move marks from old lines to new lines, delete marks
1254 // that are in deleted lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 mark_adjust(line1, line1 + read_linecount - 1,
1256 linecount, 0L);
1257 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1258 }
1259 }
1260
1261 /*
1262 * Put cursor on first filtered line for ":range!cmd".
1263 * Adjust '[ and '] (set by buf_write()).
1264 */
1265 curwin->w_cursor.lnum = line1;
1266 del_lines(linecount, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001267 curbuf->b_op_start.lnum -= linecount; // adjust '[
1268 curbuf->b_op_end.lnum -= linecount; // adjust ']
1269 write_lnum_adjust(-linecount); // adjust last line
1270 // for next write
Bram Moolenaar8c711452005-01-14 21:53:12 +00001271#ifdef FEAT_FOLDING
1272 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1273#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 }
1275 else
1276 {
1277 /*
1278 * Put cursor on last new line for ":r !cmd".
1279 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001281 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001283
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001284 beginline(BL_WHITE | BL_FIX); // cursor on first non-blank
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 --no_wait_return;
1286
1287 if (linecount > p_report)
1288 {
1289 if (do_in)
1290 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001291 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001292 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001294 // save message to display it after redraw
Bram Moolenaar32526b32019-01-19 17:43:09 +01001295 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 }
1297 else
1298 msgmore((long)linecount);
1299 }
1300 }
1301 else
1302 {
1303error:
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001304 // put cursor back in same position for ":w !cmd"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 curwin->w_cursor = cursor_save;
1306 --no_wait_return;
1307 wait_return(FALSE);
1308 }
1309
1310filterend:
1311
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001312 cmdmod.lockmarks = save_lockmarks;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 if (curbuf != old_curbuf)
1314 {
1315 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001316 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 }
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001318 else if (cmdmod.lockmarks)
1319 {
1320 curbuf->b_op_start = orig_start;
1321 curbuf->b_op_end = orig_end;
1322 }
1323
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 if (itmp != NULL)
1325 mch_remove(itmp);
1326 if (otmp != NULL)
1327 mch_remove(otmp);
1328 vim_free(itmp);
1329 vim_free(otmp);
1330}
1331
1332/*
1333 * Call a shell to execute a command.
1334 * When "cmd" is NULL start an interactive shell.
1335 */
1336 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001337do_shell(
1338 char_u *cmd,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001339 int flags) // may be SHELL_DOOUT when output is redirected
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340{
1341 buf_T *buf;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001342#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 int save_nwr;
1344#endif
1345#ifdef MSWIN
1346 int winstart = FALSE;
Bram Moolenaar049ca592019-03-17 16:59:44 +01001347 int keep_termcap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348#endif
1349
1350 /*
1351 * Disallow shell commands for "rvim".
1352 * Disallow shell commands from .exrc and .vimrc in current directory for
1353 * security reasons.
1354 */
1355 if (check_restricted() || check_secure())
1356 {
1357 msg_end();
1358 return;
1359 }
1360
1361#ifdef MSWIN
1362 /*
Bram Moolenaar049ca592019-03-17 16:59:44 +01001363 * Check if ":!start" is used. This implies not stopping termcap mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364 */
1365 if (cmd != NULL)
Bram Moolenaar049ca592019-03-17 16:59:44 +01001366 keep_termcap = winstart = (STRNICMP(cmd, "start ", 6) == 0);
1367
1368# if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
1369 // Don't stop termcap mode when using a terminal window for the shell.
1370 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
1371 keep_termcap = TRUE;
1372# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373#endif
1374
1375 /*
1376 * For autocommands we want to get the output on the current screen, to
1377 * avoid having to type return below.
1378 */
Bram Moolenaar049ca592019-03-17 16:59:44 +01001379 msg_putchar('\r'); // put cursor at start of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 {
1382#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001383 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384#endif
1385 stoptermcap();
1386 }
1387#ifdef MSWIN
1388 if (!winstart)
1389#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001390 msg_putchar('\n'); // may shift screen one line up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391
Bram Moolenaar049ca592019-03-17 16:59:44 +01001392 // warning message before calling the shell
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001393 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001394 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001395 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 {
1397#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001398 if (!keep_termcap)
1399 starttermcap(); // don't want a message box here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001401 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001403 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 stoptermcap();
1405#endif
1406 break;
1407 }
1408
Bram Moolenaar049ca592019-03-17 16:59:44 +01001409 // This windgoto is required for when the '\n' resulted in a "delete line
1410 // 1" command to the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 if (!swapping_screen())
1412 windgoto(msg_row, msg_col);
1413 cursor_on();
1414 (void)call_shell(cmd, SHELL_COOKED | flags);
1415 did_check_timestamps = FALSE;
1416 need_check_timestamps = TRUE;
1417
1418 /*
1419 * put the message cursor at the end of the screen, avoids wait_return()
1420 * to overwrite the text that the external command showed
1421 */
1422 if (!swapping_screen())
1423 {
1424 msg_row = Rows - 1;
1425 msg_col = 0;
1426 }
1427
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 if (autocmd_busy)
1429 {
1430 if (msg_silent == 0)
1431 redraw_later_clear();
1432 }
1433 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 {
1435 /*
1436 * For ":sh" there is no need to call wait_return(), just redraw.
1437 * Also for the Win32 GUI (the output is in a console window).
1438 * Otherwise there is probably text on the screen that the user wants
1439 * to read before redrawing, so call wait_return().
1440 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001441#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
1442# ifdef VIMDLL
1443 if (!gui.in_use)
1444# endif
1445 {
1446 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001447# ifdef MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001448 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001450 )
1451 {
1452 if (msg_silent == 0)
1453 redraw_later_clear();
1454 need_wait_return = FALSE;
1455 }
1456 else
1457 {
1458 /*
1459 * If we switch screens when starttermcap() is called, we
1460 * really want to wait for "hit return to continue".
1461 */
1462 save_nwr = no_wait_return;
1463 if (swapping_screen())
1464 no_wait_return = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465# ifdef AMIGA
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001466 wait_return(term_console ? -1 : msg_silent == 0); // see below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467# else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001468 wait_return(msg_silent == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001470 no_wait_return = save_nwr;
1471 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001473#endif // FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001476 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001478 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479
1480 /*
1481 * In an Amiga window redrawing is caused by asking the window size.
1482 * If we got an interrupt this will not work. The chance that the
1483 * window size is wrong is very small, but we need to redraw the
1484 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1485 * but it saves an extra redraw.
1486 */
1487#ifdef AMIGA
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001488 if (skip_redraw) // ':' hit in wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 {
1490 if (msg_silent == 0)
1491 redraw_later_clear();
1492 }
1493 else if (term_console)
1494 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001495 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); // get window size
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 if (got_int && msg_silent == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001497 redraw_later_clear(); // if got_int is TRUE, redraw needed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001499 must_redraw = 0; // no extra redraw needed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 }
1501#endif
1502 }
1503
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001504 // display any error messages now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001506
Bram Moolenaarade00832006-03-10 21:46:58 +00001507 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508}
1509
Bram Moolenaar06640892018-10-09 21:49:33 +02001510#if !defined(UNIX)
1511 static char_u *
1512find_pipe(char_u *cmd)
1513{
1514 char_u *p;
1515 int inquote = FALSE;
1516
1517 for (p = cmd; *p != NUL; ++p)
1518 {
1519 if (!inquote && *p == '|')
1520 return p;
1521 if (*p == '"')
1522 inquote = !inquote;
1523 else if (rem_backslash(p))
1524 ++p;
1525 }
1526 return NULL;
1527}
1528#endif
1529
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530/*
1531 * Create a shell command from a command string, input redirection file and
1532 * output redirection file.
1533 * Returns an allocated string with the shell command, or NULL for failure.
1534 */
1535 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001536make_filter_cmd(
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001537 char_u *cmd, // command
1538 char_u *itmp, // NULL or name of input file
1539 char_u *otmp) // NULL or name of output file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540{
1541 char_u *buf;
1542 long_u len;
1543
Bram Moolenaar53076832015-12-31 19:53:21 +01001544#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001545 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001546 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001547
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001548 // Account for fish's different syntax for subshells
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001549 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1550 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001551 if (is_fish_shell)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001552 len = (long_u)STRLEN(cmd) + 13; // "begin; " + "; end" + NUL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001553 else
1554#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001555 len = (long_u)STRLEN(cmd) + 3; // "()" + NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 if (itmp != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001557 len += (long_u)STRLEN(itmp) + 9; // " { < " + " } "
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 if (otmp != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001559 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; // " "
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02001560 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 if (buf == NULL)
1562 return NULL;
1563
Bram Moolenaar53076832015-12-31 19:53:21 +01001564#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001566 * Put braces around the command (for concatenated commands) when
1567 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001569 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001570 {
1571 if (is_fish_shell)
1572 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1573 else
1574 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1575 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001576 else
1577 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 if (itmp != NULL)
1579 {
1580 STRCAT(buf, " < ");
1581 STRCAT(buf, itmp);
1582 }
1583#else
Bram Moolenaar1a613392019-09-28 15:51:37 +02001584 // For shells that don't understand braces around commands, at least allow
1585 // the use of commands in a pipe.
1586 if (*p_sxe != NUL && *p_sxq == '(')
1587 {
1588 if (itmp != NULL || otmp != NULL)
1589 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1590 else
1591 STRCPY(buf, cmd);
1592 if (itmp != NULL)
1593 {
1594 STRCAT(buf, " < ");
1595 STRCAT(buf, itmp);
1596 }
1597 }
1598 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 {
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001600 STRCPY(buf, cmd);
1601 if (itmp != NULL)
1602 {
1603 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001605 // If there is a pipe, we have to put the '<' in front of it.
1606 // Don't do this when 'shellquote' is not empty, otherwise the
1607 // redirection would be inside the quotes.
1608 if (*p_shq == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 {
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001610 p = find_pipe(buf);
1611 if (p != NULL)
1612 *p = NUL;
1613 }
1614 STRCAT(buf, " <"); // " < " causes problems on Amiga
1615 STRCAT(buf, itmp);
1616 if (*p_shq == NUL)
1617 {
1618 p = find_pipe(cmd);
1619 if (p != NULL)
1620 {
1621 STRCAT(buf, " "); // insert a space before the '|' for DOS
1622 STRCAT(buf, p);
1623 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 }
1625 }
1626 }
1627#endif
1628 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001629 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630
1631 return buf;
1632}
1633
1634/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001635 * Append output redirection for file "fname" to the end of string buffer
1636 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 * Works with the 'shellredir' and 'shellpipe' options.
1638 * The caller should make sure that there is enough room:
1639 * STRLEN(opt) + STRLEN(fname) + 3
1640 */
1641 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001642append_redir(
1643 char_u *buf,
1644 int buflen,
1645 char_u *opt,
1646 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647{
1648 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001649 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001651 end = buf + STRLEN(buf);
Bram Moolenaar1a613392019-09-28 15:51:37 +02001652 // find "%s"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001654 {
Bram Moolenaar1a613392019-09-28 15:51:37 +02001655 if (p[1] == 's') // found %s
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 break;
Bram Moolenaar1a613392019-09-28 15:51:37 +02001657 if (p[1] == '%') // skip %%
Bram Moolenaar542805a2013-08-02 14:15:13 +02001658 ++p;
1659 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 if (p != NULL)
1661 {
Bram Moolenaar1a613392019-09-28 15:51:37 +02001662#ifdef MSWIN
1663 *end++ = ' '; // not really needed? Not with sh, ksh or bash
1664#endif
1665 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001666 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 }
1668 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001669 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 " %s %s",
1672#else
Bram Moolenaar1a613392019-09-28 15:51:37 +02001673 " %s%s", // " > %s" causes problems on Amiga
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674#endif
1675 (char *)opt, (char *)fname);
1676}
1677
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001678/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 * Implementation of ":fixdel", also used by get_stty().
1680 * <BS> resulting <Del>
1681 * ^? ^H
1682 * not ^? ^?
1683 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001685do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686{
1687 char_u *p;
1688
1689 p = find_termcode((char_u *)"kb");
1690 add_termcode((char_u *)"kD", p != NULL
1691 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
1692}
1693
1694 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001695print_line_no_prefix(
1696 linenr_T lnum,
1697 int use_number,
1698 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001700 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701
1702 if (curwin->w_p_nu || use_number)
1703 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001704 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001705 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001706 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); // Highlight line nrs
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001708 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709}
1710
1711/*
1712 * Print a text line. Also in silent mode ("ex -s").
1713 */
1714 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001715print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716{
1717 int save_silent = silent_mode;
1718
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001719 // apply :filter /pat/
Bram Moolenaard29459b2016-08-26 22:29:11 +02001720 if (message_filtered(ml_get(lnum)))
1721 return;
1722
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001724 silent_mode = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001725 info_message = TRUE; // use mch_msg(), not mch_errmsg()
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001726 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 if (save_silent)
1728 {
1729 msg_putchar('\n');
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001730 cursor_on(); // msg_start() switches it off
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 out_flush();
1732 silent_mode = save_silent;
1733 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00001734 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735}
1736
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001737 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001738rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001739{
1740 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02001741 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001742
Bram Moolenaar7e283842013-05-30 11:43:15 +02001743 buf = curbuf;
1744 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001745 // buffer changed, don't change name now
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001746 if (buf != curbuf)
1747 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001748#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001749 if (aborting()) // autocmds may abort script processing
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001750 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001751#endif
1752 /*
1753 * The name of the current buffer will be changed.
1754 * A new (unlisted) buffer entry needs to be made to hold the old file
1755 * name, which will become the alternate file name.
1756 * But don't set the alternate file name if the buffer didn't have a
1757 * name.
1758 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02001759 fname = curbuf->b_ffname;
1760 sfname = curbuf->b_sfname;
1761 xfname = curbuf->b_fname;
1762 curbuf->b_ffname = NULL;
1763 curbuf->b_sfname = NULL;
1764 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001765 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02001766 curbuf->b_ffname = fname;
1767 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001768 return FAIL;
1769 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02001770 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001771 if (xfname != NULL && *xfname != NUL)
1772 {
1773 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
1774 if (buf != NULL && !cmdmod.keepalt)
1775 curwin->w_alt_fnum = buf->b_fnum;
1776 }
1777 vim_free(fname);
1778 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02001779 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001780
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001781 // Change directories when the 'acd' option is set.
Bram Moolenaar6f470022018-04-10 18:47:20 +02001782 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001783 return OK;
1784}
1785
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786/*
1787 * ":file[!] [fname]".
1788 */
1789 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001790ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001792 // ":0file" removes the file name. Check for illegal uses ":3file",
1793 // "0file name", etc.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001794 if (eap->addr_count > 0
1795 && (*eap->arg != NUL
1796 || eap->line2 > 0
1797 || eap->addr_count > 1))
1798 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001799 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001800 return;
1801 }
1802
1803 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001805 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02001807 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02001809
1810 // print file name if no argument or 'F' is not in 'shortmess'
1811 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01001812 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813}
1814
1815/*
1816 * ":update".
1817 */
1818 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001819ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820{
1821 if (curbufIsChanged())
1822 (void)do_write(eap);
1823}
1824
1825/*
1826 * ":write" and ":saveas".
1827 */
1828 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001829ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830{
Bram Moolenaarb7316892019-05-01 18:08:42 +02001831 if (eap->cmdidx == CMD_saveas)
1832 {
1833 // :saveas does not take a range, uses all lines.
1834 eap->line1 = 1;
1835 eap->line2 = curbuf->b_ml.ml_line_count;
1836 }
1837
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001838 if (eap->usefilter) // input lines to shell command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 do_bang(1, eap, FALSE, TRUE, FALSE);
1840 else
1841 (void)do_write(eap);
1842}
1843
1844/*
1845 * write current buffer to file 'eap->arg'
1846 * if 'eap->append' is TRUE, append to the file
1847 *
1848 * if *eap->arg == NUL write to current file
1849 *
1850 * return FAIL for failure, OK otherwise
1851 */
1852 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001853do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854{
1855 int other;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001856 char_u *fname = NULL; // init to shut up gcc
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 char_u *ffname;
1858 int retval = FAIL;
1859 char_u *free_fname = NULL;
1860#ifdef FEAT_BROWSE
1861 char_u *browse_file = NULL;
1862#endif
1863 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02001864 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001866 if (not_writing()) // check 'write' option
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 return FAIL;
1868
1869 ffname = eap->arg;
1870#ifdef FEAT_BROWSE
Bram Moolenaar5c381eb2019-06-25 06:50:31 +02001871 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001873 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 NULL, NULL, NULL, curbuf);
1875 if (browse_file == NULL)
1876 goto theend;
1877 ffname = browse_file;
1878 }
1879#endif
1880 if (*ffname == NUL)
1881 {
1882 if (eap->cmdidx == CMD_saveas)
1883 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001884 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 goto theend;
1886 }
1887 other = FALSE;
1888 }
1889 else
1890 {
1891 fname = ffname;
1892 free_fname = fix_fname(ffname);
1893 /*
1894 * When out-of-memory, keep unexpanded file name, because we MUST be
1895 * able to write the file in this situation.
1896 */
1897 if (free_fname != NULL)
1898 ffname = free_fname;
1899 other = otherfile(ffname);
1900 }
1901
1902 /*
1903 * If we have a new file, put its name in the list of alternate file names.
1904 */
1905 if (other)
1906 {
1907 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
1908 || eap->cmdidx == CMD_saveas)
1909 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
1910 else
1911 alt_buf = buflist_findname(ffname);
1912 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
1913 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001914 // Overwriting a file that is loaded in another buffer is not a
1915 // good idea.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001916 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 goto theend;
1918 }
1919 }
1920
1921 /*
1922 * Writing to the current file is not allowed in readonly mode
1923 * and a file name is required.
1924 * "nofile" and "nowrite" buffers cannot be written implicitly either.
1925 */
1926 if (!other && (
1927#ifdef FEAT_QUICKFIX
1928 bt_dontwrite_msg(curbuf) ||
1929#endif
1930 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
1931 goto theend;
1932
1933 if (!other)
1934 {
1935 ffname = curbuf->b_ffname;
1936 fname = curbuf->b_fname;
1937 /*
1938 * Not writing the whole file is only allowed with '!'.
1939 */
1940 if ( (eap->line1 != 1
1941 || eap->line2 != curbuf->b_ml.ml_line_count)
1942 && !eap->forceit
1943 && !eap->append
1944 && !p_wa)
1945 {
1946#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1947 if (p_confirm || cmdmod.confirm)
1948 {
1949 if (vim_dialog_yesno(VIM_QUESTION, NULL,
1950 (char_u *)_("Write partial file?"), 2) != VIM_YES)
1951 goto theend;
1952 eap->forceit = TRUE;
1953 }
1954 else
1955#endif
1956 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001957 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 goto theend;
1959 }
1960 }
1961 }
1962
1963 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
1964 {
1965 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
1966 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 buf_T *was_curbuf = curbuf;
1968
1969 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00001970 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001971#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001973#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001975#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001977 // buffer changed, don't change name now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 retval = FAIL;
1979 goto theend;
1980 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001981 // Exchange the file names for the current and the alternate
1982 // buffer. This makes it look like we are now editing the buffer
1983 // under the new name. Must be done before buf_write(), because
1984 // if there is no file name and 'cpo' contains 'F', it will set
1985 // the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 fname = alt_buf->b_fname;
1987 alt_buf->b_fname = curbuf->b_fname;
1988 curbuf->b_fname = fname;
1989 fname = alt_buf->b_ffname;
1990 alt_buf->b_ffname = curbuf->b_ffname;
1991 curbuf->b_ffname = fname;
1992 fname = alt_buf->b_sfname;
1993 alt_buf->b_sfname = curbuf->b_sfname;
1994 curbuf->b_sfname = fname;
1995 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001996
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00001998 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 if (!alt_buf->b_p_bl)
2000 {
2001 alt_buf->b_p_bl = TRUE;
2002 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2003 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002004#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002006#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002008#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002010 // buffer changed, don't write the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 retval = FAIL;
2012 goto theend;
2013 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002014
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002015 // If 'filetype' was empty try detecting it now.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002016 if (*curbuf->b_p_ft == NUL)
2017 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002018 if (au_has_group((char_u *)"filetypedetect"))
2019 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02002020 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002021 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002022 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002023
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002024 // Autocommands may have changed buffer names, esp. when
2025 // 'autochdir' is set.
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002026 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 }
2028
Bram Moolenaar5c719942016-07-09 23:40:45 +02002029 name_was_missing = curbuf->b_ffname == NULL;
2030
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2032 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002033
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002034 // After ":saveas fname" reset 'readonly'.
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002035 if (eap->cmdidx == CMD_saveas)
2036 {
2037 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002038 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002039 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002040 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002041 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02002042 }
2043
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002044 // Change directories when the 'acd' option is set and the file name
2045 // got changed or set.
Bram Moolenaar5c719942016-07-09 23:40:45 +02002046 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02002047 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 }
2049
2050theend:
2051#ifdef FEAT_BROWSE
2052 vim_free(browse_file);
2053#endif
2054 vim_free(free_fname);
2055 return retval;
2056}
2057
2058/*
2059 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2060 * BF_NEW or BF_READERR, check for overwriting current file.
2061 * May set eap->forceit if a dialog says it's OK to overwrite.
2062 * Return OK if it's OK, FAIL if it is not.
2063 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002064 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002065check_overwrite(
2066 exarg_T *eap,
2067 buf_T *buf,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002068 char_u *fname, // file name to be used (can differ from
2069 // buf->ffname)
2070 char_u *ffname, // full path version of fname
2071 int other) // writing under other name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072{
2073 /*
Bram Moolenaara3a9c8e2020-03-19 12:38:34 +01002074 * Write to another file or b_flags set or not writing the whole file:
2075 * overwriting only allowed with '!'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 */
2077 if ( (other
2078 || (buf->b_flags & BF_NOTEDITED)
2079 || ((buf->b_flags & BF_NEW)
2080 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2081 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 && !p_wa
2083 && vim_fexists(ffname))
2084 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002085 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002087#ifdef UNIX
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002088 // with UNIX it is possible to open a directory
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002089 if (mch_isdir(ffname))
2090 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002091 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002092 return FAIL;
2093 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094#endif
2095#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002096 if (p_confirm || cmdmod.confirm)
2097 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002098 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002100 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2101 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2102 return FAIL;
2103 eap->forceit = TRUE;
2104 }
2105 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002107 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002108 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002109 return FAIL;
2110 }
2111 }
2112
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002113 // For ":w! filename" check that no swap file exists for "filename".
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002114 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002116 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002117 char_u *p;
2118 int r;
2119 char_u *swapname;
2120
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002121 // We only try the first entry in 'directory', without checking if
2122 // it's writable. If the "." directory is not writable the write
2123 // will probably fail anyway.
2124 // Use 'shortname' of the current buffer, since there is no buffer
2125 // for the written file.
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002126 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002127 {
2128 dir = alloc(5);
2129 if (dir == NULL)
2130 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002131 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002132 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002133 else
2134 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002135 dir = alloc(MAXPATHL);
2136 if (dir == NULL)
2137 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002138 p = p_dir;
2139 copy_option_part(&p, dir, MAXPATHL, ",");
2140 }
2141 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002142 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002143 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002144 if (r)
2145 {
2146#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2147 if (p_confirm || cmdmod.confirm)
2148 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002149 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002150
2151 dialog_msg(buff,
2152 _("Swap file \"%s\" exists, overwrite anyway?"),
2153 swapname);
2154 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2155 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002156 {
2157 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002158 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002159 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002160 eap->forceit = TRUE;
2161 }
2162 else
2163#endif
2164 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002165 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002166 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002167 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002168 return FAIL;
2169 }
2170 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002171 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 }
2173 }
2174 return OK;
2175}
2176
2177/*
2178 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2179 */
2180 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002181ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182{
2183 int i;
2184
2185 if (eap->cmd[1] == 'n')
2186 i = curwin->w_arg_idx + (int)eap->line2;
2187 else
2188 i = curwin->w_arg_idx - (int)eap->line2;
2189 eap->line1 = 1;
2190 eap->line2 = curbuf->b_ml.ml_line_count;
2191 if (do_write(eap) != FAIL)
2192 do_argfile(eap, i);
2193}
2194
2195/*
2196 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2197 */
2198 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002199do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200{
2201 buf_T *buf;
2202 int error = 0;
2203 int save_forceit = eap->forceit;
2204
2205 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2206 exiting = TRUE;
2207
Bram Moolenaar29323592016-07-24 22:04:11 +02002208 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01002210#ifdef FEAT_TERMINAL
2211 if (exiting && term_job_running(buf->b_term))
2212 {
2213 no_write_message_nobang(buf);
2214 ++error;
2215 }
2216 else
2217#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02002218 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 {
2220 /*
2221 * Check if there is a reason the buffer cannot be written:
2222 * 1. if the 'write' option is set
2223 * 2. if there is no file name (even after browsing)
2224 * 3. if the 'readonly' is set (even after a dialog)
2225 * 4. if overwriting is allowed (even after a dialog)
2226 */
2227 if (not_writing())
2228 {
2229 ++error;
2230 break;
2231 }
2232#ifdef FEAT_BROWSE
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002233 // ":browse wall": ask for file name if there isn't one
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 if (buf->b_ffname == NULL && cmdmod.browse)
2235 browse_save_fname(buf);
2236#endif
2237 if (buf->b_ffname == NULL)
2238 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002239 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 ++error;
2241 }
2242 else if (check_readonly(&eap->forceit, buf)
2243 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2244 FALSE) == FAIL)
2245 {
2246 ++error;
2247 }
2248 else
2249 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002250 bufref_T bufref;
2251
2252 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 if (buf_write_all(buf, eap->forceit) == FAIL)
2254 ++error;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002255 // an autocommand may have deleted the buffer
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002256 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002259 eap->forceit = save_forceit; // check_overwrite() may set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 }
2261 }
2262 if (exiting)
2263 {
2264 if (!error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002265 getout(0); // exit Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 not_exiting();
2267 }
2268}
2269
2270/*
2271 * Check the 'write' option.
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002272 * Return TRUE and give a message when it's not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02002274 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002275not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276{
2277 if (p_write)
2278 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002279 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 return TRUE;
2281}
2282
2283/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002284 * Check if a buffer is read-only (either 'readonly' option is set or file is
2285 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2286 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 */
2288 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002289check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002291 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00002292
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002293 // Handle a file being readonly when the 'readonly' option is set or when
2294 // the file exists and permissions are read-only.
2295 // We will send 0777 to check_file_readonly(), as the "perm" variable is
2296 // important for device checks but not here.
Bram Moolenaar5386a122007-06-28 20:02:32 +00002297 if (!*forceit && (buf->b_p_ro
2298 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2299 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 {
2301#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2302 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2303 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002304 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305
Bram Moolenaar5386a122007-06-28 20:02:32 +00002306 if (buf->b_p_ro)
2307 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2308 buf->b_fname);
2309 else
2310 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 +00002311 buf->b_fname);
2312
2313 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2314 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002315 // Set forceit, to force the writing of a readonly file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 *forceit = TRUE;
2317 return FALSE;
2318 }
2319 else
2320 return TRUE;
2321 }
2322 else
2323#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002324 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002325 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002326 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002327 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00002328 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 return TRUE;
2330 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002331
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 return FALSE;
2333}
2334
2335/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002336 * Try to abandon the current file and edit a new or existing file.
2337 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002338 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002340 * Return:
2341 * GETFILE_ERROR for "normal" error,
2342 * GETFILE_NOT_WRITTEN for "not written" error,
2343 * GETFILE_SAME_FILE for success
2344 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 */
2346 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002347getfile(
2348 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002349 char_u *ffname_arg,
2350 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002351 int setpm,
2352 linenr_T lnum,
2353 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002355 char_u *ffname = ffname_arg;
2356 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 int other;
2358 int retval;
2359 char_u *free_me = NULL;
2360
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002361 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002362 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002363 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002364 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
2366 if (fnum == 0)
2367 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002368 // make ffname full path, set sfname
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 fname_expand(curbuf, &ffname, &sfname);
2370 other = otherfile(ffname);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002371 free_me = ffname; // has been allocated, free() later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 }
2373 else
2374 other = (fnum != curbuf->b_fnum);
2375
2376 if (other)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002377 ++no_wait_return; // don't wait for autowrite message
Bram Moolenaareb44a682017-08-03 22:44:55 +02002378 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
2380 {
2381#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2382 if (p_confirm && p_write)
2383 dialog_changed(curbuf, FALSE);
2384 if (curbufIsChanged())
2385#endif
2386 {
2387 if (other)
2388 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002389 no_write_message();
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002390 retval = GETFILE_NOT_WRITTEN; // file has been changed
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 goto theend;
2392 }
2393 }
2394 if (other)
2395 --no_wait_return;
2396 if (setpm)
2397 setpcmark();
2398 if (!other)
2399 {
2400 if (lnum != 0)
2401 curwin->w_cursor.lnum = lnum;
2402 check_cursor_lnum();
2403 beginline(BL_SOL | BL_FIX);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002404 retval = GETFILE_SAME_FILE; // it's in the same file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 }
2406 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002407 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002408 curwin) == OK)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002409 retval = GETFILE_OPEN_OTHER; // opened another file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002411 retval = GETFILE_ERROR; // error encountered
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412
2413theend:
2414 vim_free(free_me);
2415 return retval;
2416}
2417
2418/*
2419 * start editing a new file
2420 *
2421 * fnum: file number; if zero use ffname/sfname
2422 * ffname: the file name
2423 * - full path if sfname used,
2424 * - any file name if sfname is NULL
2425 * - empty string to re-edit with the same file name (but may be
2426 * in a different directory)
2427 * - NULL to start an empty buffer
2428 * sfname: the short file name (or NULL)
2429 * eap: contains the command to be executed after loading the file and
2430 * forced 'ff' and 'fenc'
2431 * newlnum: if > 0: put cursor on this line number (if possible)
2432 * if ECMD_LASTL: use last position in loaded file
2433 * if ECMD_LAST: use last position in all files
2434 * if ECMD_ONE: use first line
2435 * flags:
2436 * ECMD_HIDE: if TRUE don't free the current buffer
2437 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
2438 * ECMD_OLDBUF: use existing buffer if it exists
2439 * ECMD_FORCEIT: ! used for Ex command
2440 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002441 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02002442 * window, NULL when splitting the window first. When not NULL info
2443 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 *
2445 * return FAIL for failure, OK otherwise
2446 */
2447 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002448do_ecmd(
2449 int fnum,
2450 char_u *ffname,
2451 char_u *sfname,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002452 exarg_T *eap, // can be NULL!
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002453 linenr_T newlnum,
2454 int flags,
2455 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002457 int other_file; // TRUE if editing another file
2458 int oldbuf; // TRUE if using existing buffer
2459 int auto_buf = FALSE; // TRUE if autocommands brought us
2460 // into the buffer unexpectedly
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002462#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002463 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464#endif
2465 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002466 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002467 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 char_u *free_fname = NULL;
2469#ifdef FEAT_BROWSE
2470 char_u *browse_file = NULL;
2471#endif
2472 int retval = FAIL;
2473 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01002474 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 linenr_T topline = 0;
2476 int newcol = -1;
2477 int solcol = -1;
2478 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002480#ifdef FEAT_SPELL
2481 int did_get_winopts = FALSE;
2482#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002483 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002484 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01002485 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486
Bram Moolenaar03a9f842020-05-13 13:40:16 +02002487#ifdef FEAT_PROP_POPUP
2488 if (ERROR_IF_TERM_POPUP_WINDOW)
2489 return FAIL;
2490#endif
2491
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 if (eap != NULL)
2493 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002494 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495
2496 if (fnum != 0)
2497 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002498 if (fnum == curbuf->b_fnum) // file is already being edited
2499 return OK; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 other_file = TRUE;
2501 }
2502 else
2503 {
2504#ifdef FEAT_BROWSE
Bram Moolenaar2eed9ba2019-06-25 23:40:29 +02002505 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002507 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002508# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002509 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002510# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002511 au_has_group((char_u *)"FileExplorer"))
2512 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002513 // No browsing supported but we do have the file explorer:
2514 // Edit the directory.
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002515 if (ffname == NULL || !mch_isdir(ffname))
2516 ffname = (char_u *)".";
2517 }
2518 else
2519 {
2520 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002522 if (browse_file == NULL)
2523 goto theend;
2524 ffname = browse_file;
2525 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 }
2527#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002528 // if no short name given, use ffname for short name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 if (sfname == NULL)
2530 sfname = ffname;
2531#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01002532 if (sfname != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002533 fname_case(sfname, 0); // set correct case for sfname
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534#endif
2535
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
2537 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538
2539 if (ffname == NULL)
2540 other_file = TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002541 // there is no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 else if (*ffname == NUL && curbuf->b_ffname == NULL)
2543 other_file = FALSE;
2544 else
2545 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002546 if (*ffname == NUL) // re-edit with same file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 {
2548 ffname = curbuf->b_ffname;
2549 sfname = curbuf->b_fname;
2550 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002551 free_fname = fix_fname(ffname); // may expand to full path name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 if (free_fname != NULL)
2553 ffname = free_fname;
2554 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 }
2556 }
2557
2558 /*
2559 * if the file was changed we may not be allowed to abandon it
2560 * - if we are going to re-edit the same file
2561 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
2562 */
2563 if ( ((!other_file && !(flags & ECMD_OLDBUF))
2564 || (curbuf->b_nwindows == 1
2565 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002566 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
2567 | (other_file ? 0 : CCGD_MULTWIN)
2568 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
2569 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 {
2571 if (fnum == 0 && other_file && ffname != NULL)
2572 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
2573 goto theend;
2574 }
2575
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 /*
2577 * End Visual mode before switching to another buffer, so the text can be
2578 * copied into the GUI selection buffer.
2579 */
2580 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002582#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002583 if ((command != NULL || newlnum > (linenr_T)0)
2584 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
2585 {
2586 int len;
2587 char_u *p;
2588
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002589 // Set v:swapcommand for the SwapExists autocommands.
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002590 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002591 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002592 else
2593 len = 30;
Bram Moolenaar964b3742019-05-24 18:54:09 +02002594 p = alloc(len);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002595 if (p != NULL)
2596 {
2597 if (command != NULL)
2598 vim_snprintf((char *)p, len, ":%s\r", command);
2599 else
2600 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
2601 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
2602 did_set_swapcommand = TRUE;
2603 vim_free(p);
2604 }
2605 }
2606#endif
2607
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 /*
2609 * If we are starting to edit another file, open a (new) buffer.
2610 * Otherwise we re-use the current buffer.
2611 */
2612 if (other_file)
2613 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002616 if (!cmdmod.keepalt)
2617 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002618 if (oldwin != NULL)
2619 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 }
2621
2622 if (fnum)
2623 buf = buflist_findnr(fnum);
2624 else
2625 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 if (flags & ECMD_ADDBUF)
2627 {
2628 linenr_T tlnum = 1L;
2629
2630 if (command != NULL)
2631 {
2632 tlnum = atol((char *)command);
2633 if (tlnum <= 0)
2634 tlnum = 1L;
2635 }
2636 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
2637 goto theend;
2638 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 buf = buflist_new(ffname, sfname, 0L,
2640 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002641
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002642 // autocommands may change curwin and curbuf
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02002643 if (oldwin != NULL)
2644 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002645 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 }
2647 if (buf == NULL)
2648 goto theend;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002649 if (buf->b_ml.ml_mfp == NULL) // no memfile yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 {
2651 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002653 else // existing memfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 {
2655 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002656 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002658 // Check if autocommands made the buffer invalid or changed the
2659 // current buffer.
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002660 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 goto theend;
2662#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002663 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 goto theend;
2665#endif
2666 }
2667
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002668 // May jump to last used line number for a loaded buffer or when asked
2669 // for explicitly
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
2671 {
2672 pos = buflist_findfpos(buf);
2673 newlnum = pos->lnum;
2674 solcol = pos->col;
2675 }
2676
2677 /*
2678 * Make the (new) buffer the one used by the current window.
2679 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
2680 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01002681 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 */
2683 if (buf != curbuf)
2684 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 /*
2686 * Be careful: The autocommands may delete any buffer and change
2687 * the current buffer.
2688 * - If the buffer we are going to edit is deleted, give up.
2689 * - If the current buffer is deleted, prefer to load the new
2690 * buffer when loading a buffer is required. This avoids
2691 * loading another buffer which then must be closed again.
2692 * - If we ended up in the new buffer already, need to skip a few
2693 * things, set auto_buf.
2694 */
2695 if (buf->b_fname != NULL)
2696 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002697 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002699 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002701 // new buffer has been deleted
2702 delbuf_msg(new_name); // frees new_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 goto theend;
2704 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002705#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002706 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 {
2708 vim_free(new_name);
2709 goto theend;
2710 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002711#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002712 if (buf == curbuf) // already in new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 auto_buf = TRUE;
2714 else
2715 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02002716 win_T *the_curwin = curwin;
2717
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002718 // Set the w_closing flag to avoid that autocommands close the
2719 // window. And set b_locked for the same reason.
Bram Moolenaar5a497892016-09-03 16:29:04 +02002720 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002721 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02002722
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002723 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 buf_copy_options(buf, BCO_ENTER);
2725
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002726 // Close the link to the current buffer. This will set
2727 // oldwin->w_buffer to NULL.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002728 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002729 close_buffer(oldwin, curbuf,
Bram Moolenaara6e8f882019-12-14 16:18:15 +01002730 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
Bram Moolenaar5a497892016-09-03 16:29:04 +02002732 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002733 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01002734
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002735#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002736 // autocmds may abort script processing
Bram Moolenaar5a497892016-09-03 16:29:04 +02002737 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 {
2739 vim_free(new_name);
2740 goto theend;
2741 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002742#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002743 // Be careful again, like above.
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002744 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002746 // new buffer has been deleted
2747 delbuf_msg(new_name); // frees new_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 goto theend;
2749 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002750 if (buf == curbuf) // already in new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 auto_buf = TRUE;
2752 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02002754#ifdef FEAT_SYN_HL
2755 /*
2756 * <VN> We could instead free the synblock
2757 * and re-attach to buffer, perhaps.
2758 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02002759 if (curwin->w_buffer == NULL
2760 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02002761 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02002762#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 curwin->w_buffer = buf;
2764 curbuf = buf;
2765 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02002766
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002767 // Set 'fileformat', 'binary' and 'fenc' when forced.
Bram Moolenaarad875fb2013-07-24 15:02:03 +02002768 if (!oldbuf && eap != NULL)
2769 {
2770 set_file_options(TRUE, eap);
2771 set_forced_fenc(eap);
2772 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 }
2774
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002775 // May get the window options from the last time this buffer
2776 // was in this window (or another window). If not used
2777 // before, reset the local window options to the global
2778 // values. Also restores old folding stuff.
Bram Moolenaarb1269f12007-06-19 09:51:25 +00002779 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002780#ifdef FEAT_SPELL
2781 did_get_winopts = TRUE;
2782#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 }
2784 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002785 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02002786 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788
2789 curwin->w_pcmark.lnum = 1;
2790 curwin->w_pcmark.col = 0;
2791 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002792 else // !other_file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002794 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01002796
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 oldbuf = (flags & ECMD_OLDBUF);
2798 }
2799
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002800 // Don't redraw until the cursor is in the right line, otherwise
2801 // autocommands may cause ml_get errors.
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002802 ++RedrawingDisabled;
2803 did_inc_redrawing_disabled = TRUE;
2804
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002805 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 if ((flags & ECMD_SET_HELP) || keep_help_flag)
2807 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002808 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 }
2810 else
2811 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002812 // Don't make a buffer listed if it's a help buffer. Useful when
2813 // using CTRL-O to go back to a help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 if (!curbuf->b_help)
2815 set_buflisted(TRUE);
2816 }
2817
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002818 // If autocommands change buffers under our fingers, forget about
2819 // editing the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 if (buf != curbuf)
2821 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002822#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002823 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002825#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002827 // Since we are starting to edit a file, consider the filetype to be
2828 // unset. Helps for when an autocommand changes files and expects syntax
2829 // highlighting to work in the other file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831
2832/*
2833 * other_file oldbuf
2834 * FALSE FALSE re-edit same file, buffer is re-used
2835 * FALSE TRUE re-edit same file, nothing changes
2836 * TRUE FALSE start editing new file, new buffer
2837 * TRUE TRUE start editing in existing buffer (nothing to do)
2838 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002839 if (!other_file && !oldbuf) // re-use the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002841 set_last_cursor(curwin); // may set b_last_cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
2843 {
2844 newlnum = curwin->w_cursor.lnum;
2845 solcol = curwin->w_cursor.col;
2846 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 buf = curbuf;
2848 if (buf->b_fname != NULL)
2849 new_name = vim_strsave(buf->b_fname);
2850 else
2851 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002852 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002853
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002854 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
2855 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002856 // Save all the text, so that the reload can be undone.
2857 // Sync first so that this is a separate undo-able action.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002858 u_sync(FALSE);
2859 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
2860 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02002861 {
2862 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002863 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02002864 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002865 u_unchanged(curbuf);
2866 buf_freeall(curbuf, BFA_KEEP_UNDO);
2867
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002868 // tell readfile() not to clear or reload undo info
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002869 readfile_flags = READ_KEEP_UNDO;
2870 }
2871 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002872 buf_freeall(curbuf, 0); // free all things for buffer
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002873
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002874 // If autocommands deleted the buffer we were going to re-edit, give
2875 // up and jump to the end.
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002876 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002878 delbuf_msg(new_name); // frees new_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 goto theend;
2880 }
2881 vim_free(new_name);
2882
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002883 // If autocommands change buffers under our fingers, forget about
2884 // re-editing the file. Should do the buf_clear_file(), but perhaps
2885 // the autocommands changed the buffer...
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 if (buf != curbuf)
2887 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002888#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002889 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891#endif
2892 buf_clear_file(curbuf);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002893 curbuf->b_op_start.lnum = 0; // clear '[ and '] marks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 curbuf->b_op_end.lnum = 0;
2895 }
2896
2897/*
2898 * If we get here we are sure to start editing
2899 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002900 // Assume success now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 retval = OK;
2902
2903 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 * Check if we are editing the w_arg_idx file in the argument list.
2905 */
2906 check_arg_idx(curwin);
2907
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 {
2910 /*
2911 * Set cursor and init window before reading the file and executing
2912 * autocommands. This allows for the autocommands to position the
2913 * cursor.
2914 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00002915 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916
2917#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002918 // It's possible that all lines in the buffer changed. Need to update
2919 // automatic folding for all windows where it's used.
Bram Moolenaareb1b6792007-08-21 13:29:28 +00002920 {
2921 win_T *win;
2922 tabpage_T *tp;
2923
2924 FOR_ALL_TAB_WINDOWS(tp, win)
2925 if (win->w_buffer == curbuf)
2926 foldUpdateAll(win);
2927 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928#endif
2929
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002930 // Change directories when the 'acd' option is set.
Bram Moolenaar6f470022018-04-10 18:47:20 +02002931 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002932
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 /*
2934 * Careful: open_buffer() and apply_autocmds() may change the current
2935 * buffer and window.
2936 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01002937 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 topline = curwin->w_topline;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002939 if (!oldbuf) // need to read the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 {
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002941#ifdef FEAT_PROP_POPUP
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002942 // Don't use the swap-exists dialog for a popup window, can't edit
2943 // the buffer.
2944 if (WIN_IS_POPUP(curwin))
2945 curbuf->b_flags |= BF_NO_SEA;
2946#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 swap_exists_action = SEA_DIALOG;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002948 curbuf->b_flags |= BF_CHECK_RO; // set/reset 'ro' flag
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949
2950 /*
2951 * Open the buffer and read the file.
2952 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002953#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002954 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 retval = FAIL;
2956#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002957 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958#endif
2959
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002960#ifdef FEAT_PROP_POPUP
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002961 curbuf->b_flags &= ~BF_NO_SEA;
2962#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 if (swap_exists_action == SEA_QUIT)
2964 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002965 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 else
2968 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002969 // Read the modelines, but only to set window-local options. Any
2970 // buffer-local options have already been set and may have been
2971 // changed by the user.
Bram Moolenaara3227e22006-03-08 21:32:40 +00002972 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00002973
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
2975 &retval);
2976 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
2977 &retval);
2978 }
2979 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002981 // If autocommands change the cursor position or topline, we should
2982 // keep it. Also when it moves within a line. But not when it moves
2983 // to the first non-blank.
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01002984 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02002986 char_u *text = ml_get_curline();
2987
2988 if (curwin->w_cursor.lnum != orig_pos.lnum
2989 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
2990 {
2991 newlnum = curwin->w_cursor.lnum;
2992 newcol = curwin->w_cursor.col;
2993 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 }
2995 if (curwin->w_topline == topline)
2996 topline = 0;
2997
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002998 // Even when cursor didn't move we need to recompute topline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 changed_line_abv_curs();
3000
3001#ifdef FEAT_TITLE
3002 maketitle();
3003#endif
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003004#if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02003005 if (WIN_IS_POPUP(curwin) && curwin->w_p_pvw && retval != FAIL)
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02003006 popup_set_title(curwin);
3007#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 }
3009
3010#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003011 // Tell the diff stuff that this buffer is new and/or needs updating.
3012 // Also needed when re-editing the same buffer, because unloading will
3013 // have removed it as a diff buffer.
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003014 if (curwin->w_p_diff)
3015 {
3016 diff_buf_add(curbuf);
3017 diff_invalidate(curbuf);
3018 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019#endif
3020
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003021#ifdef FEAT_SPELL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003022 // If the window options were changed may need to set the spell language.
3023 // Can only do this after the buffer has been properly setup.
Bram Moolenaar860cae12010-06-05 23:22:07 +02003024 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3025 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003026#endif
3027
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 if (command == NULL)
3029 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003030 if (newcol >= 0) // position set by autocommands
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 {
3032 curwin->w_cursor.lnum = newlnum;
3033 curwin->w_cursor.col = newcol;
3034 check_cursor();
3035 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003036 else if (newlnum > 0) // line number from caller or old position
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 {
3038 curwin->w_cursor.lnum = newlnum;
3039 check_cursor_lnum();
3040 if (solcol >= 0 && !p_sol)
3041 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003042 // 'sol' is off: Use last known column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 curwin->w_cursor.col = solcol;
3044 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 curwin->w_set_curswant = TRUE;
3047 }
3048 else
3049 beginline(BL_SOL | BL_FIX);
3050 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003051 else // no line number, go to last line in Ex mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 {
3053 if (exmode_active)
3054 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3055 beginline(BL_WHITE | BL_FIX);
3056 }
3057 }
3058
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003059 // Check if cursors in other windows on the same buffer are still valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061
3062 /*
3063 * Did not read the file, need to show some info about the file.
3064 * Do this after setting the cursor.
3065 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003066 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 {
3068 int msg_scroll_save = msg_scroll;
3069
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003070 // Obey the 'O' flag in 'cpoptions': overwrite any previous file
3071 // message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3073 msg_scroll = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003074 if (!msg_scroll) // wait a bit when overwriting an error msg
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 check_for_delay(FALSE);
3076 msg_start();
3077 msg_scroll = msg_scroll_save;
3078 msg_scrolled_ign = TRUE;
3079
Bram Moolenaar426dd022016-03-15 15:09:29 +01003080 if (!shortmess(SHM_FILEINFO))
3081 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082
3083 msg_scrolled_ign = FALSE;
3084 }
3085
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02003086#ifdef FEAT_VIMINFO
3087 curbuf->b_last_used = vim_time();
3088#endif
3089
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 if (command != NULL)
3091 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3092
3093#ifdef FEAT_KEYMAP
3094 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003095 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096#endif
3097
3098 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003099 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 if (!skip_redraw)
3101 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01003102 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01003104 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003107 *so_ptr = n;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003108 redraw_curbuf_later(NOT_VALID); // redraw this buffer later
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 }
3110
3111 if (p_im)
3112 need_start_insertmode = TRUE;
3113
Bram Moolenaar15833232018-02-03 18:33:17 +01003114#ifdef FEAT_AUTOCHDIR
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003115 // Change directories when the 'acd' option is set and we aren't already in
3116 // that directory (should already be done above). Expect getcwd() to be
3117 // faster than calling shorten_fnames() unnecessarily.
Bram Moolenaar15833232018-02-03 18:33:17 +01003118 if (p_acd && curbuf->b_ffname != NULL)
3119 {
3120 char_u curdir[MAXPATHL];
3121 char_u filedir[MAXPATHL];
3122
3123 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
3124 *gettail_sep(filedir) = NUL;
3125 if (mch_dirname(curdir, MAXPATHL) != FAIL
3126 && vim_fnamecmp(curdir, filedir) != 0)
3127 do_autochdir();
3128 }
3129#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01003131#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003132 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003135 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003136 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137# endif
3138 }
3139#endif
3140
3141theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003142 if (did_inc_redrawing_disabled)
3143 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003144#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003145 if (did_set_swapcommand)
3146 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3147#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148#ifdef FEAT_BROWSE
3149 vim_free(browse_file);
3150#endif
3151 vim_free(free_fname);
3152 return retval;
3153}
3154
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003156delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003158 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 name == NULL ? (char_u *)"" : name);
3160 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003161 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02003162 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003165static int append_indent = 0; // autoindent for first line
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167/*
3168 * ":insert" and ":append", also used by ":change"
3169 */
3170 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003171ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172{
3173 char_u *theline;
3174 int did_undo = FALSE;
3175 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003176 int indent = 0;
3177 char_u *p;
3178 int vcol;
3179 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003181 // the ! flag toggles autoindent
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003182 if (eap->forceit)
3183 curbuf->b_p_ai = !curbuf->b_p_ai;
3184
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003185 // First autoindent comes from the line we start on
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003186 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3187 append_indent = get_indent_lnum(lnum);
3188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 if (eap->cmdidx != CMD_append)
3190 --lnum;
3191
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003192 // when the buffer is empty need to delete the dummy line
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003193 if (empty && lnum == 1)
3194 lnum = 0;
3195
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003196 State = INSERT; // behave like in Insert mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3198 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003199
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003200 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 {
3202 msg_scroll = TRUE;
3203 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003204 if (curbuf->b_p_ai)
3205 {
3206 if (append_indent >= 0)
3207 {
3208 indent = append_indent;
3209 append_indent = -1;
3210 }
3211 else if (lnum > 0)
3212 indent = get_indent_lnum(lnum);
3213 }
3214 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003216 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003217 // No getline() function, use the lines that follow. This ends
3218 // when there is no more.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003219 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3220 break;
3221 p = vim_strchr(eap->nextcmd, NL);
3222 if (p == NULL)
3223 p = eap->nextcmd + STRLEN(eap->nextcmd);
3224 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3225 if (*p != NUL)
3226 ++p;
3227 eap->nextcmd = p;
3228 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003230 {
3231 int save_State = State;
3232
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003233 // Set State to avoid the cursor shape to be set to INSERT mode
3234 // when getline() returns.
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003235 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 theline = eap->getline(
3237#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003238 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239#endif
Bram Moolenaare96a2492019-06-25 04:12:16 +02003240 NUL, eap->cookie, indent, TRUE);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003241 State = save_State;
3242 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003244 if (theline == NULL)
3245 break;
3246
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003247 // Using ^ CTRL-D in getexmodeline() makes us repeat the indent.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003248 if (ex_keep_indent)
3249 append_indent = indent;
3250
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003251 // Look for the "." after automatic indent.
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003252 vcol = 0;
3253 for (p = theline; indent > vcol; ++p)
3254 {
3255 if (*p == ' ')
3256 ++vcol;
3257 else if (*p == TAB)
3258 vcol += 8 - vcol % 8;
3259 else
3260 break;
3261 }
3262 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003263 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3264 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 {
3266 vim_free(theline);
3267 break;
3268 }
3269
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003270 // don't use autoindent if nothing was typed.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003271 if (p[0] == NUL)
3272 theline[0] = NUL;
3273
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 did_undo = TRUE;
3275 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02003276 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277
3278 vim_free(theline);
3279 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003280
3281 if (empty)
3282 {
3283 ml_delete(2L, FALSE);
3284 empty = FALSE;
3285 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 }
3287 State = NORMAL;
3288
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003289 if (eap->forceit)
3290 curbuf->b_p_ai = !curbuf->b_p_ai;
3291
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003292 // "start" is set to eap->line2+1 unless that position is invalid (when
3293 // eap->line2 pointed to the end of the buffer and nothing was appended)
3294 // "end" is set to lnum when something has been appended, otherwise
3295 // it is the same than "start" -- Acevedo
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01003296 if (!cmdmod.lockmarks)
3297 {
3298 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3299 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3300 if (eap->cmdidx != CMD_append)
3301 --curbuf->b_op_start.lnum;
3302 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3303 ? lnum : curbuf->b_op_start.lnum;
3304 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3305 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 curwin->w_cursor.lnum = lnum;
3307 check_cursor_lnum();
3308 beginline(BL_SOL | BL_FIX);
3309
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003310 need_wait_return = FALSE; // don't use wait_return() now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 ex_no_reprint = TRUE;
3312}
3313
3314/*
3315 * ":change"
3316 */
3317 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003318ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319{
3320 linenr_T lnum;
3321
3322 if (eap->line2 >= eap->line1
3323 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3324 return;
3325
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003326 // the ! flag toggles autoindent
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003327 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3328 append_indent = get_indent_lnum(eap->line1);
3329
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3331 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003332 if (curbuf->b_ml.ml_flags & ML_EMPTY) // nothing to delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 break;
3334 ml_delete(eap->line1, FALSE);
3335 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00003336
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003337 // make sure the cursor is not beyond the end of the file now
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00003338 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3340
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003341 // ":append" on the line above the deleted lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 eap->line2 = eap->line1;
3343 ex_append(eap);
3344}
3345
3346 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003347ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348{
3349 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003350 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003351 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 int minus = 0;
3353 linenr_T start, end, curs, i;
3354 int j;
3355 linenr_T lnum = eap->line2;
3356
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003357 // Vi compatible: ":z!" uses display height, without a count uses
3358 // 'scroll'
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003359 if (eap->forceit)
3360 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01003361 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003362 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01003363 else
3364 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 if (bigness < 1)
3366 bigness = 1;
3367
3368 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003369 kind = x;
3370 if (*kind == '-' || *kind == '+' || *kind == '='
3371 || *kind == '^' || *kind == '.')
3372 ++x;
3373 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 ++x;
3375
3376 if (*x != 0)
3377 {
3378 if (!VIM_ISDIGIT(*x))
3379 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003380 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 return;
3382 }
3383 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003384 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003385 bigness = atol((char *)x);
3386
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003387 // bigness could be < 0 if atol(x) overflows.
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003388 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
3389 bigness = 2 * curbuf->b_ml.ml_line_count;
3390
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003391 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003392 if (*kind == '=')
3393 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003394 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 }
3396
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003397 // the number of '-' and '+' multiplies the distance
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003398 if (*kind == '-' || *kind == '+')
3399 for (x = kind + 1; *x == *kind; ++x)
3400 ;
3401
3402 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 {
3404 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02003405 start = lnum - bigness * (linenr_T)(x - kind) + 1;
3406 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003407 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 break;
3409
3410 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003411 start = lnum - (bigness + 1) / 2 + 1;
3412 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 curs = lnum;
3414 minus = 1;
3415 break;
3416
3417 case '^':
3418 start = lnum - bigness * 2;
3419 end = lnum - bigness;
3420 curs = lnum - bigness;
3421 break;
3422
3423 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003424 start = lnum - (bigness + 1) / 2 + 1;
3425 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 curs = end;
3427 break;
3428
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003429 default: // '+'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003431 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003432 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003433 else if (eap->addr_count == 0)
3434 ++start;
3435 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 curs = end;
3437 break;
3438 }
3439
3440 if (start < 1)
3441 start = 1;
3442
3443 if (end > curbuf->b_ml.ml_line_count)
3444 end = curbuf->b_ml.ml_line_count;
3445
3446 if (curs > curbuf->b_ml.ml_line_count)
3447 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003448 else if (curs < 1)
3449 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450
3451 for (i = start; i <= end; i++)
3452 {
3453 if (minus && i == lnum)
3454 {
3455 msg_putchar('\n');
3456
3457 for (j = 1; j < Columns; j++)
3458 msg_putchar('-');
3459 }
3460
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003461 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462
3463 if (minus && i == lnum)
3464 {
3465 msg_putchar('\n');
3466
3467 for (j = 1; j < Columns; j++)
3468 msg_putchar('-');
3469 }
3470 }
3471
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003472 if (curwin->w_cursor.lnum != curs)
3473 {
3474 curwin->w_cursor.lnum = curs;
3475 curwin->w_cursor.col = 0;
3476 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 ex_no_reprint = TRUE;
3478}
3479
3480/*
3481 * Check if the restricted flag is set.
3482 * If so, give an error message and return TRUE.
3483 * Otherwise, return FALSE.
3484 */
3485 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003486check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487{
3488 if (restricted)
3489 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01003490 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 return TRUE;
3492 }
3493 return FALSE;
3494}
3495
3496/*
3497 * Check if the secure flag is set (.exrc or .vimrc in current directory).
3498 * If so, give an error message and return TRUE.
3499 * Otherwise, return FALSE.
3500 */
3501 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003502check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503{
3504 if (secure)
3505 {
3506 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003507 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 return TRUE;
3509 }
3510#ifdef HAVE_SANDBOX
3511 /*
3512 * In the sandbox more things are not allowed, including the things
3513 * disallowed in secure mode.
3514 */
3515 if (sandbox != 0)
3516 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003517 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 return TRUE;
3519 }
3520#endif
3521 return FALSE;
3522}
3523
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003524static char_u *old_sub = NULL; // previous substitute pattern
3525static int global_need_beginline; // call beginline() after ":g"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003527/*
3528 * Flags that are kept between calls to :substitute.
3529 */
3530typedef struct {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003531 int do_all; // do multiple substitutions per line
3532 int do_ask; // ask for confirmation
3533 int do_count; // count only
3534 int do_error; // if false, ignore errors
3535 int do_print; // print last line with subs.
3536 int do_list; // list last line with subs.
3537 int do_number; // list last line with line nr
3538 int do_ic; // ignore case flag
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003539} subflags_T;
3540
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003541/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 * Perform a substitution from line eap->line1 to line eap->line2 using the
3543 * command pointed to by eap->arg which should be of the form:
3544 *
3545 * /pattern/substitution/{flags}
3546 *
3547 * The usual escapes are supported as described in the regexp docs.
3548 */
3549 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003550do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551{
3552 linenr_T lnum;
3553 long i = 0;
3554 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003555 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
3556 FALSE, FALSE, 0};
3557#ifdef FEAT_EVAL
3558 subflags_T subflags_save;
3559#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003560 int save_do_all; // remember user specified 'g' flag
3561 int save_do_ask; // remember user specified 'c' flag
3562 char_u *pat = NULL, *sub = NULL; // init for GCC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 int delimiter;
3564 int sublen;
3565 int got_quit = FALSE;
3566 int got_match = FALSE;
3567 int temp;
3568 int which_pat;
3569 char_u *cmd;
3570 int save_State;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003571 linenr_T first_line = 0; // first changed line
3572 linenr_T last_line= 0; // below last changed line AFTER the
3573 // change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
3575 linenr_T line2;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003576 long nmatch; // number of lines in match
3577 char_u *sub_firstline; // allocated copy of first sub line
3578 int endcolumn = FALSE; // cursor in last column when done
Bram Moolenaar05159a02005-02-26 23:04:13 +00003579 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01003580 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003581#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02003582 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003583#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584
3585 cmd = eap->arg;
3586 if (!global_busy)
3587 {
3588 sub_nsubs = 0;
3589 sub_nlines = 0;
3590 }
Bram Moolenaar46475522010-03-23 17:36:29 +01003591 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 if (eap->cmdidx == CMD_tilde)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003594 which_pat = RE_LAST; // use last used regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003596 which_pat = RE_SUBST; // use last substitute regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003598 // new pattern and substitution
Bram Moolenaar1c465442017-03-12 20:10:05 +01003599 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
3601 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003602 // don't accept alphanumeric for separator
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 if (isalpha(*cmd))
3604 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003605 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 return;
3607 }
3608 /*
3609 * undocumented vi feature:
3610 * "\/sub/" and "\?sub?" use last used search pattern (almost like
3611 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
3612 */
3613 if (*cmd == '\\')
3614 {
3615 ++cmd;
3616 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
3617 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003618 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 return;
3620 }
3621 if (*cmd != '&')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003622 which_pat = RE_SEARCH; // use last '/' pattern
3623 pat = (char_u *)""; // empty search pattern
3624 delimiter = *cmd++; // remember delimiter character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003626 else // find the end of the regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003628 which_pat = RE_LAST; // use last used regexp
3629 delimiter = *cmd++; // remember delimiter character
3630 pat = cmd; // remember start of search pat
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02003631 cmd = skip_regexp_ex(cmd, delimiter, p_magic, &eap->arg, NULL);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003632 if (cmd[0] == delimiter) // end delimiter found
3633 *cmd++ = NUL; // replace it with a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 }
3635
3636 /*
3637 * Small incompatibility: vi sees '\n' as end of the command, but in
3638 * Vim we want to use '\n' to find/substitute a NUL.
3639 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003640 sub = cmd; // remember the start of the substitution
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641
3642 while (cmd[0])
3643 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003644 if (cmd[0] == delimiter) // end delimiter found
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003646 *cmd++ = NUL; // replace it with a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 break;
3648 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003649 if (cmd[0] == '\\' && cmd[1] != 0) // skip escaped characters
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003651 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 }
3653
3654 if (!eap->skip)
3655 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003656 // In POSIX vi ":s/pat/%/" uses the previous subst. string.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003657 if (STRCMP(sub, "%") == 0
3658 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
3659 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003660 if (old_sub == NULL) // there is no previous command
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003661 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003662 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003663 return;
3664 }
3665 sub = old_sub;
3666 }
3667 else
3668 {
3669 vim_free(old_sub);
3670 old_sub = vim_strsave(sub);
3671 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 }
3673 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003674 else if (!eap->skip) // use previous pattern and substitution
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003676 if (old_sub == NULL) // there is no previous command
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003678 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 return;
3680 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003681 pat = NULL; // search_regcomp() will use previous pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003683
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003684 // Vi compatibility quirk: repeating with ":s" keeps the cursor in the
3685 // last column after using "$".
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003686 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 }
3688
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003689 // Recognize ":%s/\n//" and turn it into a join command, which is much
3690 // more efficient.
3691 // TODO: find a generic solution to make line-joining operations more
3692 // efficient, avoid allocating a string that grows in size.
Bram Moolenaar21e854e2014-04-04 19:00:48 +02003693 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003694 && *sub == NUL
3695 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
3696 || *cmd == 'p' || *cmd == '#'))))
3697 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003698 linenr_T joined_lines_count;
3699
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003700 curwin->w_cursor.lnum = eap->line1;
3701 if (*cmd == 'l')
3702 eap->flags = EXFLAG_LIST;
3703 else if (*cmd == '#')
3704 eap->flags = EXFLAG_NR;
3705 else if (*cmd == 'p')
3706 eap->flags = EXFLAG_PRINT;
3707
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003708 // The number of lines joined is the number of lines in the range plus
3709 // one. One less when the last line is included.
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003710 joined_lines_count = eap->line2 - eap->line1 + 1;
3711 if (eap->line2 < curbuf->b_ml.ml_line_count)
3712 ++joined_lines_count;
3713 if (joined_lines_count > 1)
3714 {
3715 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
3716 sub_nsubs = joined_lines_count - 1;
3717 sub_nlines = 1;
3718 (void)do_sub_msg(FALSE);
3719 ex_may_print(eap);
3720 }
3721
3722 if (!cmdmod.keeppatterns)
3723 save_re_pat(RE_SUBST, pat, p_magic);
Bram Moolenaard7663c22019-08-06 21:59:57 +02003724 // put pattern in history
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003725 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003726
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003727 return;
3728 }
3729
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 /*
3731 * Find trailing options. When '&' is used, keep old options.
3732 */
3733 if (*cmd == '&')
3734 ++cmd;
3735 else
3736 {
3737 if (!p_ed)
3738 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003739 if (p_gd) // default is global on
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003740 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003742 subflags.do_all = FALSE;
3743 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003745 subflags.do_error = TRUE;
3746 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01003747 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003748 subflags.do_count = FALSE;
3749 subflags.do_number = FALSE;
3750 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 }
3752 while (*cmd)
3753 {
3754 /*
3755 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
3756 * 'r' is never inverted.
3757 */
3758 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003759 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003761 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003762 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003763 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003765 subflags.do_error = !subflags.do_error;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003766 else if (*cmd == 'r') // use last used regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 which_pat = RE_LAST;
3768 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003769 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003770 else if (*cmd == '#')
3771 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003772 subflags.do_print = TRUE;
3773 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003774 }
3775 else if (*cmd == 'l')
3776 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003777 subflags.do_print = TRUE;
3778 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003779 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003780 else if (*cmd == 'i') // ignore case
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003781 subflags.do_ic = 'i';
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003782 else if (*cmd == 'I') // don't ignore case
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003783 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 else
3785 break;
3786 ++cmd;
3787 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003788 if (subflags.do_count)
3789 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003791 save_do_all = subflags.do_all;
3792 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02003793
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 /*
3795 * check for a trailing count
3796 */
3797 cmd = skipwhite(cmd);
3798 if (VIM_ISDIGIT(*cmd))
3799 {
3800 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003801 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003803 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 return;
3805 }
3806 eap->line1 = eap->line2;
3807 eap->line2 += i - 1;
3808 if (eap->line2 > curbuf->b_ml.ml_line_count)
3809 eap->line2 = curbuf->b_ml.ml_line_count;
3810 }
3811
3812 /*
3813 * check for trailing command or garbage
3814 */
3815 cmd = skipwhite(cmd);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003816 if (*cmd && *cmd != '"') // if not end-of-line or comment
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 {
3818 eap->nextcmd = check_nextcmd(cmd);
3819 if (eap->nextcmd == NULL)
3820 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003821 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 return;
3823 }
3824 }
3825
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003826 if (eap->skip) // not executing commands, only parsing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 return;
3828
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003829 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003830 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003831 // Substitution is not allowed in non-'modifiable' buffer
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003832 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003833 return;
3834 }
3835
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
3837 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003838 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003839 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 return;
3841 }
3842
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003843 // the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase'
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003844 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003846 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 regmatch.rmm_ic = FALSE;
3848
3849 sub_firstline = NULL;
3850
3851 /*
3852 * ~ in the substitute pattern is replaced with the old pattern.
3853 * We do it here once to avoid it to be replaced over and over again.
3854 * But don't do it when it starts with "\=", then it's an expression.
3855 */
3856 if (!(sub[0] == '\\' && sub[1] == '='))
3857 sub = regtilde(sub, p_magic);
3858
3859 /*
3860 * Check for a match on each line.
3861 */
3862 line2 = eap->line2;
3863 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003864#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 || aborting()
3866#endif
3867 ); ++lnum)
3868 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003869 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02003870 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 if (nmatch)
3872 {
3873 colnr_T copycol;
3874 colnr_T matchcol;
3875 colnr_T prev_matchcol = MAXCOL;
3876 char_u *new_end, *new_start = NULL;
3877 unsigned new_start_len = 0;
3878 char_u *p1;
3879 int did_sub = FALSE;
3880 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003881 int len, copy_len, needed_len;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003882 long nmatch_tl = 0; // nr of lines matched below lnum
3883 int do_again; // do it again after joining lines
Bram Moolenaar8299df92004-07-10 09:47:34 +00003884 int skip_match = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003885 linenr_T sub_firstlnum; // nr of first sub line
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003886#ifdef FEAT_PROP_POPUP
Bram Moolenaarf3333b02019-05-19 22:53:40 +02003887 int apc_flags = APC_SAVE_FOR_UNDO | APC_SUBSTITUTE;
Bram Moolenaarc7488a72019-10-26 12:23:04 +02003888 colnr_T total_added = 0;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02003889#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890
3891 /*
3892 * The new text is build up step by step, to avoid too much
3893 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00003894 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 * copycol Column in the old text where we started
3896 * looking for a match; from here old text still
3897 * needs to be copied to the new text.
3898 * matchcol Column number of the old text where to look
3899 * for the next match. It's just after the
3900 * previous match or one further.
3901 * prev_matchcol Column just after the previous match (if any).
3902 * Mostly equal to matchcol, except for the first
3903 * match and after skipping an empty match.
3904 * regmatch.*pos Where the pattern matched in the old text.
3905 * new_start The new text, all that has been produced so
3906 * far.
3907 * new_end The new text, where to append new text.
3908 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003909 * lnum The line number where we found the start of
3910 * the match. Can be below the line we searched
3911 * when there is a \n before a \zs in the
3912 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 * sub_firstlnum The line number in the buffer where to look
3914 * for a match. Can be different from "lnum"
3915 * when the pattern or substitute string contains
3916 * line breaks.
3917 *
3918 * Special situations:
3919 * - When the substitute string contains a line break, the part up
3920 * to the line break is inserted in the text, but the copy of
3921 * the original line is kept. "sub_firstlnum" is adjusted for
3922 * the inserted lines.
3923 * - When the matched pattern contains a line break, the old line
3924 * is taken from the line at the end of the pattern. The lines
3925 * in the match are deleted later, "sub_firstlnum" is adjusted
3926 * accordingly.
3927 *
3928 * The new text is built up in new_start[]. It has some extra
3929 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00003930 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 *
3932 * Make a copy of the old line, so it won't be taken away when
3933 * updating the screen or handling a multi-line match. The "old_"
3934 * pointers point into this copy.
3935 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003936 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 copycol = 0;
3938 matchcol = 0;
3939
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003940 // At first match, remember current cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 if (!got_match)
3942 {
3943 setpcmark();
3944 got_match = TRUE;
3945 }
3946
3947 /*
3948 * Loop until nothing more to replace in this line.
3949 * 1. Handle match with empty string.
3950 * 2. If do_ask is set, ask for confirmation.
3951 * 3. substitute the string.
3952 * 4. if do_all is set, find next match
3953 * 5. break if there isn't another match in this line
3954 */
3955 for (;;)
3956 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003957 // Advance "lnum" to the line where the match starts. The
3958 // match does not start in the first line when there is a line
3959 // break before \zs.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003960 if (regmatch.startpos[0].lnum > 0)
3961 {
3962 lnum += regmatch.startpos[0].lnum;
3963 sub_firstlnum += regmatch.startpos[0].lnum;
3964 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01003965 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003966 }
3967
Bram Moolenaarbb265962019-10-31 04:38:36 +01003968 // Match might be after the last line for "\n\zs" matching at
3969 // the end of the last line.
3970 if (lnum > curbuf->b_ml.ml_line_count)
3971 break;
3972
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003973 if (sub_firstline == NULL)
3974 {
3975 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
3976 if (sub_firstline == NULL)
3977 {
3978 vim_free(new_start);
3979 goto outofmem;
3980 }
3981 }
3982
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003983 // Save the line number of the last change for the final
3984 // cursor position (just like Vi).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 curwin->w_cursor.lnum = lnum;
3986 do_again = FALSE;
3987
3988 /*
3989 * 1. Match empty string does not count, except for first
3990 * match. This reproduces the strange vi behaviour.
3991 * This also catches endless loops.
3992 */
3993 if (matchcol == prev_matchcol
3994 && regmatch.endpos[0].lnum == 0
3995 && matchcol == regmatch.endpos[0].col)
3996 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00003997 if (sub_firstline[matchcol] == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003998 // We already were at the end of the line. Don't look
3999 // for a match in this line again.
Bram Moolenaar8299df92004-07-10 09:47:34 +00004000 skip_match = TRUE;
4001 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004002 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004003 // search for a match at next column
Bram Moolenaar0df11022011-05-19 14:30:16 +02004004 if (has_mbyte)
4005 matchcol += mb_ptr2len(sub_firstline + matchcol);
4006 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004007 ++matchcol;
4008 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 goto skip;
4010 }
4011
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004012 // Normally we continue searching for a match just after the
4013 // previous match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 matchcol = regmatch.endpos[0].col;
4015 prev_matchcol = matchcol;
4016
4017 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004018 * 2. If do_count is set only increase the counter.
4019 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004021 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004022 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004023 // For a multi-line match, put matchcol at the NUL at
4024 // the end of the line and set nmatch to one, so that
4025 // we continue looking for a match on the next line.
4026 // Avoids that ":s/\nB\@=//gc" get stuck.
Bram Moolenaar05159a02005-02-26 23:04:13 +00004027 if (nmatch > 1)
4028 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004029 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004030 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004031 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004032 }
4033 sub_nsubs++;
4034 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004035#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004036 // Skip the substitution, unless an expression is used,
4037 // then it is evaluated in the sandbox.
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004038 if (!(sub[0] == '\\' && sub[1] == '='))
4039#endif
4040 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004041 }
4042
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004043 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004045 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004046
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004047 // change State to CONFIRM, so that the mouse works
4048 // properly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 save_State = State;
4050 State = CONFIRM;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02004051 setmouse(); // disable mouse in xterm
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01004053 if (curwin->w_p_crb)
4054 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004056 // When 'cpoptions' contains "u" don't sync undo when
4057 // asking for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4059 ++no_u_sync;
4060
4061 /*
4062 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4063 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004064 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004066 if (exmode_active)
4067 {
4068 char_u *resp;
4069 colnr_T sc, ec;
4070
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004071 print_line_no_prefix(lnum,
4072 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004073
4074 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4075 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01004076 if (curwin->w_cursor.col < 0)
4077 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004078 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004079 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02004080 {
4081 int numw = number_width(curwin) + 1;
4082 sc += numw;
4083 ec += numw;
4084 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004085 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004086 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004087 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004088 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004089 msg_putchar('^');
4090
Bram Moolenaare96a2492019-06-25 04:12:16 +02004091 resp = getexmodeline('?', NULL, 0, TRUE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004092 if (resp != NULL)
4093 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004094 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004095 vim_free(resp);
4096 }
4097 }
4098 else
4099 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004100 char_u *orig_line = NULL;
4101 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004103 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004105 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004107 // Invert the matched string.
4108 // Remove the inversion afterwards.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004109 temp = RedrawingDisabled;
4110 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004112 if (new_start != NULL)
4113 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004114 // There already was a substitution, we would
4115 // like to show this to the user. We cannot
4116 // really update the line, it would change
4117 // what matches. Temporarily replace the line
4118 // and change it back afterwards.
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004119 orig_line = vim_strsave(ml_get(lnum));
4120 if (orig_line != NULL)
4121 {
4122 char_u *new_line = concat_str(new_start,
4123 sub_firstline + copycol);
4124
4125 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01004126 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004127 else
4128 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004129 // Position the cursor relative to the
4130 // end of the line, the previous
4131 // substitute may have inserted or
4132 // deleted characters before the
4133 // cursor.
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004134 len_change = (int)STRLEN(new_line)
4135 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004136 curwin->w_cursor.col += len_change;
4137 ml_replace(lnum, new_line, FALSE);
4138 }
4139 }
4140 }
4141
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004142 search_match_lines = regmatch.endpos[0].lnum
4143 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004144 search_match_endcol = regmatch.endpos[0].col
4145 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004146 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004148 update_topline();
4149 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004150 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004151 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004152 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153
4154#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004155 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004157 if (msg_row == Rows - 1)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004158 msg_didout = FALSE; // avoid a scroll-up
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004159 msg_starthere();
4160 i = msg_scroll;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004161 msg_scroll = 0; // truncate msg when
4162 // needed
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004163 msg_no_more = TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004164 // write message same highlighting as for
4165 // wait_return
Bram Moolenaar8820b482017-03-16 17:23:31 +01004166 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004167 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004168 msg_no_more = FALSE;
4169 msg_scroll = i;
4170 showruler(TRUE);
4171 windgoto(msg_row, msg_col);
4172 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173
4174#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004175 dont_scroll = FALSE; // allow scrolling here
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004177 ++no_mapping; // don't map this key
4178 ++allow_keys; // allow special keys
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004179 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004180 --allow_keys;
4181 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004183 // clear the question
4184 msg_didout = FALSE; // don't scroll up
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004185 msg_col = 0;
4186 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004187
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004188 // restore the line
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004189 if (orig_line != NULL)
4190 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004191 }
4192
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004193 need_wait_return = FALSE; // no hit-return prompt
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004194 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004196 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197#endif
4198 )
4199 {
4200 got_quit = TRUE;
4201 break;
4202 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004203 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004205 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004207 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004209 // last: replace and then stop
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004210 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 line2 = lnum;
4212 break;
4213 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004214 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004216 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 break;
4218 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004219 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004221 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 scrolldown_clamp();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 }
4224 State = save_State;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4227 --no_u_sync;
4228
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004229 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004231 // For a multi-line match, put matchcol at the NUL at
4232 // the end of the line and set nmatch to one, so that
4233 // we continue looking for a match on the next line.
4234 // Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4235 // get stuck when pressing 'n'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 if (nmatch > 1)
4237 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004238 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004239 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 }
4241 goto skip;
4242 }
4243 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004244 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 }
4246
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004247 // Move the cursor to the start of the match, so that we can
4248 // use "\=col(".").
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 curwin->w_cursor.col = regmatch.startpos[0].col;
4250
4251 /*
4252 * 3. substitute the string.
4253 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004254#ifdef FEAT_EVAL
Bram Moolenaar80341bc2019-05-20 20:34:51 +02004255 save_ma = curbuf->b_p_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004256 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004257 {
Bram Moolenaar6349e942019-05-18 13:41:22 +02004258 // prevent accidentally changing the buffer by a function
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004259 curbuf->b_p_ma = FALSE;
4260 sandbox++;
4261 }
Bram Moolenaar6349e942019-05-18 13:41:22 +02004262 // Save flags for recursion. They can change for e.g.
4263 // :s/^/\=execute("s#^##gn")
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004264 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004265#endif
Bram Moolenaar6349e942019-05-18 13:41:22 +02004266 // get length of substitution part
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004267 sublen = vim_regsub_multi(&regmatch,
4268 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004270#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004271 // If getting the substitute string caused an error, don't do
4272 // the replacement.
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004273 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004274 subflags = subflags_save;
Bram Moolenaar6349e942019-05-18 13:41:22 +02004275 if (aborting() || subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004276 {
4277 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004278 if (sandbox > 0)
4279 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004280 goto skip;
4281 }
4282#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004284 // When the match included the "$" of the last line it may
4285 // go beyond the last line of the buffer.
Bram Moolenaar4463f292005-09-25 22:20:24 +00004286 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4287 {
4288 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4289 skip_match = TRUE;
4290 }
4291
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004292 // Need room for:
4293 // - result so far in new_start (not for first sub in line)
4294 // - original text up to match
4295 // - length of substituted part
4296 // - original text after match
4297 // Adjust text properties here, since we have all information
4298 // needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004300 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 p1 = sub_firstline;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004302#ifdef FEAT_PROP_POPUP
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004303 if (curbuf->b_has_textprop)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004304 {
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004305 int bytes_added = sublen - 1 - (regmatch.endpos[0].col
4306 - regmatch.startpos[0].col);
4307
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004308 // When text properties are changed, need to save for
4309 // undo first, unless done already.
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004310 if (adjust_prop_columns(lnum,
4311 total_added + regmatch.startpos[0].col,
4312 bytes_added, apc_flags))
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004313 apc_flags &= ~APC_SAVE_FOR_UNDO;
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004314 // Offset for column byte number of the text property
4315 // in the resulting buffer afterwards.
4316 total_added += bytes_added;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004317 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004318#endif
4319 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 else
4321 {
4322 p1 = ml_get(sub_firstlnum + nmatch - 1);
4323 nmatch_tl += nmatch - 1;
4324 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004325 copy_len = regmatch.startpos[0].col - copycol;
4326 needed_len = copy_len + ((unsigned)STRLEN(p1)
4327 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 if (new_start == NULL)
4329 {
4330 /*
4331 * Get some space for a temporary buffer to do the
4332 * substitution into (and some extra space to avoid
4333 * too many calls to alloc()/free()).
4334 */
4335 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004336 if ((new_start = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 goto outofmem;
4338 *new_start = NUL;
4339 new_end = new_start;
4340 }
4341 else
4342 {
4343 /*
4344 * Check if the temporary buffer is long enough to do the
4345 * substitution into. If not, make it larger (with a bit
4346 * extra to avoid too many calls to alloc()/free()).
4347 */
4348 len = (unsigned)STRLEN(new_start);
4349 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004350 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 {
4352 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004353 if ((p1 = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 {
4355 vim_free(new_start);
4356 goto outofmem;
4357 }
4358 mch_memmove(p1, new_start, (size_t)(len + 1));
4359 vim_free(new_start);
4360 new_start = p1;
4361 }
4362 new_end = new_start + len;
4363 }
4364
4365 /*
4366 * copy the text up to the part that matched
4367 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004368 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4369 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004371 (void)vim_regsub_multi(&regmatch,
4372 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 sub, new_end, TRUE, p_magic, TRUE);
4374 sub_nsubs++;
4375 did_sub = TRUE;
4376
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004377 // Move the cursor to the start of the line, to avoid that it
4378 // is beyond the end of the line after the substitution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 curwin->w_cursor.col = 0;
4380
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004381 // For a multi-line match, make a copy of the last matched
4382 // line and continue in that one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 if (nmatch > 1)
4384 {
4385 sub_firstlnum += nmatch - 1;
4386 vim_free(sub_firstline);
4387 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004388 // When going beyond the last line, stop substituting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 if (sub_firstlnum <= line2)
4390 do_again = TRUE;
4391 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004392 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 }
4394
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004395 // Remember next character to be copied.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 copycol = regmatch.endpos[0].col;
4397
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004398 if (skip_match)
4399 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004400 // Already hit end of the buffer, sub_firstlnum is one
4401 // less than what it ought to be.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004402 vim_free(sub_firstline);
4403 sub_firstline = vim_strsave((char_u *)"");
4404 copycol = 0;
4405 }
4406
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 /*
4408 * Now the trick is to replace CTRL-M chars with a real line
4409 * break. This would make it impossible to insert a CTRL-M in
4410 * the text. The line break can be avoided by preceding the
4411 * CTRL-M with a backslash. To be able to insert a backslash,
4412 * they must be doubled in the string and are halved here.
4413 * That is Vi compatible.
4414 */
4415 for (p1 = new_end; *p1; ++p1)
4416 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004417 if (p1[0] == '\\' && p1[1] != NUL) // remove backslash
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004418 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004419 STRMOVE(p1, p1 + 1);
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004420#ifdef FEAT_PROP_POPUP
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004421 if (curbuf->b_has_textprop)
4422 {
4423 // When text properties are changed, need to save
4424 // for undo first, unless done already.
4425 if (adjust_prop_columns(lnum,
4426 (colnr_T)(p1 - new_start), -1,
4427 apc_flags))
4428 apc_flags &= ~APC_SAVE_FOR_UNDO;
4429 }
4430#endif
4431 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 else if (*p1 == CAR)
4433 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004434 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004436 colnr_T plen = (colnr_T)(p1 - new_start + 1);
4437
4438 *p1 = NUL; // truncate up to the CR
4439 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004441 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 appended_lines(lnum - 1, 1L);
4443 else
4444 {
4445 if (first_line == 0)
4446 first_line = lnum;
4447 last_line = lnum + 1;
4448 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004449#ifdef FEAT_PROP_POPUP
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02004450 adjust_props_for_split(lnum + 1, lnum, plen, 1);
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004451#endif
4452 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 ++sub_firstlnum;
4454 ++lnum;
4455 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004456 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004458 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004459 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 p1 = new_start - 1;
4461 }
4462 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004464 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 }
4466
4467 /*
4468 * 4. If do_all is set, find next match.
4469 * Prevent endless loop with patterns that match empty
4470 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4471 * But ":s/\n/#/" is OK.
4472 */
4473skip:
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004474 // We already know that we did the last subst when we are at
4475 // the end of the line, except that a pattern like
4476 // "bar\|\nfoo" may match at the NUL. "lnum" can be below
4477 // "line2" when there is a \zs in the pattern after a line
4478 // break.
Bram Moolenaar8299df92004-07-10 09:47:34 +00004479 lastone = (skip_match
4480 || got_int
4481 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004482 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004483 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00004484 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4485 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 nmatch = -1;
4487
4488 /*
4489 * Replace the line in the buffer when needed. This is
4490 * skipped when there are more matches.
4491 * The check for nmatch_tl is needed for when multi-line
4492 * matching must replace the lines before trying to do another
4493 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004494 * When the match starts below where we start searching also
4495 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 */
4497 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 || nmatch_tl > 0
4499 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004500 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004501 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004502 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 {
4504 if (new_start != NULL)
4505 {
4506 /*
4507 * Copy the rest of the line, that didn't match.
4508 * "matchcol" has to be adjusted, we use the end of
4509 * the line as reference, because the substitute may
4510 * have changed the number of characters. Same for
4511 * "prev_matchcol".
4512 */
4513 STRCAT(new_start, sub_firstline + copycol);
4514 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4515 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4516 - prev_matchcol;
4517
4518 if (u_savesub(lnum) != OK)
4519 break;
4520 ml_replace(lnum, new_start, TRUE);
4521
4522 if (nmatch_tl > 0)
4523 {
4524 /*
4525 * Matched lines have now been substituted and are
4526 * useless, delete them. The part after the match
4527 * has been appended to new_start, we don't need
4528 * it in the buffer.
4529 */
4530 ++lnum;
4531 if (u_savedel(lnum, nmatch_tl) != OK)
4532 break;
4533 for (i = 0; i < nmatch_tl; ++i)
4534 ml_delete(lnum, (int)FALSE);
4535 mark_adjust(lnum, lnum + nmatch_tl - 1,
4536 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004537 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 deleted_lines(lnum, nmatch_tl);
4539 --lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004540 line2 -= nmatch_tl; // nr of lines decreases
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 nmatch_tl = 0;
4542 }
4543
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004544 // When asking, undo is saved each time, must also set
4545 // changed flag each time.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004546 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 changed_bytes(lnum, 0);
4548 else
4549 {
4550 if (first_line == 0)
4551 first_line = lnum;
4552 last_line = lnum + 1;
4553 }
4554
4555 sub_firstlnum = lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004556 vim_free(sub_firstline); // free the temp buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 sub_firstline = new_start;
4558 new_start = NULL;
4559 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4560 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4561 - prev_matchcol;
4562 copycol = 0;
4563 }
4564 if (nmatch == -1 && !lastone)
4565 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004566 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567
4568 /*
4569 * 5. break if there isn't another match in this line
4570 */
4571 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004572 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004573 // If the match found didn't start where we were
4574 // searching, do the next search in the line where we
4575 // found the match.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004576 if (nmatch == -1)
4577 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004579 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 }
4581
4582 line_breakcheck();
4583 }
4584
4585 if (did_sub)
4586 ++sub_nlines;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004587 vim_free(new_start); // for when substitute was cancelled
4588 VIM_CLEAR(sub_firstline); // free the copy of the original line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 }
4590
4591 line_breakcheck();
4592 }
4593
4594 if (first_line != 0)
4595 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004596 // Need to subtract the number of added lines from "last_line" to get
4597 // the line number before the change (same as adding the number of
4598 // deleted lines).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 i = curbuf->b_ml.ml_line_count - old_line_count;
4600 changed_lines(first_line, 0, last_line - i, i);
4601 }
4602
4603outofmem:
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004604 vim_free(sub_firstline); // may have to free allocated copy of the line
Bram Moolenaar05159a02005-02-26 23:04:13 +00004605
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004606 // ":s/pat//n" doesn't move the cursor
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004607 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004608 curwin->w_cursor = old_cursor;
4609
Bram Moolenaar46475522010-03-23 17:36:29 +01004610 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 {
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01004612 if (!cmdmod.lockmarks)
4613 {
4614 // Set the '[ and '] marks.
4615 curbuf->b_op_start.lnum = eap->line1;
4616 curbuf->b_op_end.lnum = line2;
4617 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4618 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619
4620 if (!global_busy)
4621 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004622 // when interactive leave cursor on the match
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004623 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01004624 {
4625 if (endcolumn)
4626 coladvance((colnr_T)MAXCOL);
4627 else
4628 beginline(BL_WHITE | BL_FIX);
4629 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004630 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004631 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 }
4633 else
4634 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004635 if (subflags.do_print)
4636 print_line(curwin->w_cursor.lnum,
4637 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 }
4639 else if (!global_busy)
4640 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004641 if (got_int) // interrupted
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004642 emsg(_(e_interr));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004643 else if (got_match) // did find something but nothing substituted
Bram Moolenaar32526b32019-01-19 17:43:09 +01004644 msg("");
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004645 else if (subflags.do_error) // nothing found
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004646 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 }
4648
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004649#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004650 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004651 // Cursor position may require updating
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004652 changed_window_setting();
4653#endif
4654
Bram Moolenaar473de612013-06-08 18:19:48 +02004655 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004656
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004657 // Restore the flag values, they can be used for ":&&".
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004658 subflags.do_all = save_do_all;
4659 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660}
4661
4662/*
4663 * Give message for number of substitutions.
4664 * Can also be used after a ":global" command.
4665 * Return TRUE if a message was given.
4666 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004667 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004668do_sub_msg(
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004669 int count_only) // used 'n' flag for ":s"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670{
4671 /*
4672 * Only report substitutions when:
4673 * - more than 'report' substitutions
4674 * - command was typed by user, or number of changed lines > 'report'
4675 * - giving messages is not disabled by 'lazyredraw'
4676 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004677 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
4678 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 && messaging())
4680 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004681 char *msg_single;
4682 char *msg_plural;
4683
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 if (got_int)
4685 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004686 else
4687 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004688
4689 msg_single = count_only
4690 ? NGETTEXT("%ld match on %ld line",
4691 "%ld matches on %ld line", sub_nsubs)
4692 : NGETTEXT("%ld substitution on %ld line",
4693 "%ld substitutions on %ld line", sub_nsubs);
4694 msg_plural = count_only
4695 ? NGETTEXT("%ld match on %ld lines",
4696 "%ld matches on %ld lines", sub_nsubs)
4697 : NGETTEXT("%ld substitution on %ld lines",
4698 "%ld substitutions on %ld lines", sub_nsubs);
4699
Bram Moolenaar32526b32019-01-19 17:43:09 +01004700 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004701 NGETTEXT(msg_single, msg_plural, sub_nlines),
4702 sub_nsubs, (long)sub_nlines);
4703
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 if (msg(msg_buf))
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004705 // save message to display it after redraw
Bram Moolenaar32526b32019-01-19 17:43:09 +01004706 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 return TRUE;
4708 }
4709 if (got_int)
4710 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004711 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 return TRUE;
4713 }
4714 return FALSE;
4715}
4716
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004717 static void
4718global_exe_one(char_u *cmd, linenr_T lnum)
4719{
4720 curwin->w_cursor.lnum = lnum;
4721 curwin->w_cursor.col = 0;
4722 if (*cmd == NUL || *cmd == '\n')
4723 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
4724 else
4725 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
4726}
4727
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728/*
4729 * Execute a global command of the form:
4730 *
4731 * g/pattern/X : execute X on all lines where pattern matches
4732 * v/pattern/X : execute X on all lines where pattern does not match
4733 *
4734 * where 'X' is an EX command
4735 *
4736 * The command character (as well as the trailing slash) is optional, and
4737 * is assumed to be 'p' if missing.
4738 *
4739 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004740 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 * for each line that has a mark. This is required because after deleting
4742 * lines we do not know where to search for the next match.
4743 */
4744 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004745ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004747 linenr_T lnum; // line number according to old situation
Bram Moolenaar05159a02005-02-26 23:04:13 +00004748 int ndone = 0;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004749 int type; // first char of cmd: 'v' or 'g'
4750 char_u *cmd; // command argument
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004752 char_u delim; // delimiter, normally '/'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 char_u *pat;
4754 regmmatch_T regmatch;
4755 int match;
4756 int which_pat;
4757
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004758 // When nesting the command works on one line. This allows for
4759 // ":g/found/v/notfound/command".
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004760 if (global_busy && (eap->line1 != 1
4761 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004763 // will increment global_busy to break out of the loop
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004764 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 return;
4766 }
4767
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004768 if (eap->forceit) // ":global!" is like ":vglobal"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 type = 'v';
4770 else
4771 type = *eap->cmd;
4772 cmd = eap->arg;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004773 which_pat = RE_LAST; // default: use last used regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774
4775 /*
4776 * undocumented vi feature:
4777 * "\/" and "\?": use previous search pattern.
4778 * "\&": use previous substitute pattern.
4779 */
4780 if (*cmd == '\\')
4781 {
4782 ++cmd;
4783 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4784 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004785 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 return;
4787 }
4788 if (*cmd == '&')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004789 which_pat = RE_SUBST; // use previous substitute pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004791 which_pat = RE_SEARCH; // use previous search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 ++cmd;
4793 pat = (char_u *)"";
4794 }
4795 else if (*cmd == NUL)
4796 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004797 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 return;
4799 }
4800 else
4801 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004802 delim = *cmd; // get the delimiter
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 if (delim)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004804 ++cmd; // skip delimiter if there is one
4805 pat = cmd; // remember start of pattern
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004806 cmd = skip_regexp_ex(cmd, delim, p_magic, &eap->arg, NULL);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004807 if (cmd[0] == delim) // end delimiter found
4808 *cmd++ = NUL; // replace it with a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 }
4810
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4812 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004813 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 return;
4815 }
4816
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004817 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004819 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004820 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004821 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004823 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 }
4825 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004826 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004827 /*
4828 * pass 1: set marks for each (not) matching line
4829 */
4830 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
4831 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004832 // a match on this line?
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004833 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004834 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004835 if ((type == 'g' && match) || (type == 'v' && !match))
4836 {
4837 ml_setmarked(lnum);
4838 ndone++;
4839 }
4840 line_breakcheck();
4841 }
4842
4843 /*
4844 * pass 2: execute the command for each line that has been marked
4845 */
4846 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004847 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004848 else if (ndone == 0)
4849 {
4850 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004851 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004852 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004853 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004854 }
4855 else
4856 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004857#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004858 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004859#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004860 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004861#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004862 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004863#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004864 }
4865
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004866 ml_clearmarked(); // clear rest of the marks
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004867 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868
Bram Moolenaar473de612013-06-08 18:19:48 +02004869 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870}
4871
4872/*
4873 * Execute "cmd" on lines marked with ml_setmarked().
4874 */
4875 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004876global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004878 linenr_T old_lcount; // b_ml.ml_line_count before the command
4879 buf_T *old_buf = curbuf; // remember what buffer we started in
4880 linenr_T lnum; // line number according to old situation
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 /*
4883 * Set current position only once for a global command.
4884 * If global_busy is set, setpcmark() will not do anything.
4885 * If there is an error, global_busy will be incremented.
4886 */
4887 setpcmark();
4888
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004889 // When the command writes a message, don't overwrite the command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 msg_didout = TRUE;
4891
Bram Moolenaard25bc232010-03-23 17:49:24 +01004892 sub_nsubs = 0;
4893 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 global_need_beginline = FALSE;
4895 global_busy = 1;
4896 old_lcount = curbuf->b_ml.ml_line_count;
4897 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
4898 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004899 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 ui_breakcheck();
4901 }
4902
4903 global_busy = 0;
4904 if (global_need_beginline)
4905 beginline(BL_WHITE | BL_FIX);
4906 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004907 check_cursor(); // cursor may be beyond the end of the line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004909 // the cursor may not have moved in the text but a change in a previous
4910 // line may move it on the screen
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004911 changed_line_abv_curs();
4912
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004913 // If it looks like no message was written, allow overwriting the
4914 // command with the report for number of changes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 if (msg_col == 0 && msg_scrolled == 0)
4916 msg_didout = FALSE;
4917
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004918 // If substitutes done, report number of substitutes, otherwise report
4919 // number of extra or deleted lines.
4920 // Don't report extra or deleted lines in the edge case where the buffer
4921 // we are in after execution is different from the buffer we started in.
Bram Moolenaarbb993222011-05-10 16:00:47 +02004922 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
4924}
4925
4926#ifdef FEAT_VIMINFO
Bram Moolenaarc3328162019-07-23 22:15:25 +02004927/*
4928 * Get the previous substitute pattern.
4929 */
4930 char_u *
4931get_old_sub(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932{
Bram Moolenaarc3328162019-07-23 22:15:25 +02004933 return old_sub;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934}
4935
Bram Moolenaarc3328162019-07-23 22:15:25 +02004936/*
4937 * Set the previous substitute pattern. "val" must be allocated.
4938 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 void
Bram Moolenaarc3328162019-07-23 22:15:25 +02004940set_old_sub(char_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941{
Bram Moolenaarc3328162019-07-23 22:15:25 +02004942 vim_free(old_sub);
4943 old_sub = val;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944}
Bram Moolenaardefa0672019-07-21 19:25:37 +02004945#endif // FEAT_VIMINFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00004947#if defined(EXITFREE) || defined(PROTO)
4948 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004949free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00004950{
4951 vim_free(old_sub);
4952}
4953#endif
4954
Bram Moolenaar4033c552017-09-16 20:54:51 +02004955#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956/*
4957 * Set up for a tagpreview.
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004958 * Makes the preview window the current window.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004959 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004961 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004962prepare_tagpreview(
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004963 int undo_sync, // sync undo when leaving the window
4964 int use_previewpopup, // use popup if 'previewpopup' set
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004965 use_popup_T use_popup) // use other popup window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966{
4967 win_T *wp;
4968
4969# ifdef FEAT_GUI
4970 need_mouse_correct = TRUE;
4971# endif
4972
4973 /*
4974 * If there is already a preview window open, use that one.
4975 */
4976 if (!curwin->w_p_pvw)
4977 {
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004978# ifdef FEAT_PROP_POPUP
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004979 if (use_previewpopup && *p_pvp != NUL)
Bram Moolenaar79648732019-07-18 21:43:07 +02004980 {
4981 wp = popup_find_preview_window();
4982 if (wp != NULL)
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01004983 popup_set_wantpos_cursor(wp, wp->w_minwidth, NULL);
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004984 }
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004985 else if (use_popup != USEPOPUP_NONE)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004986 {
4987 wp = popup_find_info_window();
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004988 if (wp != NULL)
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004989 {
4990 if (use_popup == USEPOPUP_NORMAL)
4991 popup_show(wp);
4992 else
4993 popup_hide(wp);
Bram Moolenaarb73e4392019-11-09 20:00:35 +01004994 // When the popup moves or resizes it may reveal part of
4995 // another window. TODO: can this be done more efficiently?
4996 redraw_all_later(NOT_VALID);
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004997 }
Bram Moolenaar79648732019-07-18 21:43:07 +02004998 }
4999 else
5000# endif
5001 {
5002 FOR_ALL_WINDOWS(wp)
5003 if (wp->w_p_pvw)
5004 break;
5005 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005007 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 else
5009 {
5010 /*
5011 * There is no preview window open yet. Create one.
5012 */
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005013# ifdef FEAT_PROP_POPUP
Bram Moolenaardca7abe2019-10-20 18:17:57 +02005014 if ((use_previewpopup && *p_pvp != NUL)
5015 || use_popup != USEPOPUP_NONE)
5016 return popup_create_preview_window(use_popup != USEPOPUP_NONE);
Bram Moolenaar79648732019-07-18 21:43:07 +02005017# endif
5018 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0) == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005019 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 curwin->w_p_pvw = TRUE;
5021 curwin->w_p_wfh = TRUE;
Bram Moolenaar79648732019-07-18 21:43:07 +02005022 RESET_BINDING(curwin); // don't take over 'scrollbind'
5023 // and 'cursorbind'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024# ifdef FEAT_DIFF
Bram Moolenaar79648732019-07-18 21:43:07 +02005025 curwin->w_p_diff = FALSE; // no 'diff'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026# endif
5027# ifdef FEAT_FOLDING
Bram Moolenaar79648732019-07-18 21:43:07 +02005028 curwin->w_p_fdc = 0; // no 'foldcolumn'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005030 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 }
5032 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005033 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034}
5035
5036#endif
5037
5038
5039/*
5040 * ":help": open a read-only window on a help file
5041 */
5042 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005043ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044{
5045 char_u *arg;
5046 char_u *tag;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005047 FILE *helpfd; // file descriptor of help file
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 int n;
5049 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 int num_matches;
5052 char_u **matches;
5053 char_u *p;
5054 int empty_fnum = 0;
5055 int alt_fnum = 0;
5056 buf_T *buf;
5057#ifdef FEAT_MULTI_LANG
5058 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005059 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005061#ifdef FEAT_FOLDING
5062 int old_KeyTyped = KeyTyped;
5063#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064
5065 if (eap != NULL)
5066 {
5067 /*
5068 * A ":help" command ends at the first LF, or at a '|' that is
5069 * followed by some text. Set nextcmd to the following command.
5070 */
5071 for (arg = eap->arg; *arg; ++arg)
5072 {
5073 if (*arg == '\n' || *arg == '\r'
5074 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5075 {
5076 *arg++ = NUL;
5077 eap->nextcmd = arg;
5078 break;
5079 }
5080 }
5081 arg = eap->arg;
5082
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005083 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005085 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 return;
5087 }
5088
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005089 if (eap->skip) // not executing commands
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 return;
5091 }
5092 else
5093 arg = (char_u *)"";
5094
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005095 // remove trailing blanks
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01005097 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 *p-- = NUL;
5099
5100#ifdef FEAT_MULTI_LANG
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005101 // Check for a specified language
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005102 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103#endif
5104
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005105 // When no argument given go to the index.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 if (*arg == NUL)
5107 arg = (char_u *)"help.txt";
5108
5109 /*
5110 * Check if there is a match for the argument.
5111 */
5112 n = find_help_tags(arg, &num_matches, &matches,
5113 eap != NULL && eap->forceit);
5114
5115 i = 0;
5116#ifdef FEAT_MULTI_LANG
5117 if (n != FAIL && lang != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005118 // Find first item with the requested language.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 for (i = 0; i < num_matches; ++i)
5120 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005121 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 if (len > 3 && matches[i][len - 3] == '@'
5123 && STRICMP(matches[i] + len - 2, lang) == 0)
5124 break;
5125 }
5126#endif
5127 if (i >= num_matches || n == FAIL)
5128 {
5129#ifdef FEAT_MULTI_LANG
5130 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005131 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 else
5133#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005134 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 if (n != FAIL)
5136 FreeWild(num_matches, matches);
5137 return;
5138 }
5139
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005140 // The first match (in the requested language) is the best match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 tag = vim_strsave(matches[i]);
5142 FreeWild(num_matches, matches);
5143
5144#ifdef FEAT_GUI
5145 need_mouse_correct = TRUE;
5146#endif
5147
5148 /*
5149 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005150 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02005152 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005154 if (cmdmod.tab != 0)
5155 wp = NULL;
5156 else
Bram Moolenaar29323592016-07-24 22:04:11 +02005157 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005158 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005159 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5161 win_enter(wp, TRUE);
5162 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 {
5164 /*
5165 * There is no help window yet.
5166 * Try to open the file specified by the "helpfile" option.
5167 */
5168 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5169 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005170 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 goto erret;
5172 }
5173 fclose(helpfd);
5174
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005175 // Split off help window; put it at far top if no position
5176 // specified, the current window is vertically split and
5177 // narrow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005180 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005183 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 if (curwin->w_height < p_hh)
5186 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187
5188 /*
5189 * Open help file (do_ecmd() will set b_help flag, readfile() will
5190 * set b_p_ro flag).
5191 * Set the alternate file to the previously edited file.
5192 */
5193 alt_fnum = curbuf->b_fnum;
5194 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005195 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005196 NULL); // buffer is still open, don't store info
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005197 if (!cmdmod.keepalt)
5198 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 empty_fnum = curbuf->b_fnum;
5200 }
5201 }
5202
5203 if (!p_im)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005204 restart_edit = 0; // don't want insert mode in help file
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
Bram Moolenaar8f535582011-09-30 17:30:31 +02005206#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005207 // Restore KeyTyped, setting 'filetype=help' may reset it.
5208 // It is needed for do_tag top open folds under the cursor.
Bram Moolenaar8f535582011-09-30 17:30:31 +02005209 KeyTyped = old_KeyTyped;
5210#endif
5211
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 if (tag != NULL)
5213 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5214
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005215 // Delete the empty buffer if we're not using it. Careful: autocommands
5216 // may have jumped to another window, check that the buffer is not in a
5217 // window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5219 {
5220 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005221 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 wipe_buffer(buf, TRUE);
5223 }
5224
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005225 // keep the previous alternate file
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005226 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 curwin->w_alt_fnum = alt_fnum;
5228
5229erret:
5230 vim_free(tag);
5231}
5232
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005233/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005234 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005235 */
5236 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005237ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005238{
5239 win_T *win;
5240
5241 FOR_ALL_WINDOWS(win)
5242 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005243 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005244 {
5245 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005246 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005247 }
5248 }
5249}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005251#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5252/*
5253 * In an argument search for a language specifiers in the form "@xx".
5254 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5255 * Returns NULL if not found.
5256 */
5257 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005258check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005259{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005260 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005261
5262 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5263 && ASCII_ISALPHA(arg[len - 1]))
5264 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005265 arg[len - 3] = NUL; // remove the '@'
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005266 return arg + len - 2;
5267 }
5268 return NULL;
5269}
5270#endif
5271
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272/*
5273 * Return a heuristic indicating how well the given string matches. The
5274 * smaller the number, the better the match. This is the order of priorities,
5275 * from best match to worst match:
Bram Moolenaar4b96df52020-01-26 22:00:26 +01005276 * - Match with least alphanumeric characters is better.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 * - Match with least total characters is better.
5278 * - Match towards the start is better.
5279 * - Match starting with "+" is worse (feature instead of command)
5280 * Assumption is made that the matched_string passed has already been found to
5281 * match some string for which help is requested. webb.
5282 */
5283 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005284help_heuristic(
5285 char_u *matched_string,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005286 int offset, // offset for match
5287 int wrong_case) // no matching case
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288{
5289 int num_letters;
5290 char_u *p;
5291
5292 num_letters = 0;
5293 for (p = matched_string; *p; p++)
5294 if (ASCII_ISALNUM(*p))
5295 num_letters++;
5296
5297 /*
5298 * Multiply the number of letters by 100 to give it a much bigger
5299 * weighting than the number of characters.
5300 * If there only is a match while ignoring case, add 5000.
5301 * If the match starts in the middle of a word, add 10000 to put it
5302 * somewhere in the last half.
5303 * If the match is more than 2 chars from the start, multiply by 200 to
5304 * put it after matches at the start.
5305 */
5306 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5307 && ASCII_ISALNUM(matched_string[offset - 1]))
5308 offset += 10000;
5309 else if (offset > 2)
5310 offset *= 200;
5311 if (wrong_case)
5312 offset += 5000;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005313 // Features are less interesting than the subjects themselves, but "+"
5314 // alone is not a feature.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 if (matched_string[0] == '+' && matched_string[1] != NUL)
5316 offset += 100;
5317 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5318}
5319
5320/*
5321 * Compare functions for qsort() below, that checks the help heuristics number
5322 * that has been put after the tagname by find_tags().
5323 */
5324 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005325help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326{
5327 char *p1;
5328 char *p2;
Bram Moolenaar297610b2019-12-27 17:20:55 +01005329 int cmp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
5331 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5332 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
Bram Moolenaar297610b2019-12-27 17:20:55 +01005333
5334 // Compare by help heuristic number first.
5335 cmp = strcmp(p1, p2);
5336 if (cmp != 0)
5337 return cmp;
5338
5339 // Compare by strings as tie-breaker when same heuristic number.
5340 return strcmp(*(char **)s1, *(char **)s2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341}
5342
5343/*
5344 * Find all help tags matching "arg", sort them and return in matches[], with
5345 * the number of matches in num_matches.
5346 * The matches will be sorted with a "best" match algorithm.
5347 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5348 */
5349 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005350find_help_tags(
5351 char_u *arg,
5352 int *num_matches,
5353 char_u ***matches,
5354 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355{
5356 char_u *s, *d;
5357 int i;
5358 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005359 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005360 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005361 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5362 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005363 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005364 "[count]", "[quotex]",
5365 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005366 "[pattern]", "\\|", "\\%$",
5367 "s/\\~", "s/\\U", "s/\\L",
5368 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005370 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005371 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005372 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5373 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005374 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005375 "\\[count]", "\\[quotex]",
5376 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005377 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02005378 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005379 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005380 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
5381 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 int flags;
5383
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005384 d = IObuff; // assume IObuff is long enough!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005386 if (STRNICMP(arg, "expr-", 5) == 0)
5387 {
5388 // When the string starting with "expr-" and containing '?' and matches
Bram Moolenaar9ca25082019-10-05 11:30:09 +02005389 // the table, it is taken literally (but ~ is escaped). Otherwise '?'
5390 // is recognized as a wildcard.
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005391 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
5392 if (STRCMP(arg + 5, expr_table[i]) == 0)
5393 {
Bram Moolenaar9ca25082019-10-05 11:30:09 +02005394 int si = 0, di = 0;
5395
5396 for (;;)
5397 {
5398 if (arg[si] == '~')
5399 d[di++] = '\\';
5400 d[di++] = arg[si];
5401 if (arg[si] == NUL)
5402 break;
5403 ++si;
5404 }
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005405 break;
5406 }
5407 }
5408 else
5409 {
5410 // Recognize a few exceptions to the rule. Some strings that contain
5411 // '*' with "star". Otherwise '*' is recognized as a wildcard.
5412 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
5413 if (STRCMP(arg, mtable[i]) == 0)
5414 {
5415 STRCPY(d, rtable[i]);
5416 break;
5417 }
5418 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005420 if (i < 0) // no match in table
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005422 // Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5423 // Also replace "\%^" and "\%(", they match every tag too.
5424 // Also "\zs", "\z1", etc.
5425 // Also "\@<", "\@=", "\@<=", etc.
5426 // And also "\_$" and "\_^".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 if (arg[0] == '\\'
5428 && ((arg[1] != NUL && arg[2] == NUL)
5429 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5430 && arg[2] != NUL)))
5431 {
5432 STRCPY(d, "/\\\\");
5433 STRCPY(d + 3, arg + 1);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005434 // Check for "/\\_$", should be "/\\_\$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 if (d[3] == '_' && d[4] == '$')
5436 STRCPY(d + 4, "\\$");
5437 }
5438 else
5439 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005440 // Replace:
5441 // "[:...:]" with "\[:...:]"
5442 // "[++...]" with "\[++...]"
5443 // "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005444 if ((arg[0] == '[' && (arg[1] == ':'
5445 || (arg[1] == '+' && arg[2] == '+')))
5446 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 *d++ = '\\';
5448
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01005449 /*
5450 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
5451 */
5452 if (*arg == '(' && arg[1] == '\'')
5453 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 for (s = arg; *s; ++s)
5455 {
5456 /*
5457 * Replace "|" with "bar" and '"' with "quote" to match the name of
5458 * the tags for these commands.
5459 * Replace "*" with ".*" and "?" with "." to match command line
5460 * completion.
5461 * Insert a backslash before '~', '$' and '.' to avoid their
5462 * special meaning.
5463 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005464 if (d - IObuff > IOSIZE - 10) // getting too long!?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 break;
5466 switch (*s)
5467 {
5468 case '|': STRCPY(d, "bar");
5469 d += 3;
5470 continue;
5471 case '"': STRCPY(d, "quote");
5472 d += 5;
5473 continue;
5474 case '*': *d++ = '.';
5475 break;
5476 case '?': *d++ = '.';
5477 continue;
5478 case '$':
5479 case '.':
5480 case '~': *d++ = '\\';
5481 break;
5482 }
5483
5484 /*
5485 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5486 * ":help i_^_CTRL-D" work.
5487 * Insert '-' before and after "CTRL-X" when applicable.
5488 */
5489 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5490 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5491 {
Bram Moolenaard82db602013-08-07 15:24:41 +02005492 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005493 *d++ = '_'; // prepend a '_' to make x_CTRL-x
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 STRCPY(d, "CTRL-");
5495 d += 5;
5496 if (*s < ' ')
5497 {
5498#ifdef EBCDIC
5499 *d++ = CtrlChar(*s);
5500#else
5501 *d++ = *s + '@';
5502#endif
5503 if (d[-1] == '\\')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005504 *d++ = '\\'; // double a backslash
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 }
5506 else
5507 *d++ = *++s;
5508 if (s[1] != NUL && s[1] != '_')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005509 *d++ = '_'; // append a '_'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 continue;
5511 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005512 else if (*s == '^') // "^" or "CTRL-^" or "^_"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 *d++ = '\\';
5514
5515 /*
5516 * Insert a backslash before a backslash after a slash, for search
5517 * pattern tags: "/\|" --> "/\\|".
5518 */
5519 else if (s[0] == '\\' && s[1] != '\\'
5520 && *arg == '/' && s == arg + 1)
5521 *d++ = '\\';
5522
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005523 // "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5524 // "CTRL-\_CTRL-N"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5526 {
5527 STRCPY(d, "CTRL-\\\\");
5528 d += 7;
5529 s += 6;
5530 }
5531
5532 *d++ = *s;
5533
5534 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02005535 * If tag contains "({" or "([", tag terminates at the "(".
5536 * This is for help on functions, e.g.: abs({expr}).
5537 */
5538 if (*s == '(' && (s[1] == '{' || s[1] =='['))
5539 break;
5540
5541 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 * If tag starts with ', toss everything after a second '. Fixes
5543 * CTRL-] on 'option'. (would include the trailing '.').
5544 */
5545 if (*s == '\'' && s > arg && *arg == '\'')
5546 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005547 // Also '{' and '}'.
Bram Moolenaar28b942a2016-06-04 22:31:27 +02005548 if (*s == '}' && s > arg && *arg == '{')
5549 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 }
5551 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02005552
5553 if (*IObuff == '`')
5554 {
5555 if (d > IObuff + 2 && d[-1] == '`')
5556 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005557 // remove the backticks from `command`
Bram Moolenaar720ce532012-04-25 12:57:28 +02005558 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5559 d[-2] = NUL;
5560 }
5561 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
5562 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005563 // remove the backticks and comma from `command`,
Bram Moolenaar720ce532012-04-25 12:57:28 +02005564 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5565 d[-3] = NUL;
5566 }
5567 else if (d > IObuff + 4 && d[-3] == '`'
5568 && d[-2] == '\\' && d[-1] == '.')
5569 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005570 // remove the backticks and dot from `command`\.
Bram Moolenaar720ce532012-04-25 12:57:28 +02005571 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5572 d[-4] = NUL;
5573 }
5574 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 }
5576 }
5577
5578 *matches = (char_u **)"";
5579 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02005580 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581 if (keep_lang)
5582 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005583 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005585 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005586 // Sort the matches found on the heuristic number that is after the
5587 // tag name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 qsort((void *)*matches, (size_t)*num_matches,
5589 sizeof(char_u *), help_compare);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005590 // Delete more than TAG_MANY to reduce the size of the listing.
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005591 while (*num_matches > TAG_MANY)
5592 vim_free((*matches)[--*num_matches]);
5593 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 return OK;
5595}
5596
5597/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005598 * Called when starting to edit a buffer for a help file.
5599 */
5600 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005601prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005602{
5603 char_u *p;
5604
5605 curbuf->b_help = TRUE;
5606#ifdef FEAT_QUICKFIX
5607 set_string_option_direct((char_u *)"buftype", -1,
5608 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
5609#endif
5610
5611 /*
5612 * Always set these options after jumping to a help tag, because the
5613 * user may have an autocommand that gets in the way.
5614 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
5615 * latin1 word characters (for translated help files).
5616 * Only set it when needed, buf_init_chartab() is some work.
5617 */
5618 p =
5619#ifdef EBCDIC
5620 (char_u *)"65-255,^*,^|,^\"";
5621#else
5622 (char_u *)"!-~,^*,^|,^\",192-255";
5623#endif
5624 if (STRCMP(curbuf->b_p_isk, p) != 0)
5625 {
5626 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
5627 check_buf_options(curbuf);
5628 (void)buf_init_chartab(curbuf, FALSE);
5629 }
5630
Bram Moolenaar0b105412014-11-30 13:34:23 +01005631#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005632 // Don't use the global foldmethod.
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005633 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
5634 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01005635#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005636
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005637 curbuf->b_p_ts = 8; // 'tabstop' is 8
5638 curwin->w_p_list = FALSE; // no list mode
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005639
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005640 curbuf->b_p_ma = FALSE; // not modifiable
5641 curbuf->b_p_bin = FALSE; // reset 'bin' before reading file
5642 curwin->w_p_nu = 0; // no line numbers
5643 curwin->w_p_rnu = 0; // no relative line numbers
5644 RESET_BINDING(curwin); // no scroll or cursor binding
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005645#ifdef FEAT_ARABIC
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005646 curwin->w_p_arab = FALSE; // no arabic mode
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005647#endif
5648#ifdef FEAT_RIGHTLEFT
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005649 curwin->w_p_rl = FALSE; // help window is left-to-right
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005650#endif
5651#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005652 curwin->w_p_fen = FALSE; // No folding in the help window
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005653#endif
5654#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005655 curwin->w_p_diff = FALSE; // No 'diff'
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005656#endif
5657#ifdef FEAT_SPELL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005658 curwin->w_p_spell = FALSE; // No spell checking
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005659#endif
5660
5661 set_buflisted(FALSE);
5662}
5663
5664/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 * After reading a help file: May cleanup a help buffer when syntax
5666 * highlighting is not used.
5667 */
5668 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005669fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670{
5671 linenr_T lnum;
5672 char_u *line;
5673 int in_example = FALSE;
5674 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005675 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 char_u *p;
5677 char_u *rt;
5678 int mustfree;
5679
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005680 // Set filetype to "help" if still needed.
Bram Moolenaar90492982017-06-22 14:16:31 +02005681 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02005682 {
5683 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02005684 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02005685 --curbuf_lock;
5686 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687
5688#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02005689 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690#endif
5691 {
5692 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5693 {
5694 line = ml_get_buf(curbuf, lnum, FALSE);
5695 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005696 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005698 // End of example: non-white or '<' in first column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 if (line[0] == '<')
5700 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005701 // blank-out a '<' in the first column
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 line = ml_get_buf(curbuf, lnum, TRUE);
5703 line[0] = ' ';
5704 }
5705 in_example = FALSE;
5706 }
5707 if (!in_example && len > 0)
5708 {
5709 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5710 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005711 // blank-out a '>' in the last column (start of example)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 line = ml_get_buf(curbuf, lnum, TRUE);
5713 line[len - 1] = ' ';
5714 in_example = TRUE;
5715 }
5716 else if (line[len - 1] == '~')
5717 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005718 // blank-out a '~' at the end of line (header marker)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 line = ml_get_buf(curbuf, lnum, TRUE);
5720 line[len - 1] = ' ';
5721 }
5722 }
5723 }
5724 }
5725
5726 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005727 * In the "help.txt" and "help.abx" file, add the locally added help
5728 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005730 fname = gettail(curbuf->b_fname);
5731 if (fnamecmp(fname, "help.txt") == 0
5732#ifdef FEAT_MULTI_LANG
5733 || (fnamencmp(fname, "help.", 5) == 0
5734 && ASCII_ISALPHA(fname[5])
5735 && ASCII_ISALPHA(fname[6])
5736 && TOLOWER_ASC(fname[7]) == 'x'
5737 && fname[8] == NUL)
5738#endif
5739 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 {
5741 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5742 {
5743 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005744 if (strstr((char *)line, "*local-additions*") == NULL)
5745 continue;
5746
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005747 // Go through all directories in 'runtimepath', skipping
5748 // $VIMRUNTIME.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005749 p = p_rtp;
5750 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005752 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5753 mustfree = FALSE;
5754 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaar99499b12019-05-23 21:35:48 +02005755 if (rt != NULL &&
5756 fullpathcmp(rt, NameBuff, FALSE, TRUE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005758 int fcount;
5759 char_u **fnames;
5760 FILE *fd;
5761 char_u *s;
5762 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005763 vimconv_T vc;
5764 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005766 // Find all "doc/ *.txt" files in this directory.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005767 add_pathsep(NameBuff);
5768#ifdef FEAT_MULTI_LANG
5769 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005771 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005773 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5774 &fnames, EW_FILE|EW_SILENT) == OK
5775 && fcount > 0)
5776 {
5777#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005778 int i1, i2;
5779 char_u *f1, *f2;
5780 char_u *t1, *t2;
5781 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005782
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005783 // If foo.abx is found use it instead of foo.txt in
5784 // the same directory.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005785 for (i1 = 0; i1 < fcount; ++i1)
5786 {
5787 for (i2 = 0; i2 < fcount; ++i2)
5788 {
5789 if (i1 == i2)
5790 continue;
5791 if (fnames[i1] == NULL || fnames[i2] == NULL)
5792 continue;
5793 f1 = fnames[i1];
5794 f2 = fnames[i2];
5795 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005796 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005797 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005798 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02005799 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005800 continue;
5801 if (fnamecmp(e1, ".txt") != 0
5802 && fnamecmp(e1, fname + 4) != 0)
5803 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005804 // Not .txt and not .abx, remove it.
Bram Moolenaard23a8232018-02-10 18:45:26 +01005805 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005806 continue;
5807 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005808 if (e1 - f1 != e2 - f2
5809 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005810 continue;
5811 if (fnamecmp(e1, ".txt") == 0
5812 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005813 // use .abx instead of .txt
Bram Moolenaard23a8232018-02-10 18:45:26 +01005814 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005817#endif
5818 for (fi = 0; fi < fcount; ++fi)
5819 {
5820 if (fnames[fi] == NULL)
5821 continue;
5822 fd = mch_fopen((char *)fnames[fi], "r");
5823 if (fd != NULL)
5824 {
5825 vim_fgets(IObuff, IOSIZE, fd);
5826 if (IObuff[0] == '*'
5827 && (s = vim_strchr(IObuff + 1, '*'))
5828 != NULL)
5829 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005830 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01005831
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005832 // Change tag definition to a
5833 // reference and remove <CR>/<NL>.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005834 IObuff[0] = '|';
5835 *s = '|';
5836 while (*s != NUL)
5837 {
5838 if (*s == '\r' || *s == '\n')
5839 *s = NUL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005840 // The text is utf-8 when a byte
5841 // above 127 is found and no
5842 // illegal byte sequence is found.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005843 if (*s >= 0x80 && this_utf != FALSE)
5844 {
5845 int l;
5846
5847 this_utf = TRUE;
5848 l = utf_ptr2len(s);
5849 if (l == 1)
5850 this_utf = FALSE;
5851 s += l - 1;
5852 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005853 ++s;
5854 }
Bram Moolenaar13505972019-01-24 15:04:48 +01005855
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005856 // The help file is latin1 or utf-8;
5857 // conversion to the current
5858 // 'encoding' may be required.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005859 vc.vc_type = CONV_NONE;
5860 convert_setup(&vc, (char_u *)(
5861 this_utf == TRUE ? "utf-8"
5862 : "latin1"), p_enc);
5863 if (vc.vc_type == CONV_NONE)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005864 // No conversion needed.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005865 cp = IObuff;
5866 else
5867 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005868 // Do the conversion. If it fails
5869 // use the unconverted text.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005870 cp = string_convert(&vc, IObuff,
5871 NULL);
5872 if (cp == NULL)
5873 cp = IObuff;
5874 }
5875 convert_setup(&vc, NULL, NULL);
5876
5877 ml_append(lnum, cp, (colnr_T)0, FALSE);
5878 if (cp != IObuff)
5879 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005880 ++lnum;
5881 }
5882 fclose(fd);
5883 }
5884 }
5885 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005888 if (mustfree)
5889 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005891 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 }
5893 }
5894}
5895
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005896/*
5897 * ":exusage"
5898 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005899 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005900ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005901{
5902 do_cmdline_cmd((char_u *)"help ex-cmd-index");
5903}
5904
5905/*
5906 * ":viusage"
5907 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005908 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005909ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005910{
5911 do_cmdline_cmd((char_u *)"help normal-index");
5912}
5913
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01005915 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005918helptags_one(
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005919 char_u *dir, // doc directory
5920 char_u *ext, // suffix, ".txt", ".itx", ".frx", etc.
5921 char_u *tagfname, // "tags" for English, "tags-fr" for French.
Bram Moolenaar414b7962020-02-17 22:39:35 +01005922 int add_help_tags, // add "help-tags" tag
5923 int ignore_writeerr) // ignore write error
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924{
5925 FILE *fd_tags;
5926 FILE *fd;
5927 garray_T ga;
5928 int filecount;
5929 char_u **files;
5930 char_u *p1, *p2;
5931 int fi;
5932 char_u *s;
5933 int i;
5934 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01005935 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936 int utf8 = MAYBE;
5937 int this_utf8;
5938 int firstline;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005939 int mix = FALSE; // detected mixed encodings
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940
5941 /*
5942 * Find all *.txt files.
5943 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01005944 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01005946 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 STRCAT(NameBuff, ext);
5948 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
5949 EW_FILE|EW_SILENT) == FAIL
5950 || filecount == 0)
5951 {
5952 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005953 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 return;
5955 }
5956
5957 /*
5958 * Open the tags file for writing.
5959 * Do this before scanning through all the files.
5960 */
5961 STRCPY(NameBuff, dir);
5962 add_pathsep(NameBuff);
5963 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00005964 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 if (fd_tags == NULL)
5966 {
Bram Moolenaar414b7962020-02-17 22:39:35 +01005967 if (!ignore_writeerr)
5968 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 FreeWild(filecount, files);
5970 return;
5971 }
5972
5973 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00005974 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
5975 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 */
5977 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00005978 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
Bram Moolenaar99499b12019-05-23 21:35:48 +02005979 dir, FALSE, TRUE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 {
5981 if (ga_grow(&ga, 1) == FAIL)
5982 got_int = TRUE;
5983 else
5984 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005985 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986 if (s == NULL)
5987 got_int = TRUE;
5988 else
5989 {
5990 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
5991 ((char_u **)ga.ga_data)[ga.ga_len] = s;
5992 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 }
5994 }
5995 }
5996
5997 /*
5998 * Go over all the files and extract the tags.
5999 */
6000 for (fi = 0; fi < filecount && !got_int; ++fi)
6001 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006002 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 if (fd == NULL)
6004 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006005 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 continue;
6007 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006008 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6012 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 if (firstline)
6014 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006015 // Detect utf-8 file by a non-ASCII char in the first line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016 this_utf8 = MAYBE;
6017 for (s = IObuff; *s != NUL; ++s)
6018 if (*s >= 0x80)
6019 {
6020 int l;
6021
6022 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006023 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 if (l == 1)
6025 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006026 // Illegal UTF-8 byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 this_utf8 = FALSE;
6028 break;
6029 }
6030 s += l - 1;
6031 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006032 if (this_utf8 == MAYBE) // only ASCII characters found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 this_utf8 = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006034 if (utf8 == MAYBE) // first file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 utf8 = this_utf8;
6036 else if (utf8 != this_utf8)
6037 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006038 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 mix = !got_int;
6040 got_int = TRUE;
6041 }
6042 firstline = FALSE;
6043 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006044 p1 = vim_strchr(IObuff, '*'); // find first '*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 while (p1 != NULL)
6046 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006047 // Use vim_strbyte() instead of vim_strchr() so that when
6048 // 'encoding' is dbcs it still works, don't find '*' in the
6049 // second byte.
6050 p2 = vim_strbyte(p1 + 1, '*'); // find second '*'
6051 if (p2 != NULL && p2 > p1 + 1) // skip "*" and "**"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 {
6053 for (s = p1 + 1; s < p2; ++s)
6054 if (*s == ' ' || *s == '\t' || *s == '|')
6055 break;
6056
6057 /*
6058 * Only accept a *tag* when it consists of valid
6059 * characters, there is white space before it and is
6060 * followed by a white character or end-of-line.
6061 */
6062 if (s == p2
6063 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6064 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6065 || s[1] == '\0'))
6066 {
6067 *p2 = '\0';
6068 ++p1;
6069 if (ga_grow(&ga, 1) == FAIL)
6070 {
6071 got_int = TRUE;
6072 break;
6073 }
Bram Moolenaar964b3742019-05-24 18:54:09 +02006074 s = alloc(p2 - p1 + STRLEN(fname) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 if (s == NULL)
6076 {
6077 got_int = TRUE;
6078 break;
6079 }
6080 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6081 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 sprintf((char *)s, "%s\t%s", p1, fname);
6083
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006084 // find next '*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 p2 = vim_strchr(p2 + 1, '*');
6086 }
6087 }
6088 p1 = p2;
6089 }
6090 line_breakcheck();
6091 }
6092
6093 fclose(fd);
6094 }
6095
6096 FreeWild(filecount, files);
6097
6098 if (!got_int)
6099 {
6100 /*
6101 * Sort the tags.
6102 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02006103 if (ga.ga_data != NULL)
6104 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105
6106 /*
6107 * Check for duplicates.
6108 */
6109 for (i = 1; i < ga.ga_len; ++i)
6110 {
6111 p1 = ((char_u **)ga.ga_data)[i - 1];
6112 p2 = ((char_u **)ga.ga_data)[i];
6113 while (*p1 == *p2)
6114 {
6115 if (*p2 == '\t')
6116 {
6117 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006118 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6120 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006121 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 *p2 = '\t';
6123 break;
6124 }
6125 ++p1;
6126 ++p2;
6127 }
6128 }
6129
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 if (utf8 == TRUE)
6131 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132
6133 /*
6134 * Write the tags into the file.
6135 */
6136 for (i = 0; i < ga.ga_len; ++i)
6137 {
6138 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006139 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006140 // help-tags entry was added in formatted form
Bram Moolenaarf6210482007-07-25 20:56:39 +00006141 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 else
6143 {
6144 fprintf(fd_tags, "%s\t/*", s);
6145 for (p1 = s; *p1 != '\t'; ++p1)
6146 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006147 // insert backslash before '\\' and '/'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 if (*p1 == '\\' || *p1 == '/')
6149 putc('\\', fd_tags);
6150 putc(*p1, fd_tags);
6151 }
6152 fprintf(fd_tags, "*\n");
6153 }
6154 }
6155 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 if (mix)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006157 got_int = FALSE; // continue with other languages
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158
6159 for (i = 0; i < ga.ga_len; ++i)
6160 vim_free(((char_u **)ga.ga_data)[i]);
6161 ga_clear(&ga);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006162 fclose(fd_tags); // there is no check for an error...
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006165/*
6166 * Generate tags in one help directory, taking care of translations.
6167 */
6168 static void
Bram Moolenaar414b7962020-02-17 22:39:35 +01006169do_helptags(char_u *dirname, int add_help_tags, int ignore_writeerr)
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006170{
6171#ifdef FEAT_MULTI_LANG
6172 int len;
6173 int i, j;
6174 garray_T ga;
6175 char_u lang[2];
6176 char_u ext[5];
6177 char_u fname[8];
6178 int filecount;
6179 char_u **files;
6180
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006181 // Get a list of all files in the help directory and in subdirectories.
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006182 STRCPY(NameBuff, dirname);
6183 add_pathsep(NameBuff);
6184 STRCAT(NameBuff, "**");
6185 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6186 EW_FILE|EW_SILENT) == FAIL
6187 || filecount == 0)
6188 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006189 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006190 return;
6191 }
6192
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006193 // Go over all files in the directory to find out what languages are
6194 // present.
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006195 ga_init2(&ga, 1, 10);
6196 for (i = 0; i < filecount; ++i)
6197 {
6198 len = (int)STRLEN(files[i]);
6199 if (len > 4)
6200 {
6201 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6202 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006203 // ".txt" -> language "en"
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006204 lang[0] = 'e';
6205 lang[1] = 'n';
6206 }
6207 else if (files[i][len - 4] == '.'
6208 && ASCII_ISALPHA(files[i][len - 3])
6209 && ASCII_ISALPHA(files[i][len - 2])
6210 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6211 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006212 // ".abx" -> language "ab"
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006213 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6214 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6215 }
6216 else
6217 continue;
6218
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006219 // Did we find this language already?
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006220 for (j = 0; j < ga.ga_len; j += 2)
6221 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6222 break;
6223 if (j == ga.ga_len)
6224 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006225 // New language, add it.
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006226 if (ga_grow(&ga, 2) == FAIL)
6227 break;
6228 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6229 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6230 }
6231 }
6232 }
6233
6234 /*
6235 * Loop over the found languages to generate a tags file for each one.
6236 */
6237 for (j = 0; j < ga.ga_len; j += 2)
6238 {
6239 STRCPY(fname, "tags-xx");
6240 fname[5] = ((char_u *)ga.ga_data)[j];
6241 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6242 if (fname[5] == 'e' && fname[6] == 'n')
6243 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006244 // English is an exception: use ".txt" and "tags".
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006245 fname[4] = NUL;
6246 STRCPY(ext, ".txt");
6247 }
6248 else
6249 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006250 // Language "ab" uses ".abx" and "tags-ab".
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006251 STRCPY(ext, ".xxx");
6252 ext[1] = fname[5];
6253 ext[2] = fname[6];
6254 }
Bram Moolenaar414b7962020-02-17 22:39:35 +01006255 helptags_one(dirname, ext, fname, add_help_tags, ignore_writeerr);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006256 }
6257
6258 ga_clear(&ga);
6259 FreeWild(filecount, files);
6260
6261#else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006262 // No language support, just use "*.txt" and "tags".
Bram Moolenaar414b7962020-02-17 22:39:35 +01006263 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags,
6264 ignore_writeerr);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006265#endif
6266}
6267
6268 static void
6269helptags_cb(char_u *fname, void *cookie)
6270{
Bram Moolenaar414b7962020-02-17 22:39:35 +01006271 do_helptags(fname, *(int *)cookie, TRUE);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006272}
6273
6274/*
6275 * ":helptags"
6276 */
6277 void
6278ex_helptags(exarg_T *eap)
6279{
6280 expand_T xpc;
6281 char_u *dirname;
6282 int add_help_tags = FALSE;
6283
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006284 // Check for ":helptags ++t {dir}".
Bram Moolenaar1c465442017-03-12 20:10:05 +01006285 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006286 {
6287 add_help_tags = TRUE;
6288 eap->arg = skipwhite(eap->arg + 3);
6289 }
6290
6291 if (STRCMP(eap->arg, "ALL") == 0)
6292 {
6293 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
6294 helptags_cb, &add_help_tags);
6295 }
6296 else
6297 {
6298 ExpandInit(&xpc);
6299 xpc.xp_context = EXPAND_DIRECTORIES;
6300 dirname = ExpandOne(&xpc, eap->arg, NULL,
6301 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6302 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006303 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006304 else
Bram Moolenaar414b7962020-02-17 22:39:35 +01006305 do_helptags(dirname, add_help_tags, FALSE);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006306 vim_free(dirname);
6307 }
6308}
6309
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006310/*
6311 * Make the user happy.
6312 */
6313 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006314ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006315{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006316 static char *code[] = {
6317 "\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$",
6318 "\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"
6319 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006320 char *p;
6321 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006322 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006323
6324 msg_start();
6325 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006326 for (i = 0; i < 2; ++i)
6327 for (p = code[i]; *p != NUL; ++p)
6328 if (*p == 'x')
6329 msg_putchar('\n');
6330 else
6331 for (n = *p++; n > 0; --n)
6332 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01006333 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006334 else
6335 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006336 msg_clr_eos();
6337}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339/*
6340 * ":drop"
6341 * Opens the first argument in a window. When there are two or more arguments
6342 * the argument list is redefined.
6343 */
6344 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006345ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346{
6347 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 win_T *wp;
6349 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006350 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351
Bram Moolenaar3f65c662020-05-27 23:15:16 +02006352 if (ERROR_IF_POPUP_WINDOW || ERROR_IF_TERM_POPUP_WINDOW)
6353 return;
6354
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 /*
6356 * Check if the first argument is already being edited in a window. If
6357 * so, jump to that window.
6358 * We would actually need to check all arguments, but that's complicated
6359 * and mostly only one file is dropped.
6360 * This also ignores wildcards, since it is very unlikely the user is
6361 * editing a file name with a wildcard character.
6362 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006363 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00006365 /*
6366 * Expanding wildcards may result in an empty argument list. E.g. when
6367 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
6368 * already did an error message for this.
6369 */
6370 if (ARGCOUNT == 0)
6371 return;
6372
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006373 if (cmdmod.tab)
6374 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006375 // ":tab drop file ...": open a tab for each argument that isn't
6376 // edited in a window yet. It's like ":tab all" but without closing
6377 // windows or tabs.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006378 ex_all(eap);
6379 }
6380 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006381 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006382 // ":drop file ...": Edit the first argument. Jump to an existing
6383 // window if possible, edit in current window if the current buffer
6384 // can be abandoned, otherwise open a new window.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006385 buf = buflist_findnr(ARGLIST[0].ae_fnum);
6386
6387 FOR_ALL_TAB_WINDOWS(tp, wp)
6388 {
6389 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006391 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 return;
6394 }
6395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006397 /*
6398 * Check whether the current buffer is changed. If so, we will need
6399 * to split the current window or data could be lost.
6400 * Skip the check if the 'hidden' option is set, as in this case the
6401 * buffer won't be lost.
6402 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02006403 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006404 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006405 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01006406 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006407 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006408 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006410 // Fake a ":sfirst" or ":first" command edit the first argument.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006411 if (split)
6412 {
6413 eap->cmdidx = CMD_sfirst;
6414 eap->cmd[0] = 's';
6415 }
6416 else
6417 eap->cmdidx = CMD_first;
6418 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006421
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006422/*
6423 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
6424 * Put the start of the pattern in "*s", unless "s" is NULL.
6425 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
6426 * If "s" is not NULL terminate the pattern with a NUL.
6427 * Return a pointer to the char just past the pattern plus flags.
6428 */
6429 char_u *
6430skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
6431{
6432 int c;
6433
6434 if (vim_isIDc(*p))
6435 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006436 // ":vimgrep pattern fname"
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006437 if (s != NULL)
6438 *s = p;
6439 p = skiptowhite(p);
6440 if (s != NULL && *p != NUL)
6441 *p++ = NUL;
6442 }
6443 else
6444 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006445 // ":vimgrep /pattern/[g][j] fname"
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006446 if (s != NULL)
6447 *s = p + 1;
6448 c = *p;
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02006449 p = skip_regexp(p + 1, c, TRUE);
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006450 if (*p != c)
6451 return NULL;
6452
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006453 // Truncate the pattern.
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006454 if (s != NULL)
6455 *p = NUL;
6456 ++p;
6457
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006458 // Find the flags
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006459 while (*p == 'g' || *p == 'j')
6460 {
6461 if (flags != NULL)
6462 {
6463 if (*p == 'g')
6464 *flags |= VGR_GLOBAL;
6465 else
6466 *flags |= VGR_NOJUMP;
6467 }
6468 ++p;
6469 }
6470 }
6471 return p;
6472}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006473
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006474#if defined(FEAT_EVAL) || defined(PROTO)
6475/*
6476 * List v:oldfiles in a nice way.
6477 */
6478 void
6479ex_oldfiles(exarg_T *eap UNUSED)
6480{
6481 list_T *l = get_vim_var_list(VV_OLDFILES);
6482 listitem_T *li;
6483 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006484 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006485
6486 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006487 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006488 else
6489 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006490 msg_start();
6491 msg_scroll = TRUE;
6492 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
6493 {
6494 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006495 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02006496 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006497 {
6498 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01006499 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006500 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02006501 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006502 msg_putchar('\n');
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006503 out_flush(); // output one line at a time
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006504 ui_breakcheck();
6505 }
6506 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006507
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006508 // Assume "got_int" was set to truncate the listing.
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006509 got_int = FALSE;
6510
6511# ifdef FEAT_BROWSE_CMD
6512 if (cmdmod.browse)
6513 {
6514 quit_more = FALSE;
6515 nr = prompt_for_number(FALSE);
6516 msg_starthere();
6517 if (nr > 0)
6518 {
6519 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
6520 (long)nr);
6521
6522 if (p != NULL)
6523 {
6524 p = expand_env_save(p);
6525 eap->arg = p;
6526 eap->cmdidx = CMD_edit;
6527 cmdmod.browse = FALSE;
6528 do_exedit(eap, NULL);
6529 vim_free(p);
6530 }
6531 }
6532 }
6533# endif
6534 }
6535}
6536#endif