blob: 0eeb3f33996ba79f6cbbec92fda99dde20753e62 [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 {
454 s = skip_regexp(p + 1, *p, TRUE, NULL);
455 if (*s != *p)
456 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100457 emsg(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000458 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000459 }
460 *s = NUL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100461 // Use last search pattern if sort pattern is empty.
Bram Moolenaar210f3702013-03-07 16:41:30 +0100462 if (s == p + 1)
463 {
464 if (last_search_pat() == NULL)
465 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100466 emsg(_(e_noprevre));
Bram Moolenaar210f3702013-03-07 16:41:30 +0100467 goto sortend;
468 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000469 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100470 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000471 else
472 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000473 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 goto sortend;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100475 p = s; // continue after the regexp
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000476 regmatch.rm_ic = p_ic;
477 }
478 else
479 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100480 semsg(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000481 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000482 }
483 }
484
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100485 // Can only have one of 'n', 'b', 'o' and 'x'.
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100486 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000487 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100488 emsg(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000489 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 }
491
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100492 // From here on "sort_nr" is used as a flag for any integer number
493 // sorting.
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100494 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000496 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000497 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000498 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000499 * When sorting on strings "start_col_nr" is the offset in the line, for
500 * numbers sorting it's the number to sort on. This means the pattern
501 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000503 */
504 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
505 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000506 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000507 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 if (maxlen < len)
509 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000510
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 start_col = 0;
512 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000513 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000514 {
515 if (sort_rx)
516 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000517 start_col = (colnr_T)(regmatch.startp[0] - s);
518 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000519 }
520 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000521 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000522 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000523 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000524 if (regmatch.regprog != NULL)
525 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000526
Bram Moolenaar937204a2016-01-30 23:37:38 +0100527 if (sort_nr
528#ifdef FEAT_FLOAT
529 || sort_flt
530#endif
531 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000532 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100533 // Make sure vim_str2nr doesn't read any digits past the end
534 // of the match, by temporarily terminating the string there
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000535 s2 = s + end_col;
536 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200537 *s2 = NUL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100538 // Sorting on number: Store the number itself.
Bram Moolenaar1387a602008-07-24 19:31:11 +0000539 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100540 if (sort_nr)
541 {
542 if (sort_what & STR2NR_HEX)
543 s = skiptohex(p);
544 else if (sort_what & STR2NR_BIN)
545 s = skiptobin(p);
546 else
547 s = skiptodigit(p);
548 if (s > p && s[-1] == '-')
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100549 --s; // include preceding negative sign
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100550 if (*s == NUL)
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100551 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100552 // line without number should sort before any number
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100553 nrs[lnum - eap->line1].st_u.num.is_number = FALSE;
554 nrs[lnum - eap->line1].st_u.num.value = 0;
555 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100556 else
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100557 {
558 nrs[lnum - eap->line1].st_u.num.is_number = TRUE;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100559 vim_str2nr(s, NULL, NULL, sort_what,
Bram Moolenaar16e9b852019-05-19 19:59:35 +0200560 &nrs[lnum - eap->line1].st_u.num.value,
561 NULL, 0, FALSE);
Bram Moolenaara25e3d02019-02-20 22:19:05 +0100562 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100563 }
564#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000565 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100566 {
567 s = skipwhite(p);
568 if (*s == '+')
569 s = skipwhite(s + 1);
570
571 if (*s == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100572 // empty line should sort before any number
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100573 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
574 else
575 nrs[lnum - eap->line1].st_u.value_flt =
576 strtod((char *)s, NULL);
577 }
578#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200579 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000580 }
581 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000582 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100583 // Store the column to sort at.
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100584 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
585 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000586 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000587
588 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000589
590 if (regmatch.regprog != NULL)
591 fast_breakcheck();
592 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000594 }
595
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100596 // Allocate a buffer that can hold the longest line.
Bram Moolenaar964b3742019-05-24 18:54:09 +0200597 sortbuf1 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000598 if (sortbuf1 == NULL)
599 goto sortend;
Bram Moolenaar964b3742019-05-24 18:54:09 +0200600 sortbuf2 = alloc(maxlen + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000601 if (sortbuf2 == NULL)
602 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100604 // Sort the array of line numbers. Note: can't be interrupted!
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000605 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000606
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000607 if (sort_abort)
608 goto sortend;
609
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100610 // Insert the lines in the sorted order below the last one.
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000611 lnum = eap->line2;
612 for (i = 0; i < count; ++i)
613 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200614 linenr_T get_lnum = nrs[eap->forceit ? count - i - 1 : i].lnum;
615
616 // If the original line number of the line being placed is not the same
617 // as "lnum" (accounting for offset), we know that the buffer changed.
618 if (get_lnum + ((linenr_T)count - 1) != lnum)
619 change_occurred = TRUE;
620
621 s = ml_get(get_lnum);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000622 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000623 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 {
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200625 // Copy the line into a buffer, it may become invalid in
626 // ml_append(). And it's needed for "unique".
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100627 STRCPY(sortbuf1, s);
628 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000629 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000630 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000631 fast_breakcheck();
632 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000633 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 }
635
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100636 // delete the original lines if appending worked
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000637 if (i == count)
638 for (i = 0; i < count; ++i)
639 ml_delete(eap->line1, FALSE);
640 else
641 count = 0;
642
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100643 // Adjust marks for deleted (or added) lines and prepare for displaying.
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000644 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000645 if (deleted > 0)
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200646 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000647 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
Bram Moolenaarb0e982b2018-09-21 12:46:22 +0200648 msgmore(-deleted);
649 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000650 else if (deleted < 0)
651 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
Bram Moolenaardc9e9552018-06-28 11:28:08 +0200652
653 if (change_occurred || deleted != 0)
654 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000655
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000656 curwin->w_cursor.lnum = eap->line1;
657 beginline(BL_WHITE | BL_FIX);
658
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000659sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000660 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000661 vim_free(sortbuf1);
662 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200663 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000664 if (got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100665 emsg(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000666}
667
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 * :move command - move lines line1-line2 to line dest
670 *
671 * return FAIL for failure, OK otherwise
672 */
673 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100674do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675{
676 char_u *str;
677 linenr_T l;
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100678 linenr_T extra; // Num lines added before line1
679 linenr_T num_lines; // Num lines moved
680 linenr_T last_line; // Last line in file after adding new text
Bram Moolenaard5f69332015-04-15 12:43:50 +0200681#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100682 win_T *win;
683 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200684#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
686 if (dest >= line1 && dest < line2)
687 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100688 emsg(_("E134: Cannot move a range of lines into itself"));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 return FAIL;
690 }
691
Bram Moolenaarddd1f912018-11-10 19:19:36 +0100692 // Do nothing if we are not actually moving any lines. This will prevent
693 // the 'modified' flag from being set without cause.
694 if (dest == line1 - 1 || dest == line2)
695 {
696 // Move the cursor as if lines were moved (see below) to be backwards
697 // compatible.
698 if (dest >= line1)
699 curwin->w_cursor.lnum = dest;
700 else
701 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
702
703 return OK;
704 }
705
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 num_lines = line2 - line1 + 1;
707
708 /*
709 * First we copy the old text to its new location -- webb
710 * Also copy the flag that ":global" command uses.
711 */
712 if (u_save(dest, dest + 1) == FAIL)
713 return FAIL;
714 for (extra = 0, l = line1; l <= line2; l++)
715 {
716 str = vim_strsave(ml_get(l + extra));
717 if (str != NULL)
718 {
719 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
720 vim_free(str);
721 if (dest < line1)
722 extra++;
723 }
724 }
725
726 /*
727 * Now we must be careful adjusting our marks so that we don't overlap our
728 * mark_adjust() calls.
729 *
730 * We adjust the marks within the old text so that they refer to the
731 * last lines of the file (temporarily), because we know no other marks
732 * will be set there since these line numbers did not exist until we added
733 * our new lines.
734 *
735 * Then we adjust the marks on lines between the old and new text positions
736 * (either forwards or backwards).
737 *
738 * And Finally we adjust the marks we put at the end of the file back to
739 * their final destination at the new text position -- webb
740 */
741 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100742 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 if (dest >= line2)
744 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100745 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
746#ifdef FEAT_FOLDING
747 FOR_ALL_TAB_WINDOWS(tp, win) {
748 if (win->w_buffer == curbuf)
749 foldMoveRange(&win->w_folds, line1, line2, dest);
750 }
751#endif
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100752 if (!cmdmod.lockmarks)
753 {
754 curbuf->b_op_start.lnum = dest - num_lines + 1;
755 curbuf->b_op_end.lnum = dest;
756 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 }
758 else
759 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100760 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
761#ifdef FEAT_FOLDING
762 FOR_ALL_TAB_WINDOWS(tp, win) {
763 if (win->w_buffer == curbuf)
764 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
765 }
766#endif
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100767 if (!cmdmod.lockmarks)
768 {
769 curbuf->b_op_start.lnum = dest + 1;
770 curbuf->b_op_end.lnum = dest + num_lines;
771 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 }
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100773 if (!cmdmod.lockmarks)
774 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100775 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 -(last_line - dest - extra), 0L);
777
778 /*
779 * Now we delete the original text -- webb
780 */
781 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
782 return FAIL;
783
784 for (l = line1; l <= line2; l++)
785 ml_delete(line1 + extra, TRUE);
786
787 if (!global_busy && num_lines > p_report)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100788 smsg(NGETTEXT("%ld line moved", "%ld lines moved", num_lines),
Bram Moolenaarda6e8912018-08-21 15:12:14 +0200789 (long)num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 /*
792 * Leave the cursor on the last of the moved lines.
793 */
794 if (dest >= line1)
795 curwin->w_cursor.lnum = dest;
796 else
797 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
798
799 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100800 {
801 dest += num_lines + 1;
802 last_line = curbuf->b_ml.ml_line_count;
803 if (dest > last_line + 1)
804 dest = last_line + 1;
805 changed_lines(line1, 0, dest, 0L);
806 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 else
808 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
809
810 return OK;
811}
812
813/*
814 * ":copy"
815 */
816 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100817ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818{
819 linenr_T count;
820 char_u *p;
821
822 count = line2 - line1 + 1;
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +0100823 if (!cmdmod.lockmarks)
824 {
825 curbuf->b_op_start.lnum = n + 1;
826 curbuf->b_op_end.lnum = n + count;
827 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
828 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829
830 /*
831 * there are three situations:
832 * 1. destination is above line1
833 * 2. destination is between line1 and line2
834 * 3. destination is below line2
835 *
836 * n = destination (when starting)
837 * curwin->w_cursor.lnum = destination (while copying)
838 * line1 = start of source (while copying)
839 * line2 = end of source (while copying)
840 */
841 if (u_save(n, n + 1) == FAIL)
842 return;
843
844 curwin->w_cursor.lnum = n;
845 while (line1 <= line2)
846 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100847 // need to use vim_strsave() because the line will be unlocked within
848 // ml_append()
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 p = vim_strsave(ml_get(line1));
850 if (p != NULL)
851 {
852 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
853 vim_free(p);
854 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100855 // situation 2: skip already copied lines
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (line1 == n)
857 line1 = curwin->w_cursor.lnum;
858 ++line1;
859 if (curwin->w_cursor.lnum < line1)
860 ++line1;
861 if (curwin->w_cursor.lnum < line2)
862 ++line2;
863 ++curwin->w_cursor.lnum;
864 }
865
866 appended_lines_mark(n, count);
867
868 msgmore((long)count);
869}
870
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100871static char_u *prevcmd = NULL; // the previous command
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000872
873#if defined(EXITFREE) || defined(PROTO)
874 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100875free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000876{
877 vim_free(prevcmd);
878}
879#endif
880
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881/*
882 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
883 * Bangs in the argument are replaced with the previously entered command.
884 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 */
886 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100887do_bang(
888 int addr_count,
889 exarg_T *eap,
890 int forceit,
891 int do_in,
892 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100894 char_u *arg = eap->arg; // command
895 linenr_T line1 = eap->line1; // start of range
896 linenr_T line2 = eap->line2; // end of range
897 char_u *newcmd = NULL; // the new command
898 int free_newcmd = FALSE; // need to free() newcmd
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 int ins_prevcmd;
900 char_u *t;
901 char_u *p;
902 char_u *trailarg;
903 int len;
904 int scroll_save = msg_scroll;
905
906 /*
907 * Disallow shell commands for "rvim".
908 * Disallow shell commands from .exrc and .vimrc in current directory for
909 * security reasons.
910 */
911 if (check_restricted() || check_secure())
912 return;
913
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100914 if (addr_count == 0) // :!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100916 msg_scroll = FALSE; // don't scroll here
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917 autowrite_all();
918 msg_scroll = scroll_save;
919 }
920
921 /*
922 * Try to find an embedded bang, like in :!<cmd> ! [args]
923 * (:!! is indicated by the 'forceit' variable)
924 */
925 ins_prevcmd = forceit;
926 trailarg = arg;
927 do
928 {
929 len = (int)STRLEN(trailarg) + 1;
930 if (newcmd != NULL)
931 len += (int)STRLEN(newcmd);
932 if (ins_prevcmd)
933 {
934 if (prevcmd == NULL)
935 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100936 emsg(_(e_noprev));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 vim_free(newcmd);
938 return;
939 }
940 len += (int)STRLEN(prevcmd);
941 }
Bram Moolenaar964b3742019-05-24 18:54:09 +0200942 if ((t = alloc(len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 {
944 vim_free(newcmd);
945 return;
946 }
947 *t = NUL;
948 if (newcmd != NULL)
949 STRCAT(t, newcmd);
950 if (ins_prevcmd)
951 STRCAT(t, prevcmd);
952 p = t + STRLEN(t);
953 STRCAT(t, trailarg);
954 vim_free(newcmd);
955 newcmd = t;
956
957 /*
958 * Scan the rest of the argument for '!', which is replaced by the
959 * previous command. "\!" is replaced by "!" (this is vi compatible).
960 */
961 trailarg = NULL;
962 while (*p)
963 {
Bram Moolenaare60acc12011-05-10 16:41:25 +0200964 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 {
966 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000967 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 else
969 {
970 trailarg = p;
971 *trailarg++ = NUL;
972 ins_prevcmd = TRUE;
973 break;
974 }
975 }
976 ++p;
977 }
978 } while (trailarg != NULL);
979
980 vim_free(prevcmd);
981 prevcmd = newcmd;
982
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100983 if (bangredo) // put cmd in redo buffer for ! command
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100985 // If % or # appears in the command, it must have been escaped.
986 // Reescape them, so that redoing them does not substitute them by the
987 // buffername.
Bram Moolenaar529d2d62014-03-19 17:41:23 +0100988 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
989
990 if (cmd != NULL)
991 {
992 AppendToRedobuffLit(cmd, -1);
993 vim_free(cmd);
994 }
995 else
996 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 AppendToRedobuff((char_u *)"\n");
998 bangredo = FALSE;
999 }
1000 /*
1001 * Add quotes around the command, for shells that need them.
1002 */
1003 if (*p_shq != NUL)
1004 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001005 newcmd = alloc(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 if (newcmd == NULL)
1007 return;
1008 STRCPY(newcmd, p_shq);
1009 STRCAT(newcmd, prevcmd);
1010 STRCAT(newcmd, p_shq);
1011 free_newcmd = TRUE;
1012 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001013 if (addr_count == 0) // :!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001015 // echo the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 msg_start();
1017 msg_putchar(':');
1018 msg_putchar('!');
1019 msg_outtrans(newcmd);
1020 msg_clr_eos();
1021 windgoto(msg_row, msg_col);
1022
1023 do_shell(newcmd, 0);
1024 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001025 else // :range!
Bram Moolenaarade00832006-03-10 21:46:58 +00001026 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001027 // Careful: This may recursively call do_bang() again! (because of
1028 // autocommands)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001030 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001031 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 if (free_newcmd)
1033 vim_free(newcmd);
1034}
1035
1036/*
1037 * do_filter: filter lines through a command given by the user
1038 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001039 * We mostly use temp files and the call_shell() routine here. This would
1040 * normally be done using pipes on a UNIX machine, but this is more portable
1041 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 * to deal with redirection somehow, and should handle things like looking
1043 * at the PATH env. variable, and adding reasonable extensions to the
1044 * command name given by the user. All reasonable versions of call_shell()
1045 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001046 * Alternatively, if on Unix and redirecting input or output, but not both,
1047 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 * We use input redirection if do_in is TRUE.
1049 * We use output redirection if do_out is TRUE.
1050 */
1051 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001052do_filter(
1053 linenr_T line1,
1054 linenr_T line2,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001055 exarg_T *eap, // for forced 'ff' and 'fenc'
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001056 char_u *cmd,
1057 int do_in,
1058 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059{
1060 char_u *itmp = NULL;
1061 char_u *otmp = NULL;
1062 linenr_T linecount;
1063 linenr_T read_linecount;
1064 pos_T cursor_save;
1065 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001067 int shell_flags = 0;
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001068 pos_T orig_start = curbuf->b_op_start;
1069 pos_T orig_end = curbuf->b_op_end;
1070 int save_lockmarks = cmdmod.lockmarks;
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001071#ifdef FEAT_FILTERPIPE
1072 int stmp = p_stmp;
1073#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001075 if (*cmd == NUL) // no filter command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 return;
1077
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001078 // Temporarily disable lockmarks since that's needed to propagate changed
1079 // regions of the buffer for foldUpdate(), linecount, etc.
1080 cmdmod.lockmarks = 0;
1081
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 cursor_save = curwin->w_cursor;
1083 linecount = line2 - line1 + 1;
1084 curwin->w_cursor.lnum = line1;
1085 curwin->w_cursor.col = 0;
1086 changed_line_abv_curs();
1087 invalidate_botline();
1088
1089 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001090 * When using temp files:
1091 * 1. * Form temp file names
1092 * 2. * Write the lines to a temp file
1093 * 3. Run the filter command on the temp file
1094 * 4. * Read the output of the command into the buffer
1095 * 5. * Delete the original lines to be filtered
1096 * 6. * Remove the temp files
1097 *
1098 * When writing the input with a pipe or when catching the output with a
1099 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 */
1101
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001102 if (do_out)
1103 shell_flags |= SHELL_DOOUT;
1104
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001105#ifdef FEAT_FILTERPIPE
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001106# ifdef VIMDLL
1107 if (!gui.in_use && !gui.starting)
1108 stmp = 1; // Console mode doesn't support filterpipe.
1109# endif
1110
1111 if (!do_in && do_out && !stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001113 // Use a pipe to fetch stdout of the command, do not use a temp file.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001114 shell_flags |= SHELL_READ;
1115 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 }
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001117 else if (do_in && !do_out && !stmp)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001118 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001119 // Use a pipe to write stdin of the command, do not use a temp file.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001120 shell_flags |= SHELL_WRITE;
1121 curbuf->b_op_start.lnum = line1;
1122 curbuf->b_op_end.lnum = line2;
1123 }
Bram Moolenaar310c32e2019-11-29 23:15:25 +01001124 else if (do_in && do_out && !stmp)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001125 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001126 // Use a pipe to write stdin and fetch stdout of the command, do not
1127 // use a temp file.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001128 shell_flags |= SHELL_READ|SHELL_WRITE;
1129 curbuf->b_op_start.lnum = line1;
1130 curbuf->b_op_end.lnum = line2;
1131 curwin->w_cursor.lnum = line2;
1132 }
1133 else
1134#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001135 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1136 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001137 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001138 emsg(_(e_notmp));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001139 goto filterend;
1140 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141
1142/*
1143 * The writing and reading of temp files will not be shown.
1144 * Vi also doesn't do this and the messages are not very informative.
1145 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001146 ++no_wait_return; // don't call wait_return() while busy
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001147 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 FALSE, FALSE, FALSE, TRUE) == FAIL)
1149 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001150 msg_putchar('\n'); // keep message from buf_write()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001152#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 if (!aborting())
1154#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001155 (void)semsg(_(e_notcreate), itmp); // will call wait_return
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 goto filterend;
1157 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 if (curbuf != old_curbuf)
1159 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160
1161 if (!do_out)
1162 msg_putchar('\n');
1163
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001164 // Create the shell command in allocated memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1166 if (cmd_buf == NULL)
1167 goto filterend;
1168
1169 windgoto((int)Rows - 1, 0);
1170 cursor_on();
1171
1172 /*
1173 * When not redirecting the output the command can write anything to the
1174 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1175 * stderr output of external command. Clear the screen later.
1176 * If do_in is FALSE, this could be something like ":r !cat", which may
1177 * also mess up the screen, clear it later.
1178 */
1179 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1180 redraw_later_clear();
1181
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001182 if (do_out)
1183 {
1184 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001185 {
1186 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001187 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001188 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001189 redraw_curbuf_later(VALID);
1190 }
1191 read_linecount = curbuf->b_ml.ml_line_count;
1192
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 /*
1194 * When call_shell() fails wait_return() is called to give the user a
1195 * chance to read the error messages. Otherwise errors are ignored, so you
1196 * can see the error messages from the command that appear on stdout; use
1197 * 'u' to fix the text
1198 * Switch to cooked mode when not redirecting stdin, avoids that something
1199 * like ":r !cat" hangs.
1200 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1201 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001202 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 {
1204 redraw_later_clear();
1205 wait_return(FALSE);
1206 }
1207 vim_free(cmd_buf);
1208
1209 did_check_timestamps = FALSE;
1210 need_check_timestamps = TRUE;
1211
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001212 // When interrupting the shell command, it may still have produced some
1213 // useful output. Reset got_int here, so that readfile() won't cancel
1214 // reading.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 ui_breakcheck();
1216 got_int = FALSE;
1217
1218 if (do_out)
1219 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001220 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001222 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001223 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001225#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001226 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001228 {
1229 msg_putchar('\n');
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001230 semsg(_(e_notread), otmp);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001231 }
1232 goto error;
1233 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001234 if (curbuf != old_curbuf)
1235 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 }
1237
1238 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1239
1240 if (shell_flags & SHELL_READ)
1241 {
1242 curbuf->b_op_start.lnum = line2 + 1;
1243 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1244 appended_lines_mark(line2, read_linecount);
1245 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246
1247 if (do_in)
1248 {
1249 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1250 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 if (read_linecount >= linecount)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001252 // move all marks from old lines to new lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 mark_adjust(line1, line2, linecount, 0L);
1254 else
1255 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001256 // move marks from old lines to new lines, delete marks
1257 // that are in deleted lines
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 mark_adjust(line1, line1 + read_linecount - 1,
1259 linecount, 0L);
1260 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1261 }
1262 }
1263
1264 /*
1265 * Put cursor on first filtered line for ":range!cmd".
1266 * Adjust '[ and '] (set by buf_write()).
1267 */
1268 curwin->w_cursor.lnum = line1;
1269 del_lines(linecount, TRUE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001270 curbuf->b_op_start.lnum -= linecount; // adjust '[
1271 curbuf->b_op_end.lnum -= linecount; // adjust ']
1272 write_lnum_adjust(-linecount); // adjust last line
1273 // for next write
Bram Moolenaar8c711452005-01-14 21:53:12 +00001274#ifdef FEAT_FOLDING
1275 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 }
1278 else
1279 {
1280 /*
1281 * Put cursor on last new line for ":r !cmd".
1282 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001284 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001286
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001287 beginline(BL_WHITE | BL_FIX); // cursor on first non-blank
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288 --no_wait_return;
1289
1290 if (linecount > p_report)
1291 {
1292 if (do_in)
1293 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001294 vim_snprintf(msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00001295 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001297 // save message to display it after redraw
Bram Moolenaar32526b32019-01-19 17:43:09 +01001298 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 }
1300 else
1301 msgmore((long)linecount);
1302 }
1303 }
1304 else
1305 {
1306error:
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001307 // put cursor back in same position for ":w !cmd"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 curwin->w_cursor = cursor_save;
1309 --no_wait_return;
1310 wait_return(FALSE);
1311 }
1312
1313filterend:
1314
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001315 cmdmod.lockmarks = save_lockmarks;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 if (curbuf != old_curbuf)
1317 {
1318 --no_wait_return;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001319 emsg(_("E135: *Filter* Autocommands must not change current buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 }
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01001321 else if (cmdmod.lockmarks)
1322 {
1323 curbuf->b_op_start = orig_start;
1324 curbuf->b_op_end = orig_end;
1325 }
1326
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 if (itmp != NULL)
1328 mch_remove(itmp);
1329 if (otmp != NULL)
1330 mch_remove(otmp);
1331 vim_free(itmp);
1332 vim_free(otmp);
1333}
1334
1335/*
1336 * Call a shell to execute a command.
1337 * When "cmd" is NULL start an interactive shell.
1338 */
1339 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001340do_shell(
1341 char_u *cmd,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001342 int flags) // may be SHELL_DOOUT when output is redirected
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343{
1344 buf_T *buf;
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001345#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 int save_nwr;
1347#endif
1348#ifdef MSWIN
1349 int winstart = FALSE;
Bram Moolenaar049ca592019-03-17 16:59:44 +01001350 int keep_termcap = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351#endif
1352
1353 /*
1354 * Disallow shell commands for "rvim".
1355 * Disallow shell commands from .exrc and .vimrc in current directory for
1356 * security reasons.
1357 */
1358 if (check_restricted() || check_secure())
1359 {
1360 msg_end();
1361 return;
1362 }
1363
1364#ifdef MSWIN
1365 /*
Bram Moolenaar049ca592019-03-17 16:59:44 +01001366 * Check if ":!start" is used. This implies not stopping termcap mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 */
1368 if (cmd != NULL)
Bram Moolenaar049ca592019-03-17 16:59:44 +01001369 keep_termcap = winstart = (STRNICMP(cmd, "start ", 6) == 0);
1370
1371# if defined(FEAT_GUI) && defined(FEAT_TERMINAL)
1372 // Don't stop termcap mode when using a terminal window for the shell.
1373 if (gui.in_use && vim_strchr(p_go, GO_TERMINAL) != NULL)
1374 keep_termcap = TRUE;
1375# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376#endif
1377
1378 /*
1379 * For autocommands we want to get the output on the current screen, to
1380 * avoid having to type return below.
1381 */
Bram Moolenaar049ca592019-03-17 16:59:44 +01001382 msg_putchar('\r'); // put cursor at start of line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 {
1385#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001386 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387#endif
1388 stoptermcap();
1389 }
1390#ifdef MSWIN
1391 if (!winstart)
1392#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001393 msg_putchar('\n'); // may shift screen one line up
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394
Bram Moolenaar049ca592019-03-17 16:59:44 +01001395 // warning message before calling the shell
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001396 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001397 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001398 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 {
1400#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001401 if (!keep_termcap)
1402 starttermcap(); // don't want a message box here
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403#endif
Bram Moolenaar32526b32019-01-19 17:43:09 +01001404 msg_puts(_("[No write since last change]\n"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405#ifdef FEAT_GUI_MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001406 if (!keep_termcap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 stoptermcap();
1408#endif
1409 break;
1410 }
1411
Bram Moolenaar049ca592019-03-17 16:59:44 +01001412 // This windgoto is required for when the '\n' resulted in a "delete line
1413 // 1" command to the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414 if (!swapping_screen())
1415 windgoto(msg_row, msg_col);
1416 cursor_on();
1417 (void)call_shell(cmd, SHELL_COOKED | flags);
1418 did_check_timestamps = FALSE;
1419 need_check_timestamps = TRUE;
1420
1421 /*
1422 * put the message cursor at the end of the screen, avoids wait_return()
1423 * to overwrite the text that the external command showed
1424 */
1425 if (!swapping_screen())
1426 {
1427 msg_row = Rows - 1;
1428 msg_col = 0;
1429 }
1430
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 if (autocmd_busy)
1432 {
1433 if (msg_silent == 0)
1434 redraw_later_clear();
1435 }
1436 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 {
1438 /*
1439 * For ":sh" there is no need to call wait_return(), just redraw.
1440 * Also for the Win32 GUI (the output is in a console window).
1441 * Otherwise there is probably text on the screen that the user wants
1442 * to read before redrawing, so call wait_return().
1443 */
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001444#if !defined(FEAT_GUI_MSWIN) || defined(VIMDLL)
1445# ifdef VIMDLL
1446 if (!gui.in_use)
1447# endif
1448 {
1449 if (cmd == NULL
Bram Moolenaar4f974752019-02-17 17:44:42 +01001450# ifdef MSWIN
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001451 || (keep_termcap && !need_wait_return)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001453 )
1454 {
1455 if (msg_silent == 0)
1456 redraw_later_clear();
1457 need_wait_return = FALSE;
1458 }
1459 else
1460 {
1461 /*
1462 * If we switch screens when starttermcap() is called, we
1463 * really want to wait for "hit return to continue".
1464 */
1465 save_nwr = no_wait_return;
1466 if (swapping_screen())
1467 no_wait_return = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468# ifdef AMIGA
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001469 wait_return(term_console ? -1 : msg_silent == 0); // see below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470# else
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001471 wait_return(msg_silent == 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472# endif
Bram Moolenaarafde13b2019-04-28 19:46:49 +02001473 no_wait_return = save_nwr;
1474 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001476#endif // FEAT_GUI_MSWIN
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477
1478#ifdef MSWIN
Bram Moolenaar049ca592019-03-17 16:59:44 +01001479 if (!keep_termcap) // if keep_termcap is TRUE didn't stop termcap
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480#endif
Bram Moolenaar049ca592019-03-17 16:59:44 +01001481 starttermcap(); // start termcap if not done by wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482
1483 /*
1484 * In an Amiga window redrawing is caused by asking the window size.
1485 * If we got an interrupt this will not work. The chance that the
1486 * window size is wrong is very small, but we need to redraw the
1487 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1488 * but it saves an extra redraw.
1489 */
1490#ifdef AMIGA
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001491 if (skip_redraw) // ':' hit in wait_return()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 {
1493 if (msg_silent == 0)
1494 redraw_later_clear();
1495 }
1496 else if (term_console)
1497 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001498 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); // get window size
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 if (got_int && msg_silent == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001500 redraw_later_clear(); // if got_int is TRUE, redraw needed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001502 must_redraw = 0; // no extra redraw needed
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 }
1504#endif
1505 }
1506
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001507 // display any error messages now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001509
Bram Moolenaarade00832006-03-10 21:46:58 +00001510 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511}
1512
Bram Moolenaar06640892018-10-09 21:49:33 +02001513#if !defined(UNIX)
1514 static char_u *
1515find_pipe(char_u *cmd)
1516{
1517 char_u *p;
1518 int inquote = FALSE;
1519
1520 for (p = cmd; *p != NUL; ++p)
1521 {
1522 if (!inquote && *p == '|')
1523 return p;
1524 if (*p == '"')
1525 inquote = !inquote;
1526 else if (rem_backslash(p))
1527 ++p;
1528 }
1529 return NULL;
1530}
1531#endif
1532
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533/*
1534 * Create a shell command from a command string, input redirection file and
1535 * output redirection file.
1536 * Returns an allocated string with the shell command, or NULL for failure.
1537 */
1538 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001539make_filter_cmd(
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001540 char_u *cmd, // command
1541 char_u *itmp, // NULL or name of input file
1542 char_u *otmp) // NULL or name of output file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543{
1544 char_u *buf;
1545 long_u len;
1546
Bram Moolenaar53076832015-12-31 19:53:21 +01001547#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001548 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001549 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001550
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001551 // Account for fish's different syntax for subshells
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001552 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1553 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001554 if (is_fish_shell)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001555 len = (long_u)STRLEN(cmd) + 13; // "begin; " + "; end" + NUL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001556 else
1557#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001558 len = (long_u)STRLEN(cmd) + 3; // "()" + NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 if (itmp != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001560 len += (long_u)STRLEN(itmp) + 9; // " { < " + " } "
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 if (otmp != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001562 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; // " "
Bram Moolenaar18a4ba22019-05-24 19:39:03 +02001563 buf = alloc(len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 if (buf == NULL)
1565 return NULL;
1566
Bram Moolenaar53076832015-12-31 19:53:21 +01001567#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001569 * Put braces around the command (for concatenated commands) when
1570 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001572 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001573 {
1574 if (is_fish_shell)
1575 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1576 else
1577 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1578 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001579 else
1580 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 if (itmp != NULL)
1582 {
1583 STRCAT(buf, " < ");
1584 STRCAT(buf, itmp);
1585 }
1586#else
Bram Moolenaar1a613392019-09-28 15:51:37 +02001587 // For shells that don't understand braces around commands, at least allow
1588 // the use of commands in a pipe.
1589 if (*p_sxe != NUL && *p_sxq == '(')
1590 {
1591 if (itmp != NULL || otmp != NULL)
1592 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1593 else
1594 STRCPY(buf, cmd);
1595 if (itmp != NULL)
1596 {
1597 STRCAT(buf, " < ");
1598 STRCAT(buf, itmp);
1599 }
1600 }
1601 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 {
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001603 STRCPY(buf, cmd);
1604 if (itmp != NULL)
1605 {
1606 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001608 // If there is a pipe, we have to put the '<' in front of it.
1609 // Don't do this when 'shellquote' is not empty, otherwise the
1610 // redirection would be inside the quotes.
1611 if (*p_shq == NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 {
Bram Moolenaar2886dcc2019-10-01 12:10:25 +02001613 p = find_pipe(buf);
1614 if (p != NULL)
1615 *p = NUL;
1616 }
1617 STRCAT(buf, " <"); // " < " causes problems on Amiga
1618 STRCAT(buf, itmp);
1619 if (*p_shq == NUL)
1620 {
1621 p = find_pipe(cmd);
1622 if (p != NULL)
1623 {
1624 STRCAT(buf, " "); // insert a space before the '|' for DOS
1625 STRCAT(buf, p);
1626 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 }
1628 }
1629 }
1630#endif
1631 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001632 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633
1634 return buf;
1635}
1636
1637/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001638 * Append output redirection for file "fname" to the end of string buffer
1639 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 * Works with the 'shellredir' and 'shellpipe' options.
1641 * The caller should make sure that there is enough room:
1642 * STRLEN(opt) + STRLEN(fname) + 3
1643 */
1644 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001645append_redir(
1646 char_u *buf,
1647 int buflen,
1648 char_u *opt,
1649 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650{
1651 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001652 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001654 end = buf + STRLEN(buf);
Bram Moolenaar1a613392019-09-28 15:51:37 +02001655 // find "%s"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001657 {
Bram Moolenaar1a613392019-09-28 15:51:37 +02001658 if (p[1] == 's') // found %s
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 break;
Bram Moolenaar1a613392019-09-28 15:51:37 +02001660 if (p[1] == '%') // skip %%
Bram Moolenaar542805a2013-08-02 14:15:13 +02001661 ++p;
1662 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 if (p != NULL)
1664 {
Bram Moolenaar1a613392019-09-28 15:51:37 +02001665#ifdef MSWIN
1666 *end++ = ' '; // not really needed? Not with sh, ksh or bash
1667#endif
1668 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001669 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 }
1671 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001672 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 " %s %s",
1675#else
Bram Moolenaar1a613392019-09-28 15:51:37 +02001676 " %s%s", // " > %s" causes problems on Amiga
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677#endif
1678 (char *)opt, (char *)fname);
1679}
1680
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001681/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 * Implementation of ":fixdel", also used by get_stty().
1683 * <BS> resulting <Del>
1684 * ^? ^H
1685 * not ^? ^?
1686 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001688do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689{
1690 char_u *p;
1691
1692 p = find_termcode((char_u *)"kb");
1693 add_termcode((char_u *)"kD", p != NULL
1694 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
1695}
1696
1697 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001698print_line_no_prefix(
1699 linenr_T lnum,
1700 int use_number,
1701 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702{
Bram Moolenaar32526b32019-01-19 17:43:09 +01001703 char numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704
1705 if (curwin->w_p_nu || use_number)
1706 {
Bram Moolenaar32526b32019-01-19 17:43:09 +01001707 vim_snprintf(numbuf, sizeof(numbuf),
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001708 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001709 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); // Highlight line nrs
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001711 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712}
1713
1714/*
1715 * Print a text line. Also in silent mode ("ex -s").
1716 */
1717 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001718print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719{
1720 int save_silent = silent_mode;
1721
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001722 // apply :filter /pat/
Bram Moolenaard29459b2016-08-26 22:29:11 +02001723 if (message_filtered(ml_get(lnum)))
1724 return;
1725
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001727 silent_mode = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001728 info_message = TRUE; // use mch_msg(), not mch_errmsg()
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001729 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 if (save_silent)
1731 {
1732 msg_putchar('\n');
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001733 cursor_on(); // msg_start() switches it off
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 out_flush();
1735 silent_mode = save_silent;
1736 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00001737 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738}
1739
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001740 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001741rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001742{
1743 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02001744 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001745
Bram Moolenaar7e283842013-05-30 11:43:15 +02001746 buf = curbuf;
1747 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001748 // buffer changed, don't change name now
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001749 if (buf != curbuf)
1750 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001751#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001752 if (aborting()) // autocmds may abort script processing
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001753 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001754#endif
1755 /*
1756 * The name of the current buffer will be changed.
1757 * A new (unlisted) buffer entry needs to be made to hold the old file
1758 * name, which will become the alternate file name.
1759 * But don't set the alternate file name if the buffer didn't have a
1760 * name.
1761 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02001762 fname = curbuf->b_ffname;
1763 sfname = curbuf->b_sfname;
1764 xfname = curbuf->b_fname;
1765 curbuf->b_ffname = NULL;
1766 curbuf->b_sfname = NULL;
1767 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001768 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02001769 curbuf->b_ffname = fname;
1770 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001771 return FAIL;
1772 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02001773 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001774 if (xfname != NULL && *xfname != NUL)
1775 {
1776 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
1777 if (buf != NULL && !cmdmod.keepalt)
1778 curwin->w_alt_fnum = buf->b_fnum;
1779 }
1780 vim_free(fname);
1781 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02001782 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001783
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001784 // Change directories when the 'acd' option is set.
Bram Moolenaar6f470022018-04-10 18:47:20 +02001785 DO_AUTOCHDIR;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001786 return OK;
1787}
1788
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789/*
1790 * ":file[!] [fname]".
1791 */
1792 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001793ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001795 // ":0file" removes the file name. Check for illegal uses ":3file",
1796 // "0file name", etc.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001797 if (eap->addr_count > 0
1798 && (*eap->arg != NUL
1799 || eap->line2 > 0
1800 || eap->addr_count > 1))
1801 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001802 emsg(_(e_invarg));
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001803 return;
1804 }
1805
1806 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02001808 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 return;
Bram Moolenaarfc089602018-06-24 16:53:35 +02001810 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 }
Bram Moolenaarfc089602018-06-24 16:53:35 +02001812
1813 // print file name if no argument or 'F' is not in 'shortmess'
1814 if (*eap->arg == NUL || !shortmess(SHM_FILEINFO))
Bram Moolenaar426dd022016-03-15 15:09:29 +01001815 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816}
1817
1818/*
1819 * ":update".
1820 */
1821 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001822ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823{
1824 if (curbufIsChanged())
1825 (void)do_write(eap);
1826}
1827
1828/*
1829 * ":write" and ":saveas".
1830 */
1831 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001832ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833{
Bram Moolenaarb7316892019-05-01 18:08:42 +02001834 if (eap->cmdidx == CMD_saveas)
1835 {
1836 // :saveas does not take a range, uses all lines.
1837 eap->line1 = 1;
1838 eap->line2 = curbuf->b_ml.ml_line_count;
1839 }
1840
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001841 if (eap->usefilter) // input lines to shell command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 do_bang(1, eap, FALSE, TRUE, FALSE);
1843 else
1844 (void)do_write(eap);
1845}
1846
1847/*
1848 * write current buffer to file 'eap->arg'
1849 * if 'eap->append' is TRUE, append to the file
1850 *
1851 * if *eap->arg == NUL write to current file
1852 *
1853 * return FAIL for failure, OK otherwise
1854 */
1855 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001856do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857{
1858 int other;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001859 char_u *fname = NULL; // init to shut up gcc
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 char_u *ffname;
1861 int retval = FAIL;
1862 char_u *free_fname = NULL;
1863#ifdef FEAT_BROWSE
1864 char_u *browse_file = NULL;
1865#endif
1866 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02001867 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001869 if (not_writing()) // check 'write' option
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 return FAIL;
1871
1872 ffname = eap->arg;
1873#ifdef FEAT_BROWSE
Bram Moolenaar5c381eb2019-06-25 06:50:31 +02001874 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001876 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 NULL, NULL, NULL, curbuf);
1878 if (browse_file == NULL)
1879 goto theend;
1880 ffname = browse_file;
1881 }
1882#endif
1883 if (*ffname == NUL)
1884 {
1885 if (eap->cmdidx == CMD_saveas)
1886 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001887 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 goto theend;
1889 }
1890 other = FALSE;
1891 }
1892 else
1893 {
1894 fname = ffname;
1895 free_fname = fix_fname(ffname);
1896 /*
1897 * When out-of-memory, keep unexpanded file name, because we MUST be
1898 * able to write the file in this situation.
1899 */
1900 if (free_fname != NULL)
1901 ffname = free_fname;
1902 other = otherfile(ffname);
1903 }
1904
1905 /*
1906 * If we have a new file, put its name in the list of alternate file names.
1907 */
1908 if (other)
1909 {
1910 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
1911 || eap->cmdidx == CMD_saveas)
1912 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
1913 else
1914 alt_buf = buflist_findname(ffname);
1915 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
1916 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001917 // Overwriting a file that is loaded in another buffer is not a
1918 // good idea.
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001919 emsg(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 goto theend;
1921 }
1922 }
1923
1924 /*
1925 * Writing to the current file is not allowed in readonly mode
1926 * and a file name is required.
1927 * "nofile" and "nowrite" buffers cannot be written implicitly either.
1928 */
1929 if (!other && (
1930#ifdef FEAT_QUICKFIX
1931 bt_dontwrite_msg(curbuf) ||
1932#endif
1933 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
1934 goto theend;
1935
1936 if (!other)
1937 {
1938 ffname = curbuf->b_ffname;
1939 fname = curbuf->b_fname;
1940 /*
1941 * Not writing the whole file is only allowed with '!'.
1942 */
1943 if ( (eap->line1 != 1
1944 || eap->line2 != curbuf->b_ml.ml_line_count)
1945 && !eap->forceit
1946 && !eap->append
1947 && !p_wa)
1948 {
1949#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1950 if (p_confirm || cmdmod.confirm)
1951 {
1952 if (vim_dialog_yesno(VIM_QUESTION, NULL,
1953 (char_u *)_("Write partial file?"), 2) != VIM_YES)
1954 goto theend;
1955 eap->forceit = TRUE;
1956 }
1957 else
1958#endif
1959 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001960 emsg(_("E140: Use ! to write partial buffer"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 goto theend;
1962 }
1963 }
1964 }
1965
1966 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
1967 {
1968 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
1969 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 buf_T *was_curbuf = curbuf;
1971
1972 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00001973 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001974#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001976#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001980 // buffer changed, don't change name now
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 retval = FAIL;
1982 goto theend;
1983 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001984 // Exchange the file names for the current and the alternate
1985 // buffer. This makes it look like we are now editing the buffer
1986 // under the new name. Must be done before buf_write(), because
1987 // if there is no file name and 'cpo' contains 'F', it will set
1988 // the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 fname = alt_buf->b_fname;
1990 alt_buf->b_fname = curbuf->b_fname;
1991 curbuf->b_fname = fname;
1992 fname = alt_buf->b_ffname;
1993 alt_buf->b_ffname = curbuf->b_ffname;
1994 curbuf->b_ffname = fname;
1995 fname = alt_buf->b_sfname;
1996 alt_buf->b_sfname = curbuf->b_sfname;
1997 curbuf->b_sfname = fname;
1998 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001999
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002001 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 if (!alt_buf->b_p_bl)
2003 {
2004 alt_buf->b_p_bl = TRUE;
2005 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2006 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002007#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002009#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002011#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002013 // buffer changed, don't write the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 retval = FAIL;
2015 goto theend;
2016 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002017
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002018 // If 'filetype' was empty try detecting it now.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002019 if (*curbuf->b_p_ft == NUL)
2020 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002021 if (au_has_group((char_u *)"filetypedetect"))
2022 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02002023 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002024 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002025 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002026
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002027 // Autocommands may have changed buffer names, esp. when
2028 // 'autochdir' is set.
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002029 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 }
2031
Bram Moolenaar5c719942016-07-09 23:40:45 +02002032 name_was_missing = curbuf->b_ffname == NULL;
2033
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2035 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002036
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002037 // After ":saveas fname" reset 'readonly'.
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002038 if (eap->cmdidx == CMD_saveas)
2039 {
2040 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002041 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002042 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002043 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002044 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02002045 }
2046
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002047 // Change directories when the 'acd' option is set and the file name
2048 // got changed or set.
Bram Moolenaar5c719942016-07-09 23:40:45 +02002049 if (eap->cmdidx == CMD_saveas || name_was_missing)
Bram Moolenaar6f470022018-04-10 18:47:20 +02002050 DO_AUTOCHDIR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 }
2052
2053theend:
2054#ifdef FEAT_BROWSE
2055 vim_free(browse_file);
2056#endif
2057 vim_free(free_fname);
2058 return retval;
2059}
2060
2061/*
2062 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2063 * BF_NEW or BF_READERR, check for overwriting current file.
2064 * May set eap->forceit if a dialog says it's OK to overwrite.
2065 * Return OK if it's OK, FAIL if it is not.
2066 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002067 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002068check_overwrite(
2069 exarg_T *eap,
2070 buf_T *buf,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002071 char_u *fname, // file name to be used (can differ from
2072 // buf->ffname)
2073 char_u *ffname, // full path version of fname
2074 int other) // writing under other name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075{
2076 /*
2077 * write to other file or b_flags set or not writing the whole file:
2078 * overwriting only allowed with '!'
2079 */
2080 if ( (other
2081 || (buf->b_flags & BF_NOTEDITED)
2082 || ((buf->b_flags & BF_NEW)
2083 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2084 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002086#ifdef FEAT_QUICKFIX
Bram Moolenaar26910de2019-06-15 19:37:15 +02002087 && !bt_nofilename(buf)
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002088#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 && vim_fexists(ffname))
2090 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002091 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002093#ifdef UNIX
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002094 // with UNIX it is possible to open a directory
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002095 if (mch_isdir(ffname))
2096 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002097 semsg(_(e_isadir2), ffname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002098 return FAIL;
2099 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100#endif
2101#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002102 if (p_confirm || cmdmod.confirm)
2103 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002104 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002106 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2107 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2108 return FAIL;
2109 eap->forceit = TRUE;
2110 }
2111 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002113 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002114 emsg(_(e_exists));
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002115 return FAIL;
2116 }
2117 }
2118
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002119 // For ":w! filename" check that no swap file exists for "filename".
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002120 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002122 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002123 char_u *p;
2124 int r;
2125 char_u *swapname;
2126
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002127 // We only try the first entry in 'directory', without checking if
2128 // it's writable. If the "." directory is not writable the write
2129 // will probably fail anyway.
2130 // Use 'shortname' of the current buffer, since there is no buffer
2131 // for the written file.
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002132 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002133 {
2134 dir = alloc(5);
2135 if (dir == NULL)
2136 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002137 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002138 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002139 else
2140 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002141 dir = alloc(MAXPATHL);
2142 if (dir == NULL)
2143 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002144 p = p_dir;
2145 copy_option_part(&p, dir, MAXPATHL, ",");
2146 }
2147 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002148 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002149 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002150 if (r)
2151 {
2152#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2153 if (p_confirm || cmdmod.confirm)
2154 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002155 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002156
2157 dialog_msg(buff,
2158 _("Swap file \"%s\" exists, overwrite anyway?"),
2159 swapname);
2160 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2161 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002162 {
2163 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002164 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002165 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002166 eap->forceit = TRUE;
2167 }
2168 else
2169#endif
2170 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002171 semsg(_("E768: Swap file exists: %s (:silent! overrides)"),
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002172 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002173 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002174 return FAIL;
2175 }
2176 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002177 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 }
2179 }
2180 return OK;
2181}
2182
2183/*
2184 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2185 */
2186 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002187ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188{
2189 int i;
2190
2191 if (eap->cmd[1] == 'n')
2192 i = curwin->w_arg_idx + (int)eap->line2;
2193 else
2194 i = curwin->w_arg_idx - (int)eap->line2;
2195 eap->line1 = 1;
2196 eap->line2 = curbuf->b_ml.ml_line_count;
2197 if (do_write(eap) != FAIL)
2198 do_argfile(eap, i);
2199}
2200
2201/*
2202 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2203 */
2204 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002205do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206{
2207 buf_T *buf;
2208 int error = 0;
2209 int save_forceit = eap->forceit;
2210
2211 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2212 exiting = TRUE;
2213
Bram Moolenaar29323592016-07-24 22:04:11 +02002214 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01002216#ifdef FEAT_TERMINAL
2217 if (exiting && term_job_running(buf->b_term))
2218 {
2219 no_write_message_nobang(buf);
2220 ++error;
2221 }
2222 else
2223#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02002224 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 {
2226 /*
2227 * Check if there is a reason the buffer cannot be written:
2228 * 1. if the 'write' option is set
2229 * 2. if there is no file name (even after browsing)
2230 * 3. if the 'readonly' is set (even after a dialog)
2231 * 4. if overwriting is allowed (even after a dialog)
2232 */
2233 if (not_writing())
2234 {
2235 ++error;
2236 break;
2237 }
2238#ifdef FEAT_BROWSE
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002239 // ":browse wall": ask for file name if there isn't one
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 if (buf->b_ffname == NULL && cmdmod.browse)
2241 browse_save_fname(buf);
2242#endif
2243 if (buf->b_ffname == NULL)
2244 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002245 semsg(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 ++error;
2247 }
2248 else if (check_readonly(&eap->forceit, buf)
2249 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2250 FALSE) == FAIL)
2251 {
2252 ++error;
2253 }
2254 else
2255 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002256 bufref_T bufref;
2257
2258 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 if (buf_write_all(buf, eap->forceit) == FAIL)
2260 ++error;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002261 // an autocommand may have deleted the buffer
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002262 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002265 eap->forceit = save_forceit; // check_overwrite() may set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 }
2267 }
2268 if (exiting)
2269 {
2270 if (!error)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002271 getout(0); // exit Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 not_exiting();
2273 }
2274}
2275
2276/*
2277 * Check the 'write' option.
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002278 * Return TRUE and give a message when it's not set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02002280 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002281not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282{
2283 if (p_write)
2284 return FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002285 emsg(_("E142: File not written: Writing is disabled by 'write' option"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 return TRUE;
2287}
2288
2289/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002290 * Check if a buffer is read-only (either 'readonly' option is set or file is
2291 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2292 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 */
2294 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002295check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296{
Bram Moolenaar8767f522016-07-01 17:17:39 +02002297 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00002298
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002299 // Handle a file being readonly when the 'readonly' option is set or when
2300 // the file exists and permissions are read-only.
2301 // We will send 0777 to check_file_readonly(), as the "perm" variable is
2302 // important for device checks but not here.
Bram Moolenaar5386a122007-06-28 20:02:32 +00002303 if (!*forceit && (buf->b_p_ro
2304 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2305 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 {
2307#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2308 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2309 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002310 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311
Bram Moolenaar5386a122007-06-28 20:02:32 +00002312 if (buf->b_p_ro)
2313 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2314 buf->b_fname);
2315 else
2316 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 +00002317 buf->b_fname);
2318
2319 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2320 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002321 // Set forceit, to force the writing of a readonly file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 *forceit = TRUE;
2323 return FALSE;
2324 }
2325 else
2326 return TRUE;
2327 }
2328 else
2329#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002330 if (buf->b_p_ro)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002331 emsg(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002332 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002333 semsg(_("E505: \"%s\" is read-only (add ! to override)"),
Bram Moolenaar5386a122007-06-28 20:02:32 +00002334 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 return TRUE;
2336 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002337
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 return FALSE;
2339}
2340
2341/*
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002342 * Try to abandon the current file and edit a new or existing file.
2343 * "fnum" is the number of the file, if zero use "ffname_arg"/"sfname_arg".
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002344 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002346 * Return:
2347 * GETFILE_ERROR for "normal" error,
2348 * GETFILE_NOT_WRITTEN for "not written" error,
2349 * GETFILE_SAME_FILE for success
2350 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 */
2352 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002353getfile(
2354 int fnum,
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002355 char_u *ffname_arg,
2356 char_u *sfname_arg,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002357 int setpm,
2358 linenr_T lnum,
2359 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360{
Bram Moolenaar3d6014f2018-10-11 19:27:47 +02002361 char_u *ffname = ffname_arg;
2362 char_u *sfname = sfname_arg;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 int other;
2364 int retval;
2365 char_u *free_me = NULL;
2366
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002367 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002368 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002369 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02002370 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
2372 if (fnum == 0)
2373 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002374 // make ffname full path, set sfname
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 fname_expand(curbuf, &ffname, &sfname);
2376 other = otherfile(ffname);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002377 free_me = ffname; // has been allocated, free() later
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 }
2379 else
2380 other = (fnum != curbuf->b_fnum);
2381
2382 if (other)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002383 ++no_wait_return; // don't wait for autowrite message
Bram Moolenaareb44a682017-08-03 22:44:55 +02002384 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
2386 {
2387#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2388 if (p_confirm && p_write)
2389 dialog_changed(curbuf, FALSE);
2390 if (curbufIsChanged())
2391#endif
2392 {
2393 if (other)
2394 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002395 no_write_message();
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002396 retval = GETFILE_NOT_WRITTEN; // file has been changed
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 goto theend;
2398 }
2399 }
2400 if (other)
2401 --no_wait_return;
2402 if (setpm)
2403 setpcmark();
2404 if (!other)
2405 {
2406 if (lnum != 0)
2407 curwin->w_cursor.lnum = lnum;
2408 check_cursor_lnum();
2409 beginline(BL_SOL | BL_FIX);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002410 retval = GETFILE_SAME_FILE; // it's in the same file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 }
2412 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002413 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002414 curwin) == OK)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002415 retval = GETFILE_OPEN_OTHER; // opened another file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002417 retval = GETFILE_ERROR; // error encountered
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418
2419theend:
2420 vim_free(free_me);
2421 return retval;
2422}
2423
2424/*
2425 * start editing a new file
2426 *
2427 * fnum: file number; if zero use ffname/sfname
2428 * ffname: the file name
2429 * - full path if sfname used,
2430 * - any file name if sfname is NULL
2431 * - empty string to re-edit with the same file name (but may be
2432 * in a different directory)
2433 * - NULL to start an empty buffer
2434 * sfname: the short file name (or NULL)
2435 * eap: contains the command to be executed after loading the file and
2436 * forced 'ff' and 'fenc'
2437 * newlnum: if > 0: put cursor on this line number (if possible)
2438 * if ECMD_LASTL: use last position in loaded file
2439 * if ECMD_LAST: use last position in all files
2440 * if ECMD_ONE: use first line
2441 * flags:
2442 * ECMD_HIDE: if TRUE don't free the current buffer
2443 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
2444 * ECMD_OLDBUF: use existing buffer if it exists
2445 * ECMD_FORCEIT: ! used for Ex command
2446 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002447 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02002448 * window, NULL when splitting the window first. When not NULL info
2449 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 *
2451 * return FAIL for failure, OK otherwise
2452 */
2453 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002454do_ecmd(
2455 int fnum,
2456 char_u *ffname,
2457 char_u *sfname,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002458 exarg_T *eap, // can be NULL!
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002459 linenr_T newlnum,
2460 int flags,
2461 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002463 int other_file; // TRUE if editing another file
2464 int oldbuf; // TRUE if using existing buffer
2465 int auto_buf = FALSE; // TRUE if autocommands brought us
2466 // into the buffer unexpectedly
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002468#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002469 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470#endif
2471 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002472 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002473 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 char_u *free_fname = NULL;
2475#ifdef FEAT_BROWSE
2476 char_u *browse_file = NULL;
2477#endif
2478 int retval = FAIL;
2479 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01002480 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 linenr_T topline = 0;
2482 int newcol = -1;
2483 int solcol = -1;
2484 pos_T *pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002486#ifdef FEAT_SPELL
2487 int did_get_winopts = FALSE;
2488#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002489 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002490 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar375e3392019-01-31 18:26:10 +01002491 long *so_ptr = curwin->w_p_so >= 0 ? &curwin->w_p_so : &p_so;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492
2493 if (eap != NULL)
2494 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002495 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496
2497 if (fnum != 0)
2498 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002499 if (fnum == curbuf->b_fnum) // file is already being edited
2500 return OK; // nothing to do
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 other_file = TRUE;
2502 }
2503 else
2504 {
2505#ifdef FEAT_BROWSE
Bram Moolenaar2eed9ba2019-06-25 23:40:29 +02002506 if (cmdmod.browse && !exiting)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002508 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002509# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002510 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002511# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002512 au_has_group((char_u *)"FileExplorer"))
2513 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002514 // No browsing supported but we do have the file explorer:
2515 // Edit the directory.
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002516 if (ffname == NULL || !mch_isdir(ffname))
2517 ffname = (char_u *)".";
2518 }
2519 else
2520 {
2521 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00002523 if (browse_file == NULL)
2524 goto theend;
2525 ffname = browse_file;
2526 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 }
2528#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002529 // if no short name given, use ffname for short name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 if (sfname == NULL)
2531 sfname = ffname;
2532#ifdef USE_FNAME_CASE
Bram Moolenaar00f148d2019-02-12 22:37:27 +01002533 if (sfname != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002534 fname_case(sfname, 0); // set correct case for sfname
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535#endif
2536
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
2538 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539
2540 if (ffname == NULL)
2541 other_file = TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002542 // there is no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 else if (*ffname == NUL && curbuf->b_ffname == NULL)
2544 other_file = FALSE;
2545 else
2546 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002547 if (*ffname == NUL) // re-edit with same file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 {
2549 ffname = curbuf->b_ffname;
2550 sfname = curbuf->b_fname;
2551 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002552 free_fname = fix_fname(ffname); // may expand to full path name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 if (free_fname != NULL)
2554 ffname = free_fname;
2555 other_file = otherfile(ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 }
2557 }
2558
2559 /*
2560 * if the file was changed we may not be allowed to abandon it
2561 * - if we are going to re-edit the same file
2562 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
2563 */
2564 if ( ((!other_file && !(flags & ECMD_OLDBUF))
2565 || (curbuf->b_nwindows == 1
2566 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002567 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
2568 | (other_file ? 0 : CCGD_MULTWIN)
2569 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
2570 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 {
2572 if (fnum == 0 && other_file && ffname != NULL)
2573 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
2574 goto theend;
2575 }
2576
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 /*
2578 * End Visual mode before switching to another buffer, so the text can be
2579 * copied into the GUI selection buffer.
2580 */
2581 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002583#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002584 if ((command != NULL || newlnum > (linenr_T)0)
2585 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
2586 {
2587 int len;
2588 char_u *p;
2589
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002590 // Set v:swapcommand for the SwapExists autocommands.
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002591 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00002592 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002593 else
2594 len = 30;
Bram Moolenaar964b3742019-05-24 18:54:09 +02002595 p = alloc(len);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002596 if (p != NULL)
2597 {
2598 if (command != NULL)
2599 vim_snprintf((char *)p, len, ":%s\r", command);
2600 else
2601 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
2602 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
2603 did_set_swapcommand = TRUE;
2604 vim_free(p);
2605 }
2606 }
2607#endif
2608
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 /*
2610 * If we are starting to edit another file, open a (new) buffer.
2611 * Otherwise we re-use the current buffer.
2612 */
2613 if (other_file)
2614 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 if (!(flags & ECMD_ADDBUF))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002617 if (!cmdmod.keepalt)
2618 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002619 if (oldwin != NULL)
2620 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 }
2622
2623 if (fnum)
2624 buf = buflist_findnr(fnum);
2625 else
2626 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 if (flags & ECMD_ADDBUF)
2628 {
2629 linenr_T tlnum = 1L;
2630
2631 if (command != NULL)
2632 {
2633 tlnum = atol((char *)command);
2634 if (tlnum <= 0)
2635 tlnum = 1L;
2636 }
2637 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
2638 goto theend;
2639 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 buf = buflist_new(ffname, sfname, 0L,
2641 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002642
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002643 // autocommands may change curwin and curbuf
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02002644 if (oldwin != NULL)
2645 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002646 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 }
2648 if (buf == NULL)
2649 goto theend;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002650 if (buf->b_ml.ml_mfp == NULL) // no memfile yet
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 {
2652 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002654 else // existing memfile
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 {
2656 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002657 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002659 // Check if autocommands made the buffer invalid or changed the
2660 // current buffer.
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002661 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 goto theend;
2663#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002664 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 goto theend;
2666#endif
2667 }
2668
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002669 // May jump to last used line number for a loaded buffer or when asked
2670 // for explicitly
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
2672 {
2673 pos = buflist_findfpos(buf);
2674 newlnum = pos->lnum;
2675 solcol = pos->col;
2676 }
2677
2678 /*
2679 * Make the (new) buffer the one used by the current window.
2680 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
2681 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01002682 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 */
2684 if (buf != curbuf)
2685 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 /*
2687 * Be careful: The autocommands may delete any buffer and change
2688 * the current buffer.
2689 * - If the buffer we are going to edit is deleted, give up.
2690 * - If the current buffer is deleted, prefer to load the new
2691 * buffer when loading a buffer is required. This avoids
2692 * loading another buffer which then must be closed again.
2693 * - If we ended up in the new buffer already, need to skip a few
2694 * things, set auto_buf.
2695 */
2696 if (buf->b_fname != NULL)
2697 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002698 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002700 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002702 // new buffer has been deleted
2703 delbuf_msg(new_name); // frees new_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 goto theend;
2705 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002706#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002707 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 {
2709 vim_free(new_name);
2710 goto theend;
2711 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002712#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002713 if (buf == curbuf) // already in new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 auto_buf = TRUE;
2715 else
2716 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02002717 win_T *the_curwin = curwin;
2718
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002719 // Set the w_closing flag to avoid that autocommands close the
2720 // window. And set b_locked for the same reason.
Bram Moolenaar5a497892016-09-03 16:29:04 +02002721 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002722 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02002723
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002724 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 buf_copy_options(buf, BCO_ENTER);
2726
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002727 // Close the link to the current buffer. This will set
2728 // oldwin->w_buffer to NULL.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002729 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002730 close_buffer(oldwin, curbuf,
Bram Moolenaara6e8f882019-12-14 16:18:15 +01002731 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732
Bram Moolenaar5a497892016-09-03 16:29:04 +02002733 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02002734 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01002735
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002736#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002737 // autocmds may abort script processing
Bram Moolenaar5a497892016-09-03 16:29:04 +02002738 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 {
2740 vim_free(new_name);
2741 goto theend;
2742 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002743#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002744 // Be careful again, like above.
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002745 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002747 // new buffer has been deleted
2748 delbuf_msg(new_name); // frees new_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 goto theend;
2750 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002751 if (buf == curbuf) // already in new buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 auto_buf = TRUE;
2753 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02002755#ifdef FEAT_SYN_HL
2756 /*
2757 * <VN> We could instead free the synblock
2758 * and re-attach to buffer, perhaps.
2759 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02002760 if (curwin->w_buffer == NULL
2761 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02002762 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02002763#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 curwin->w_buffer = buf;
2765 curbuf = buf;
2766 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02002767
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002768 // Set 'fileformat', 'binary' and 'fenc' when forced.
Bram Moolenaarad875fb2013-07-24 15:02:03 +02002769 if (!oldbuf && eap != NULL)
2770 {
2771 set_file_options(TRUE, eap);
2772 set_forced_fenc(eap);
2773 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 }
2775
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002776 // May get the window options from the last time this buffer
2777 // was in this window (or another window). If not used
2778 // before, reset the local window options to the global
2779 // values. Also restores old folding stuff.
Bram Moolenaarb1269f12007-06-19 09:51:25 +00002780 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00002781#ifdef FEAT_SPELL
2782 did_get_winopts = TRUE;
2783#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 }
2785 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002786 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02002787 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
2790 curwin->w_pcmark.lnum = 1;
2791 curwin->w_pcmark.col = 0;
2792 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002793 else // !other_file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 {
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002795 if ((flags & ECMD_ADDBUF) || check_fname() == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01002797
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 oldbuf = (flags & ECMD_OLDBUF);
2799 }
2800
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002801 // Don't redraw until the cursor is in the right line, otherwise
2802 // autocommands may cause ml_get errors.
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01002803 ++RedrawingDisabled;
2804 did_inc_redrawing_disabled = TRUE;
2805
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002806 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 if ((flags & ECMD_SET_HELP) || keep_help_flag)
2808 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01002809 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 }
2811 else
2812 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002813 // Don't make a buffer listed if it's a help buffer. Useful when
2814 // using CTRL-O to go back to a help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 if (!curbuf->b_help)
2816 set_buflisted(TRUE);
2817 }
2818
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002819 // If autocommands change buffers under our fingers, forget about
2820 // editing the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 if (buf != curbuf)
2822 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002823#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002824 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002826#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002828 // Since we are starting to edit a file, consider the filetype to be
2829 // unset. Helps for when an autocommand changes files and expects syntax
2830 // highlighting to work in the other file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832
2833/*
2834 * other_file oldbuf
2835 * FALSE FALSE re-edit same file, buffer is re-used
2836 * FALSE TRUE re-edit same file, nothing changes
2837 * TRUE FALSE start editing new file, new buffer
2838 * TRUE TRUE start editing in existing buffer (nothing to do)
2839 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002840 if (!other_file && !oldbuf) // re-use the buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002842 set_last_cursor(curwin); // may set b_last_cursor
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
2844 {
2845 newlnum = curwin->w_cursor.lnum;
2846 solcol = curwin->w_cursor.col;
2847 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 buf = curbuf;
2849 if (buf->b_fname != NULL)
2850 new_name = vim_strsave(buf->b_fname);
2851 else
2852 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002853 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002854
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002855 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
2856 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002857 // Save all the text, so that the reload can be undone.
2858 // Sync first so that this is a separate undo-able action.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002859 u_sync(FALSE);
2860 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
2861 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02002862 {
2863 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002864 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02002865 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002866 u_unchanged(curbuf);
2867 buf_freeall(curbuf, BFA_KEEP_UNDO);
2868
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002869 // tell readfile() not to clear or reload undo info
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002870 readfile_flags = READ_KEEP_UNDO;
2871 }
2872 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002873 buf_freeall(curbuf, 0); // free all things for buffer
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002874
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002875 // If autocommands deleted the buffer we were going to re-edit, give
2876 // up and jump to the end.
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02002877 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002879 delbuf_msg(new_name); // frees new_name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 goto theend;
2881 }
2882 vim_free(new_name);
2883
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002884 // If autocommands change buffers under our fingers, forget about
2885 // re-editing the file. Should do the buf_clear_file(), but perhaps
2886 // the autocommands changed the buffer...
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 if (buf != curbuf)
2888 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002889#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002890 if (aborting()) // autocmds may abort script processing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892#endif
2893 buf_clear_file(curbuf);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002894 curbuf->b_op_start.lnum = 0; // clear '[ and '] marks
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 curbuf->b_op_end.lnum = 0;
2896 }
2897
2898/*
2899 * If we get here we are sure to start editing
2900 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002901 // Assume success now
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 retval = OK;
2903
2904 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 * Check if we are editing the w_arg_idx file in the argument list.
2906 */
2907 check_arg_idx(curwin);
2908
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 {
2911 /*
2912 * Set cursor and init window before reading the file and executing
2913 * autocommands. This allows for the autocommands to position the
2914 * cursor.
2915 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00002916 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
2918#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002919 // It's possible that all lines in the buffer changed. Need to update
2920 // automatic folding for all windows where it's used.
Bram Moolenaareb1b6792007-08-21 13:29:28 +00002921 {
2922 win_T *win;
2923 tabpage_T *tp;
2924
2925 FOR_ALL_TAB_WINDOWS(tp, win)
2926 if (win->w_buffer == curbuf)
2927 foldUpdateAll(win);
2928 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929#endif
2930
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002931 // Change directories when the 'acd' option is set.
Bram Moolenaar6f470022018-04-10 18:47:20 +02002932 DO_AUTOCHDIR;
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002933
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 /*
2935 * Careful: open_buffer() and apply_autocmds() may change the current
2936 * buffer and window.
2937 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01002938 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 topline = curwin->w_topline;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002940 if (!oldbuf) // need to read the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 {
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002942#ifdef FEAT_PROP_POPUP
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002943 // Don't use the swap-exists dialog for a popup window, can't edit
2944 // the buffer.
2945 if (WIN_IS_POPUP(curwin))
2946 curbuf->b_flags |= BF_NO_SEA;
2947#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 swap_exists_action = SEA_DIALOG;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002949 curbuf->b_flags |= BF_CHECK_RO; // set/reset 'ro' flag
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950
2951 /*
2952 * Open the buffer and read the file.
2953 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002954#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002955 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 retval = FAIL;
2957#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02002958 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959#endif
2960
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01002961#ifdef FEAT_PROP_POPUP
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02002962 curbuf->b_flags &= ~BF_NO_SEA;
2963#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 if (swap_exists_action == SEA_QUIT)
2965 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002966 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 else
2969 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002970 // Read the modelines, but only to set window-local options. Any
2971 // buffer-local options have already been set and may have been
2972 // changed by the user.
Bram Moolenaara3227e22006-03-08 21:32:40 +00002973 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00002974
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
2976 &retval);
2977 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
2978 &retval);
2979 }
2980 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002982 // If autocommands change the cursor position or topline, we should
2983 // keep it. Also when it moves within a line. But not when it moves
2984 // to the first non-blank.
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01002985 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 {
Bram Moolenaaradb8fbe2018-06-04 20:34:23 +02002987 char_u *text = ml_get_curline();
2988
2989 if (curwin->w_cursor.lnum != orig_pos.lnum
2990 || curwin->w_cursor.col != (int)(skipwhite(text) - text))
2991 {
2992 newlnum = curwin->w_cursor.lnum;
2993 newcol = curwin->w_cursor.col;
2994 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 }
2996 if (curwin->w_topline == topline)
2997 topline = 0;
2998
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002999 // Even when cursor didn't move we need to recompute topline.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 changed_line_abv_curs();
3001
3002#ifdef FEAT_TITLE
3003 maketitle();
3004#endif
Bram Moolenaar5a4c3082019-12-01 15:23:11 +01003005#if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
Bram Moolenaar2debf1c2019-08-04 20:44:19 +02003006 if (WIN_IS_POPUP(curwin) && curwin->w_p_pvw && retval != FAIL)
Bram Moolenaar90f3e7a2019-08-01 22:40:44 +02003007 popup_set_title(curwin);
3008#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 }
3010
3011#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003012 // Tell the diff stuff that this buffer is new and/or needs updating.
3013 // Also needed when re-editing the same buffer, because unloading will
3014 // have removed it as a diff buffer.
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003015 if (curwin->w_p_diff)
3016 {
3017 diff_buf_add(curbuf);
3018 diff_invalidate(curbuf);
3019 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020#endif
3021
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003022#ifdef FEAT_SPELL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003023 // If the window options were changed may need to set the spell language.
3024 // Can only do this after the buffer has been properly setup.
Bram Moolenaar860cae12010-06-05 23:22:07 +02003025 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3026 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003027#endif
3028
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 if (command == NULL)
3030 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003031 if (newcol >= 0) // position set by autocommands
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 {
3033 curwin->w_cursor.lnum = newlnum;
3034 curwin->w_cursor.col = newcol;
3035 check_cursor();
3036 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003037 else if (newlnum > 0) // line number from caller or old position
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 {
3039 curwin->w_cursor.lnum = newlnum;
3040 check_cursor_lnum();
3041 if (solcol >= 0 && !p_sol)
3042 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003043 // 'sol' is off: Use last known column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 curwin->w_cursor.col = solcol;
3045 check_cursor_col();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 curwin->w_cursor.coladd = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 curwin->w_set_curswant = TRUE;
3048 }
3049 else
3050 beginline(BL_SOL | BL_FIX);
3051 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003052 else // no line number, go to last line in Ex mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 {
3054 if (exmode_active)
3055 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3056 beginline(BL_WHITE | BL_FIX);
3057 }
3058 }
3059
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003060 // Check if cursors in other windows on the same buffer are still valid
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062
3063 /*
3064 * Did not read the file, need to show some info about the file.
3065 * Do this after setting the cursor.
3066 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003067 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 {
3069 int msg_scroll_save = msg_scroll;
3070
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003071 // Obey the 'O' flag in 'cpoptions': overwrite any previous file
3072 // message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3074 msg_scroll = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003075 if (!msg_scroll) // wait a bit when overwriting an error msg
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 check_for_delay(FALSE);
3077 msg_start();
3078 msg_scroll = msg_scroll_save;
3079 msg_scrolled_ign = TRUE;
3080
Bram Moolenaar426dd022016-03-15 15:09:29 +01003081 if (!shortmess(SHM_FILEINFO))
3082 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083
3084 msg_scrolled_ign = FALSE;
3085 }
3086
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02003087#ifdef FEAT_VIMINFO
3088 curbuf->b_last_used = vim_time();
3089#endif
3090
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 if (command != NULL)
3092 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3093
3094#ifdef FEAT_KEYMAP
3095 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003096 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097#endif
3098
3099 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003100 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 if (!skip_redraw)
3102 {
Bram Moolenaar375e3392019-01-31 18:26:10 +01003103 n = *so_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 if (topline == 0 && command == NULL)
Bram Moolenaar375e3392019-01-31 18:26:10 +01003105 *so_ptr = 9999; // force cursor halfway the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 update_topline();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 curwin->w_scbind_pos = curwin->w_topline;
Bram Moolenaar375e3392019-01-31 18:26:10 +01003108 *so_ptr = n;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003109 redraw_curbuf_later(NOT_VALID); // redraw this buffer later
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 }
3111
3112 if (p_im)
3113 need_start_insertmode = TRUE;
3114
Bram Moolenaar15833232018-02-03 18:33:17 +01003115#ifdef FEAT_AUTOCHDIR
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003116 // Change directories when the 'acd' option is set and we aren't already in
3117 // that directory (should already be done above). Expect getcwd() to be
3118 // faster than calling shorten_fnames() unnecessarily.
Bram Moolenaar15833232018-02-03 18:33:17 +01003119 if (p_acd && curbuf->b_ffname != NULL)
3120 {
3121 char_u curdir[MAXPATHL];
3122 char_u filedir[MAXPATHL];
3123
3124 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
3125 *gettail_sep(filedir) = NUL;
3126 if (mch_dirname(curdir, MAXPATHL) != FAIL
3127 && vim_fnamecmp(curdir, filedir) != 0)
3128 do_autochdir();
3129 }
3130#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131
Bram Moolenaarbb1969b2019-01-17 15:45:25 +01003132#if defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003133 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003136 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003137 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138# endif
3139 }
3140#endif
3141
3142theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003143 if (did_inc_redrawing_disabled)
3144 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003145#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003146 if (did_set_swapcommand)
3147 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3148#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149#ifdef FEAT_BROWSE
3150 vim_free(browse_file);
3151#endif
3152 vim_free(free_fname);
3153 return retval;
3154}
3155
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003157delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003159 semsg(_("E143: Autocommands unexpectedly deleted new buffer %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 name == NULL ? (char_u *)"" : name);
3161 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003162 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02003163 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003166static int append_indent = 0; // autoindent for first line
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003167
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168/*
3169 * ":insert" and ":append", also used by ":change"
3170 */
3171 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003172ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173{
3174 char_u *theline;
3175 int did_undo = FALSE;
3176 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003177 int indent = 0;
3178 char_u *p;
3179 int vcol;
3180 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003182 // the ! flag toggles autoindent
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003183 if (eap->forceit)
3184 curbuf->b_p_ai = !curbuf->b_p_ai;
3185
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003186 // First autoindent comes from the line we start on
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003187 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3188 append_indent = get_indent_lnum(lnum);
3189
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 if (eap->cmdidx != CMD_append)
3191 --lnum;
3192
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003193 // when the buffer is empty need to delete the dummy line
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003194 if (empty && lnum == 1)
3195 lnum = 0;
3196
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003197 State = INSERT; // behave like in Insert mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3199 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003200
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003201 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 {
3203 msg_scroll = TRUE;
3204 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003205 if (curbuf->b_p_ai)
3206 {
3207 if (append_indent >= 0)
3208 {
3209 indent = append_indent;
3210 append_indent = -1;
3211 }
3212 else if (lnum > 0)
3213 indent = get_indent_lnum(lnum);
3214 }
3215 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003217 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003218 // No getline() function, use the lines that follow. This ends
3219 // when there is no more.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003220 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3221 break;
3222 p = vim_strchr(eap->nextcmd, NL);
3223 if (p == NULL)
3224 p = eap->nextcmd + STRLEN(eap->nextcmd);
3225 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3226 if (*p != NUL)
3227 ++p;
3228 eap->nextcmd = p;
3229 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003231 {
3232 int save_State = State;
3233
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003234 // Set State to avoid the cursor shape to be set to INSERT mode
3235 // when getline() returns.
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003236 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 theline = eap->getline(
3238#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003239 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240#endif
Bram Moolenaare96a2492019-06-25 04:12:16 +02003241 NUL, eap->cookie, indent, TRUE);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02003242 State = save_State;
3243 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003245 if (theline == NULL)
3246 break;
3247
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003248 // Using ^ CTRL-D in getexmodeline() makes us repeat the indent.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003249 if (ex_keep_indent)
3250 append_indent = indent;
3251
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003252 // Look for the "." after automatic indent.
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003253 vcol = 0;
3254 for (p = theline; indent > vcol; ++p)
3255 {
3256 if (*p == ' ')
3257 ++vcol;
3258 else if (*p == TAB)
3259 vcol += 8 - vcol % 8;
3260 else
3261 break;
3262 }
3263 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003264 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3265 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 {
3267 vim_free(theline);
3268 break;
3269 }
3270
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003271 // don't use autoindent if nothing was typed.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003272 if (p[0] == NUL)
3273 theline[0] = NUL;
3274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 did_undo = TRUE;
3276 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02003277 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278
3279 vim_free(theline);
3280 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003281
3282 if (empty)
3283 {
3284 ml_delete(2L, FALSE);
3285 empty = FALSE;
3286 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 }
3288 State = NORMAL;
3289
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003290 if (eap->forceit)
3291 curbuf->b_p_ai = !curbuf->b_p_ai;
3292
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003293 // "start" is set to eap->line2+1 unless that position is invalid (when
3294 // eap->line2 pointed to the end of the buffer and nothing was appended)
3295 // "end" is set to lnum when something has been appended, otherwise
3296 // it is the same than "start" -- Acevedo
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01003297 if (!cmdmod.lockmarks)
3298 {
3299 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3300 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3301 if (eap->cmdidx != CMD_append)
3302 --curbuf->b_op_start.lnum;
3303 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3304 ? lnum : curbuf->b_op_start.lnum;
3305 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3306 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 curwin->w_cursor.lnum = lnum;
3308 check_cursor_lnum();
3309 beginline(BL_SOL | BL_FIX);
3310
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003311 need_wait_return = FALSE; // don't use wait_return() now
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 ex_no_reprint = TRUE;
3313}
3314
3315/*
3316 * ":change"
3317 */
3318 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003319ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320{
3321 linenr_T lnum;
3322
3323 if (eap->line2 >= eap->line1
3324 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3325 return;
3326
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003327 // the ! flag toggles autoindent
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003328 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3329 append_indent = get_indent_lnum(eap->line1);
3330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3332 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003333 if (curbuf->b_ml.ml_flags & ML_EMPTY) // nothing to delete
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 break;
3335 ml_delete(eap->line1, FALSE);
3336 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00003337
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003338 // make sure the cursor is not beyond the end of the file now
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00003339 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3341
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003342 // ":append" on the line above the deleted lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 eap->line2 = eap->line1;
3344 ex_append(eap);
3345}
3346
3347 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003348ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349{
3350 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003351 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003352 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 int minus = 0;
3354 linenr_T start, end, curs, i;
3355 int j;
3356 linenr_T lnum = eap->line2;
3357
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003358 // Vi compatible: ":z!" uses display height, without a count uses
3359 // 'scroll'
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003360 if (eap->forceit)
3361 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01003362 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003363 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01003364 else
3365 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 if (bigness < 1)
3367 bigness = 1;
3368
3369 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003370 kind = x;
3371 if (*kind == '-' || *kind == '+' || *kind == '='
3372 || *kind == '^' || *kind == '.')
3373 ++x;
3374 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 ++x;
3376
3377 if (*x != 0)
3378 {
3379 if (!VIM_ISDIGIT(*x))
3380 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003381 emsg(_("E144: non-numeric argument to :z"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 return;
3383 }
3384 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003385 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003386 bigness = atol((char *)x);
3387
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003388 // bigness could be < 0 if atol(x) overflows.
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02003389 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
3390 bigness = 2 * curbuf->b_ml.ml_line_count;
3391
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003392 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003393 if (*kind == '=')
3394 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 }
3397
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003398 // the number of '-' and '+' multiplies the distance
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003399 if (*kind == '-' || *kind == '+')
3400 for (x = kind + 1; *x == *kind; ++x)
3401 ;
3402
3403 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 {
3405 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02003406 start = lnum - bigness * (linenr_T)(x - kind) + 1;
3407 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003408 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 break;
3410
3411 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003412 start = lnum - (bigness + 1) / 2 + 1;
3413 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 curs = lnum;
3415 minus = 1;
3416 break;
3417
3418 case '^':
3419 start = lnum - bigness * 2;
3420 end = lnum - bigness;
3421 curs = lnum - bigness;
3422 break;
3423
3424 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00003425 start = lnum - (bigness + 1) / 2 + 1;
3426 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 curs = end;
3428 break;
3429
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003430 default: // '+'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003432 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003433 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003434 else if (eap->addr_count == 0)
3435 ++start;
3436 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 curs = end;
3438 break;
3439 }
3440
3441 if (start < 1)
3442 start = 1;
3443
3444 if (end > curbuf->b_ml.ml_line_count)
3445 end = curbuf->b_ml.ml_line_count;
3446
3447 if (curs > curbuf->b_ml.ml_line_count)
3448 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003449 else if (curs < 1)
3450 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451
3452 for (i = start; i <= end; i++)
3453 {
3454 if (minus && i == lnum)
3455 {
3456 msg_putchar('\n');
3457
3458 for (j = 1; j < Columns; j++)
3459 msg_putchar('-');
3460 }
3461
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003462 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463
3464 if (minus && i == lnum)
3465 {
3466 msg_putchar('\n');
3467
3468 for (j = 1; j < Columns; j++)
3469 msg_putchar('-');
3470 }
3471 }
3472
Bram Moolenaara364cdb2017-04-20 21:12:30 +02003473 if (curwin->w_cursor.lnum != curs)
3474 {
3475 curwin->w_cursor.lnum = curs;
3476 curwin->w_cursor.col = 0;
3477 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 ex_no_reprint = TRUE;
3479}
3480
3481/*
3482 * Check if the restricted flag is set.
3483 * If so, give an error message and return TRUE.
3484 * Otherwise, return FALSE.
3485 */
3486 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003487check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488{
3489 if (restricted)
3490 {
Bram Moolenaar8c62a082019-02-08 14:34:10 +01003491 emsg(_("E145: Shell commands and some functionality not allowed in rvim"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 return TRUE;
3493 }
3494 return FALSE;
3495}
3496
3497/*
3498 * Check if the secure flag is set (.exrc or .vimrc in current directory).
3499 * If so, give an error message and return TRUE.
3500 * Otherwise, return FALSE.
3501 */
3502 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003503check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504{
3505 if (secure)
3506 {
3507 secure = 2;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003508 emsg(_(e_curdir));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 return TRUE;
3510 }
3511#ifdef HAVE_SANDBOX
3512 /*
3513 * In the sandbox more things are not allowed, including the things
3514 * disallowed in secure mode.
3515 */
3516 if (sandbox != 0)
3517 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003518 emsg(_(e_sandbox));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 return TRUE;
3520 }
3521#endif
3522 return FALSE;
3523}
3524
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003525static char_u *old_sub = NULL; // previous substitute pattern
3526static int global_need_beginline; // call beginline() after ":g"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003528/*
3529 * Flags that are kept between calls to :substitute.
3530 */
3531typedef struct {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003532 int do_all; // do multiple substitutions per line
3533 int do_ask; // ask for confirmation
3534 int do_count; // count only
3535 int do_error; // if false, ignore errors
3536 int do_print; // print last line with subs.
3537 int do_list; // list last line with subs.
3538 int do_number; // list last line with line nr
3539 int do_ic; // ignore case flag
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003540} subflags_T;
3541
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003542/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 * Perform a substitution from line eap->line1 to line eap->line2 using the
3544 * command pointed to by eap->arg which should be of the form:
3545 *
3546 * /pattern/substitution/{flags}
3547 *
3548 * The usual escapes are supported as described in the regexp docs.
3549 */
3550 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003551do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552{
3553 linenr_T lnum;
3554 long i = 0;
3555 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003556 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
3557 FALSE, FALSE, 0};
3558#ifdef FEAT_EVAL
3559 subflags_T subflags_save;
3560#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003561 int save_do_all; // remember user specified 'g' flag
3562 int save_do_ask; // remember user specified 'c' flag
3563 char_u *pat = NULL, *sub = NULL; // init for GCC
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 int delimiter;
3565 int sublen;
3566 int got_quit = FALSE;
3567 int got_match = FALSE;
3568 int temp;
3569 int which_pat;
3570 char_u *cmd;
3571 int save_State;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003572 linenr_T first_line = 0; // first changed line
3573 linenr_T last_line= 0; // below last changed line AFTER the
3574 // change
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
3576 linenr_T line2;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003577 long nmatch; // number of lines in match
3578 char_u *sub_firstline; // allocated copy of first sub line
3579 int endcolumn = FALSE; // cursor in last column when done
Bram Moolenaar05159a02005-02-26 23:04:13 +00003580 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01003581 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003582#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02003583 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02003584#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585
3586 cmd = eap->arg;
3587 if (!global_busy)
3588 {
3589 sub_nsubs = 0;
3590 sub_nlines = 0;
3591 }
Bram Moolenaar46475522010-03-23 17:36:29 +01003592 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 if (eap->cmdidx == CMD_tilde)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003595 which_pat = RE_LAST; // use last used regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003597 which_pat = RE_SUBST; // use last substitute regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003599 // new pattern and substitution
Bram Moolenaar1c465442017-03-12 20:10:05 +01003600 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
3602 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003603 // don't accept alphanumeric for separator
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 if (isalpha(*cmd))
3605 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003606 emsg(_("E146: Regular expressions can't be delimited by letters"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 return;
3608 }
3609 /*
3610 * undocumented vi feature:
3611 * "\/sub/" and "\?sub?" use last used search pattern (almost like
3612 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
3613 */
3614 if (*cmd == '\\')
3615 {
3616 ++cmd;
3617 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
3618 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003619 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 return;
3621 }
3622 if (*cmd != '&')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003623 which_pat = RE_SEARCH; // use last '/' pattern
3624 pat = (char_u *)""; // empty search pattern
3625 delimiter = *cmd++; // remember delimiter character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003627 else // find the end of the regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003629 which_pat = RE_LAST; // use last used regexp
3630 delimiter = *cmd++; // remember delimiter character
3631 pat = cmd; // remember start of search pat
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003633 if (cmd[0] == delimiter) // end delimiter found
3634 *cmd++ = NUL; // replace it with a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 }
3636
3637 /*
3638 * Small incompatibility: vi sees '\n' as end of the command, but in
3639 * Vim we want to use '\n' to find/substitute a NUL.
3640 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003641 sub = cmd; // remember the start of the substitution
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642
3643 while (cmd[0])
3644 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003645 if (cmd[0] == delimiter) // end delimiter found
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003647 *cmd++ = NUL; // replace it with a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 break;
3649 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003650 if (cmd[0] == '\\' && cmd[1] != 0) // skip escaped characters
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003652 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 }
3654
3655 if (!eap->skip)
3656 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003657 // In POSIX vi ":s/pat/%/" uses the previous subst. string.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003658 if (STRCMP(sub, "%") == 0
3659 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
3660 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003661 if (old_sub == NULL) // there is no previous command
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003662 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003663 emsg(_(e_nopresub));
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003664 return;
3665 }
3666 sub = old_sub;
3667 }
3668 else
3669 {
3670 vim_free(old_sub);
3671 old_sub = vim_strsave(sub);
3672 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 }
3674 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003675 else if (!eap->skip) // use previous pattern and substitution
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003677 if (old_sub == NULL) // there is no previous command
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003679 emsg(_(e_nopresub));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 return;
3681 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003682 pat = NULL; // search_regcomp() will use previous pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003684
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003685 // Vi compatibility quirk: repeating with ":s" keeps the cursor in the
3686 // last column after using "$".
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00003687 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 }
3689
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003690 // Recognize ":%s/\n//" and turn it into a join command, which is much
3691 // more efficient.
3692 // TODO: find a generic solution to make line-joining operations more
3693 // efficient, avoid allocating a string that grows in size.
Bram Moolenaar21e854e2014-04-04 19:00:48 +02003694 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003695 && *sub == NUL
3696 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
3697 || *cmd == 'p' || *cmd == '#'))))
3698 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003699 linenr_T joined_lines_count;
3700
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003701 curwin->w_cursor.lnum = eap->line1;
3702 if (*cmd == 'l')
3703 eap->flags = EXFLAG_LIST;
3704 else if (*cmd == '#')
3705 eap->flags = EXFLAG_NR;
3706 else if (*cmd == 'p')
3707 eap->flags = EXFLAG_PRINT;
3708
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003709 // The number of lines joined is the number of lines in the range plus
3710 // one. One less when the last line is included.
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003711 joined_lines_count = eap->line2 - eap->line1 + 1;
3712 if (eap->line2 < curbuf->b_ml.ml_line_count)
3713 ++joined_lines_count;
3714 if (joined_lines_count > 1)
3715 {
3716 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
3717 sub_nsubs = joined_lines_count - 1;
3718 sub_nlines = 1;
3719 (void)do_sub_msg(FALSE);
3720 ex_may_print(eap);
3721 }
3722
3723 if (!cmdmod.keeppatterns)
3724 save_re_pat(RE_SUBST, pat, p_magic);
Bram Moolenaard7663c22019-08-06 21:59:57 +02003725 // put pattern in history
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003726 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01003727
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02003728 return;
3729 }
3730
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 /*
3732 * Find trailing options. When '&' is used, keep old options.
3733 */
3734 if (*cmd == '&')
3735 ++cmd;
3736 else
3737 {
3738 if (!p_ed)
3739 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003740 if (p_gd) // default is global on
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003741 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003743 subflags.do_all = FALSE;
3744 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003746 subflags.do_error = TRUE;
3747 subflags.do_print = FALSE;
Bram Moolenaar94747162019-02-10 21:55:26 +01003748 subflags.do_list = FALSE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003749 subflags.do_count = FALSE;
3750 subflags.do_number = FALSE;
3751 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 }
3753 while (*cmd)
3754 {
3755 /*
3756 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
3757 * 'r' is never inverted.
3758 */
3759 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003760 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003762 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003763 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003764 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003766 subflags.do_error = !subflags.do_error;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003767 else if (*cmd == 'r') // use last used regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 which_pat = RE_LAST;
3769 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003770 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003771 else if (*cmd == '#')
3772 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003773 subflags.do_print = TRUE;
3774 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003775 }
3776 else if (*cmd == 'l')
3777 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003778 subflags.do_print = TRUE;
3779 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003780 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003781 else if (*cmd == 'i') // ignore case
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003782 subflags.do_ic = 'i';
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003783 else if (*cmd == 'I') // don't ignore case
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003784 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 else
3786 break;
3787 ++cmd;
3788 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003789 if (subflags.do_count)
3790 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003792 save_do_all = subflags.do_all;
3793 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02003794
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 /*
3796 * check for a trailing count
3797 */
3798 cmd = skipwhite(cmd);
3799 if (VIM_ISDIGIT(*cmd))
3800 {
3801 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003802 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003804 emsg(_(e_zerocount));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 return;
3806 }
3807 eap->line1 = eap->line2;
3808 eap->line2 += i - 1;
3809 if (eap->line2 > curbuf->b_ml.ml_line_count)
3810 eap->line2 = curbuf->b_ml.ml_line_count;
3811 }
3812
3813 /*
3814 * check for trailing command or garbage
3815 */
3816 cmd = skipwhite(cmd);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003817 if (*cmd && *cmd != '"') // if not end-of-line or comment
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 {
3819 eap->nextcmd = check_nextcmd(cmd);
3820 if (eap->nextcmd == NULL)
3821 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003822 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 return;
3824 }
3825 }
3826
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003827 if (eap->skip) // not executing commands, only parsing
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 return;
3829
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003830 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003831 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003832 // Substitution is not allowed in non-'modifiable' buffer
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003833 emsg(_(e_modifiable));
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003834 return;
3835 }
3836
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
3838 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003839 if (subflags.do_error)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003840 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 return;
3842 }
3843
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003844 // the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase'
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003845 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02003847 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 regmatch.rmm_ic = FALSE;
3849
3850 sub_firstline = NULL;
3851
3852 /*
3853 * ~ in the substitute pattern is replaced with the old pattern.
3854 * We do it here once to avoid it to be replaced over and over again.
3855 * But don't do it when it starts with "\=", then it's an expression.
3856 */
3857 if (!(sub[0] == '\\' && sub[1] == '='))
3858 sub = regtilde(sub, p_magic);
3859
3860 /*
3861 * Check for a match on each line.
3862 */
3863 line2 = eap->line2;
3864 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003865#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 || aborting()
3867#endif
3868 ); ++lnum)
3869 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003870 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02003871 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 if (nmatch)
3873 {
3874 colnr_T copycol;
3875 colnr_T matchcol;
3876 colnr_T prev_matchcol = MAXCOL;
3877 char_u *new_end, *new_start = NULL;
3878 unsigned new_start_len = 0;
3879 char_u *p1;
3880 int did_sub = FALSE;
3881 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00003882 int len, copy_len, needed_len;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003883 long nmatch_tl = 0; // nr of lines matched below lnum
3884 int do_again; // do it again after joining lines
Bram Moolenaar8299df92004-07-10 09:47:34 +00003885 int skip_match = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003886 linenr_T sub_firstlnum; // nr of first sub line
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01003887#ifdef FEAT_PROP_POPUP
Bram Moolenaarf3333b02019-05-19 22:53:40 +02003888 int apc_flags = APC_SAVE_FOR_UNDO | APC_SUBSTITUTE;
Bram Moolenaarc7488a72019-10-26 12:23:04 +02003889 colnr_T total_added = 0;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02003890#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891
3892 /*
3893 * The new text is build up step by step, to avoid too much
3894 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00003895 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 * copycol Column in the old text where we started
3897 * looking for a match; from here old text still
3898 * needs to be copied to the new text.
3899 * matchcol Column number of the old text where to look
3900 * for the next match. It's just after the
3901 * previous match or one further.
3902 * prev_matchcol Column just after the previous match (if any).
3903 * Mostly equal to matchcol, except for the first
3904 * match and after skipping an empty match.
3905 * regmatch.*pos Where the pattern matched in the old text.
3906 * new_start The new text, all that has been produced so
3907 * far.
3908 * new_end The new text, where to append new text.
3909 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003910 * lnum The line number where we found the start of
3911 * the match. Can be below the line we searched
3912 * when there is a \n before a \zs in the
3913 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 * sub_firstlnum The line number in the buffer where to look
3915 * for a match. Can be different from "lnum"
3916 * when the pattern or substitute string contains
3917 * line breaks.
3918 *
3919 * Special situations:
3920 * - When the substitute string contains a line break, the part up
3921 * to the line break is inserted in the text, but the copy of
3922 * the original line is kept. "sub_firstlnum" is adjusted for
3923 * the inserted lines.
3924 * - When the matched pattern contains a line break, the old line
3925 * is taken from the line at the end of the pattern. The lines
3926 * in the match are deleted later, "sub_firstlnum" is adjusted
3927 * accordingly.
3928 *
3929 * The new text is built up in new_start[]. It has some extra
3930 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00003931 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 *
3933 * Make a copy of the old line, so it won't be taken away when
3934 * updating the screen or handling a multi-line match. The "old_"
3935 * pointers point into this copy.
3936 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003937 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 copycol = 0;
3939 matchcol = 0;
3940
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003941 // At first match, remember current cursor position.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 if (!got_match)
3943 {
3944 setpcmark();
3945 got_match = TRUE;
3946 }
3947
3948 /*
3949 * Loop until nothing more to replace in this line.
3950 * 1. Handle match with empty string.
3951 * 2. If do_ask is set, ask for confirmation.
3952 * 3. substitute the string.
3953 * 4. if do_all is set, find next match
3954 * 5. break if there isn't another match in this line
3955 */
3956 for (;;)
3957 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003958 // Advance "lnum" to the line where the match starts. The
3959 // match does not start in the first line when there is a line
3960 // break before \zs.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003961 if (regmatch.startpos[0].lnum > 0)
3962 {
3963 lnum += regmatch.startpos[0].lnum;
3964 sub_firstlnum += regmatch.startpos[0].lnum;
3965 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01003966 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003967 }
3968
Bram Moolenaarbb265962019-10-31 04:38:36 +01003969 // Match might be after the last line for "\n\zs" matching at
3970 // the end of the last line.
3971 if (lnum > curbuf->b_ml.ml_line_count)
3972 break;
3973
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00003974 if (sub_firstline == NULL)
3975 {
3976 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
3977 if (sub_firstline == NULL)
3978 {
3979 vim_free(new_start);
3980 goto outofmem;
3981 }
3982 }
3983
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003984 // Save the line number of the last change for the final
3985 // cursor position (just like Vi).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 curwin->w_cursor.lnum = lnum;
3987 do_again = FALSE;
3988
3989 /*
3990 * 1. Match empty string does not count, except for first
3991 * match. This reproduces the strange vi behaviour.
3992 * This also catches endless loops.
3993 */
3994 if (matchcol == prev_matchcol
3995 && regmatch.endpos[0].lnum == 0
3996 && matchcol == regmatch.endpos[0].col)
3997 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00003998 if (sub_firstline[matchcol] == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01003999 // We already were at the end of the line. Don't look
4000 // for a match in this line again.
Bram Moolenaar8299df92004-07-10 09:47:34 +00004001 skip_match = TRUE;
4002 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004003 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004004 // search for a match at next column
Bram Moolenaar0df11022011-05-19 14:30:16 +02004005 if (has_mbyte)
4006 matchcol += mb_ptr2len(sub_firstline + matchcol);
4007 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004008 ++matchcol;
4009 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 goto skip;
4011 }
4012
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004013 // Normally we continue searching for a match just after the
4014 // previous match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 matchcol = regmatch.endpos[0].col;
4016 prev_matchcol = matchcol;
4017
4018 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004019 * 2. If do_count is set only increase the counter.
4020 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004022 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004023 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004024 // For a multi-line match, put matchcol at the NUL at
4025 // the end of the line and set nmatch to one, so that
4026 // we continue looking for a match on the next line.
4027 // Avoids that ":s/\nB\@=//gc" get stuck.
Bram Moolenaar05159a02005-02-26 23:04:13 +00004028 if (nmatch > 1)
4029 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004030 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004031 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004032 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004033 }
4034 sub_nsubs++;
4035 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004036#ifdef FEAT_EVAL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004037 // Skip the substitution, unless an expression is used,
4038 // then it is evaluated in the sandbox.
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004039 if (!(sub[0] == '\\' && sub[1] == '='))
4040#endif
4041 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004042 }
4043
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004044 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004046 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004047
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004048 // change State to CONFIRM, so that the mouse works
4049 // properly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 save_State = State;
4051 State = CONFIRM;
Bram Moolenaarb20b9e12019-09-21 20:48:04 +02004052 setmouse(); // disable mouse in xterm
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01004054 if (curwin->w_p_crb)
4055 do_check_cursorbind();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004057 // When 'cpoptions' contains "u" don't sync undo when
4058 // asking for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4060 ++no_u_sync;
4061
4062 /*
4063 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4064 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004065 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004067 if (exmode_active)
4068 {
4069 char_u *resp;
4070 colnr_T sc, ec;
4071
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004072 print_line_no_prefix(lnum,
4073 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004074
4075 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4076 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01004077 if (curwin->w_cursor.col < 0)
4078 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004079 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004080 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02004081 {
4082 int numw = number_width(curwin) + 1;
4083 sc += numw;
4084 ec += numw;
4085 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004086 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004087 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004088 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004089 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004090 msg_putchar('^');
4091
Bram Moolenaare96a2492019-06-25 04:12:16 +02004092 resp = getexmodeline('?', NULL, 0, TRUE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004093 if (resp != NULL)
4094 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004095 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004096 vim_free(resp);
4097 }
4098 }
4099 else
4100 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004101 char_u *orig_line = NULL;
4102 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004104 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004106 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004108 // Invert the matched string.
4109 // Remove the inversion afterwards.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004110 temp = RedrawingDisabled;
4111 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004113 if (new_start != NULL)
4114 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004115 // There already was a substitution, we would
4116 // like to show this to the user. We cannot
4117 // really update the line, it would change
4118 // what matches. Temporarily replace the line
4119 // and change it back afterwards.
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004120 orig_line = vim_strsave(ml_get(lnum));
4121 if (orig_line != NULL)
4122 {
4123 char_u *new_line = concat_str(new_start,
4124 sub_firstline + copycol);
4125
4126 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01004127 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004128 else
4129 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004130 // Position the cursor relative to the
4131 // end of the line, the previous
4132 // substitute may have inserted or
4133 // deleted characters before the
4134 // cursor.
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004135 len_change = (int)STRLEN(new_line)
4136 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004137 curwin->w_cursor.col += len_change;
4138 ml_replace(lnum, new_line, FALSE);
4139 }
4140 }
4141 }
4142
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004143 search_match_lines = regmatch.endpos[0].lnum
4144 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004145 search_match_endcol = regmatch.endpos[0].col
4146 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004147 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004149 update_topline();
4150 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004151 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004152 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004153 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154
4155#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004156 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004158 if (msg_row == Rows - 1)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004159 msg_didout = FALSE; // avoid a scroll-up
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004160 msg_starthere();
4161 i = msg_scroll;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004162 msg_scroll = 0; // truncate msg when
4163 // needed
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004164 msg_no_more = TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004165 // write message same highlighting as for
4166 // wait_return
Bram Moolenaar8820b482017-03-16 17:23:31 +01004167 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004168 _("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004169 msg_no_more = FALSE;
4170 msg_scroll = i;
4171 showruler(TRUE);
4172 windgoto(msg_row, msg_col);
4173 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174
4175#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004176 dont_scroll = FALSE; // allow scrolling here
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177#endif
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004178 ++no_mapping; // don't map this key
4179 ++allow_keys; // allow special keys
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004180 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004181 --allow_keys;
4182 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004184 // clear the question
4185 msg_didout = FALSE; // don't scroll up
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004186 msg_col = 0;
4187 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004188
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004189 // restore the line
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004190 if (orig_line != NULL)
4191 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004192 }
4193
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004194 need_wait_return = FALSE; // no hit-return prompt
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004195 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004197 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198#endif
4199 )
4200 {
4201 got_quit = TRUE;
4202 break;
4203 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004204 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004206 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004208 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004210 // last: replace and then stop
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004211 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 line2 = lnum;
4213 break;
4214 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004215 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004217 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 break;
4219 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004220 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004222 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 scrolldown_clamp();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224 }
4225 State = save_State;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 setmouse();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4228 --no_u_sync;
4229
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004230 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004232 // For a multi-line match, put matchcol at the NUL at
4233 // the end of the line and set nmatch to one, so that
4234 // we continue looking for a match on the next line.
4235 // Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4236 // get stuck when pressing 'n'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 if (nmatch > 1)
4238 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004239 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004240 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 }
4242 goto skip;
4243 }
4244 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004245 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 }
4247
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004248 // Move the cursor to the start of the match, so that we can
4249 // use "\=col(".").
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 curwin->w_cursor.col = regmatch.startpos[0].col;
4251
4252 /*
4253 * 3. substitute the string.
4254 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004255#ifdef FEAT_EVAL
Bram Moolenaar80341bc2019-05-20 20:34:51 +02004256 save_ma = curbuf->b_p_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004257 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004258 {
Bram Moolenaar6349e942019-05-18 13:41:22 +02004259 // prevent accidentally changing the buffer by a function
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004260 curbuf->b_p_ma = FALSE;
4261 sandbox++;
4262 }
Bram Moolenaar6349e942019-05-18 13:41:22 +02004263 // Save flags for recursion. They can change for e.g.
4264 // :s/^/\=execute("s#^##gn")
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004265 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004266#endif
Bram Moolenaar6349e942019-05-18 13:41:22 +02004267 // get length of substitution part
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004268 sublen = vim_regsub_multi(&regmatch,
4269 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004271#ifdef FEAT_EVAL
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004272 // If getting the substitute string caused an error, don't do
4273 // the replacement.
Bram Moolenaar0e97b942019-03-27 22:53:53 +01004274 // Don't keep flags set by a recursive call.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004275 subflags = subflags_save;
Bram Moolenaar6349e942019-05-18 13:41:22 +02004276 if (aborting() || subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004277 {
4278 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004279 if (sandbox > 0)
4280 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004281 goto skip;
4282 }
4283#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004285 // When the match included the "$" of the last line it may
4286 // go beyond the last line of the buffer.
Bram Moolenaar4463f292005-09-25 22:20:24 +00004287 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4288 {
4289 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4290 skip_match = TRUE;
4291 }
4292
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004293 // Need room for:
4294 // - result so far in new_start (not for first sub in line)
4295 // - original text up to match
4296 // - length of substituted part
4297 // - original text after match
4298 // Adjust text properties here, since we have all information
4299 // needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 if (nmatch == 1)
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004301 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 p1 = sub_firstline;
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004303#ifdef FEAT_PROP_POPUP
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004304 if (curbuf->b_has_textprop)
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004305 {
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004306 int bytes_added = sublen - 1 - (regmatch.endpos[0].col
4307 - regmatch.startpos[0].col);
4308
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004309 // When text properties are changed, need to save for
4310 // undo first, unless done already.
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004311 if (adjust_prop_columns(lnum,
4312 total_added + regmatch.startpos[0].col,
4313 bytes_added, apc_flags))
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004314 apc_flags &= ~APC_SAVE_FOR_UNDO;
Bram Moolenaar1fd30d72019-10-25 22:13:29 +02004315 // Offset for column byte number of the text property
4316 // in the resulting buffer afterwards.
4317 total_added += bytes_added;
Bram Moolenaar338dfda2019-05-19 15:19:57 +02004318 }
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004319#endif
4320 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 else
4322 {
4323 p1 = ml_get(sub_firstlnum + nmatch - 1);
4324 nmatch_tl += nmatch - 1;
4325 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004326 copy_len = regmatch.startpos[0].col - copycol;
4327 needed_len = copy_len + ((unsigned)STRLEN(p1)
4328 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 if (new_start == NULL)
4330 {
4331 /*
4332 * Get some space for a temporary buffer to do the
4333 * substitution into (and some extra space to avoid
4334 * too many calls to alloc()/free()).
4335 */
4336 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004337 if ((new_start = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 goto outofmem;
4339 *new_start = NUL;
4340 new_end = new_start;
4341 }
4342 else
4343 {
4344 /*
4345 * Check if the temporary buffer is long enough to do the
4346 * substitution into. If not, make it larger (with a bit
4347 * extra to avoid too many calls to alloc()/free()).
4348 */
4349 len = (unsigned)STRLEN(new_start);
4350 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004351 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 {
4353 new_start_len = needed_len + 50;
Bram Moolenaar964b3742019-05-24 18:54:09 +02004354 if ((p1 = alloc(new_start_len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 {
4356 vim_free(new_start);
4357 goto outofmem;
4358 }
4359 mch_memmove(p1, new_start, (size_t)(len + 1));
4360 vim_free(new_start);
4361 new_start = p1;
4362 }
4363 new_end = new_start + len;
4364 }
4365
4366 /*
4367 * copy the text up to the part that matched
4368 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004369 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4370 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004372 (void)vim_regsub_multi(&regmatch,
4373 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 sub, new_end, TRUE, p_magic, TRUE);
4375 sub_nsubs++;
4376 did_sub = TRUE;
4377
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004378 // Move the cursor to the start of the line, to avoid that it
4379 // is beyond the end of the line after the substitution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 curwin->w_cursor.col = 0;
4381
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004382 // For a multi-line match, make a copy of the last matched
4383 // line and continue in that one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 if (nmatch > 1)
4385 {
4386 sub_firstlnum += nmatch - 1;
4387 vim_free(sub_firstline);
4388 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004389 // When going beyond the last line, stop substituting.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 if (sub_firstlnum <= line2)
4391 do_again = TRUE;
4392 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004393 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 }
4395
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004396 // Remember next character to be copied.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 copycol = regmatch.endpos[0].col;
4398
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004399 if (skip_match)
4400 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004401 // Already hit end of the buffer, sub_firstlnum is one
4402 // less than what it ought to be.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004403 vim_free(sub_firstline);
4404 sub_firstline = vim_strsave((char_u *)"");
4405 copycol = 0;
4406 }
4407
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 /*
4409 * Now the trick is to replace CTRL-M chars with a real line
4410 * break. This would make it impossible to insert a CTRL-M in
4411 * the text. The line break can be avoided by preceding the
4412 * CTRL-M with a backslash. To be able to insert a backslash,
4413 * they must be doubled in the string and are halved here.
4414 * That is Vi compatible.
4415 */
4416 for (p1 = new_end; *p1; ++p1)
4417 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004418 if (p1[0] == '\\' && p1[1] != NUL) // remove backslash
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004419 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004420 STRMOVE(p1, p1 + 1);
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004421#ifdef FEAT_PROP_POPUP
Bram Moolenaarf3333b02019-05-19 22:53:40 +02004422 if (curbuf->b_has_textprop)
4423 {
4424 // When text properties are changed, need to save
4425 // for undo first, unless done already.
4426 if (adjust_prop_columns(lnum,
4427 (colnr_T)(p1 - new_start), -1,
4428 apc_flags))
4429 apc_flags &= ~APC_SAVE_FOR_UNDO;
4430 }
4431#endif
4432 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 else if (*p1 == CAR)
4434 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004435 if (u_inssub(lnum) == OK) // prepare for undo
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 {
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004437 colnr_T plen = (colnr_T)(p1 - new_start + 1);
4438
4439 *p1 = NUL; // truncate up to the CR
4440 ml_append(lnum - 1, new_start, plen, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004442 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 appended_lines(lnum - 1, 1L);
4444 else
4445 {
4446 if (first_line == 0)
4447 first_line = lnum;
4448 last_line = lnum + 1;
4449 }
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004450#ifdef FEAT_PROP_POPUP
Bram Moolenaar45dd07f2019-05-15 22:45:37 +02004451 adjust_props_for_split(lnum + 1, lnum, plen, 1);
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004452#endif
4453 // all line numbers increase
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 ++sub_firstlnum;
4455 ++lnum;
4456 ++line2;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004457 // move the cursor to the new line, like Vi
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 ++curwin->w_cursor.lnum;
Bram Moolenaar4164bb22019-01-04 23:09:49 +01004459 // copy the rest
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004460 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 p1 = new_start - 1;
4462 }
4463 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004465 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 }
4467
4468 /*
4469 * 4. If do_all is set, find next match.
4470 * Prevent endless loop with patterns that match empty
4471 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4472 * But ":s/\n/#/" is OK.
4473 */
4474skip:
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004475 // We already know that we did the last subst when we are at
4476 // the end of the line, except that a pattern like
4477 // "bar\|\nfoo" may match at the NUL. "lnum" can be below
4478 // "line2" when there is a \zs in the pattern after a line
4479 // break.
Bram Moolenaar8299df92004-07-10 09:47:34 +00004480 lastone = (skip_match
4481 || got_int
4482 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004483 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004484 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00004485 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4486 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 nmatch = -1;
4488
4489 /*
4490 * Replace the line in the buffer when needed. This is
4491 * skipped when there are more matches.
4492 * The check for nmatch_tl is needed for when multi-line
4493 * matching must replace the lines before trying to do another
4494 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004495 * When the match starts below where we start searching also
4496 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 */
4498 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 || nmatch_tl > 0
4500 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004501 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004502 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004503 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 {
4505 if (new_start != NULL)
4506 {
4507 /*
4508 * Copy the rest of the line, that didn't match.
4509 * "matchcol" has to be adjusted, we use the end of
4510 * the line as reference, because the substitute may
4511 * have changed the number of characters. Same for
4512 * "prev_matchcol".
4513 */
4514 STRCAT(new_start, sub_firstline + copycol);
4515 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4516 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4517 - prev_matchcol;
4518
4519 if (u_savesub(lnum) != OK)
4520 break;
4521 ml_replace(lnum, new_start, TRUE);
4522
4523 if (nmatch_tl > 0)
4524 {
4525 /*
4526 * Matched lines have now been substituted and are
4527 * useless, delete them. The part after the match
4528 * has been appended to new_start, we don't need
4529 * it in the buffer.
4530 */
4531 ++lnum;
4532 if (u_savedel(lnum, nmatch_tl) != OK)
4533 break;
4534 for (i = 0; i < nmatch_tl; ++i)
4535 ml_delete(lnum, (int)FALSE);
4536 mark_adjust(lnum, lnum + nmatch_tl - 1,
4537 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004538 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 deleted_lines(lnum, nmatch_tl);
4540 --lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004541 line2 -= nmatch_tl; // nr of lines decreases
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 nmatch_tl = 0;
4543 }
4544
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004545 // When asking, undo is saved each time, must also set
4546 // changed flag each time.
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004547 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 changed_bytes(lnum, 0);
4549 else
4550 {
4551 if (first_line == 0)
4552 first_line = lnum;
4553 last_line = lnum + 1;
4554 }
4555
4556 sub_firstlnum = lnum;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004557 vim_free(sub_firstline); // free the temp buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 sub_firstline = new_start;
4559 new_start = NULL;
4560 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4561 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4562 - prev_matchcol;
4563 copycol = 0;
4564 }
4565 if (nmatch == -1 && !lastone)
4566 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004567 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568
4569 /*
4570 * 5. break if there isn't another match in this line
4571 */
4572 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004573 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004574 // If the match found didn't start where we were
4575 // searching, do the next search in the line where we
4576 // found the match.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004577 if (nmatch == -1)
4578 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004580 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 }
4582
4583 line_breakcheck();
4584 }
4585
4586 if (did_sub)
4587 ++sub_nlines;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004588 vim_free(new_start); // for when substitute was cancelled
4589 VIM_CLEAR(sub_firstline); // free the copy of the original line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 }
4591
4592 line_breakcheck();
4593 }
4594
4595 if (first_line != 0)
4596 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004597 // Need to subtract the number of added lines from "last_line" to get
4598 // the line number before the change (same as adding the number of
4599 // deleted lines).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 i = curbuf->b_ml.ml_line_count - old_line_count;
4601 changed_lines(first_line, 0, last_line - i, i);
4602 }
4603
4604outofmem:
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004605 vim_free(sub_firstline); // may have to free allocated copy of the line
Bram Moolenaar05159a02005-02-26 23:04:13 +00004606
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004607 // ":s/pat//n" doesn't move the cursor
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004608 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004609 curwin->w_cursor = old_cursor;
4610
Bram Moolenaar46475522010-03-23 17:36:29 +01004611 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 {
Bram Moolenaarf4a1d1c2019-11-16 13:50:25 +01004613 if (!cmdmod.lockmarks)
4614 {
4615 // Set the '[ and '] marks.
4616 curbuf->b_op_start.lnum = eap->line1;
4617 curbuf->b_op_end.lnum = line2;
4618 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4619 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620
4621 if (!global_busy)
4622 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004623 // when interactive leave cursor on the match
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004624 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01004625 {
4626 if (endcolumn)
4627 coladvance((colnr_T)MAXCOL);
4628 else
4629 beginline(BL_WHITE | BL_FIX);
4630 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004631 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004632 msg("");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 }
4634 else
4635 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004636 if (subflags.do_print)
4637 print_line(curwin->w_cursor.lnum,
4638 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 }
4640 else if (!global_busy)
4641 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004642 if (got_int) // interrupted
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004643 emsg(_(e_interr));
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004644 else if (got_match) // did find something but nothing substituted
Bram Moolenaar32526b32019-01-19 17:43:09 +01004645 msg("");
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004646 else if (subflags.do_error) // nothing found
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004647 semsg(_(e_patnotf2), get_search_pat());
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 }
4649
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004650#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004651 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004652 // Cursor position may require updating
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01004653 changed_window_setting();
4654#endif
4655
Bram Moolenaar473de612013-06-08 18:19:48 +02004656 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004657
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004658 // Restore the flag values, they can be used for ":&&".
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004659 subflags.do_all = save_do_all;
4660 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661}
4662
4663/*
4664 * Give message for number of substitutions.
4665 * Can also be used after a ":global" command.
4666 * Return TRUE if a message was given.
4667 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004668 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004669do_sub_msg(
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004670 int count_only) // used 'n' flag for ":s"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671{
4672 /*
4673 * Only report substitutions when:
4674 * - more than 'report' substitutions
4675 * - command was typed by user, or number of changed lines > 'report'
4676 * - giving messages is not disabled by 'lazyredraw'
4677 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004678 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
4679 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 && messaging())
4681 {
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004682 char *msg_single;
4683 char *msg_plural;
4684
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 if (got_int)
4686 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004687 else
4688 *msg_buf = NUL;
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004689
4690 msg_single = count_only
4691 ? NGETTEXT("%ld match on %ld line",
4692 "%ld matches on %ld line", sub_nsubs)
4693 : NGETTEXT("%ld substitution on %ld line",
4694 "%ld substitutions on %ld line", sub_nsubs);
4695 msg_plural = count_only
4696 ? NGETTEXT("%ld match on %ld lines",
4697 "%ld matches on %ld lines", sub_nsubs)
4698 : NGETTEXT("%ld substitution on %ld lines",
4699 "%ld substitutions on %ld lines", sub_nsubs);
4700
Bram Moolenaar32526b32019-01-19 17:43:09 +01004701 vim_snprintf_add(msg_buf, sizeof(msg_buf),
Bram Moolenaarda6e8912018-08-21 15:12:14 +02004702 NGETTEXT(msg_single, msg_plural, sub_nlines),
4703 sub_nsubs, (long)sub_nlines);
4704
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 if (msg(msg_buf))
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004706 // save message to display it after redraw
Bram Moolenaar32526b32019-01-19 17:43:09 +01004707 set_keep_msg((char_u *)msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 return TRUE;
4709 }
4710 if (got_int)
4711 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004712 emsg(_(e_interr));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 return TRUE;
4714 }
4715 return FALSE;
4716}
4717
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004718 static void
4719global_exe_one(char_u *cmd, linenr_T lnum)
4720{
4721 curwin->w_cursor.lnum = lnum;
4722 curwin->w_cursor.col = 0;
4723 if (*cmd == NUL || *cmd == '\n')
4724 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
4725 else
4726 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
4727}
4728
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729/*
4730 * Execute a global command of the form:
4731 *
4732 * g/pattern/X : execute X on all lines where pattern matches
4733 * v/pattern/X : execute X on all lines where pattern does not match
4734 *
4735 * where 'X' is an EX command
4736 *
4737 * The command character (as well as the trailing slash) is optional, and
4738 * is assumed to be 'p' if missing.
4739 *
4740 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004741 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 * for each line that has a mark. This is required because after deleting
4743 * lines we do not know where to search for the next match.
4744 */
4745 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004746ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004748 linenr_T lnum; // line number according to old situation
Bram Moolenaar05159a02005-02-26 23:04:13 +00004749 int ndone = 0;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004750 int type; // first char of cmd: 'v' or 'g'
4751 char_u *cmd; // command argument
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004753 char_u delim; // delimiter, normally '/'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 char_u *pat;
4755 regmmatch_T regmatch;
4756 int match;
4757 int which_pat;
4758
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004759 // When nesting the command works on one line. This allows for
4760 // ":g/found/v/notfound/command".
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004761 if (global_busy && (eap->line1 != 1
4762 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004764 // will increment global_busy to break out of the loop
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004765 emsg(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766 return;
4767 }
4768
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004769 if (eap->forceit) // ":global!" is like ":vglobal"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 type = 'v';
4771 else
4772 type = *eap->cmd;
4773 cmd = eap->arg;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004774 which_pat = RE_LAST; // default: use last used regexp
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775
4776 /*
4777 * undocumented vi feature:
4778 * "\/" and "\?": use previous search pattern.
4779 * "\&": use previous substitute pattern.
4780 */
4781 if (*cmd == '\\')
4782 {
4783 ++cmd;
4784 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4785 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004786 emsg(_(e_backslash));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 return;
4788 }
4789 if (*cmd == '&')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004790 which_pat = RE_SUBST; // use previous substitute pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004792 which_pat = RE_SEARCH; // use previous search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 ++cmd;
4794 pat = (char_u *)"";
4795 }
4796 else if (*cmd == NUL)
4797 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004798 emsg(_("E148: Regular expression missing from global"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 return;
4800 }
4801 else
4802 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004803 delim = *cmd; // get the delimiter
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 if (delim)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004805 ++cmd; // skip delimiter if there is one
4806 pat = cmd; // remember start of pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004808 if (cmd[0] == delim) // end delimiter found
4809 *cmd++ = NUL; // replace it with a NUL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 }
4811
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4813 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004814 emsg(_(e_invcmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 return;
4816 }
4817
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004818 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004820 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004821 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004822 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004824 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 }
4826 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004827 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004828 /*
4829 * pass 1: set marks for each (not) matching line
4830 */
4831 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
4832 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004833 // a match on this line?
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004834 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02004835 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004836 if ((type == 'g' && match) || (type == 'v' && !match))
4837 {
4838 ml_setmarked(lnum);
4839 ndone++;
4840 }
4841 line_breakcheck();
4842 }
4843
4844 /*
4845 * pass 2: execute the command for each line that has been marked
4846 */
4847 if (got_int)
Bram Moolenaar32526b32019-01-19 17:43:09 +01004848 msg(_(e_interr));
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004849 else if (ndone == 0)
4850 {
4851 if (type == 'v')
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004852 smsg(_("Pattern found in every line: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004853 else
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01004854 smsg(_("Pattern not found: %s"), pat);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004855 }
4856 else
4857 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004858#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004859 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004860#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004861 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004862#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004863 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004864#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004865 }
4866
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004867 ml_clearmarked(); // clear rest of the marks
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02004868 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869
Bram Moolenaar473de612013-06-08 18:19:48 +02004870 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871}
4872
4873/*
4874 * Execute "cmd" on lines marked with ml_setmarked().
4875 */
4876 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004877global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878{
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004879 linenr_T old_lcount; // b_ml.ml_line_count before the command
4880 buf_T *old_buf = curbuf; // remember what buffer we started in
4881 linenr_T lnum; // line number according to old situation
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882
4883 /*
4884 * Set current position only once for a global command.
4885 * If global_busy is set, setpcmark() will not do anything.
4886 * If there is an error, global_busy will be incremented.
4887 */
4888 setpcmark();
4889
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004890 // When the command writes a message, don't overwrite the command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 msg_didout = TRUE;
4892
Bram Moolenaard25bc232010-03-23 17:49:24 +01004893 sub_nsubs = 0;
4894 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 global_need_beginline = FALSE;
4896 global_busy = 1;
4897 old_lcount = curbuf->b_ml.ml_line_count;
4898 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
4899 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02004900 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 ui_breakcheck();
4902 }
4903
4904 global_busy = 0;
4905 if (global_need_beginline)
4906 beginline(BL_WHITE | BL_FIX);
4907 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004908 check_cursor(); // cursor may be beyond the end of the line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004910 // the cursor may not have moved in the text but a change in a previous
4911 // line may move it on the screen
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004912 changed_line_abv_curs();
4913
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004914 // If it looks like no message was written, allow overwriting the
4915 // command with the report for number of changes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 if (msg_col == 0 && msg_scrolled == 0)
4917 msg_didout = FALSE;
4918
Bram Moolenaar217e1b82019-12-01 21:41:28 +01004919 // If substitutes done, report number of substitutes, otherwise report
4920 // number of extra or deleted lines.
4921 // Don't report extra or deleted lines in the edge case where the buffer
4922 // we are in after execution is different from the buffer we started in.
Bram Moolenaarbb993222011-05-10 16:00:47 +02004923 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
4925}
4926
4927#ifdef FEAT_VIMINFO
Bram Moolenaarc3328162019-07-23 22:15:25 +02004928/*
4929 * Get the previous substitute pattern.
4930 */
4931 char_u *
4932get_old_sub(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933{
Bram Moolenaarc3328162019-07-23 22:15:25 +02004934 return old_sub;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935}
4936
Bram Moolenaarc3328162019-07-23 22:15:25 +02004937/*
4938 * Set the previous substitute pattern. "val" must be allocated.
4939 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 void
Bram Moolenaarc3328162019-07-23 22:15:25 +02004941set_old_sub(char_u *val)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942{
Bram Moolenaarc3328162019-07-23 22:15:25 +02004943 vim_free(old_sub);
4944 old_sub = val;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945}
Bram Moolenaardefa0672019-07-21 19:25:37 +02004946#endif // FEAT_VIMINFO
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00004948#if defined(EXITFREE) || defined(PROTO)
4949 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004950free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00004951{
4952 vim_free(old_sub);
4953}
4954#endif
4955
Bram Moolenaar4033c552017-09-16 20:54:51 +02004956#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957/*
4958 * Set up for a tagpreview.
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004959 * Makes the preview window the current window.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004960 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00004962 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004963prepare_tagpreview(
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004964 int undo_sync, // sync undo when leaving the window
4965 int use_previewpopup, // use popup if 'previewpopup' set
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004966 use_popup_T use_popup) // use other popup window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967{
4968 win_T *wp;
4969
4970# ifdef FEAT_GUI
4971 need_mouse_correct = TRUE;
4972# endif
4973
4974 /*
4975 * If there is already a preview window open, use that one.
4976 */
4977 if (!curwin->w_p_pvw)
4978 {
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01004979# ifdef FEAT_PROP_POPUP
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004980 if (use_previewpopup && *p_pvp != NUL)
Bram Moolenaar79648732019-07-18 21:43:07 +02004981 {
4982 wp = popup_find_preview_window();
4983 if (wp != NULL)
Bram Moolenaar4dd8fe02019-11-09 15:33:31 +01004984 popup_set_wantpos_cursor(wp, wp->w_minwidth, NULL);
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004985 }
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004986 else if (use_popup != USEPOPUP_NONE)
Bram Moolenaar576a4a62019-08-18 15:25:17 +02004987 {
4988 wp = popup_find_info_window();
Bram Moolenaarc7c5f102019-08-21 18:31:03 +02004989 if (wp != NULL)
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004990 {
4991 if (use_popup == USEPOPUP_NORMAL)
4992 popup_show(wp);
4993 else
4994 popup_hide(wp);
Bram Moolenaarb73e4392019-11-09 20:00:35 +01004995 // When the popup moves or resizes it may reveal part of
4996 // another window. TODO: can this be done more efficiently?
4997 redraw_all_later(NOT_VALID);
Bram Moolenaardca7abe2019-10-20 18:17:57 +02004998 }
Bram Moolenaar79648732019-07-18 21:43:07 +02004999 }
5000 else
5001# endif
5002 {
5003 FOR_ALL_WINDOWS(wp)
5004 if (wp->w_p_pvw)
5005 break;
5006 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005008 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 else
5010 {
5011 /*
5012 * There is no preview window open yet. Create one.
5013 */
Bram Moolenaar05ad5ff2019-11-30 22:48:27 +01005014# ifdef FEAT_PROP_POPUP
Bram Moolenaardca7abe2019-10-20 18:17:57 +02005015 if ((use_previewpopup && *p_pvp != NUL)
5016 || use_popup != USEPOPUP_NONE)
5017 return popup_create_preview_window(use_popup != USEPOPUP_NONE);
Bram Moolenaar79648732019-07-18 21:43:07 +02005018# endif
5019 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0) == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005020 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 curwin->w_p_pvw = TRUE;
5022 curwin->w_p_wfh = TRUE;
Bram Moolenaar79648732019-07-18 21:43:07 +02005023 RESET_BINDING(curwin); // don't take over 'scrollbind'
5024 // and 'cursorbind'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025# ifdef FEAT_DIFF
Bram Moolenaar79648732019-07-18 21:43:07 +02005026 curwin->w_p_diff = FALSE; // no 'diff'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027# endif
5028# ifdef FEAT_FOLDING
Bram Moolenaar79648732019-07-18 21:43:07 +02005029 curwin->w_p_fdc = 0; // no 'foldcolumn'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005031 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 }
5033 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005034 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035}
5036
5037#endif
5038
5039
5040/*
5041 * ":help": open a read-only window on a help file
5042 */
5043 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005044ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045{
5046 char_u *arg;
5047 char_u *tag;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005048 FILE *helpfd; // file descriptor of help file
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 int n;
5050 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 int num_matches;
5053 char_u **matches;
5054 char_u *p;
5055 int empty_fnum = 0;
5056 int alt_fnum = 0;
5057 buf_T *buf;
5058#ifdef FEAT_MULTI_LANG
5059 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005060 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005062#ifdef FEAT_FOLDING
5063 int old_KeyTyped = KeyTyped;
5064#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
5066 if (eap != NULL)
5067 {
5068 /*
5069 * A ":help" command ends at the first LF, or at a '|' that is
5070 * followed by some text. Set nextcmd to the following command.
5071 */
5072 for (arg = eap->arg; *arg; ++arg)
5073 {
5074 if (*arg == '\n' || *arg == '\r'
5075 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5076 {
5077 *arg++ = NUL;
5078 eap->nextcmd = arg;
5079 break;
5080 }
5081 }
5082 arg = eap->arg;
5083
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005084 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005086 emsg(_("E478: Don't panic!"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 return;
5088 }
5089
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005090 if (eap->skip) // not executing commands
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 return;
5092 }
5093 else
5094 arg = (char_u *)"";
5095
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005096 // remove trailing blanks
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01005098 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 *p-- = NUL;
5100
5101#ifdef FEAT_MULTI_LANG
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005102 // Check for a specified language
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005103 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104#endif
5105
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005106 // When no argument given go to the index.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 if (*arg == NUL)
5108 arg = (char_u *)"help.txt";
5109
5110 /*
5111 * Check if there is a match for the argument.
5112 */
5113 n = find_help_tags(arg, &num_matches, &matches,
5114 eap != NULL && eap->forceit);
5115
5116 i = 0;
5117#ifdef FEAT_MULTI_LANG
5118 if (n != FAIL && lang != NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005119 // Find first item with the requested language.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 for (i = 0; i < num_matches; ++i)
5121 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005122 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 if (len > 3 && matches[i][len - 3] == '@'
5124 && STRICMP(matches[i] + len - 2, lang) == 0)
5125 break;
5126 }
5127#endif
5128 if (i >= num_matches || n == FAIL)
5129 {
5130#ifdef FEAT_MULTI_LANG
5131 if (lang != NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005132 semsg(_("E661: Sorry, no '%s' help for %s"), lang, arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 else
5134#endif
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005135 semsg(_("E149: Sorry, no help for %s"), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 if (n != FAIL)
5137 FreeWild(num_matches, matches);
5138 return;
5139 }
5140
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005141 // The first match (in the requested language) is the best match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 tag = vim_strsave(matches[i]);
5143 FreeWild(num_matches, matches);
5144
5145#ifdef FEAT_GUI
5146 need_mouse_correct = TRUE;
5147#endif
5148
5149 /*
5150 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005151 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02005153 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005155 if (cmdmod.tab != 0)
5156 wp = NULL;
5157 else
Bram Moolenaar29323592016-07-24 22:04:11 +02005158 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005159 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005160 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5162 win_enter(wp, TRUE);
5163 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 {
5165 /*
5166 * There is no help window yet.
5167 * Try to open the file specified by the "helpfile" option.
5168 */
5169 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5170 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01005171 smsg(_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 goto erret;
5173 }
5174 fclose(helpfd);
5175
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005176 // Split off help window; put it at far top if no position
5177 // specified, the current window is vertically split and
5178 // narrow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005181 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005184 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 if (curwin->w_height < p_hh)
5187 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188
5189 /*
5190 * Open help file (do_ecmd() will set b_help flag, readfile() will
5191 * set b_p_ro flag).
5192 * Set the alternate file to the previously edited file.
5193 */
5194 alt_fnum = curbuf->b_fnum;
5195 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005196 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005197 NULL); // buffer is still open, don't store info
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005198 if (!cmdmod.keepalt)
5199 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 empty_fnum = curbuf->b_fnum;
5201 }
5202 }
5203
5204 if (!p_im)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005205 restart_edit = 0; // don't want insert mode in help file
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206
Bram Moolenaar8f535582011-09-30 17:30:31 +02005207#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005208 // Restore KeyTyped, setting 'filetype=help' may reset it.
5209 // It is needed for do_tag top open folds under the cursor.
Bram Moolenaar8f535582011-09-30 17:30:31 +02005210 KeyTyped = old_KeyTyped;
5211#endif
5212
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 if (tag != NULL)
5214 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5215
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005216 // Delete the empty buffer if we're not using it. Careful: autocommands
5217 // may have jumped to another window, check that the buffer is not in a
5218 // window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5220 {
5221 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005222 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 wipe_buffer(buf, TRUE);
5224 }
5225
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005226 // keep the previous alternate file
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005227 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 curwin->w_alt_fnum = alt_fnum;
5229
5230erret:
5231 vim_free(tag);
5232}
5233
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005234/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005235 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005236 */
5237 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005238ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005239{
5240 win_T *win;
5241
5242 FOR_ALL_WINDOWS(win)
5243 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02005244 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005245 {
5246 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02005247 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02005248 }
5249 }
5250}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005252#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5253/*
5254 * In an argument search for a language specifiers in the form "@xx".
5255 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5256 * Returns NULL if not found.
5257 */
5258 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005259check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005260{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005261 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005262
5263 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5264 && ASCII_ISALPHA(arg[len - 1]))
5265 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005266 arg[len - 3] = NUL; // remove the '@'
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005267 return arg + len - 2;
5268 }
5269 return NULL;
5270}
5271#endif
5272
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273/*
5274 * Return a heuristic indicating how well the given string matches. The
5275 * smaller the number, the better the match. This is the order of priorities,
5276 * from best match to worst match:
Bram Moolenaar4b96df52020-01-26 22:00:26 +01005277 * - Match with least alphanumeric characters is better.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 * - Match with least total characters is better.
5279 * - Match towards the start is better.
5280 * - Match starting with "+" is worse (feature instead of command)
5281 * Assumption is made that the matched_string passed has already been found to
5282 * match some string for which help is requested. webb.
5283 */
5284 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005285help_heuristic(
5286 char_u *matched_string,
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005287 int offset, // offset for match
5288 int wrong_case) // no matching case
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289{
5290 int num_letters;
5291 char_u *p;
5292
5293 num_letters = 0;
5294 for (p = matched_string; *p; p++)
5295 if (ASCII_ISALNUM(*p))
5296 num_letters++;
5297
5298 /*
5299 * Multiply the number of letters by 100 to give it a much bigger
5300 * weighting than the number of characters.
5301 * If there only is a match while ignoring case, add 5000.
5302 * If the match starts in the middle of a word, add 10000 to put it
5303 * somewhere in the last half.
5304 * If the match is more than 2 chars from the start, multiply by 200 to
5305 * put it after matches at the start.
5306 */
5307 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5308 && ASCII_ISALNUM(matched_string[offset - 1]))
5309 offset += 10000;
5310 else if (offset > 2)
5311 offset *= 200;
5312 if (wrong_case)
5313 offset += 5000;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005314 // Features are less interesting than the subjects themselves, but "+"
5315 // alone is not a feature.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 if (matched_string[0] == '+' && matched_string[1] != NUL)
5317 offset += 100;
5318 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5319}
5320
5321/*
5322 * Compare functions for qsort() below, that checks the help heuristics number
5323 * that has been put after the tagname by find_tags().
5324 */
5325 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005326help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327{
5328 char *p1;
5329 char *p2;
Bram Moolenaar297610b2019-12-27 17:20:55 +01005330 int cmp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
5332 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5333 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
Bram Moolenaar297610b2019-12-27 17:20:55 +01005334
5335 // Compare by help heuristic number first.
5336 cmp = strcmp(p1, p2);
5337 if (cmp != 0)
5338 return cmp;
5339
5340 // Compare by strings as tie-breaker when same heuristic number.
5341 return strcmp(*(char **)s1, *(char **)s2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342}
5343
5344/*
5345 * Find all help tags matching "arg", sort them and return in matches[], with
5346 * the number of matches in num_matches.
5347 * The matches will be sorted with a "best" match algorithm.
5348 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5349 */
5350 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005351find_help_tags(
5352 char_u *arg,
5353 int *num_matches,
5354 char_u ***matches,
5355 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356{
5357 char_u *s, *d;
5358 int i;
5359 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005360 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005361 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005362 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5363 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005364 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005365 "[count]", "[quotex]",
5366 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005367 "[pattern]", "\\|", "\\%$",
5368 "s/\\~", "s/\\U", "s/\\L",
5369 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005371 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02005372 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005373 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
5374 "-?", "q?", "v_g?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005375 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01005376 "\\[count]", "\\[quotex]",
5377 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005378 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02005379 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01005380 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005381 static char *(expr_table[]) = {"!=?", "!~?", "<=?", "<?", "==?", "=~?",
5382 ">=?", ">?", "is?", "isnot?"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 int flags;
5384
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005385 d = IObuff; // assume IObuff is long enough!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005387 if (STRNICMP(arg, "expr-", 5) == 0)
5388 {
5389 // When the string starting with "expr-" and containing '?' and matches
Bram Moolenaar9ca25082019-10-05 11:30:09 +02005390 // the table, it is taken literally (but ~ is escaped). Otherwise '?'
5391 // is recognized as a wildcard.
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005392 for (i = (int)(sizeof(expr_table) / sizeof(char *)); --i >= 0; )
5393 if (STRCMP(arg + 5, expr_table[i]) == 0)
5394 {
Bram Moolenaar9ca25082019-10-05 11:30:09 +02005395 int si = 0, di = 0;
5396
5397 for (;;)
5398 {
5399 if (arg[si] == '~')
5400 d[di++] = '\\';
5401 d[di++] = arg[si];
5402 if (arg[si] == NUL)
5403 break;
5404 ++si;
5405 }
Bram Moolenaar3bf5e6a2018-08-02 22:23:57 +02005406 break;
5407 }
5408 }
5409 else
5410 {
5411 // Recognize a few exceptions to the rule. Some strings that contain
5412 // '*' with "star". Otherwise '*' is recognized as a wildcard.
5413 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
5414 if (STRCMP(arg, mtable[i]) == 0)
5415 {
5416 STRCPY(d, rtable[i]);
5417 break;
5418 }
5419 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005421 if (i < 0) // no match in table
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005423 // Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5424 // Also replace "\%^" and "\%(", they match every tag too.
5425 // Also "\zs", "\z1", etc.
5426 // Also "\@<", "\@=", "\@<=", etc.
5427 // And also "\_$" and "\_^".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 if (arg[0] == '\\'
5429 && ((arg[1] != NUL && arg[2] == NUL)
5430 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5431 && arg[2] != NUL)))
5432 {
5433 STRCPY(d, "/\\\\");
5434 STRCPY(d + 3, arg + 1);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005435 // Check for "/\\_$", should be "/\\_\$"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 if (d[3] == '_' && d[4] == '$')
5437 STRCPY(d + 4, "\\$");
5438 }
5439 else
5440 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005441 // Replace:
5442 // "[:...:]" with "\[:...:]"
5443 // "[++...]" with "\[++...]"
5444 // "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005445 if ((arg[0] == '[' && (arg[1] == ':'
5446 || (arg[1] == '+' && arg[2] == '+')))
5447 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 *d++ = '\\';
5449
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01005450 /*
5451 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
5452 */
5453 if (*arg == '(' && arg[1] == '\'')
5454 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 for (s = arg; *s; ++s)
5456 {
5457 /*
5458 * Replace "|" with "bar" and '"' with "quote" to match the name of
5459 * the tags for these commands.
5460 * Replace "*" with ".*" and "?" with "." to match command line
5461 * completion.
5462 * Insert a backslash before '~', '$' and '.' to avoid their
5463 * special meaning.
5464 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005465 if (d - IObuff > IOSIZE - 10) // getting too long!?
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 break;
5467 switch (*s)
5468 {
5469 case '|': STRCPY(d, "bar");
5470 d += 3;
5471 continue;
5472 case '"': STRCPY(d, "quote");
5473 d += 5;
5474 continue;
5475 case '*': *d++ = '.';
5476 break;
5477 case '?': *d++ = '.';
5478 continue;
5479 case '$':
5480 case '.':
5481 case '~': *d++ = '\\';
5482 break;
5483 }
5484
5485 /*
5486 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5487 * ":help i_^_CTRL-D" work.
5488 * Insert '-' before and after "CTRL-X" when applicable.
5489 */
5490 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5491 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5492 {
Bram Moolenaard82db602013-08-07 15:24:41 +02005493 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005494 *d++ = '_'; // prepend a '_' to make x_CTRL-x
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 STRCPY(d, "CTRL-");
5496 d += 5;
5497 if (*s < ' ')
5498 {
5499#ifdef EBCDIC
5500 *d++ = CtrlChar(*s);
5501#else
5502 *d++ = *s + '@';
5503#endif
5504 if (d[-1] == '\\')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005505 *d++ = '\\'; // double a backslash
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 }
5507 else
5508 *d++ = *++s;
5509 if (s[1] != NUL && s[1] != '_')
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005510 *d++ = '_'; // append a '_'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 continue;
5512 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005513 else if (*s == '^') // "^" or "CTRL-^" or "^_"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 *d++ = '\\';
5515
5516 /*
5517 * Insert a backslash before a backslash after a slash, for search
5518 * pattern tags: "/\|" --> "/\\|".
5519 */
5520 else if (s[0] == '\\' && s[1] != '\\'
5521 && *arg == '/' && s == arg + 1)
5522 *d++ = '\\';
5523
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005524 // "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5525 // "CTRL-\_CTRL-N"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5527 {
5528 STRCPY(d, "CTRL-\\\\");
5529 d += 7;
5530 s += 6;
5531 }
5532
5533 *d++ = *s;
5534
5535 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02005536 * If tag contains "({" or "([", tag terminates at the "(".
5537 * This is for help on functions, e.g.: abs({expr}).
5538 */
5539 if (*s == '(' && (s[1] == '{' || s[1] =='['))
5540 break;
5541
5542 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 * If tag starts with ', toss everything after a second '. Fixes
5544 * CTRL-] on 'option'. (would include the trailing '.').
5545 */
5546 if (*s == '\'' && s > arg && *arg == '\'')
5547 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005548 // Also '{' and '}'.
Bram Moolenaar28b942a2016-06-04 22:31:27 +02005549 if (*s == '}' && s > arg && *arg == '{')
5550 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 }
5552 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02005553
5554 if (*IObuff == '`')
5555 {
5556 if (d > IObuff + 2 && d[-1] == '`')
5557 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005558 // remove the backticks from `command`
Bram Moolenaar720ce532012-04-25 12:57:28 +02005559 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5560 d[-2] = NUL;
5561 }
5562 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
5563 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005564 // remove the backticks and comma from `command`,
Bram Moolenaar720ce532012-04-25 12:57:28 +02005565 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5566 d[-3] = NUL;
5567 }
5568 else if (d > IObuff + 4 && d[-3] == '`'
5569 && d[-2] == '\\' && d[-1] == '.')
5570 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005571 // remove the backticks and dot from `command`\.
Bram Moolenaar720ce532012-04-25 12:57:28 +02005572 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
5573 d[-4] = NUL;
5574 }
5575 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 }
5577 }
5578
5579 *matches = (char_u **)"";
5580 *num_matches = 0;
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02005581 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE | TAG_NO_TAGFUNC;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 if (keep_lang)
5583 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005584 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005586 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005587 // Sort the matches found on the heuristic number that is after the
5588 // tag name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 qsort((void *)*matches, (size_t)*num_matches,
5590 sizeof(char_u *), help_compare);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005591 // Delete more than TAG_MANY to reduce the size of the listing.
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005592 while (*num_matches > TAG_MANY)
5593 vim_free((*matches)[--*num_matches]);
5594 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 return OK;
5596}
5597
5598/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005599 * Called when starting to edit a buffer for a help file.
5600 */
5601 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005602prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005603{
5604 char_u *p;
5605
5606 curbuf->b_help = TRUE;
5607#ifdef FEAT_QUICKFIX
5608 set_string_option_direct((char_u *)"buftype", -1,
5609 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
5610#endif
5611
5612 /*
5613 * Always set these options after jumping to a help tag, because the
5614 * user may have an autocommand that gets in the way.
5615 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
5616 * latin1 word characters (for translated help files).
5617 * Only set it when needed, buf_init_chartab() is some work.
5618 */
5619 p =
5620#ifdef EBCDIC
5621 (char_u *)"65-255,^*,^|,^\"";
5622#else
5623 (char_u *)"!-~,^*,^|,^\",192-255";
5624#endif
5625 if (STRCMP(curbuf->b_p_isk, p) != 0)
5626 {
5627 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
5628 check_buf_options(curbuf);
5629 (void)buf_init_chartab(curbuf, FALSE);
5630 }
5631
Bram Moolenaar0b105412014-11-30 13:34:23 +01005632#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005633 // Don't use the global foldmethod.
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005634 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
5635 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01005636#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005637
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005638 curbuf->b_p_ts = 8; // 'tabstop' is 8
5639 curwin->w_p_list = FALSE; // no list mode
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005640
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005641 curbuf->b_p_ma = FALSE; // not modifiable
5642 curbuf->b_p_bin = FALSE; // reset 'bin' before reading file
5643 curwin->w_p_nu = 0; // no line numbers
5644 curwin->w_p_rnu = 0; // no relative line numbers
5645 RESET_BINDING(curwin); // no scroll or cursor binding
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005646#ifdef FEAT_ARABIC
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005647 curwin->w_p_arab = FALSE; // no arabic mode
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005648#endif
5649#ifdef FEAT_RIGHTLEFT
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005650 curwin->w_p_rl = FALSE; // help window is left-to-right
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005651#endif
5652#ifdef FEAT_FOLDING
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005653 curwin->w_p_fen = FALSE; // No folding in the help window
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005654#endif
5655#ifdef FEAT_DIFF
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005656 curwin->w_p_diff = FALSE; // No 'diff'
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005657#endif
5658#ifdef FEAT_SPELL
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005659 curwin->w_p_spell = FALSE; // No spell checking
Bram Moolenaar54fb4382014-11-12 19:28:16 +01005660#endif
5661
5662 set_buflisted(FALSE);
5663}
5664
5665/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 * After reading a help file: May cleanup a help buffer when syntax
5667 * highlighting is not used.
5668 */
5669 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005670fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671{
5672 linenr_T lnum;
5673 char_u *line;
5674 int in_example = FALSE;
5675 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005676 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 char_u *p;
5678 char_u *rt;
5679 int mustfree;
5680
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005681 // Set filetype to "help" if still needed.
Bram Moolenaar90492982017-06-22 14:16:31 +02005682 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02005683 {
5684 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02005685 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02005686 --curbuf_lock;
5687 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688
5689#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02005690 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691#endif
5692 {
5693 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5694 {
5695 line = ml_get_buf(curbuf, lnum, FALSE);
5696 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005697 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005699 // End of example: non-white or '<' in first column.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 if (line[0] == '<')
5701 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005702 // blank-out a '<' in the first column
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 line = ml_get_buf(curbuf, lnum, TRUE);
5704 line[0] = ' ';
5705 }
5706 in_example = FALSE;
5707 }
5708 if (!in_example && len > 0)
5709 {
5710 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5711 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005712 // blank-out a '>' in the last column (start of example)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 line = ml_get_buf(curbuf, lnum, TRUE);
5714 line[len - 1] = ' ';
5715 in_example = TRUE;
5716 }
5717 else if (line[len - 1] == '~')
5718 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005719 // blank-out a '~' at the end of line (header marker)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 line = ml_get_buf(curbuf, lnum, TRUE);
5721 line[len - 1] = ' ';
5722 }
5723 }
5724 }
5725 }
5726
5727 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005728 * In the "help.txt" and "help.abx" file, add the locally added help
5729 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005731 fname = gettail(curbuf->b_fname);
5732 if (fnamecmp(fname, "help.txt") == 0
5733#ifdef FEAT_MULTI_LANG
5734 || (fnamencmp(fname, "help.", 5) == 0
5735 && ASCII_ISALPHA(fname[5])
5736 && ASCII_ISALPHA(fname[6])
5737 && TOLOWER_ASC(fname[7]) == 'x'
5738 && fname[8] == NUL)
5739#endif
5740 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 {
5742 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5743 {
5744 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005745 if (strstr((char *)line, "*local-additions*") == NULL)
5746 continue;
5747
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005748 // Go through all directories in 'runtimepath', skipping
5749 // $VIMRUNTIME.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005750 p = p_rtp;
5751 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005753 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5754 mustfree = FALSE;
5755 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaar99499b12019-05-23 21:35:48 +02005756 if (rt != NULL &&
5757 fullpathcmp(rt, NameBuff, FALSE, TRUE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005759 int fcount;
5760 char_u **fnames;
5761 FILE *fd;
5762 char_u *s;
5763 int fi;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005764 vimconv_T vc;
5765 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005767 // Find all "doc/ *.txt" files in this directory.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005768 add_pathsep(NameBuff);
5769#ifdef FEAT_MULTI_LANG
5770 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005772 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005774 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5775 &fnames, EW_FILE|EW_SILENT) == OK
5776 && fcount > 0)
5777 {
5778#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005779 int i1, i2;
5780 char_u *f1, *f2;
5781 char_u *t1, *t2;
5782 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005783
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005784 // If foo.abx is found use it instead of foo.txt in
5785 // the same directory.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005786 for (i1 = 0; i1 < fcount; ++i1)
5787 {
5788 for (i2 = 0; i2 < fcount; ++i2)
5789 {
5790 if (i1 == i2)
5791 continue;
5792 if (fnames[i1] == NULL || fnames[i2] == NULL)
5793 continue;
5794 f1 = fnames[i1];
5795 f2 = fnames[i2];
5796 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005797 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005798 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005799 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02005800 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005801 continue;
5802 if (fnamecmp(e1, ".txt") != 0
5803 && fnamecmp(e1, fname + 4) != 0)
5804 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005805 // Not .txt and not .abx, remove it.
Bram Moolenaard23a8232018-02-10 18:45:26 +01005806 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005807 continue;
5808 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01005809 if (e1 - f1 != e2 - f2
5810 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005811 continue;
5812 if (fnamecmp(e1, ".txt") == 0
5813 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005814 // use .abx instead of .txt
Bram Moolenaard23a8232018-02-10 18:45:26 +01005815 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005818#endif
5819 for (fi = 0; fi < fcount; ++fi)
5820 {
5821 if (fnames[fi] == NULL)
5822 continue;
5823 fd = mch_fopen((char *)fnames[fi], "r");
5824 if (fd != NULL)
5825 {
5826 vim_fgets(IObuff, IOSIZE, fd);
5827 if (IObuff[0] == '*'
5828 && (s = vim_strchr(IObuff + 1, '*'))
5829 != NULL)
5830 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005831 int this_utf = MAYBE;
Bram Moolenaar13505972019-01-24 15:04:48 +01005832
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005833 // Change tag definition to a
5834 // reference and remove <CR>/<NL>.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005835 IObuff[0] = '|';
5836 *s = '|';
5837 while (*s != NUL)
5838 {
5839 if (*s == '\r' || *s == '\n')
5840 *s = NUL;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005841 // The text is utf-8 when a byte
5842 // above 127 is found and no
5843 // illegal byte sequence is found.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005844 if (*s >= 0x80 && this_utf != FALSE)
5845 {
5846 int l;
5847
5848 this_utf = TRUE;
5849 l = utf_ptr2len(s);
5850 if (l == 1)
5851 this_utf = FALSE;
5852 s += l - 1;
5853 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005854 ++s;
5855 }
Bram Moolenaar13505972019-01-24 15:04:48 +01005856
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005857 // The help file is latin1 or utf-8;
5858 // conversion to the current
5859 // 'encoding' may be required.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005860 vc.vc_type = CONV_NONE;
5861 convert_setup(&vc, (char_u *)(
5862 this_utf == TRUE ? "utf-8"
5863 : "latin1"), p_enc);
5864 if (vc.vc_type == CONV_NONE)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005865 // No conversion needed.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005866 cp = IObuff;
5867 else
5868 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005869 // Do the conversion. If it fails
5870 // use the unconverted text.
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005871 cp = string_convert(&vc, IObuff,
5872 NULL);
5873 if (cp == NULL)
5874 cp = IObuff;
5875 }
5876 convert_setup(&vc, NULL, NULL);
5877
5878 ml_append(lnum, cp, (colnr_T)0, FALSE);
5879 if (cp != IObuff)
5880 vim_free(cp);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005881 ++lnum;
5882 }
5883 fclose(fd);
5884 }
5885 }
5886 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005889 if (mustfree)
5890 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02005892 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 }
5894 }
5895}
5896
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005897/*
5898 * ":exusage"
5899 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005900 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005901ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005902{
5903 do_cmdline_cmd((char_u *)"help ex-cmd-index");
5904}
5905
5906/*
5907 * ":viusage"
5908 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005909 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005910ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005911{
5912 do_cmdline_cmd((char_u *)"help normal-index");
5913}
5914
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01005916 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005919helptags_one(
Bram Moolenaar217e1b82019-12-01 21:41:28 +01005920 char_u *dir, // doc directory
5921 char_u *ext, // suffix, ".txt", ".itx", ".frx", etc.
5922 char_u *tagfname, // "tags" for English, "tags-fr" for French.
5923 int add_help_tags) // add "help-tags" tag
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 Moolenaarf9e3e092019-01-13 23:38:42 +01005967 semsg(_("E152: Cannot open %s for writing"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 FreeWild(filecount, files);
5969 return;
5970 }
5971
5972 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00005973 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
5974 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 */
5976 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00005977 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
Bram Moolenaar99499b12019-05-23 21:35:48 +02005978 dir, FALSE, TRUE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 {
5980 if (ga_grow(&ga, 1) == FAIL)
5981 got_int = TRUE;
5982 else
5983 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005984 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 if (s == NULL)
5986 got_int = TRUE;
5987 else
5988 {
5989 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
5990 ((char_u **)ga.ga_data)[ga.ga_len] = s;
5991 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 }
5993 }
5994 }
5995
5996 /*
5997 * Go over all the files and extract the tags.
5998 */
5999 for (fi = 0; fi < filecount && !got_int; ++fi)
6000 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006001 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 if (fd == NULL)
6003 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006004 semsg(_("E153: Unable to open %s for reading"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 continue;
6006 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006007 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 firstline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6011 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 if (firstline)
6013 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006014 // Detect utf-8 file by a non-ASCII char in the first line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 this_utf8 = MAYBE;
6016 for (s = IObuff; *s != NUL; ++s)
6017 if (*s >= 0x80)
6018 {
6019 int l;
6020
6021 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006022 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 if (l == 1)
6024 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006025 // Illegal UTF-8 byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 this_utf8 = FALSE;
6027 break;
6028 }
6029 s += l - 1;
6030 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006031 if (this_utf8 == MAYBE) // only ASCII characters found
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 this_utf8 = FALSE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006033 if (utf8 == MAYBE) // first file
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034 utf8 = this_utf8;
6035 else if (utf8 != this_utf8)
6036 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006037 semsg(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 mix = !got_int;
6039 got_int = TRUE;
6040 }
6041 firstline = FALSE;
6042 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006043 p1 = vim_strchr(IObuff, '*'); // find first '*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 while (p1 != NULL)
6045 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006046 // Use vim_strbyte() instead of vim_strchr() so that when
6047 // 'encoding' is dbcs it still works, don't find '*' in the
6048 // second byte.
6049 p2 = vim_strbyte(p1 + 1, '*'); // find second '*'
6050 if (p2 != NULL && p2 > p1 + 1) // skip "*" and "**"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 {
6052 for (s = p1 + 1; s < p2; ++s)
6053 if (*s == ' ' || *s == '\t' || *s == '|')
6054 break;
6055
6056 /*
6057 * Only accept a *tag* when it consists of valid
6058 * characters, there is white space before it and is
6059 * followed by a white character or end-of-line.
6060 */
6061 if (s == p2
6062 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6063 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6064 || s[1] == '\0'))
6065 {
6066 *p2 = '\0';
6067 ++p1;
6068 if (ga_grow(&ga, 1) == FAIL)
6069 {
6070 got_int = TRUE;
6071 break;
6072 }
Bram Moolenaar964b3742019-05-24 18:54:09 +02006073 s = alloc(p2 - p1 + STRLEN(fname) + 2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 if (s == NULL)
6075 {
6076 got_int = TRUE;
6077 break;
6078 }
6079 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6080 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 sprintf((char *)s, "%s\t%s", p1, fname);
6082
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006083 // find next '*'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 p2 = vim_strchr(p2 + 1, '*');
6085 }
6086 }
6087 p1 = p2;
6088 }
6089 line_breakcheck();
6090 }
6091
6092 fclose(fd);
6093 }
6094
6095 FreeWild(filecount, files);
6096
6097 if (!got_int)
6098 {
6099 /*
6100 * Sort the tags.
6101 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02006102 if (ga.ga_data != NULL)
6103 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104
6105 /*
6106 * Check for duplicates.
6107 */
6108 for (i = 1; i < ga.ga_len; ++i)
6109 {
6110 p1 = ((char_u **)ga.ga_data)[i - 1];
6111 p2 = ((char_u **)ga.ga_data)[i];
6112 while (*p1 == *p2)
6113 {
6114 if (*p2 == '\t')
6115 {
6116 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006117 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6119 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006120 emsg((char *)NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 *p2 = '\t';
6122 break;
6123 }
6124 ++p1;
6125 ++p2;
6126 }
6127 }
6128
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 if (utf8 == TRUE)
6130 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131
6132 /*
6133 * Write the tags into the file.
6134 */
6135 for (i = 0; i < ga.ga_len; ++i)
6136 {
6137 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006138 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006139 // help-tags entry was added in formatted form
Bram Moolenaarf6210482007-07-25 20:56:39 +00006140 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 else
6142 {
6143 fprintf(fd_tags, "%s\t/*", s);
6144 for (p1 = s; *p1 != '\t'; ++p1)
6145 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006146 // insert backslash before '\\' and '/'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 if (*p1 == '\\' || *p1 == '/')
6148 putc('\\', fd_tags);
6149 putc(*p1, fd_tags);
6150 }
6151 fprintf(fd_tags, "*\n");
6152 }
6153 }
6154 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 if (mix)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006156 got_int = FALSE; // continue with other languages
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157
6158 for (i = 0; i < ga.ga_len; ++i)
6159 vim_free(((char_u **)ga.ga_data)[i]);
6160 ga_clear(&ga);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006161 fclose(fd_tags); // there is no check for an error...
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006164/*
6165 * Generate tags in one help directory, taking care of translations.
6166 */
6167 static void
6168do_helptags(char_u *dirname, int add_help_tags)
6169{
6170#ifdef FEAT_MULTI_LANG
6171 int len;
6172 int i, j;
6173 garray_T ga;
6174 char_u lang[2];
6175 char_u ext[5];
6176 char_u fname[8];
6177 int filecount;
6178 char_u **files;
6179
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006180 // Get a list of all files in the help directory and in subdirectories.
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006181 STRCPY(NameBuff, dirname);
6182 add_pathsep(NameBuff);
6183 STRCAT(NameBuff, "**");
6184 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6185 EW_FILE|EW_SILENT) == FAIL
6186 || filecount == 0)
6187 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006188 semsg(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006189 return;
6190 }
6191
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006192 // Go over all files in the directory to find out what languages are
6193 // present.
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006194 ga_init2(&ga, 1, 10);
6195 for (i = 0; i < filecount; ++i)
6196 {
6197 len = (int)STRLEN(files[i]);
6198 if (len > 4)
6199 {
6200 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6201 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006202 // ".txt" -> language "en"
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006203 lang[0] = 'e';
6204 lang[1] = 'n';
6205 }
6206 else if (files[i][len - 4] == '.'
6207 && ASCII_ISALPHA(files[i][len - 3])
6208 && ASCII_ISALPHA(files[i][len - 2])
6209 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6210 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006211 // ".abx" -> language "ab"
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006212 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6213 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6214 }
6215 else
6216 continue;
6217
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006218 // Did we find this language already?
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006219 for (j = 0; j < ga.ga_len; j += 2)
6220 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6221 break;
6222 if (j == ga.ga_len)
6223 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006224 // New language, add it.
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006225 if (ga_grow(&ga, 2) == FAIL)
6226 break;
6227 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6228 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6229 }
6230 }
6231 }
6232
6233 /*
6234 * Loop over the found languages to generate a tags file for each one.
6235 */
6236 for (j = 0; j < ga.ga_len; j += 2)
6237 {
6238 STRCPY(fname, "tags-xx");
6239 fname[5] = ((char_u *)ga.ga_data)[j];
6240 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6241 if (fname[5] == 'e' && fname[6] == 'n')
6242 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006243 // English is an exception: use ".txt" and "tags".
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006244 fname[4] = NUL;
6245 STRCPY(ext, ".txt");
6246 }
6247 else
6248 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006249 // Language "ab" uses ".abx" and "tags-ab".
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006250 STRCPY(ext, ".xxx");
6251 ext[1] = fname[5];
6252 ext[2] = fname[6];
6253 }
6254 helptags_one(dirname, ext, fname, add_help_tags);
6255 }
6256
6257 ga_clear(&ga);
6258 FreeWild(filecount, files);
6259
6260#else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006261 // No language support, just use "*.txt" and "tags".
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006262 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6263#endif
6264}
6265
6266 static void
6267helptags_cb(char_u *fname, void *cookie)
6268{
6269 do_helptags(fname, *(int *)cookie);
6270}
6271
6272/*
6273 * ":helptags"
6274 */
6275 void
6276ex_helptags(exarg_T *eap)
6277{
6278 expand_T xpc;
6279 char_u *dirname;
6280 int add_help_tags = FALSE;
6281
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006282 // Check for ":helptags ++t {dir}".
Bram Moolenaar1c465442017-03-12 20:10:05 +01006283 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006284 {
6285 add_help_tags = TRUE;
6286 eap->arg = skipwhite(eap->arg + 3);
6287 }
6288
6289 if (STRCMP(eap->arg, "ALL") == 0)
6290 {
6291 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
6292 helptags_cb, &add_help_tags);
6293 }
6294 else
6295 {
6296 ExpandInit(&xpc);
6297 xpc.xp_context = EXPAND_DIRECTORIES;
6298 dirname = ExpandOne(&xpc, eap->arg, NULL,
6299 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6300 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006301 semsg(_("E150: Not a directory: %s"), eap->arg);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006302 else
6303 do_helptags(dirname, add_help_tags);
6304 vim_free(dirname);
6305 }
6306}
6307
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006308/*
6309 * Make the user happy.
6310 */
6311 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006312ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006313{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006314 static char *code[] = {
6315 "\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$",
6316 "\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"
6317 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006318 char *p;
6319 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006320 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006321
6322 msg_start();
6323 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006324 for (i = 0; i < 2; ++i)
6325 for (p = code[i]; *p != NUL; ++p)
6326 if (*p == 'x')
6327 msg_putchar('\n');
6328 else
6329 for (n = *p++; n > 0; --n)
6330 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01006331 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02006332 else
6333 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01006334 msg_clr_eos();
6335}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337/*
6338 * ":drop"
6339 * Opens the first argument in a window. When there are two or more arguments
6340 * the argument list is redefined.
6341 */
6342 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006343ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344{
6345 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 win_T *wp;
6347 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006348 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349
6350 /*
6351 * Check if the first argument is already being edited in a window. If
6352 * so, jump to that window.
6353 * We would actually need to check all arguments, but that's complicated
6354 * and mostly only one file is dropped.
6355 * This also ignores wildcards, since it is very unlikely the user is
6356 * editing a file name with a wildcard character.
6357 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006358 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00006360 /*
6361 * Expanding wildcards may result in an empty argument list. E.g. when
6362 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
6363 * already did an error message for this.
6364 */
6365 if (ARGCOUNT == 0)
6366 return;
6367
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006368 if (cmdmod.tab)
6369 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006370 // ":tab drop file ...": open a tab for each argument that isn't
6371 // edited in a window yet. It's like ":tab all" but without closing
6372 // windows or tabs.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006373 ex_all(eap);
6374 }
6375 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006376 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006377 // ":drop file ...": Edit the first argument. Jump to an existing
6378 // window if possible, edit in current window if the current buffer
6379 // can be abandoned, otherwise open a new window.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006380 buf = buflist_findnr(ARGLIST[0].ae_fnum);
6381
6382 FOR_ALL_TAB_WINDOWS(tp, wp)
6383 {
6384 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006386 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 return;
6389 }
6390 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006392 /*
6393 * Check whether the current buffer is changed. If so, we will need
6394 * to split the current window or data could be lost.
6395 * Skip the check if the 'hidden' option is set, as in this case the
6396 * buffer won't be lost.
6397 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02006398 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006399 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006400 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01006401 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006402 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006403 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006405 // Fake a ":sfirst" or ":first" command edit the first argument.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006406 if (split)
6407 {
6408 eap->cmdidx = CMD_sfirst;
6409 eap->cmd[0] = 's';
6410 }
6411 else
6412 eap->cmdidx = CMD_first;
6413 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006416
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006417/*
6418 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
6419 * Put the start of the pattern in "*s", unless "s" is NULL.
6420 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
6421 * If "s" is not NULL terminate the pattern with a NUL.
6422 * Return a pointer to the char just past the pattern plus flags.
6423 */
6424 char_u *
6425skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
6426{
6427 int c;
6428
6429 if (vim_isIDc(*p))
6430 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006431 // ":vimgrep pattern fname"
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006432 if (s != NULL)
6433 *s = p;
6434 p = skiptowhite(p);
6435 if (s != NULL && *p != NUL)
6436 *p++ = NUL;
6437 }
6438 else
6439 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006440 // ":vimgrep /pattern/[g][j] fname"
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006441 if (s != NULL)
6442 *s = p + 1;
6443 c = *p;
6444 p = skip_regexp(p + 1, c, TRUE, NULL);
6445 if (*p != c)
6446 return NULL;
6447
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006448 // Truncate the pattern.
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006449 if (s != NULL)
6450 *p = NUL;
6451 ++p;
6452
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006453 // Find the flags
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006454 while (*p == 'g' || *p == 'j')
6455 {
6456 if (flags != NULL)
6457 {
6458 if (*p == 'g')
6459 *flags |= VGR_GLOBAL;
6460 else
6461 *flags |= VGR_NOJUMP;
6462 }
6463 ++p;
6464 }
6465 }
6466 return p;
6467}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02006468
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006469#if defined(FEAT_EVAL) || defined(PROTO)
6470/*
6471 * List v:oldfiles in a nice way.
6472 */
6473 void
6474ex_oldfiles(exarg_T *eap UNUSED)
6475{
6476 list_T *l = get_vim_var_list(VV_OLDFILES);
6477 listitem_T *li;
6478 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006479 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006480
6481 if (l == NULL)
Bram Moolenaar32526b32019-01-19 17:43:09 +01006482 msg(_("No old files"));
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006483 else
6484 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006485 msg_start();
6486 msg_scroll = TRUE;
6487 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
6488 {
6489 ++nr;
Bram Moolenaard155d7a2018-12-21 16:04:21 +01006490 fname = tv_get_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02006491 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006492 {
6493 msg_outnum((long)nr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01006494 msg_puts(": ");
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006495 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02006496 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006497 msg_putchar('\n');
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006498 out_flush(); // output one line at a time
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006499 ui_breakcheck();
6500 }
6501 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006502
Bram Moolenaar217e1b82019-12-01 21:41:28 +01006503 // Assume "got_int" was set to truncate the listing.
Bram Moolenaare11d61a2016-08-20 18:36:54 +02006504 got_int = FALSE;
6505
6506# ifdef FEAT_BROWSE_CMD
6507 if (cmdmod.browse)
6508 {
6509 quit_more = FALSE;
6510 nr = prompt_for_number(FALSE);
6511 msg_starthere();
6512 if (nr > 0)
6513 {
6514 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
6515 (long)nr);
6516
6517 if (p != NULL)
6518 {
6519 p = expand_env_save(p);
6520 eap->arg = p;
6521 eap->cmdidx = CMD_edit;
6522 cmdmod.browse = FALSE;
6523 do_exedit(eap, NULL);
6524 vim_free(p);
6525 }
6526 }
6527 }
6528# endif
6529 }
6530}
6531#endif