blob: 23930ca2a0c016093dc72244c3f1e9c80d64c3dc [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds.c: some functions for command line commands
12 */
13
Bram Moolenaar8c8de832008-06-24 22:58:06 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaar17576a12016-01-20 20:05:44 +010017#ifdef FEAT_FLOAT
18# include <float.h>
19#endif
20
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010021static int linelen(int *has_tab);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010022static void do_filter(linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#ifdef FEAT_VIMINFO
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static char_u *viminfo_filename(char_u *);
25static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags);
26static int viminfo_encoding(vir_T *virp);
27static int read_viminfo_up_to_marks(vir_T *virp, int forceit, int writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028#endif
29
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010030static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010031static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000032static int
33#ifdef __BORLANDC__
34 _RTLENTRYF
35#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010036 help_compare(const void *s1, const void *s2);
37static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
39/*
40 * ":ascii" and "ga".
41 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000042 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010043do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000044{
45 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000046 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 char buf1[20];
48 char buf2[20];
49 char_u buf3[7];
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010050#ifdef FEAT_DIGRAPHS
51 char_u *dig;
52#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000053#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000054 int cc[MAX_MCO];
55 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000056 int len;
57
58 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000059 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000060 else
61#endif
62 c = gchar_cursor();
63 if (c == NUL)
64 {
65 MSG("NUL");
66 return;
67 }
68
69#ifdef FEAT_MBYTE
70 IObuff[0] = NUL;
71 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
72#endif
73 {
74 if (c == NL) /* NUL is stored as NL */
75 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000076 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
77 cval = NL; /* NL is stored as CR */
78 else
79 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 if (vim_isprintc_strict(c) && (c < ' '
81#ifndef EBCDIC
82 || c > '~'
83#endif
84 ))
85 {
86 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000087 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000088 }
89 else
90 buf1[0] = NUL;
91#ifndef EBCDIC
92 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000093 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
94 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 else
96#endif
97 buf2[0] = NUL;
Bram Moolenaar5f73ef82018-02-27 21:09:30 +010098#ifdef FEAT_DIGRAPHS
99 dig = get_digraph_for_char(cval);
100 if (dig != NULL)
101 vim_snprintf((char *)IObuff, IOSIZE,
102 _("<%s>%s%s %d, Hex %02x, Oct %03o, Digr %s"),
103 transchar(c), buf1, buf2, cval, cval, cval, dig);
104 else
105#endif
106 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar555b2802005-05-19 21:08:39 +0000107 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +0000108 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000110 if (enc_utf8)
111 c = cc[ci++];
112 else
113 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114#endif
115 }
116
117#ifdef FEAT_MBYTE
118 /* Repeat for combining characters. */
119 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
120 {
121 len = (int)STRLEN(IObuff);
122 /* This assumes every multi-byte char is printable... */
123 if (len > 0)
124 IObuff[len++] = ' ';
125 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000126 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000127# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000129# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130 )
131 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000132 len += (*mb_char2bytes)(c, IObuff + len);
Bram Moolenaar5f73ef82018-02-27 21:09:30 +0100133#ifdef FEAT_DIGRAPHS
134 dig = get_digraph_for_char(c);
135 if (dig != NULL)
136 vim_snprintf((char *)IObuff + len, IOSIZE - len,
137 c < 0x10000 ? _("> %d, Hex %04x, Oct %o, Digr %s")
138 : _("> %d, Hex %08x, Oct %o, Digr %s"),
139 c, c, c, dig);
140 else
141#endif
142 vim_snprintf((char *)IObuff + len, IOSIZE - len,
143 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
144 : _("> %d, Hex %08x, Octal %o"),
145 c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000146 if (ci == MAX_MCO)
147 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000148 if (enc_utf8)
149 c = cc[ci++];
150 else
151 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 }
153#endif
154
155 msg(IObuff);
156}
157
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158/*
159 * ":left", ":center" and ":right": align text.
160 */
161 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100162ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163{
164 pos_T save_curpos;
165 int len;
166 int indent = 0;
167 int new_indent;
168 int has_tab;
169 int width;
170
171#ifdef FEAT_RIGHTLEFT
172 if (curwin->w_p_rl)
173 {
174 /* switch left and right aligning */
175 if (eap->cmdidx == CMD_right)
176 eap->cmdidx = CMD_left;
177 else if (eap->cmdidx == CMD_left)
178 eap->cmdidx = CMD_right;
179 }
180#endif
181
182 width = atoi((char *)eap->arg);
183 save_curpos = curwin->w_cursor;
184 if (eap->cmdidx == CMD_left) /* width is used for new indent */
185 {
186 if (width >= 0)
187 indent = width;
188 }
189 else
190 {
191 /*
192 * if 'textwidth' set, use it
193 * else if 'wrapmargin' set, use it
194 * if invalid value, use 80
195 */
196 if (width <= 0)
197 width = curbuf->b_p_tw;
198 if (width == 0 && curbuf->b_p_wm > 0)
Bram Moolenaar02631462017-09-22 15:20:32 +0200199 width = curwin->w_width - curbuf->b_p_wm;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200 if (width <= 0)
201 width = 80;
202 }
203
204 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
205 return;
206
207 for (curwin->w_cursor.lnum = eap->line1;
208 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
209 {
210 if (eap->cmdidx == CMD_left) /* left align */
211 new_indent = indent;
212 else
213 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000214 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 len = linelen(eap->cmdidx == CMD_right ? &has_tab
216 : NULL) - get_indent();
217
218 if (len <= 0) /* skip blank lines */
219 continue;
220
221 if (eap->cmdidx == CMD_center)
222 new_indent = (width - len) / 2;
223 else
224 {
225 new_indent = width - len; /* right align */
226
227 /*
228 * Make sure that embedded TABs don't make the text go too far
229 * to the right.
230 */
231 if (has_tab)
232 while (new_indent > 0)
233 {
234 (void)set_indent(new_indent, 0);
235 if (linelen(NULL) <= width)
236 {
237 /*
238 * Now try to move the line as much as possible to
239 * the right. Stop when it moves too far.
240 */
241 do
242 (void)set_indent(++new_indent, 0);
243 while (linelen(NULL) <= width);
244 --new_indent;
245 break;
246 }
247 --new_indent;
248 }
249 }
250 }
251 if (new_indent < 0)
252 new_indent = 0;
253 (void)set_indent(new_indent, 0); /* set indent */
254 }
255 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
256 curwin->w_cursor = save_curpos;
257 beginline(BL_WHITE | BL_FIX);
258}
259
260/*
261 * Get the length of the current line, excluding trailing white space.
262 */
263 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100264linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265{
266 char_u *line;
267 char_u *first;
268 char_u *last;
269 int save;
270 int len;
271
272 /* find the first non-blank character */
273 line = ml_get_curline();
274 first = skipwhite(line);
275
276 /* find the character after the last non-blank character */
277 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100278 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 ;
280 save = *last;
281 *last = NUL;
282 len = linetabsize(line); /* get line length */
283 if (has_tab != NULL) /* check for embedded TAB */
284 *has_tab = (vim_strrchr(first, TAB) != NULL);
285 *last = save;
286
287 return len;
288}
289
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000290/* Buffer for two lines used during sorting. They are allocated to
291 * contain the longest line being sorted. */
292static char_u *sortbuf1;
293static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000294
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100295static int sort_ic; /* ignore case */
296static int sort_nr; /* sort on number */
297static int sort_rx; /* sort on regex instead of skipping it */
298#ifdef FEAT_FLOAT
299static int sort_flt; /* sort on floating number */
300#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000301
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100302static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000303
304/* Struct to store info to be sorted. */
305typedef struct
306{
307 linenr_T lnum; /* line number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100308 union {
309 struct
310 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200311 varnumber_T start_col_nr; /* starting column number */
312 varnumber_T end_col_nr; /* ending column number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100313 } line;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200314 varnumber_T value; /* value if sorting by integer */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100315#ifdef FEAT_FLOAT
316 float_T value_flt; /* value if sorting by float */
317#endif
318 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000319} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000320
321static int
322#ifdef __BORLANDC__
323_RTLENTRYF
324#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100325sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000326
327 static int
328#ifdef __BORLANDC__
329_RTLENTRYF
330#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100331sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000332{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000333 sorti_T l1 = *(sorti_T *)s1;
334 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000335 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000336
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000338 * if we return 0 every time, qsort will assume it's done sorting and
339 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000340 if (sort_abort)
341 return 0;
342 fast_breakcheck();
343 if (got_int)
344 sort_abort = TRUE;
345
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000346 /* When sorting numbers "start_col_nr" is the number, not the column
347 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000348 if (sort_nr)
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100349 result = l1.st_u.value == l2.st_u.value ? 0
350 : l1.st_u.value > l2.st_u.value ? 1 : -1;
351#ifdef FEAT_FLOAT
352 else if (sort_flt)
353 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
354 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
355#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000356 else
357 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000358 /* We need to copy one line into "sortbuf1", because there is no
359 * guarantee that the first pointer becomes invalid when obtaining the
360 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100361 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
362 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
363 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
364 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
365 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
366 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000367
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000368 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
369 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000370 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000371
372 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000373 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000374 return (int)(l1.lnum - l2.lnum);
375 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000376}
377
378/*
379 * ":sort".
380 */
381 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100382ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000383{
384 regmatch_T regmatch;
385 int len;
386 linenr_T lnum;
387 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000388 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000389 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000390 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000391 char_u *p;
392 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000393 char_u *s2;
394 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000395 int unique = FALSE;
396 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000397 colnr_T start_col;
398 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100399 int sort_what = 0;
400 int format_found = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401
Bram Moolenaar48c99162008-02-18 18:42:52 +0000402 /* Sorting one line is really quick! */
403 if (count <= 1)
404 return;
405
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000406 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
407 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000408 sortbuf1 = NULL;
409 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000410 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000411 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000412 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000413 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000414
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100415 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100416#ifdef FEAT_FLOAT
417 sort_flt = 0;
418#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000419
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000420 for (p = eap->arg; *p != NUL; ++p)
421 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100422 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000423 ;
424 else if (*p == 'i')
425 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000426 else if (*p == 'r')
427 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000428 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100429 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100430 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100431 ++format_found;
432 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100433#ifdef FEAT_FLOAT
434 else if (*p == 'f')
435 {
436 sort_flt = 1;
437 ++format_found;
438 }
439#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100440 else if (*p == 'b')
441 {
442 sort_what = STR2NR_BIN + STR2NR_FORCE;
443 ++format_found;
444 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000445 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100446 {
447 sort_what = STR2NR_OCT + STR2NR_FORCE;
448 ++format_found;
449 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000450 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100451 {
452 sort_what = STR2NR_HEX + STR2NR_FORCE;
453 ++format_found;
454 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000455 else if (*p == 'u')
456 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000457 else if (*p == '"') /* comment start */
458 break;
459 else if (check_nextcmd(p) != NULL)
460 {
461 eap->nextcmd = check_nextcmd(p);
462 break;
463 }
464 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000465 {
466 s = skip_regexp(p + 1, *p, TRUE, NULL);
467 if (*s != *p)
468 {
469 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000470 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000471 }
472 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000473 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100474 if (s == p + 1)
475 {
476 if (last_search_pat() == NULL)
477 {
478 EMSG(_(e_noprevre));
479 goto sortend;
480 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000481 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100482 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000483 else
484 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000485 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000486 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000487 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000488 regmatch.rm_ic = p_ic;
489 }
490 else
491 {
492 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000493 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000494 }
495 }
496
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100497 /* Can only have one of 'n', 'b', 'o' and 'x'. */
498 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000499 {
500 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000501 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 }
503
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100504 /* From here on "sort_nr" is used as a flag for any integer number
505 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100506 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000508 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000509 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000510 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000511 * When sorting on strings "start_col_nr" is the offset in the line, for
512 * numbers sorting it's the number to sort on. This means the pattern
513 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000514 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000515 */
516 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
517 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000518 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000519 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000520 if (maxlen < len)
521 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000522
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000523 start_col = 0;
524 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 {
527 if (sort_rx)
528 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000529 start_col = (colnr_T)(regmatch.startp[0] - s);
530 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000531 }
532 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000533 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000534 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000535 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000536 if (regmatch.regprog != NULL)
537 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000538
Bram Moolenaar937204a2016-01-30 23:37:38 +0100539 if (sort_nr
540#ifdef FEAT_FLOAT
541 || sort_flt
542#endif
543 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000544 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000545 /* Make sure vim_str2nr doesn't read any digits past the end
546 * of the match, by temporarily terminating the string there */
547 s2 = s + end_col;
548 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200549 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000550 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000551 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 if (sort_nr)
553 {
554 if (sort_what & STR2NR_HEX)
555 s = skiptohex(p);
556 else if (sort_what & STR2NR_BIN)
557 s = skiptobin(p);
558 else
559 s = skiptodigit(p);
560 if (s > p && s[-1] == '-')
561 --s; /* include preceding negative sign */
562 if (*s == NUL)
563 /* empty line should sort before any number */
564 nrs[lnum - eap->line1].st_u.value = -MAXLNUM;
565 else
566 vim_str2nr(s, NULL, NULL, sort_what,
567 &nrs[lnum - eap->line1].st_u.value, NULL, 0);
568 }
569#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000570 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100571 {
572 s = skipwhite(p);
573 if (*s == '+')
574 s = skipwhite(s + 1);
575
576 if (*s == NUL)
577 /* empty line should sort before any number */
578 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
579 else
580 nrs[lnum - eap->line1].st_u.value_flt =
581 strtod((char *)s, NULL);
582 }
583#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200584 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000585 }
586 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000587 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000588 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100589 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
590 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000591 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000592
593 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000594
595 if (regmatch.regprog != NULL)
596 fast_breakcheck();
597 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000598 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000599 }
600
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000601 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000602 sortbuf1 = alloc((unsigned)maxlen + 1);
603 if (sortbuf1 == NULL)
604 goto sortend;
605 sortbuf2 = alloc((unsigned)maxlen + 1);
606 if (sortbuf2 == NULL)
607 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000609 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000610 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000611
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000612 if (sort_abort)
613 goto sortend;
614
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000615 /* Insert the lines in the sorted order below the last one. */
616 lnum = eap->line2;
617 for (i = 0; i < count; ++i)
618 {
619 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
620 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000621 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000622 {
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100623 /* Copy the line into a buffer, it may become invalid in
624 * ml_append(). And it's needed for "unique". */
625 STRCPY(sortbuf1, s);
626 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000627 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000628 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000629 fast_breakcheck();
630 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000631 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000632 }
633
634 /* delete the original lines if appending worked */
635 if (i == count)
636 for (i = 0; i < count; ++i)
637 ml_delete(eap->line1, FALSE);
638 else
639 count = 0;
640
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000641 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000642 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000643 if (deleted > 0)
644 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
645 else if (deleted < 0)
646 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
647 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000648
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000649 curwin->w_cursor.lnum = eap->line1;
650 beginline(BL_WHITE | BL_FIX);
651
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000652sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000653 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000654 vim_free(sortbuf1);
655 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200656 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000657 if (got_int)
658 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000659}
660
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661/*
662 * ":retab".
663 */
664 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100665ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666{
667 linenr_T lnum;
668 int got_tab = FALSE;
669 long num_spaces = 0;
670 long num_tabs;
671 long len;
672 long col;
673 long vcol;
674 long start_col = 0; /* For start of white-space string */
675 long start_vcol = 0; /* For start of white-space string */
676 int temp;
677 long old_len;
678 char_u *ptr;
679 char_u *new_line = (char_u *)1; /* init to non-NULL */
680 int did_undo; /* called u_save for current line */
681 int new_ts;
682 int save_list;
683 linenr_T first_line = 0; /* first changed line */
684 linenr_T last_line = 0; /* last changed line */
685
686 save_list = curwin->w_p_list;
687 curwin->w_p_list = 0; /* don't want list mode here */
688
689 new_ts = getdigits(&(eap->arg));
690 if (new_ts < 0)
691 {
692 EMSG(_(e_positive));
693 return;
694 }
695 if (new_ts == 0)
696 new_ts = curbuf->b_p_ts;
697 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
698 {
699 ptr = ml_get(lnum);
700 col = 0;
701 vcol = 0;
702 did_undo = FALSE;
703 for (;;)
704 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100705 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 {
707 if (!got_tab && num_spaces == 0)
708 {
709 /* First consecutive white-space */
710 start_vcol = vcol;
711 start_col = col;
712 }
713 if (ptr[col] == ' ')
714 num_spaces++;
715 else
716 got_tab = TRUE;
717 }
718 else
719 {
720 if (got_tab || (eap->forceit && num_spaces > 1))
721 {
722 /* Retabulate this string of white-space */
723
724 /* len is virtual length of white string */
725 len = num_spaces = vcol - start_vcol;
726 num_tabs = 0;
727 if (!curbuf->b_p_et)
728 {
729 temp = new_ts - (start_vcol % new_ts);
730 if (num_spaces >= temp)
731 {
732 num_spaces -= temp;
733 num_tabs++;
734 }
735 num_tabs += num_spaces / new_ts;
736 num_spaces -= (num_spaces / new_ts) * new_ts;
737 }
738 if (curbuf->b_p_et || got_tab ||
739 (num_spaces + num_tabs < len))
740 {
741 if (did_undo == FALSE)
742 {
743 did_undo = TRUE;
744 if (u_save((linenr_T)(lnum - 1),
745 (linenr_T)(lnum + 1)) == FAIL)
746 {
747 new_line = NULL; /* flag out-of-memory */
748 break;
749 }
750 }
751
752 /* len is actual number of white characters used */
753 len = num_spaces + num_tabs;
754 old_len = (long)STRLEN(ptr);
755 new_line = lalloc(old_len - col + start_col + len + 1,
756 TRUE);
757 if (new_line == NULL)
758 break;
759 if (start_col > 0)
760 mch_memmove(new_line, ptr, (size_t)start_col);
761 mch_memmove(new_line + start_col + len,
762 ptr + col, (size_t)(old_len - col + 1));
763 ptr = new_line + start_col;
764 for (col = 0; col < len; col++)
765 ptr[col] = (col < num_tabs) ? '\t' : ' ';
766 ml_replace(lnum, new_line, FALSE);
767 if (first_line == 0)
768 first_line = lnum;
769 last_line = lnum;
770 ptr = new_line;
771 col = start_col + len;
772 }
773 }
774 got_tab = FALSE;
775 num_spaces = 0;
776 }
777 if (ptr[col] == NUL)
778 break;
779 vcol += chartabsize(ptr + col, (colnr_T)vcol);
780#ifdef FEAT_MBYTE
781 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000782 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 else
784#endif
785 ++col;
786 }
787 if (new_line == NULL) /* out of memory */
788 break;
789 line_breakcheck();
790 }
791 if (got_int)
792 EMSG(_(e_interr));
793
794 if (curbuf->b_p_ts != new_ts)
795 redraw_curbuf_later(NOT_VALID);
796 if (first_line != 0)
797 changed_lines(first_line, 0, last_line + 1, 0L);
798
799 curwin->w_p_list = save_list; /* restore 'list' */
800
801 curbuf->b_p_ts = new_ts;
802 coladvance(curwin->w_curswant);
803
804 u_clearline();
805}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807/*
808 * :move command - move lines line1-line2 to line dest
809 *
810 * return FAIL for failure, OK otherwise
811 */
812 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100813do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814{
815 char_u *str;
816 linenr_T l;
817 linenr_T extra; /* Num lines added before line1 */
818 linenr_T num_lines; /* Num lines moved */
819 linenr_T last_line; /* Last line in file after adding new text */
Bram Moolenaard5f69332015-04-15 12:43:50 +0200820#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100821 win_T *win;
822 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200823#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824
825 if (dest >= line1 && dest < line2)
826 {
827 EMSG(_("E134: Move lines into themselves"));
828 return FAIL;
829 }
830
831 num_lines = line2 - line1 + 1;
832
833 /*
834 * First we copy the old text to its new location -- webb
835 * Also copy the flag that ":global" command uses.
836 */
837 if (u_save(dest, dest + 1) == FAIL)
838 return FAIL;
839 for (extra = 0, l = line1; l <= line2; l++)
840 {
841 str = vim_strsave(ml_get(l + extra));
842 if (str != NULL)
843 {
844 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
845 vim_free(str);
846 if (dest < line1)
847 extra++;
848 }
849 }
850
851 /*
852 * Now we must be careful adjusting our marks so that we don't overlap our
853 * mark_adjust() calls.
854 *
855 * We adjust the marks within the old text so that they refer to the
856 * last lines of the file (temporarily), because we know no other marks
857 * will be set there since these line numbers did not exist until we added
858 * our new lines.
859 *
860 * Then we adjust the marks on lines between the old and new text positions
861 * (either forwards or backwards).
862 *
863 * And Finally we adjust the marks we put at the end of the file back to
864 * their final destination at the new text position -- webb
865 */
866 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100867 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000868 if (dest >= line2)
869 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100870 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
871#ifdef FEAT_FOLDING
872 FOR_ALL_TAB_WINDOWS(tp, win) {
873 if (win->w_buffer == curbuf)
874 foldMoveRange(&win->w_folds, line1, line2, dest);
875 }
876#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 curbuf->b_op_start.lnum = dest - num_lines + 1;
878 curbuf->b_op_end.lnum = dest;
879 }
880 else
881 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100882 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
883#ifdef FEAT_FOLDING
884 FOR_ALL_TAB_WINDOWS(tp, win) {
885 if (win->w_buffer == curbuf)
886 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
887 }
888#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 curbuf->b_op_start.lnum = dest + 1;
890 curbuf->b_op_end.lnum = dest + num_lines;
891 }
892 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100893 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894 -(last_line - dest - extra), 0L);
895
896 /*
897 * Now we delete the original text -- webb
898 */
899 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
900 return FAIL;
901
902 for (l = line1; l <= line2; l++)
903 ml_delete(line1 + extra, TRUE);
904
905 if (!global_busy && num_lines > p_report)
906 {
907 if (num_lines == 1)
908 MSG(_("1 line moved"));
909 else
910 smsg((char_u *)_("%ld lines moved"), num_lines);
911 }
912
913 /*
914 * Leave the cursor on the last of the moved lines.
915 */
916 if (dest >= line1)
917 curwin->w_cursor.lnum = dest;
918 else
919 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
920
921 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100922 {
923 dest += num_lines + 1;
924 last_line = curbuf->b_ml.ml_line_count;
925 if (dest > last_line + 1)
926 dest = last_line + 1;
927 changed_lines(line1, 0, dest, 0L);
928 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 else
930 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
931
932 return OK;
933}
934
935/*
936 * ":copy"
937 */
938 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100939ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940{
941 linenr_T count;
942 char_u *p;
943
944 count = line2 - line1 + 1;
945 curbuf->b_op_start.lnum = n + 1;
946 curbuf->b_op_end.lnum = n + count;
947 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
948
949 /*
950 * there are three situations:
951 * 1. destination is above line1
952 * 2. destination is between line1 and line2
953 * 3. destination is below line2
954 *
955 * n = destination (when starting)
956 * curwin->w_cursor.lnum = destination (while copying)
957 * line1 = start of source (while copying)
958 * line2 = end of source (while copying)
959 */
960 if (u_save(n, n + 1) == FAIL)
961 return;
962
963 curwin->w_cursor.lnum = n;
964 while (line1 <= line2)
965 {
966 /* need to use vim_strsave() because the line will be unlocked within
967 * ml_append() */
968 p = vim_strsave(ml_get(line1));
969 if (p != NULL)
970 {
971 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
972 vim_free(p);
973 }
974 /* situation 2: skip already copied lines */
975 if (line1 == n)
976 line1 = curwin->w_cursor.lnum;
977 ++line1;
978 if (curwin->w_cursor.lnum < line1)
979 ++line1;
980 if (curwin->w_cursor.lnum < line2)
981 ++line2;
982 ++curwin->w_cursor.lnum;
983 }
984
985 appended_lines_mark(n, count);
986
987 msgmore((long)count);
988}
989
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000990static char_u *prevcmd = NULL; /* the previous command */
991
992#if defined(EXITFREE) || defined(PROTO)
993 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100994free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000995{
996 vim_free(prevcmd);
997}
998#endif
999
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000/*
1001 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
1002 * Bangs in the argument are replaced with the previously entered command.
1003 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 */
1005 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001006do_bang(
1007 int addr_count,
1008 exarg_T *eap,
1009 int forceit,
1010 int do_in,
1011 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012{
1013 char_u *arg = eap->arg; /* command */
1014 linenr_T line1 = eap->line1; /* start of range */
1015 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 char_u *newcmd = NULL; /* the new command */
1017 int free_newcmd = FALSE; /* need to free() newcmd */
1018 int ins_prevcmd;
1019 char_u *t;
1020 char_u *p;
1021 char_u *trailarg;
1022 int len;
1023 int scroll_save = msg_scroll;
1024
1025 /*
1026 * Disallow shell commands for "rvim".
1027 * Disallow shell commands from .exrc and .vimrc in current directory for
1028 * security reasons.
1029 */
1030 if (check_restricted() || check_secure())
1031 return;
1032
1033 if (addr_count == 0) /* :! */
1034 {
1035 msg_scroll = FALSE; /* don't scroll here */
1036 autowrite_all();
1037 msg_scroll = scroll_save;
1038 }
1039
1040 /*
1041 * Try to find an embedded bang, like in :!<cmd> ! [args]
1042 * (:!! is indicated by the 'forceit' variable)
1043 */
1044 ins_prevcmd = forceit;
1045 trailarg = arg;
1046 do
1047 {
1048 len = (int)STRLEN(trailarg) + 1;
1049 if (newcmd != NULL)
1050 len += (int)STRLEN(newcmd);
1051 if (ins_prevcmd)
1052 {
1053 if (prevcmd == NULL)
1054 {
1055 EMSG(_(e_noprev));
1056 vim_free(newcmd);
1057 return;
1058 }
1059 len += (int)STRLEN(prevcmd);
1060 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001061 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 {
1063 vim_free(newcmd);
1064 return;
1065 }
1066 *t = NUL;
1067 if (newcmd != NULL)
1068 STRCAT(t, newcmd);
1069 if (ins_prevcmd)
1070 STRCAT(t, prevcmd);
1071 p = t + STRLEN(t);
1072 STRCAT(t, trailarg);
1073 vim_free(newcmd);
1074 newcmd = t;
1075
1076 /*
1077 * Scan the rest of the argument for '!', which is replaced by the
1078 * previous command. "\!" is replaced by "!" (this is vi compatible).
1079 */
1080 trailarg = NULL;
1081 while (*p)
1082 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001083 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 {
1085 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001086 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 else
1088 {
1089 trailarg = p;
1090 *trailarg++ = NUL;
1091 ins_prevcmd = TRUE;
1092 break;
1093 }
1094 }
1095 ++p;
1096 }
1097 } while (trailarg != NULL);
1098
1099 vim_free(prevcmd);
1100 prevcmd = newcmd;
1101
1102 if (bangredo) /* put cmd in redo buffer for ! command */
1103 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001104 /* If % or # appears in the command, it must have been escaped.
1105 * Reescape them, so that redoing them does not substitute them by the
1106 * buffername. */
1107 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1108
1109 if (cmd != NULL)
1110 {
1111 AppendToRedobuffLit(cmd, -1);
1112 vim_free(cmd);
1113 }
1114 else
1115 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 AppendToRedobuff((char_u *)"\n");
1117 bangredo = FALSE;
1118 }
1119 /*
1120 * Add quotes around the command, for shells that need them.
1121 */
1122 if (*p_shq != NUL)
1123 {
1124 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1125 if (newcmd == NULL)
1126 return;
1127 STRCPY(newcmd, p_shq);
1128 STRCAT(newcmd, prevcmd);
1129 STRCAT(newcmd, p_shq);
1130 free_newcmd = TRUE;
1131 }
1132 if (addr_count == 0) /* :! */
1133 {
1134 /* echo the command */
1135 msg_start();
1136 msg_putchar(':');
1137 msg_putchar('!');
1138 msg_outtrans(newcmd);
1139 msg_clr_eos();
1140 windgoto(msg_row, msg_col);
1141
1142 do_shell(newcmd, 0);
1143 }
1144 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001145 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 /* Careful: This may recursively call do_bang() again! (because of
1147 * autocommands) */
1148 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001149 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarade00832006-03-10 21:46:58 +00001150 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151 if (free_newcmd)
1152 vim_free(newcmd);
1153}
1154
1155/*
1156 * do_filter: filter lines through a command given by the user
1157 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001158 * We mostly use temp files and the call_shell() routine here. This would
1159 * normally be done using pipes on a UNIX machine, but this is more portable
1160 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 * to deal with redirection somehow, and should handle things like looking
1162 * at the PATH env. variable, and adding reasonable extensions to the
1163 * command name given by the user. All reasonable versions of call_shell()
1164 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001165 * Alternatively, if on Unix and redirecting input or output, but not both,
1166 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 * We use input redirection if do_in is TRUE.
1168 * We use output redirection if do_out is TRUE.
1169 */
1170 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001171do_filter(
1172 linenr_T line1,
1173 linenr_T line2,
1174 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1175 char_u *cmd,
1176 int do_in,
1177 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178{
1179 char_u *itmp = NULL;
1180 char_u *otmp = NULL;
1181 linenr_T linecount;
1182 linenr_T read_linecount;
1183 pos_T cursor_save;
1184 char_u *cmd_buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 buf_T *old_curbuf = curbuf;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001186 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187
1188 if (*cmd == NUL) /* no filter command */
1189 return;
1190
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191 cursor_save = curwin->w_cursor;
1192 linecount = line2 - line1 + 1;
1193 curwin->w_cursor.lnum = line1;
1194 curwin->w_cursor.col = 0;
1195 changed_line_abv_curs();
1196 invalidate_botline();
1197
1198 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001199 * When using temp files:
1200 * 1. * Form temp file names
1201 * 2. * Write the lines to a temp file
1202 * 3. Run the filter command on the temp file
1203 * 4. * Read the output of the command into the buffer
1204 * 5. * Delete the original lines to be filtered
1205 * 6. * Remove the temp files
1206 *
1207 * When writing the input with a pipe or when catching the output with a
1208 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 */
1210
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001211 if (do_out)
1212 shell_flags |= SHELL_DOOUT;
1213
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001214#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001215 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001217 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1218 shell_flags |= SHELL_READ;
1219 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001221 else if (do_in && !do_out && !p_stmp)
1222 {
1223 /* Use a pipe to write stdin of the command, do not use a temp file. */
1224 shell_flags |= SHELL_WRITE;
1225 curbuf->b_op_start.lnum = line1;
1226 curbuf->b_op_end.lnum = line2;
1227 }
1228 else if (do_in && do_out && !p_stmp)
1229 {
1230 /* Use a pipe to write stdin and fetch stdout of the command, do not
1231 * use a temp file. */
1232 shell_flags |= SHELL_READ|SHELL_WRITE;
1233 curbuf->b_op_start.lnum = line1;
1234 curbuf->b_op_end.lnum = line2;
1235 curwin->w_cursor.lnum = line2;
1236 }
1237 else
1238#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001239 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1240 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001241 {
1242 EMSG(_(e_notmp));
1243 goto filterend;
1244 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245
1246/*
1247 * The writing and reading of temp files will not be shown.
1248 * Vi also doesn't do this and the messages are not very informative.
1249 */
1250 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001251 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 FALSE, FALSE, FALSE, TRUE) == FAIL)
1253 {
1254 msg_putchar('\n'); /* keep message from buf_write() */
1255 --no_wait_return;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001256#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 if (!aborting())
1258#endif
1259 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1260 goto filterend;
1261 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 if (curbuf != old_curbuf)
1263 goto filterend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264
1265 if (!do_out)
1266 msg_putchar('\n');
1267
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001268 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1270 if (cmd_buf == NULL)
1271 goto filterend;
1272
1273 windgoto((int)Rows - 1, 0);
1274 cursor_on();
1275
1276 /*
1277 * When not redirecting the output the command can write anything to the
1278 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1279 * stderr output of external command. Clear the screen later.
1280 * If do_in is FALSE, this could be something like ":r !cat", which may
1281 * also mess up the screen, clear it later.
1282 */
1283 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1284 redraw_later_clear();
1285
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001286 if (do_out)
1287 {
1288 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001289 {
1290 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001291 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001292 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001293 redraw_curbuf_later(VALID);
1294 }
1295 read_linecount = curbuf->b_ml.ml_line_count;
1296
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 /*
1298 * When call_shell() fails wait_return() is called to give the user a
1299 * chance to read the error messages. Otherwise errors are ignored, so you
1300 * can see the error messages from the command that appear on stdout; use
1301 * 'u' to fix the text
1302 * Switch to cooked mode when not redirecting stdin, avoids that something
1303 * like ":r !cat" hangs.
1304 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1305 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001306 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 {
1308 redraw_later_clear();
1309 wait_return(FALSE);
1310 }
1311 vim_free(cmd_buf);
1312
1313 did_check_timestamps = FALSE;
1314 need_check_timestamps = TRUE;
1315
1316 /* When interrupting the shell command, it may still have produced some
1317 * useful output. Reset got_int here, so that readfile() won't cancel
1318 * reading. */
1319 ui_breakcheck();
1320 got_int = FALSE;
1321
1322 if (do_out)
1323 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001324 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001326 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001327 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001329#if defined(FEAT_EVAL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001330 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001332 {
1333 msg_putchar('\n');
1334 EMSG2(_(e_notread), otmp);
1335 }
1336 goto error;
1337 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001338 if (curbuf != old_curbuf)
1339 goto filterend;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001340 }
1341
1342 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1343
1344 if (shell_flags & SHELL_READ)
1345 {
1346 curbuf->b_op_start.lnum = line2 + 1;
1347 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1348 appended_lines_mark(line2, read_linecount);
1349 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
1351 if (do_in)
1352 {
1353 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1354 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 if (read_linecount >= linecount)
1356 /* move all marks from old lines to new lines */
1357 mark_adjust(line1, line2, linecount, 0L);
1358 else
1359 {
1360 /* move marks from old lines to new lines, delete marks
1361 * that are in deleted lines */
1362 mark_adjust(line1, line1 + read_linecount - 1,
1363 linecount, 0L);
1364 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1365 }
1366 }
1367
1368 /*
1369 * Put cursor on first filtered line for ":range!cmd".
1370 * Adjust '[ and '] (set by buf_write()).
1371 */
1372 curwin->w_cursor.lnum = line1;
1373 del_lines(linecount, TRUE);
1374 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1375 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1376 write_lnum_adjust(-linecount); /* adjust last line
1377 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001378#ifdef FEAT_FOLDING
1379 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1380#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 }
1382 else
1383 {
1384 /*
1385 * Put cursor on last new line for ":r !cmd".
1386 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001388 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001390
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1392 --no_wait_return;
1393
1394 if (linecount > p_report)
1395 {
1396 if (do_in)
1397 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001398 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1399 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001402 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 }
1404 else
1405 msgmore((long)linecount);
1406 }
1407 }
1408 else
1409 {
1410error:
1411 /* put cursor back in same position for ":w !cmd" */
1412 curwin->w_cursor = cursor_save;
1413 --no_wait_return;
1414 wait_return(FALSE);
1415 }
1416
1417filterend:
1418
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 if (curbuf != old_curbuf)
1420 {
1421 --no_wait_return;
1422 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1423 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 if (itmp != NULL)
1425 mch_remove(itmp);
1426 if (otmp != NULL)
1427 mch_remove(otmp);
1428 vim_free(itmp);
1429 vim_free(otmp);
1430}
1431
1432/*
1433 * Call a shell to execute a command.
1434 * When "cmd" is NULL start an interactive shell.
1435 */
1436 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001437do_shell(
1438 char_u *cmd,
1439 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440{
1441 buf_T *buf;
1442#ifndef FEAT_GUI_MSWIN
1443 int save_nwr;
1444#endif
1445#ifdef MSWIN
1446 int winstart = FALSE;
1447#endif
1448
1449 /*
1450 * Disallow shell commands for "rvim".
1451 * Disallow shell commands from .exrc and .vimrc in current directory for
1452 * security reasons.
1453 */
1454 if (check_restricted() || check_secure())
1455 {
1456 msg_end();
1457 return;
1458 }
1459
1460#ifdef MSWIN
1461 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 * Check if ":!start" is used.
1463 */
1464 if (cmd != NULL)
1465 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1466#endif
1467
1468 /*
1469 * For autocommands we want to get the output on the current screen, to
1470 * avoid having to type return below.
1471 */
1472 msg_putchar('\r'); /* put cursor at start of line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 if (!autocmd_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 {
1475#ifdef MSWIN
1476 if (!winstart)
1477#endif
1478 stoptermcap();
1479 }
1480#ifdef MSWIN
1481 if (!winstart)
1482#endif
1483 msg_putchar('\n'); /* may shift screen one line up */
1484
1485 /* warning message before calling the shell */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01001486 if (p_warn && !autocmd_busy && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001487 FOR_ALL_BUFFERS(buf)
Bram Moolenaarf405c8f2017-12-09 19:51:49 +01001488 if (bufIsChangedNotTerm(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 {
1490#ifdef FEAT_GUI_MSWIN
1491 if (!winstart)
1492 starttermcap(); /* don't want a message box here */
1493#endif
1494 MSG_PUTS(_("[No write since last change]\n"));
1495#ifdef FEAT_GUI_MSWIN
1496 if (!winstart)
1497 stoptermcap();
1498#endif
1499 break;
1500 }
1501
1502 /* This windgoto is required for when the '\n' resulted in a "delete line
1503 * 1" command to the terminal. */
1504 if (!swapping_screen())
1505 windgoto(msg_row, msg_col);
1506 cursor_on();
1507 (void)call_shell(cmd, SHELL_COOKED | flags);
1508 did_check_timestamps = FALSE;
1509 need_check_timestamps = TRUE;
1510
1511 /*
1512 * put the message cursor at the end of the screen, avoids wait_return()
1513 * to overwrite the text that the external command showed
1514 */
1515 if (!swapping_screen())
1516 {
1517 msg_row = Rows - 1;
1518 msg_col = 0;
1519 }
1520
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 if (autocmd_busy)
1522 {
1523 if (msg_silent == 0)
1524 redraw_later_clear();
1525 }
1526 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 {
1528 /*
1529 * For ":sh" there is no need to call wait_return(), just redraw.
1530 * Also for the Win32 GUI (the output is in a console window).
1531 * Otherwise there is probably text on the screen that the user wants
1532 * to read before redrawing, so call wait_return().
1533 */
1534#ifndef FEAT_GUI_MSWIN
1535 if (cmd == NULL
1536# ifdef WIN3264
1537 || (winstart && !need_wait_return)
1538# endif
1539 )
1540 {
1541 if (msg_silent == 0)
1542 redraw_later_clear();
1543 need_wait_return = FALSE;
1544 }
1545 else
1546 {
1547 /*
1548 * If we switch screens when starttermcap() is called, we really
1549 * want to wait for "hit return to continue".
1550 */
1551 save_nwr = no_wait_return;
1552 if (swapping_screen())
1553 no_wait_return = FALSE;
1554# ifdef AMIGA
1555 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1556# else
1557 wait_return(msg_silent == 0);
1558# endif
1559 no_wait_return = save_nwr;
1560 }
1561#endif /* FEAT_GUI_W32 */
1562
1563#ifdef MSWIN
1564 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1565#endif
1566 starttermcap(); /* start termcap if not done by wait_return() */
1567
1568 /*
1569 * In an Amiga window redrawing is caused by asking the window size.
1570 * If we got an interrupt this will not work. The chance that the
1571 * window size is wrong is very small, but we need to redraw the
1572 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1573 * but it saves an extra redraw.
1574 */
1575#ifdef AMIGA
1576 if (skip_redraw) /* ':' hit in wait_return() */
1577 {
1578 if (msg_silent == 0)
1579 redraw_later_clear();
1580 }
1581 else if (term_console)
1582 {
1583 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1584 if (got_int && msg_silent == 0)
1585 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1586 else
1587 must_redraw = 0; /* no extra redraw needed */
1588 }
1589#endif
1590 }
1591
1592 /* display any error messages now */
1593 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001594
Bram Moolenaarade00832006-03-10 21:46:58 +00001595 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596}
1597
1598/*
1599 * Create a shell command from a command string, input redirection file and
1600 * output redirection file.
1601 * Returns an allocated string with the shell command, or NULL for failure.
1602 */
1603 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001604make_filter_cmd(
1605 char_u *cmd, /* command */
1606 char_u *itmp, /* NULL or name of input file */
1607 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608{
1609 char_u *buf;
1610 long_u len;
1611
Bram Moolenaar53076832015-12-31 19:53:21 +01001612#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001613 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001614 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001615
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001616 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001617 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1618 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001619 if (is_fish_shell)
1620 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1621 else
1622#endif
1623 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 if (itmp != NULL)
1625 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1626 if (otmp != NULL)
1627 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1628 buf = lalloc(len, TRUE);
1629 if (buf == NULL)
1630 return NULL;
1631
Bram Moolenaar53076832015-12-31 19:53:21 +01001632#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001634 * Put braces around the command (for concatenated commands) when
1635 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001637 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001638 {
1639 if (is_fish_shell)
1640 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1641 else
1642 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1643 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001644 else
1645 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646 if (itmp != NULL)
1647 {
1648 STRCAT(buf, " < ");
1649 STRCAT(buf, itmp);
1650 }
1651#else
1652 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001653 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 * the use of commands in a pipe.
1655 */
1656 STRCPY(buf, cmd);
1657 if (itmp != NULL)
1658 {
1659 char_u *p;
1660
1661 /*
1662 * If there is a pipe, we have to put the '<' in front of it.
1663 * Don't do this when 'shellquote' is not empty, otherwise the
1664 * redirection would be inside the quotes.
1665 */
1666 if (*p_shq == NUL)
1667 {
1668 p = vim_strchr(buf, '|');
1669 if (p != NULL)
1670 *p = NUL;
1671 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1673 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 if (*p_shq == NUL)
1675 {
1676 p = vim_strchr(cmd, '|');
1677 if (p != NULL)
1678 {
1679 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1680 STRCAT(buf, p);
1681 }
1682 }
1683 }
1684#endif
1685 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001686 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687
1688 return buf;
1689}
1690
1691/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001692 * Append output redirection for file "fname" to the end of string buffer
1693 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 * Works with the 'shellredir' and 'shellpipe' options.
1695 * The caller should make sure that there is enough room:
1696 * STRLEN(opt) + STRLEN(fname) + 3
1697 */
1698 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001699append_redir(
1700 char_u *buf,
1701 int buflen,
1702 char_u *opt,
1703 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704{
1705 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001706 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001708 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001709 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001711 {
1712 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001714 if (p[1] == '%') /* skip %% */
1715 ++p;
1716 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 if (p != NULL)
1718 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001719 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1720 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1721 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 }
1723 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001724 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 " %s %s",
1727#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729#endif
1730 (char *)opt, (char *)fname);
1731}
1732
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001733#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001735static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001736static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001737static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001738static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739static int viminfo_errcnt;
1740
1741 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001742no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743{
1744 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001745 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746}
1747
1748/*
1749 * Report an error for reading a viminfo file.
1750 * Count the number of errors. When there are more than 10, return TRUE.
1751 */
1752 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001753viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001755 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1756 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001757 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001758 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1759 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 emsg(IObuff);
1761 if (++viminfo_errcnt >= 10)
1762 {
1763 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1764 return TRUE;
1765 }
1766 return FALSE;
1767}
1768
1769/*
1770 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001771 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 */
1773 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001774read_viminfo(
1775 char_u *file, /* file name or NULL to use default name */
1776 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777{
1778 FILE *fp;
1779 char_u *fname;
1780
1781 if (no_viminfo())
1782 return FAIL;
1783
Bram Moolenaard812df62008-11-09 12:46:09 +00001784 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 if (fname == NULL)
1786 return FAIL;
1787 fp = mch_fopen((char *)fname, READBIN);
1788
1789 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001790 {
1791 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001792 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1793 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001794 (flags & VIF_WANT_INFO) ? _(" info") : "",
1795 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1796 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001797 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001798 verbose_leave();
1799 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800
1801 vim_free(fname);
1802 if (fp == NULL)
1803 return FAIL;
1804
1805 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001806 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807
1808 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 return OK;
1810}
1811
1812/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001813 * Write the viminfo file. The old one is read in first so that effectively a
1814 * merge of current info and old info is done. This allows multiple vims to
1815 * run simultaneously, without losing any marks etc.
1816 * If "forceit" is TRUE, then the old file is not read in, and only internal
1817 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 */
1819 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001820write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821{
1822 char_u *fname;
1823 FILE *fp_in = NULL; /* input viminfo file, if any */
1824 FILE *fp_out = NULL; /* output viminfo file */
1825 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001826 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827#if defined(UNIX) || defined(VMS)
1828 mode_t umask_save;
1829#endif
1830#ifdef UNIX
1831 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001832 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001834#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001835 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001836#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837
1838 if (no_viminfo())
1839 return;
1840
1841 fname = viminfo_filename(file); /* may set to default if NULL */
1842 if (fname == NULL)
1843 return;
1844
1845 fp_in = mch_fopen((char *)fname, READBIN);
1846 if (fp_in == NULL)
1847 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001848 int fd;
1849
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 /* if it does exist, but we can't read it, don't try writing */
1851 if (mch_stat((char *)fname, &st_new) == 0)
1852 goto end;
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001853
1854 /* Create the new .viminfo non-accessible for others, because it may
1855 * contain text from non-accessible documents. It is up to the user to
1856 * widen access (e.g. to a group). This may also fail if there is a
1857 * race condition, then just give up. */
1858 fd = mch_open((char *)fname,
1859 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1860 if (fd < 0)
1861 goto end;
1862 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 }
1864 else
1865 {
1866 /*
1867 * There is an existing viminfo file. Create a temporary file to
1868 * write the new viminfo into, in the same directory as the
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001869 * existing viminfo file, which will be renamed once all writing is
1870 * successful.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 */
1872#ifdef UNIX
1873 /*
1874 * For Unix we check the owner of the file. It's not very nice to
1875 * overwrite a user's viminfo file after a "su root", with a
1876 * viminfo file that the user can't read.
1877 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001878 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001879 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001881 if (mch_stat((char *)fname, &st_old) == 0
1882 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001883 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 ? (st_old.st_mode & 0200)
1885 : (st_old.st_gid == getgid()
1886 ? (st_old.st_mode & 0020)
1887 : (st_old.st_mode & 0002))))
1888 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001889 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
1891 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1893 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001894 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 goto end;
1896 }
1897#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001898#ifdef WIN3264
1899 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001900 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001901#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902
1903 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001904 * Make tempname, find one that does not exist yet.
1905 * Beware of a race condition: If someone logs out and all Vim
1906 * instances exit at the same time a temp file might be created between
1907 * stat() and open(). Use mch_open() with O_EXCL to avoid that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 * May try twice: Once normal and once with shortname set, just in
1909 * case somebody puts his viminfo file in an 8.3 filesystem.
1910 */
1911 for (;;)
1912 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001913 int next_char = 'z';
1914 char_u *wp;
1915
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 tempname = buf_modname(
1917#ifdef UNIX
1918 shortname,
1919#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921#endif
1922 fname,
1923#ifdef VMS
1924 (char_u *)"-tmp",
1925#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927#endif
1928 FALSE);
1929 if (tempname == NULL) /* out of memory */
1930 break;
1931
1932 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001933 * Try a series of names. Change one character, just before
1934 * the extension. This should also work for an 8.3
1935 * file name, when after adding the extension it still is
1936 * the same file as the original.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001938 wp = tempname + STRLEN(tempname) - 5;
1939 if (wp < gettail(tempname)) /* empty file name? */
1940 wp = gettail(tempname);
1941 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001943 /*
1944 * Check if tempfile already exists. Never overwrite an
1945 * existing file!
1946 */
1947 if (mch_stat((char *)tempname, &st_new) == 0)
1948 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949#ifdef UNIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 /*
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001951 * Check if tempfile is same as original file. May happen
1952 * when modname() gave the same file back. E.g. silly
1953 * link, or file name-length reached. Try again with
1954 * shortname set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001956 if (!shortname && st_new.st_dev == st_old.st_dev
1957 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 {
Bram Moolenaard23a8232018-02-10 18:45:26 +01001959 VIM_CLEAR(tempname);
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001960 shortname = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 break;
1962 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001963#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01001965 else
1966 {
1967 /* Try creating the file exclusively. This may fail if
1968 * another Vim tries to do it at the same time. */
1969#ifdef VMS
1970 /* fdopen() fails for some reason */
1971 umask_save = umask(077);
1972 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1973 (void)umask(umask_save);
1974#else
1975 int fd;
1976
1977 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1978 * protection:
1979 * Unix: same as original file, but strip s-bit. Reset
1980 * umask to avoid it getting in the way.
1981 * Others: r&w for user only. */
1982# ifdef UNIX
1983 umask_save = umask(0);
1984 fd = mch_open((char *)tempname,
1985 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1986 (int)((st_old.st_mode & 0777) | 0600));
1987 (void)umask(umask_save);
1988# else
1989 fd = mch_open((char *)tempname,
1990 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1991# endif
1992 if (fd < 0)
1993 {
1994 fp_out = NULL;
1995# ifdef EEXIST
1996 /* Avoid trying lots of names while the problem is lack
1997 * of premission, only retry if the file already
1998 * exists. */
1999 if (errno != EEXIST)
2000 break;
2001# endif
2002 }
2003 else
2004 fp_out = fdopen(fd, WRITEBIN);
2005#endif /* VMS */
2006 if (fp_out != NULL)
2007 break;
2008 }
2009
2010 /* Assume file exists, try again with another name. */
2011 if (next_char == 'a' - 1)
2012 {
2013 /* They all exist? Must be something wrong! Don't write
2014 * the viminfo file then. */
2015 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
2016 tempname);
2017 break;
2018 }
2019 *wp = next_char;
2020 --next_char;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002022
2023 if (tempname != NULL)
2024 break;
2025 /* continue if shortname was set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 }
2027
Bram Moolenaara5792f52005-11-23 21:25:05 +00002028#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002029 if (tempname != NULL && fp_out != NULL)
2030 {
2031 stat_T tmp_st;
2032
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 /*
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002034 * Make sure the original owner can read/write the tempfile and
2035 * otherwise preserve permissions, making sure the group matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 */
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002037 if (mch_stat((char *)tempname, &tmp_st) >= 0)
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002038 {
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002039 if (st_old.st_uid != tmp_st.st_uid)
2040 /* Changing the owner might fail, in which case the
2041 * file will now owned by the current user, oh well. */
2042 ignored = fchown(fileno(fp_out), st_old.st_uid, -1);
2043 if (st_old.st_gid != tmp_st.st_gid
2044 && fchown(fileno(fp_out), -1, st_old.st_gid) == -1)
2045 /* can't set the group to what it should be, remove
2046 * group permissions */
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01002047 (void)mch_setperm(tempname, 0600);
2048 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002049 else
2050 /* can't stat the file, set conservative permissions */
2051 (void)mch_setperm(tempname, 0600);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 }
Bram Moolenaarc41838a2017-11-26 16:50:41 +01002053#endif
Bram Moolenaare0aa23f2017-11-26 17:08:03 +01002054 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055
2056 /*
2057 * Check if the new viminfo file can be written to.
2058 */
2059 if (fp_out == NULL)
2060 {
2061 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002062 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 if (fp_in != NULL)
2064 fclose(fp_in);
2065 goto end;
2066 }
2067
2068 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002069 {
2070 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002071 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002072 verbose_leave();
2073 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074
2075 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002076 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077
Bram Moolenaar927030a2016-03-15 18:23:55 +01002078 if (fclose(fp_out) == EOF)
2079 ++viminfo_errcnt;
2080
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 if (fp_in != NULL)
2082 {
2083 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002084
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002085 /* In case of an error keep the original viminfo file. Otherwise
2086 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002087 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002088 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002089 if (vim_rename(tempname, fname) == -1)
2090 {
2091 ++viminfo_errcnt;
2092 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2093 }
2094# ifdef WIN3264
2095 /* If the viminfo file was hidden then also hide the new file. */
2096 else if (hidden)
2097 mch_hide(fname);
2098# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002099 }
2100 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 mch_remove(tempname);
2102 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002103
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104end:
2105 vim_free(fname);
2106 vim_free(tempname);
2107}
2108
2109/*
2110 * Get the viminfo file name to use.
2111 * If "file" is given and not empty, use it (has already been expanded by
2112 * cmdline functions).
2113 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2114 * expand environment variables.
2115 * Returns an allocated string. NULL when out of memory.
2116 */
2117 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002118viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119{
2120 if (file == NULL || *file == NUL)
2121 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002122 if (*p_viminfofile != NUL)
2123 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2125 {
2126#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127# ifdef VMS
2128 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2129# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002130# ifdef MSWIN
2131 /* Use $VIM only if $HOME is the default "C:/". */
2132 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2133 && mch_getenv((char_u *)"HOME") == NULL)
2134# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002136# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137# endif
2138 {
2139 /* don't use $VIM when not available. */
2140 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2141 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2142 file = (char_u *)VIMINFO_FILE2;
2143 else
2144 file = (char_u *)VIMINFO_FILE;
2145 }
2146 else
2147#endif
2148 file = (char_u *)VIMINFO_FILE;
2149 }
2150 expand_env(file, NameBuff, MAXPATHL);
2151 file = NameBuff;
2152 }
2153 return vim_strsave(file);
2154}
2155
2156/*
2157 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2158 */
2159 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002160do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 int eof = FALSE;
2163 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002164 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002165 int do_copy_marks = FALSE;
2166 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167
2168 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2169 return;
2170 vir.vir_fd = fp_in;
2171#ifdef FEAT_MBYTE
2172 vir.vir_conv.vc_type = CONV_NONE;
2173#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002174 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002175 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176
2177 if (fp_in != NULL)
2178 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002179 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002180 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002181 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002182 {
2183 /* Registers and marks are read and kept separate from what
2184 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002185 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002186 prepare_viminfo_marks();
2187 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002188
Bram Moolenaard812df62008-11-09 12:46:09 +00002189 eof = read_viminfo_up_to_marks(&vir,
2190 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002191 merge = TRUE;
2192 }
2193 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 /* Skip info, find start of marks */
2195 while (!(eof = viminfo_readline(&vir))
2196 && vir.vir_line[0] != '>')
2197 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002198
2199 do_copy_marks = (flags &
2200 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002202
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 if (fp_out != NULL)
2204 {
2205 /* Write the info: */
2206 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2207 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002208 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002209 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002211 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2213#endif
2214 write_viminfo_search_pattern(fp_out);
2215 write_viminfo_sub_string(fp_out);
2216#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002217 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218#endif
2219 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002220 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221#ifdef FEAT_EVAL
2222 write_viminfo_varlist(fp_out);
2223#endif
2224 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002225 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002227 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002228
2229 if (do_copy_marks)
2230 ga_init2(&buflist, sizeof(buf_T *), 50);
2231 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002233
2234 if (do_copy_marks)
2235 {
2236 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2237 if (fp_out != NULL)
2238 ga_clear(&buflist);
2239 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240
2241 vim_free(vir.vir_line);
2242#ifdef FEAT_MBYTE
2243 if (vir.vir_conv.vc_type != CONV_NONE)
2244 convert_setup(&vir.vir_conv, NULL, NULL);
2245#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002246 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247}
2248
2249/*
2250 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2251 * first part of the viminfo file which contains everything but the marks that
2252 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2253 */
2254 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002255read_viminfo_up_to_marks(
2256 vir_T *virp,
2257 int forceit,
2258 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259{
2260 int eof;
2261 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002262 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263
2264#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002265 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002267
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 eof = viminfo_readline(virp);
2269 while (!eof && virp->vir_line[0] != '>')
2270 {
2271 switch (virp->vir_line[0])
2272 {
2273 /* Characters reserved for future expansion, ignored now */
2274 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 case '^': /* to be defined */
2276 case '<': /* long line - ignored */
2277 /* A comment or empty line. */
2278 case NUL:
2279 case '\r':
2280 case '\n':
2281 case '#':
2282 eof = viminfo_readline(virp);
2283 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002284 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002285 eof = read_viminfo_barline(virp, got_encoding,
2286 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002287 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002289 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 eof = viminfo_encoding(virp);
2291 break;
2292 case '!': /* global variable */
2293#ifdef FEAT_EVAL
2294 eof = read_viminfo_varlist(virp, writing);
2295#else
2296 eof = viminfo_readline(virp);
2297#endif
2298 break;
2299 case '%': /* entry for buffer list */
2300 eof = read_viminfo_bufferlist(virp, writing);
2301 break;
2302 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002303 /* When registers are in bar lines skip the old style register
2304 * lines. */
2305 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2306 eof = read_viminfo_register(virp, forceit);
2307 else
2308 do {
2309 eof = viminfo_readline(virp);
2310 } while (!eof && (virp->vir_line[0] == TAB
2311 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 break;
2313 case '/': /* Search string */
2314 case '&': /* Substitute search string */
2315 case '~': /* Last search string, followed by '/' or '&' */
2316 eof = read_viminfo_search_pattern(virp, forceit);
2317 break;
2318 case '$':
2319 eof = read_viminfo_sub_string(virp, forceit);
2320 break;
2321 case ':':
2322 case '?':
2323 case '=':
2324 case '@':
2325#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002326 /* When history is in bar lines skip the old style history
2327 * lines. */
2328 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2329 eof = read_viminfo_history(virp, writing);
2330 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002332 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 break;
2334 case '-':
2335 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002336 /* When file marks are in bar lines skip the old style lines. */
2337 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2338 eof = read_viminfo_filemark(virp, forceit);
2339 else
2340 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 break;
2342 default:
2343 if (viminfo_error("E575: ", _("Illegal starting char"),
2344 virp->vir_line))
2345 eof = TRUE;
2346 else
2347 eof = viminfo_readline(virp);
2348 break;
2349 }
2350 }
2351
2352#ifdef FEAT_CMDHIST
2353 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002354 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002355 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356#endif
2357
2358 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002359 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 fmarks_check_names(buf);
2361
2362 return eof;
2363}
2364
2365/*
2366 * Compare the 'encoding' value in the viminfo file with the current value of
2367 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2368 * conversion of text with iconv() in viminfo_readstring().
2369 */
2370 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002371viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372{
2373#ifdef FEAT_MBYTE
2374 char_u *p;
2375 int i;
2376
2377 if (get_viminfo_parameter('c') != 0)
2378 {
2379 p = vim_strchr(virp->vir_line, '=');
2380 if (p != NULL)
2381 {
2382 /* remove trailing newline */
2383 ++p;
2384 for (i = 0; vim_isprintc(p[i]); ++i)
2385 ;
2386 p[i] = NUL;
2387
2388 convert_setup(&virp->vir_conv, p, p_enc);
2389 }
2390 }
2391#endif
2392 return viminfo_readline(virp);
2393}
2394
2395/*
2396 * Read a line from the viminfo file.
2397 * Returns TRUE for end-of-file;
2398 */
2399 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002400viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401{
2402 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2403}
2404
2405/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002406 * Check string read from viminfo file.
2407 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 * - replace CTRL-V CTRL-V with CTRL-V
2409 * - replace CTRL-V 'n' with '\n'
2410 *
2411 * Check for a long line as written by viminfo_writestring().
2412 *
2413 * Return the string in allocated memory (NULL when out of memory).
2414 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002416viminfo_readstring(
2417 vir_T *virp,
2418 int off, /* offset for virp->vir_line */
2419 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420{
2421 char_u *retval;
2422 char_u *s, *d;
2423 long len;
2424
2425 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2426 {
2427 len = atol((char *)virp->vir_line + off + 1);
2428 retval = lalloc(len, TRUE);
2429 if (retval == NULL)
2430 {
2431 /* Line too long? File messed up? Skip next line. */
2432 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2433 return NULL;
2434 }
2435 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2436 s = retval + 1; /* Skip the leading '<' */
2437 }
2438 else
2439 {
2440 retval = vim_strsave(virp->vir_line + off);
2441 if (retval == NULL)
2442 return NULL;
2443 s = retval;
2444 }
2445
2446 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2447 d = retval;
2448 while (*s != NUL && *s != '\n')
2449 {
2450 if (s[0] == Ctrl_V && s[1] != NUL)
2451 {
2452 if (s[1] == 'n')
2453 *d++ = '\n';
2454 else
2455 *d++ = Ctrl_V;
2456 s += 2;
2457 }
2458 else
2459 *d++ = *s++;
2460 }
2461 *d = NUL;
2462
2463#ifdef FEAT_MBYTE
2464 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2465 {
2466 d = string_convert(&virp->vir_conv, retval, NULL);
2467 if (d != NULL)
2468 {
2469 vim_free(retval);
2470 retval = d;
2471 }
2472 }
2473#endif
2474
2475 return retval;
2476}
2477
2478/*
2479 * write string to viminfo file
2480 * - replace CTRL-V with CTRL-V CTRL-V
2481 * - replace '\n' with CTRL-V 'n'
2482 * - add a '\n' at the end
2483 *
2484 * For a long line:
2485 * - write " CTRL-V <length> \n " in first line
2486 * - write " < <string> \n " in second line
2487 */
2488 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002489viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490{
2491 int c;
2492 char_u *s;
2493 int len = 0;
2494
2495 for (s = p; *s != NUL; ++s)
2496 {
2497 if (*s == Ctrl_V || *s == '\n')
2498 ++len;
2499 ++len;
2500 }
2501
2502 /* If the string will be too long, write its length and put it in the next
2503 * line. Take into account that some room is needed for what comes before
2504 * the string (e.g., variable name). Add something to the length for the
2505 * '<', NL and trailing NUL. */
2506 if (len > LSIZE / 2)
2507 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2508
2509 while ((c = *p++) != NUL)
2510 {
2511 if (c == Ctrl_V || c == '\n')
2512 {
2513 putc(Ctrl_V, fd);
2514 if (c == '\n')
2515 c = 'n';
2516 }
2517 putc(c, fd);
2518 }
2519 putc('\n', fd);
2520}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002521
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002522/*
2523 * Write a string in quotes that barline_parse() can read back.
2524 * Breaks the line in less than LSIZE pieces when needed.
2525 * Returns remaining characters in the line.
2526 */
2527 int
2528barline_writestring(FILE *fd, char_u *s, int remaining_start)
2529{
2530 char_u *p;
2531 int remaining = remaining_start;
2532 int len = 2;
2533
2534 /* Count the number of characters produced, including quotes. */
2535 for (p = s; *p != NUL; ++p)
2536 {
2537 if (*p == NL)
2538 len += 2;
2539 else if (*p == '"' || *p == '\\')
2540 len += 2;
2541 else
2542 ++len;
2543 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002544 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002545 {
2546 fprintf(fd, ">%d\n|<", len);
2547 remaining = LSIZE - 20;
2548 }
2549
2550 putc('"', fd);
2551 for (p = s; *p != NUL; ++p)
2552 {
2553 if (*p == NL)
2554 {
2555 putc('\\', fd);
2556 putc('n', fd);
2557 --remaining;
2558 }
2559 else if (*p == '"' || *p == '\\')
2560 {
2561 putc('\\', fd);
2562 putc(*p, fd);
2563 --remaining;
2564 }
2565 else
2566 putc(*p, fd);
2567 --remaining;
2568
2569 if (remaining < 3)
2570 {
2571 putc('\n', fd);
2572 putc('|', fd);
2573 putc('<', fd);
2574 /* Leave enough space for another continuation. */
2575 remaining = LSIZE - 20;
2576 }
2577 }
2578 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002579 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002580}
2581
2582/*
2583 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002584 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002585 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002586 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002587 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002588barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002589{
2590 char_u *p = text;
2591 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002592 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002593 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002594 int i;
2595 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002596 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002597#ifdef FEAT_MBYTE
2598 char_u *sconv;
2599 int converted;
2600#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002601
2602 while (*p == ',')
2603 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002604 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002605 if (ga_grow(values, 1) == FAIL)
2606 break;
2607 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002608
2609 if (*p == '>')
2610 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002611 /* Need to read a continuation line. Put strings in allocated
2612 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002613 if (!allocated)
2614 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002615 for (i = 0; i < values->ga_len; ++i)
2616 {
2617 bval_T *vp = (bval_T *)(values->ga_data) + i;
2618
2619 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002620 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002621 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2622 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002623 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002624 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002625 allocated = TRUE;
2626 }
2627
2628 if (vim_isdigit(p[1]))
2629 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002630 size_t len;
2631 size_t todo;
2632 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002633
2634 /* String value was split into lines that are each shorter
2635 * than LSIZE:
2636 * |{bartype},>{length of "{text}{text2}"}
2637 * |<"{text1}
2638 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002639 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002640 */
2641 ++p;
2642 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002643 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002644 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002645 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002646 p = buf;
2647 for (todo = len; todo > 0; todo -= n)
2648 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002649 eof = viminfo_readline(virp);
2650 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002651 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002652 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002653 /* File was truncated or garbled. Read another line if
2654 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002655 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002656 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002657 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002658 /* Get length of text, excluding |< and NL chars. */
2659 n = STRLEN(virp->vir_line);
2660 while (n > 0 && (virp->vir_line[n - 1] == NL
2661 || virp->vir_line[n - 1] == CAR))
2662 --n;
2663 n -= 2;
2664 if (n > todo)
2665 {
2666 /* more values follow after the string */
2667 nextp = virp->vir_line + 2 + todo;
2668 n = todo;
2669 }
2670 mch_memmove(p, virp->vir_line + 2, n);
2671 p += n;
2672 }
2673 *p = NUL;
2674 p = buf;
2675 }
2676 else
2677 {
2678 /* Line ending in ">" continues in the next line:
2679 * |{bartype},{lots of values},>
2680 * |<{value},{value}
2681 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002682 eof = viminfo_readline(virp);
2683 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002684 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002685 /* File was truncated or garbled. Read another line if
2686 * this one starts with '|'. */
2687 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002688 p = virp->vir_line + 2;
2689 }
2690 }
2691
2692 if (isdigit(*p))
2693 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002694 value->bv_type = BVAL_NR;
2695 value->bv_nr = getdigits(&p);
2696 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002697 }
2698 else if (*p == '"')
2699 {
2700 int len = 0;
2701 char_u *s = p;
2702
2703 /* Unescape special characters in-place. */
2704 ++p;
2705 while (*p != '"')
2706 {
2707 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002708 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002709 if (*p == '\\')
2710 {
2711 ++p;
2712 if (*p == 'n')
2713 s[len++] = '\n';
2714 else
2715 s[len++] = *p;
2716 ++p;
2717 }
2718 else
2719 s[len++] = *p++;
2720 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002721 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002722 s[len] = NUL;
2723
Bram Moolenaar01227092016-06-11 14:47:40 +02002724#ifdef FEAT_MBYTE
2725 converted = FALSE;
2726 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2727 {
2728 sconv = string_convert(&virp->vir_conv, s, NULL);
2729 if (sconv != NULL)
2730 {
2731 if (s == buf)
2732 vim_free(s);
2733 s = sconv;
2734 buf = s;
2735 converted = TRUE;
2736 }
2737 }
2738#endif
2739 /* Need to copy in allocated memory if the string wasn't allocated
2740 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002741 if (s != buf && allocated)
2742 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002743 value->bv_string = s;
2744 value->bv_type = BVAL_STRING;
2745 value->bv_len = len;
2746 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002747#ifdef FEAT_MBYTE
2748 || converted
2749#endif
2750 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002751 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002752 if (nextp != NULL)
2753 {
2754 /* values following a long string */
2755 p = nextp;
2756 nextp = NULL;
2757 }
2758 }
2759 else if (*p == ',')
2760 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002761 value->bv_type = BVAL_EMPTY;
2762 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002763 }
2764 else
2765 break;
2766 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002767 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002768}
2769
2770 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002771read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002772{
2773 char_u *p = virp->vir_line + 1;
2774 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002775 garray_T values;
2776 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002777 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002778 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002779
2780 /* The format is: |{bartype},{value},...
2781 * For a very long string:
2782 * |{bartype},>{length of "{text}{text2}"}
2783 * |<{text1}
2784 * |<{text2},{value}
2785 * For a long line not using a string
2786 * |{bartype},{lots of values},>
2787 * |<{value},{value}
2788 */
2789 if (*p == '<')
2790 {
2791 /* Continuation line of an unrecognized item. */
2792 if (writing)
2793 ga_add_string(&virp->vir_barlines, virp->vir_line);
2794 }
2795 else
2796 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002797 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002798 bartype = getdigits(&p);
2799 switch (bartype)
2800 {
2801 case BARTYPE_VERSION:
2802 /* Only use the version when it comes before the encoding.
2803 * If it comes later it was copied by a Vim version that
2804 * doesn't understand the version. */
2805 if (!got_encoding)
2806 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002807 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002808 vp = (bval_T *)values.ga_data;
2809 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2810 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002811 }
2812 break;
2813
2814 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002815 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002816 handle_viminfo_history(&values, writing);
2817 break;
2818
2819 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002820 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002821 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002822 break;
2823
Bram Moolenaar2d358992016-06-12 21:20:54 +02002824 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002825 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002826 handle_viminfo_mark(&values, force);
2827 break;
2828
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002829 default:
2830 /* copy unrecognized line (for future use) */
2831 if (writing)
2832 ga_add_string(&virp->vir_barlines, virp->vir_line);
2833 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002834 for (i = 0; i < values.ga_len; ++i)
2835 {
2836 vp = (bval_T *)values.ga_data + i;
2837 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2838 vim_free(vp->bv_string);
2839 }
2840 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002841 }
2842
Bram Moolenaarecefe712016-06-20 12:50:17 +02002843 if (read_next)
2844 return viminfo_readline(virp);
2845 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002846}
2847
2848 static void
2849write_viminfo_version(FILE *fp_out)
2850{
2851 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2852 BARTYPE_VERSION, VIMINFO_VERSION);
2853}
2854
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002855 static void
2856write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2857{
2858 int i;
2859 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002860 int seen_useful = FALSE;
2861 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002862
2863 if (gap->ga_len > 0)
2864 {
2865 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2866
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002867 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002868 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002869 {
2870 line = ((char **)(gap->ga_data))[i];
2871 if (seen_useful || line[1] != '<')
2872 {
2873 fputs(line, fp_out);
2874 seen_useful = TRUE;
2875 }
2876 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002877 }
2878}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879#endif /* FEAT_VIMINFO */
2880
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002881/*
2882 * Return the current time in seconds. Calls time(), unless test_settime()
2883 * was used.
2884 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002885 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002886vim_time(void)
2887{
2888# ifdef FEAT_EVAL
2889 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2890# else
2891 return time(NULL);
2892# endif
2893}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895/*
2896 * Implementation of ":fixdel", also used by get_stty().
2897 * <BS> resulting <Del>
2898 * ^? ^H
2899 * not ^? ^?
2900 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002902do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903{
2904 char_u *p;
2905
2906 p = find_termcode((char_u *)"kb");
2907 add_termcode((char_u *)"kD", p != NULL
2908 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2909}
2910
2911 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002912print_line_no_prefix(
2913 linenr_T lnum,
2914 int use_number,
2915 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002917 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918
2919 if (curwin->w_p_nu || use_number)
2920 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002921 vim_snprintf((char *)numbuf, sizeof(numbuf),
2922 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01002923 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002925 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926}
2927
2928/*
2929 * Print a text line. Also in silent mode ("ex -s").
2930 */
2931 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002932print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933{
2934 int save_silent = silent_mode;
2935
Bram Moolenaard29459b2016-08-26 22:29:11 +02002936 /* apply :filter /pat/ */
2937 if (message_filtered(ml_get(lnum)))
2938 return;
2939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002941 silent_mode = FALSE;
2942 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2943 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 if (save_silent)
2945 {
2946 msg_putchar('\n');
2947 cursor_on(); /* msg_start() switches it off */
2948 out_flush();
2949 silent_mode = save_silent;
2950 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002951 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952}
2953
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002954 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002955rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002956{
2957 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002958 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002959
Bram Moolenaar7e283842013-05-30 11:43:15 +02002960 buf = curbuf;
2961 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002962 /* buffer changed, don't change name now */
2963 if (buf != curbuf)
2964 return FAIL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002965#ifdef FEAT_EVAL
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002966 if (aborting()) /* autocmds may abort script processing */
2967 return FAIL;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002968#endif
2969 /*
2970 * The name of the current buffer will be changed.
2971 * A new (unlisted) buffer entry needs to be made to hold the old file
2972 * name, which will become the alternate file name.
2973 * But don't set the alternate file name if the buffer didn't have a
2974 * name.
2975 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002976 fname = curbuf->b_ffname;
2977 sfname = curbuf->b_sfname;
2978 xfname = curbuf->b_fname;
2979 curbuf->b_ffname = NULL;
2980 curbuf->b_sfname = NULL;
2981 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002982 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002983 curbuf->b_ffname = fname;
2984 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002985 return FAIL;
2986 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002987 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002988 if (xfname != NULL && *xfname != NUL)
2989 {
2990 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2991 if (buf != NULL && !cmdmod.keepalt)
2992 curwin->w_alt_fnum = buf->b_fnum;
2993 }
2994 vim_free(fname);
2995 vim_free(sfname);
Bram Moolenaar7e283842013-05-30 11:43:15 +02002996 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002997
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002998 /* Change directories when the 'acd' option is set. */
2999 DO_AUTOCHDIR
3000 return OK;
3001}
3002
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003/*
3004 * ":file[!] [fname]".
3005 */
3006 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003007ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00003009 /* ":0file" removes the file name. Check for illegal uses ":3file",
3010 * "0file name", etc. */
3011 if (eap->addr_count > 0
3012 && (*eap->arg != NUL
3013 || eap->line2 > 0
3014 || eap->addr_count > 1))
3015 {
3016 EMSG(_(e_invarg));
3017 return;
3018 }
3019
3020 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003022 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 }
3025 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01003026 if (!shortmess(SHM_FILEINFO))
3027 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar6ce65042017-10-24 22:32:59 +02003028 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029}
3030
3031/*
3032 * ":update".
3033 */
3034 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003035ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036{
3037 if (curbufIsChanged())
3038 (void)do_write(eap);
3039}
3040
3041/*
3042 * ":write" and ":saveas".
3043 */
3044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003045ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046{
3047 if (eap->usefilter) /* input lines to shell command */
3048 do_bang(1, eap, FALSE, TRUE, FALSE);
3049 else
3050 (void)do_write(eap);
3051}
3052
3053/*
3054 * write current buffer to file 'eap->arg'
3055 * if 'eap->append' is TRUE, append to the file
3056 *
3057 * if *eap->arg == NUL write to current file
3058 *
3059 * return FAIL for failure, OK otherwise
3060 */
3061 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003062do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063{
3064 int other;
3065 char_u *fname = NULL; /* init to shut up gcc */
3066 char_u *ffname;
3067 int retval = FAIL;
3068 char_u *free_fname = NULL;
3069#ifdef FEAT_BROWSE
3070 char_u *browse_file = NULL;
3071#endif
3072 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003073 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074
3075 if (not_writing()) /* check 'write' option */
3076 return FAIL;
3077
3078 ffname = eap->arg;
3079#ifdef FEAT_BROWSE
3080 if (cmdmod.browse)
3081 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003082 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 NULL, NULL, NULL, curbuf);
3084 if (browse_file == NULL)
3085 goto theend;
3086 ffname = browse_file;
3087 }
3088#endif
3089 if (*ffname == NUL)
3090 {
3091 if (eap->cmdidx == CMD_saveas)
3092 {
3093 EMSG(_(e_argreq));
3094 goto theend;
3095 }
3096 other = FALSE;
3097 }
3098 else
3099 {
3100 fname = ffname;
3101 free_fname = fix_fname(ffname);
3102 /*
3103 * When out-of-memory, keep unexpanded file name, because we MUST be
3104 * able to write the file in this situation.
3105 */
3106 if (free_fname != NULL)
3107 ffname = free_fname;
3108 other = otherfile(ffname);
3109 }
3110
3111 /*
3112 * If we have a new file, put its name in the list of alternate file names.
3113 */
3114 if (other)
3115 {
3116 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3117 || eap->cmdidx == CMD_saveas)
3118 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3119 else
3120 alt_buf = buflist_findname(ffname);
3121 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3122 {
3123 /* Overwriting a file that is loaded in another buffer is not a
3124 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003125 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 goto theend;
3127 }
3128 }
3129
3130 /*
3131 * Writing to the current file is not allowed in readonly mode
3132 * and a file name is required.
3133 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3134 */
3135 if (!other && (
3136#ifdef FEAT_QUICKFIX
3137 bt_dontwrite_msg(curbuf) ||
3138#endif
3139 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3140 goto theend;
3141
3142 if (!other)
3143 {
3144 ffname = curbuf->b_ffname;
3145 fname = curbuf->b_fname;
3146 /*
3147 * Not writing the whole file is only allowed with '!'.
3148 */
3149 if ( (eap->line1 != 1
3150 || eap->line2 != curbuf->b_ml.ml_line_count)
3151 && !eap->forceit
3152 && !eap->append
3153 && !p_wa)
3154 {
3155#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3156 if (p_confirm || cmdmod.confirm)
3157 {
3158 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3159 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3160 goto theend;
3161 eap->forceit = TRUE;
3162 }
3163 else
3164#endif
3165 {
3166 EMSG(_("E140: Use ! to write partial buffer"));
3167 goto theend;
3168 }
3169 }
3170 }
3171
3172 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3173 {
3174 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3175 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 buf_T *was_curbuf = curbuf;
3177
3178 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003179 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003180#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003182#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003184#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 {
3186 /* buffer changed, don't change name now */
3187 retval = FAIL;
3188 goto theend;
3189 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 /* Exchange the file names for the current and the alternate
3191 * buffer. This makes it look like we are now editing the buffer
3192 * under the new name. Must be done before buf_write(), because
3193 * if there is no file name and 'cpo' contains 'F', it will set
3194 * the file name. */
3195 fname = alt_buf->b_fname;
3196 alt_buf->b_fname = curbuf->b_fname;
3197 curbuf->b_fname = fname;
3198 fname = alt_buf->b_ffname;
3199 alt_buf->b_ffname = curbuf->b_ffname;
3200 curbuf->b_ffname = fname;
3201 fname = alt_buf->b_sfname;
3202 alt_buf->b_sfname = curbuf->b_sfname;
3203 curbuf->b_sfname = fname;
3204 buf_name_changed(curbuf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003207 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 if (!alt_buf->b_p_bl)
3209 {
3210 alt_buf->b_p_bl = TRUE;
3211 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3212 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003213#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 if (curbuf != was_curbuf || aborting())
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003215#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 if (curbuf != was_curbuf)
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003217#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 {
3219 /* buffer changed, don't write the file */
3220 retval = FAIL;
3221 goto theend;
3222 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003223
3224 /* If 'filetype' was empty try detecting it now. */
3225 if (*curbuf->b_p_ft == NUL)
3226 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003227 if (au_has_group((char_u *)"filetypedetect"))
3228 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003229 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003230 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003231 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003232
3233 /* Autocommands may have changed buffer names, esp. when
3234 * 'autochdir' is set. */
3235 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 }
3237
Bram Moolenaar5c719942016-07-09 23:40:45 +02003238 name_was_missing = curbuf->b_ffname == NULL;
3239
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3241 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003242
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003243 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003244 if (eap->cmdidx == CMD_saveas)
3245 {
3246 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003247 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003248 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003249 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003250 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003251 }
3252
3253 /* Change directories when the 'acd' option is set and the file name
3254 * got changed or set. */
3255 if (eap->cmdidx == CMD_saveas || name_was_missing)
3256 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003257 DO_AUTOCHDIR
3258 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 }
3260
3261theend:
3262#ifdef FEAT_BROWSE
3263 vim_free(browse_file);
3264#endif
3265 vim_free(free_fname);
3266 return retval;
3267}
3268
3269/*
3270 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3271 * BF_NEW or BF_READERR, check for overwriting current file.
3272 * May set eap->forceit if a dialog says it's OK to overwrite.
3273 * Return OK if it's OK, FAIL if it is not.
3274 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003275 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003276check_overwrite(
3277 exarg_T *eap,
3278 buf_T *buf,
3279 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003281 char_u *ffname, /* full path version of fname */
3282 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283{
3284 /*
3285 * write to other file or b_flags set or not writing the whole file:
3286 * overwriting only allowed with '!'
3287 */
3288 if ( (other
3289 || (buf->b_flags & BF_NOTEDITED)
3290 || ((buf->b_flags & BF_NEW)
3291 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3292 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003294#ifdef FEAT_QUICKFIX
3295 && !bt_nofile(buf)
3296#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 && vim_fexists(ffname))
3298 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003299 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003301#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003302 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003303 if (mch_isdir(ffname))
3304 {
3305 EMSG2(_(e_isadir2), ffname);
3306 return FAIL;
3307 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308#endif
3309#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003310 if (p_confirm || cmdmod.confirm)
3311 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003312 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003314 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3315 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3316 return FAIL;
3317 eap->forceit = TRUE;
3318 }
3319 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003321 {
3322 EMSG(_(e_exists));
3323 return FAIL;
3324 }
3325 }
3326
3327 /* For ":w! filename" check that no swap file exists for "filename". */
3328 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003330 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003331 char_u *p;
3332 int r;
3333 char_u *swapname;
3334
3335 /* We only try the first entry in 'directory', without checking if
3336 * it's writable. If the "." directory is not writable the write
3337 * will probably fail anyway.
3338 * Use 'shortname' of the current buffer, since there is no buffer
3339 * for the written file. */
3340 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003341 {
3342 dir = alloc(5);
3343 if (dir == NULL)
3344 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003345 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003346 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003347 else
3348 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003349 dir = alloc(MAXPATHL);
3350 if (dir == NULL)
3351 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003352 p = p_dir;
3353 copy_option_part(&p, dir, MAXPATHL, ",");
3354 }
3355 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003356 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003357 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003358 if (r)
3359 {
3360#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3361 if (p_confirm || cmdmod.confirm)
3362 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003363 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003364
3365 dialog_msg(buff,
3366 _("Swap file \"%s\" exists, overwrite anyway?"),
3367 swapname);
3368 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3369 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003370 {
3371 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003372 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003373 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003374 eap->forceit = TRUE;
3375 }
3376 else
3377#endif
3378 {
3379 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3380 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003381 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003382 return FAIL;
3383 }
3384 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003385 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 }
3387 }
3388 return OK;
3389}
3390
3391/*
3392 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3393 */
3394 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003395ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396{
3397 int i;
3398
3399 if (eap->cmd[1] == 'n')
3400 i = curwin->w_arg_idx + (int)eap->line2;
3401 else
3402 i = curwin->w_arg_idx - (int)eap->line2;
3403 eap->line1 = 1;
3404 eap->line2 = curbuf->b_ml.ml_line_count;
3405 if (do_write(eap) != FAIL)
3406 do_argfile(eap, i);
3407}
3408
3409/*
3410 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3411 */
3412 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003413do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414{
3415 buf_T *buf;
3416 int error = 0;
3417 int save_forceit = eap->forceit;
3418
3419 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3420 exiting = TRUE;
3421
Bram Moolenaar29323592016-07-24 22:04:11 +02003422 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 {
Bram Moolenaar7a760922018-02-19 23:10:02 +01003424#ifdef FEAT_TERMINAL
3425 if (exiting && term_job_running(buf->b_term))
3426 {
3427 no_write_message_nobang(buf);
3428 ++error;
3429 }
3430 else
3431#endif
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003432 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 {
3434 /*
3435 * Check if there is a reason the buffer cannot be written:
3436 * 1. if the 'write' option is set
3437 * 2. if there is no file name (even after browsing)
3438 * 3. if the 'readonly' is set (even after a dialog)
3439 * 4. if overwriting is allowed (even after a dialog)
3440 */
3441 if (not_writing())
3442 {
3443 ++error;
3444 break;
3445 }
3446#ifdef FEAT_BROWSE
3447 /* ":browse wall": ask for file name if there isn't one */
3448 if (buf->b_ffname == NULL && cmdmod.browse)
3449 browse_save_fname(buf);
3450#endif
3451 if (buf->b_ffname == NULL)
3452 {
3453 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3454 ++error;
3455 }
3456 else if (check_readonly(&eap->forceit, buf)
3457 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3458 FALSE) == FAIL)
3459 {
3460 ++error;
3461 }
3462 else
3463 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003464 bufref_T bufref;
3465
3466 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 if (buf_write_all(buf, eap->forceit) == FAIL)
3468 ++error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003470 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 }
3473 eap->forceit = save_forceit; /* check_overwrite() may set it */
3474 }
3475 }
3476 if (exiting)
3477 {
3478 if (!error)
3479 getout(0); /* exit Vim */
3480 not_exiting();
3481 }
3482}
3483
3484/*
3485 * Check the 'write' option.
3486 * Return TRUE and give a message when it's not st.
3487 */
3488 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003489not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490{
3491 if (p_write)
3492 return FALSE;
3493 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3494 return TRUE;
3495}
3496
3497/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003498 * Check if a buffer is read-only (either 'readonly' option is set or file is
3499 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3500 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 */
3502 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003503check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003505 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003506
3507 /* Handle a file being readonly when the 'readonly' option is set or when
3508 * the file exists and permissions are read-only.
3509 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3510 * important for device checks but not here. */
3511 if (!*forceit && (buf->b_p_ro
3512 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3513 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 {
3515#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3516 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3517 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003518 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519
Bram Moolenaar5386a122007-06-28 20:02:32 +00003520 if (buf->b_p_ro)
3521 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3522 buf->b_fname);
3523 else
3524 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 +00003525 buf->b_fname);
3526
3527 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3528 {
3529 /* Set forceit, to force the writing of a readonly file */
3530 *forceit = TRUE;
3531 return FALSE;
3532 }
3533 else
3534 return TRUE;
3535 }
3536 else
3537#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003538 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003540 else
3541 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3542 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 return TRUE;
3544 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 return FALSE;
3547}
3548
3549/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003550 * Try to abandon current file and edit a new or existing file.
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003551 * "fnum" is the number of the file, if zero use ffname/sfname.
3552 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003554 * Return:
3555 * GETFILE_ERROR for "normal" error,
3556 * GETFILE_NOT_WRITTEN for "not written" error,
3557 * GETFILE_SAME_FILE for success
3558 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 */
3560 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003561getfile(
3562 int fnum,
3563 char_u *ffname,
3564 char_u *sfname,
3565 int setpm,
3566 linenr_T lnum,
3567 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568{
3569 int other;
3570 int retval;
3571 char_u *free_me = NULL;
3572
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003573 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003574 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003575 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003576 return GETFILE_ERROR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577
3578 if (fnum == 0)
3579 {
3580 /* make ffname full path, set sfname */
3581 fname_expand(curbuf, &ffname, &sfname);
3582 other = otherfile(ffname);
3583 free_me = ffname; /* has been allocated, free() later */
3584 }
3585 else
3586 other = (fnum != curbuf->b_fnum);
3587
3588 if (other)
3589 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003590 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3592 {
3593#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3594 if (p_confirm && p_write)
3595 dialog_changed(curbuf, FALSE);
3596 if (curbufIsChanged())
3597#endif
3598 {
3599 if (other)
3600 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003601 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003602 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 goto theend;
3604 }
3605 }
3606 if (other)
3607 --no_wait_return;
3608 if (setpm)
3609 setpcmark();
3610 if (!other)
3611 {
3612 if (lnum != 0)
3613 curwin->w_cursor.lnum = lnum;
3614 check_cursor_lnum();
3615 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003616 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 }
3618 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003619 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003620 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003621 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003623 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624
3625theend:
3626 vim_free(free_me);
3627 return retval;
3628}
3629
3630/*
3631 * start editing a new file
3632 *
3633 * fnum: file number; if zero use ffname/sfname
3634 * ffname: the file name
3635 * - full path if sfname used,
3636 * - any file name if sfname is NULL
3637 * - empty string to re-edit with the same file name (but may be
3638 * in a different directory)
3639 * - NULL to start an empty buffer
3640 * sfname: the short file name (or NULL)
3641 * eap: contains the command to be executed after loading the file and
3642 * forced 'ff' and 'fenc'
3643 * newlnum: if > 0: put cursor on this line number (if possible)
3644 * if ECMD_LASTL: use last position in loaded file
3645 * if ECMD_LAST: use last position in all files
3646 * if ECMD_ONE: use first line
3647 * flags:
3648 * ECMD_HIDE: if TRUE don't free the current buffer
3649 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3650 * ECMD_OLDBUF: use existing buffer if it exists
3651 * ECMD_FORCEIT: ! used for Ex command
3652 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003653 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003654 * window, NULL when splitting the window first. When not NULL info
3655 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 *
3657 * return FAIL for failure, OK otherwise
3658 */
3659 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003660do_ecmd(
3661 int fnum,
3662 char_u *ffname,
3663 char_u *sfname,
3664 exarg_T *eap, /* can be NULL! */
3665 linenr_T newlnum,
3666 int flags,
3667 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668{
3669 int other_file; /* TRUE if editing another file */
3670 int oldbuf; /* TRUE if using existing buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 int auto_buf = FALSE; /* TRUE if autocommands brought us
3672 into the buffer unexpectedly */
3673 char_u *new_name = NULL;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003674#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003675 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676#endif
3677 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003678 bufref_T bufref;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003679 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 char_u *free_fname = NULL;
3681#ifdef FEAT_BROWSE
3682 char_u *browse_file = NULL;
3683#endif
3684 int retval = FAIL;
3685 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003686 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 linenr_T topline = 0;
3688 int newcol = -1;
3689 int solcol = -1;
3690 pos_T *pos;
3691#ifdef FEAT_SUN_WORKSHOP
3692 char_u *cp;
3693#endif
3694 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003695#ifdef FEAT_SPELL
3696 int did_get_winopts = FALSE;
3697#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003698 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003699 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700
3701 if (eap != NULL)
3702 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003703 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704
3705 if (fnum != 0)
3706 {
3707 if (fnum == curbuf->b_fnum) /* file is already being edited */
3708 return OK; /* nothing to do */
3709 other_file = TRUE;
3710 }
3711 else
3712 {
3713#ifdef FEAT_BROWSE
3714 if (cmdmod.browse)
3715 {
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003716 if (
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003717# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003718 !gui.in_use &&
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003719# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003720 au_has_group((char_u *)"FileExplorer"))
3721 {
3722 /* No browsing supported but we do have the file explorer:
3723 * Edit the directory. */
3724 if (ffname == NULL || !mch_isdir(ffname))
3725 ffname = (char_u *)".";
3726 }
3727 else
3728 {
3729 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003731 if (browse_file == NULL)
3732 goto theend;
3733 ffname = browse_file;
3734 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 }
3736#endif
3737 /* if no short name given, use ffname for short name */
3738 if (sfname == NULL)
3739 sfname = ffname;
3740#ifdef USE_FNAME_CASE
3741# ifdef USE_LONG_FNAME
3742 if (USE_LONG_FNAME)
3743# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003744 if (sfname != NULL)
3745 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746#endif
3747
3748#ifdef FEAT_LISTCMDS
3749 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3750 goto theend;
3751#endif
3752
3753 if (ffname == NULL)
3754 other_file = TRUE;
3755 /* there is no file name */
3756 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3757 other_file = FALSE;
3758 else
3759 {
3760 if (*ffname == NUL) /* re-edit with same file name */
3761 {
3762 ffname = curbuf->b_ffname;
3763 sfname = curbuf->b_fname;
3764 }
3765 free_fname = fix_fname(ffname); /* may expand to full path name */
3766 if (free_fname != NULL)
3767 ffname = free_fname;
3768 other_file = otherfile(ffname);
3769#ifdef FEAT_SUN_WORKSHOP
3770 if (usingSunWorkShop && p_acd
3771 && (cp = vim_strrchr(sfname, '/')) != NULL)
3772 sfname = ++cp;
3773#endif
3774 }
3775 }
3776
3777 /*
3778 * if the file was changed we may not be allowed to abandon it
3779 * - if we are going to re-edit the same file
3780 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3781 */
3782 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3783 || (curbuf->b_nwindows == 1
3784 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003785 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3786 | (other_file ? 0 : CCGD_MULTWIN)
3787 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3788 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 {
3790 if (fnum == 0 && other_file && ffname != NULL)
3791 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3792 goto theend;
3793 }
3794
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 /*
3796 * End Visual mode before switching to another buffer, so the text can be
3797 * copied into the GUI selection buffer.
3798 */
3799 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003801#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003802 if ((command != NULL || newlnum > (linenr_T)0)
3803 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3804 {
3805 int len;
3806 char_u *p;
3807
3808 /* Set v:swapcommand for the SwapExists autocommands. */
3809 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003810 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003811 else
3812 len = 30;
3813 p = alloc((unsigned)len);
3814 if (p != NULL)
3815 {
3816 if (command != NULL)
3817 vim_snprintf((char *)p, len, ":%s\r", command);
3818 else
3819 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3820 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3821 did_set_swapcommand = TRUE;
3822 vim_free(p);
3823 }
3824 }
3825#endif
3826
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 /*
3828 * If we are starting to edit another file, open a (new) buffer.
3829 * Otherwise we re-use the current buffer.
3830 */
3831 if (other_file)
3832 {
3833#ifdef FEAT_LISTCMDS
3834 if (!(flags & ECMD_ADDBUF))
3835#endif
3836 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003837 if (!cmdmod.keepalt)
3838 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003839 if (oldwin != NULL)
3840 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 }
3842
3843 if (fnum)
3844 buf = buflist_findnr(fnum);
3845 else
3846 {
3847#ifdef FEAT_LISTCMDS
3848 if (flags & ECMD_ADDBUF)
3849 {
3850 linenr_T tlnum = 1L;
3851
3852 if (command != NULL)
3853 {
3854 tlnum = atol((char *)command);
3855 if (tlnum <= 0)
3856 tlnum = 1L;
3857 }
3858 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3859 goto theend;
3860 }
3861#endif
3862 buf = buflist_new(ffname, sfname, 0L,
3863 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003864
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003865 /* autocommands may change curwin and curbuf */
3866 if (oldwin != NULL)
3867 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003868 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 }
3870 if (buf == NULL)
3871 goto theend;
3872 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3873 {
3874 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 }
3876 else /* existing memfile */
3877 {
3878 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003879 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003881 /* Check if autocommands made the buffer invalid or changed the
3882 * current buffer. */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003883 if (!bufref_valid(&bufref) || curbuf != old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 goto theend;
3885#ifdef FEAT_EVAL
3886 if (aborting()) /* autocmds may abort script processing */
3887 goto theend;
3888#endif
3889 }
3890
3891 /* May jump to last used line number for a loaded buffer or when asked
3892 * for explicitly */
3893 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3894 {
3895 pos = buflist_findfpos(buf);
3896 newlnum = pos->lnum;
3897 solcol = pos->col;
3898 }
3899
3900 /*
3901 * Make the (new) buffer the one used by the current window.
3902 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3903 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003904 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 */
3906 if (buf != curbuf)
3907 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 /*
3909 * Be careful: The autocommands may delete any buffer and change
3910 * the current buffer.
3911 * - If the buffer we are going to edit is deleted, give up.
3912 * - If the current buffer is deleted, prefer to load the new
3913 * buffer when loading a buffer is required. This avoids
3914 * loading another buffer which then must be closed again.
3915 * - If we ended up in the new buffer already, need to skip a few
3916 * things, set auto_buf.
3917 */
3918 if (buf->b_fname != NULL)
3919 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003920 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003922 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003924 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 delbuf_msg(new_name); /* frees new_name */
3926 goto theend;
3927 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003928#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 if (aborting()) /* autocmds may abort script processing */
3930 {
3931 vim_free(new_name);
3932 goto theend;
3933 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003934#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 if (buf == curbuf) /* already in new buffer */
3936 auto_buf = TRUE;
3937 else
3938 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02003939 win_T *the_curwin = curwin;
3940
3941 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003942 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02003943 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003944 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02003945
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003946 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 buf_copy_options(buf, BCO_ENTER);
3948
Bram Moolenaar5a497892016-09-03 16:29:04 +02003949 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02003950 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003951 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003952 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003953 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954
Bram Moolenaar5a497892016-09-03 16:29:04 +02003955 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003956 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01003957
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003958#ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02003959 /* autocmds may abort script processing */
3960 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 {
3962 vim_free(new_name);
3963 goto theend;
3964 }
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003965#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003967 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003969 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 delbuf_msg(new_name); /* frees new_name */
3971 goto theend;
3972 }
3973 if (buf == curbuf) /* already in new buffer */
3974 auto_buf = TRUE;
3975 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003977#ifdef FEAT_SYN_HL
3978 /*
3979 * <VN> We could instead free the synblock
3980 * and re-attach to buffer, perhaps.
3981 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02003982 if (curwin->w_buffer == NULL
3983 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003984 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003985#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 curwin->w_buffer = buf;
3987 curbuf = buf;
3988 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003989
3990 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3991 if (!oldbuf && eap != NULL)
3992 {
3993 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003994#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003995 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003996#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003997 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 }
3999
4000 /* May get the window options from the last time this buffer
4001 * was in this window (or another window). If not used
4002 * before, reset the local window options to the global
4003 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004004 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004005#ifdef FEAT_SPELL
4006 did_get_winopts = TRUE;
4007#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 }
4009 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004010 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004011 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013
4014 curwin->w_pcmark.lnum = 1;
4015 curwin->w_pcmark.col = 0;
4016 }
4017 else /* !other_file */
4018 {
4019 if (
4020#ifdef FEAT_LISTCMDS
4021 (flags & ECMD_ADDBUF) ||
4022#endif
4023 check_fname() == FAIL)
4024 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004025
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 oldbuf = (flags & ECMD_OLDBUF);
4027 }
4028
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004029 /* Don't redraw until the cursor is in the right line, otherwise
4030 * autocommands may cause ml_get errors. */
4031 ++RedrawingDisabled;
4032 did_inc_redrawing_disabled = TRUE;
4033
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004034 buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4036 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004037 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 }
4039 else
4040 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 /* Don't make a buffer listed if it's a help buffer. Useful when
4042 * using CTRL-O to go back to a help file. */
4043 if (!curbuf->b_help)
4044 set_buflisted(TRUE);
4045 }
4046
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 /* If autocommands change buffers under our fingers, forget about
4048 * editing the file. */
4049 if (buf != curbuf)
4050 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004051#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 if (aborting()) /* autocmds may abort script processing */
4053 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004054#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055
4056 /* Since we are starting to edit a file, consider the filetype to be
4057 * unset. Helps for when an autocommand changes files and expects syntax
4058 * highlighting to work in the other file. */
4059 did_filetype = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060
4061/*
4062 * other_file oldbuf
4063 * FALSE FALSE re-edit same file, buffer is re-used
4064 * FALSE TRUE re-edit same file, nothing changes
4065 * TRUE FALSE start editing new file, new buffer
4066 * TRUE TRUE start editing in existing buffer (nothing to do)
4067 */
4068 if (!other_file && !oldbuf) /* re-use the buffer */
4069 {
4070 set_last_cursor(curwin); /* may set b_last_cursor */
4071 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4072 {
4073 newlnum = curwin->w_cursor.lnum;
4074 solcol = curwin->w_cursor.col;
4075 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 buf = curbuf;
4077 if (buf->b_fname != NULL)
4078 new_name = vim_strsave(buf->b_fname);
4079 else
4080 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004081 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004082
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004083 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4084 {
4085 /* Save all the text, so that the reload can be undone.
4086 * Sync first so that this is a separate undo-able action. */
4087 u_sync(FALSE);
4088 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4089 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004090 {
4091 vim_free(new_name);
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004092 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004093 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004094 u_unchanged(curbuf);
4095 buf_freeall(curbuf, BFA_KEEP_UNDO);
4096
4097 /* tell readfile() not to clear or reload undo info */
4098 readfile_flags = READ_KEEP_UNDO;
4099 }
4100 else
4101 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004102
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 /* If autocommands deleted the buffer we were going to re-edit, give
4104 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004105 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {
4107 delbuf_msg(new_name); /* frees new_name */
4108 goto theend;
4109 }
4110 vim_free(new_name);
4111
4112 /* If autocommands change buffers under our fingers, forget about
4113 * re-editing the file. Should do the buf_clear_file(), but perhaps
4114 * the autocommands changed the buffer... */
4115 if (buf != curbuf)
4116 goto theend;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004117#ifdef FEAT_EVAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 if (aborting()) /* autocmds may abort script processing */
4119 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120#endif
4121 buf_clear_file(curbuf);
4122 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4123 curbuf->b_op_end.lnum = 0;
4124 }
4125
4126/*
4127 * If we get here we are sure to start editing
4128 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 /* Assume success now */
4130 retval = OK;
4131
4132 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 * Check if we are editing the w_arg_idx file in the argument list.
4134 */
4135 check_arg_idx(curwin);
4136
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 if (!auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 {
4139 /*
4140 * Set cursor and init window before reading the file and executing
4141 * autocommands. This allows for the autocommands to position the
4142 * cursor.
4143 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004144 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145
4146#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004147 /* It's possible that all lines in the buffer changed. Need to update
4148 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004149 {
4150 win_T *win;
4151 tabpage_T *tp;
4152
4153 FOR_ALL_TAB_WINDOWS(tp, win)
4154 if (win->w_buffer == curbuf)
4155 foldUpdateAll(win);
4156 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157#endif
4158
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004159 /* Change directories when the 'acd' option is set. */
4160 DO_AUTOCHDIR
4161
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 /*
4163 * Careful: open_buffer() and apply_autocmds() may change the current
4164 * buffer and window.
4165 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004166 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 topline = curwin->w_topline;
4168 if (!oldbuf) /* need to read the file */
4169 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004170#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 swap_exists_action = SEA_DIALOG;
4172#endif
4173 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4174
4175 /*
4176 * Open the buffer and read the file.
4177 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004178#if defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004179 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 retval = FAIL;
4181#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004182 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183#endif
4184
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004185#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 if (swap_exists_action == SEA_QUIT)
4187 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004188 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189#endif
4190 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 else
4192 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004193 /* Read the modelines, but only to set window-local options. Any
4194 * buffer-local options have already been set and may have been
4195 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004196 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004197
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4199 &retval);
4200 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4201 &retval);
4202 }
4203 check_arg_idx(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204
Bram Moolenaareab316b2015-03-24 11:46:30 +01004205 /* If autocommands change the cursor position or topline, we should
4206 * keep it. Also when it moves within a line. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004207 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 {
4209 newlnum = curwin->w_cursor.lnum;
4210 newcol = curwin->w_cursor.col;
4211 }
4212 if (curwin->w_topline == topline)
4213 topline = 0;
4214
4215 /* Even when cursor didn't move we need to recompute topline. */
4216 changed_line_abv_curs();
4217
4218#ifdef FEAT_TITLE
4219 maketitle();
4220#endif
4221 }
4222
4223#ifdef FEAT_DIFF
4224 /* Tell the diff stuff that this buffer is new and/or needs updating.
4225 * Also needed when re-editing the same buffer, because unloading will
4226 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004227 if (curwin->w_p_diff)
4228 {
4229 diff_buf_add(curbuf);
4230 diff_invalidate(curbuf);
4231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232#endif
4233
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004234#ifdef FEAT_SPELL
4235 /* If the window options were changed may need to set the spell language.
4236 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004237 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4238 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004239#endif
4240
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 if (command == NULL)
4242 {
4243 if (newcol >= 0) /* position set by autocommands */
4244 {
4245 curwin->w_cursor.lnum = newlnum;
4246 curwin->w_cursor.col = newcol;
4247 check_cursor();
4248 }
4249 else if (newlnum > 0) /* line number from caller or old position */
4250 {
4251 curwin->w_cursor.lnum = newlnum;
4252 check_cursor_lnum();
4253 if (solcol >= 0 && !p_sol)
4254 {
4255 /* 'sol' is off: Use last known column. */
4256 curwin->w_cursor.col = solcol;
4257 check_cursor_col();
4258#ifdef FEAT_VIRTUALEDIT
4259 curwin->w_cursor.coladd = 0;
4260#endif
4261 curwin->w_set_curswant = TRUE;
4262 }
4263 else
4264 beginline(BL_SOL | BL_FIX);
4265 }
4266 else /* no line number, go to last line in Ex mode */
4267 {
4268 if (exmode_active)
4269 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4270 beginline(BL_WHITE | BL_FIX);
4271 }
4272 }
4273
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 /* Check if cursors in other windows on the same buffer are still valid */
4275 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276
4277 /*
4278 * Did not read the file, need to show some info about the file.
4279 * Do this after setting the cursor.
4280 */
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004281 if (oldbuf && !auto_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 {
4283 int msg_scroll_save = msg_scroll;
4284
4285 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4286 * message. */
4287 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4288 msg_scroll = FALSE;
4289 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4290 check_for_delay(FALSE);
4291 msg_start();
4292 msg_scroll = msg_scroll_save;
4293 msg_scrolled_ign = TRUE;
4294
Bram Moolenaar426dd022016-03-15 15:09:29 +01004295 if (!shortmess(SHM_FILEINFO))
4296 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
4298 msg_scrolled_ign = FALSE;
4299 }
4300
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004301#ifdef FEAT_VIMINFO
4302 curbuf->b_last_used = vim_time();
4303#endif
4304
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 if (command != NULL)
4306 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4307
4308#ifdef FEAT_KEYMAP
4309 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004310 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311#endif
4312
4313 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004314 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 if (!skip_redraw)
4316 {
4317 n = p_so;
4318 if (topline == 0 && command == NULL)
4319 p_so = 999; /* force cursor halfway the window */
4320 update_topline();
4321#ifdef FEAT_SCROLLBIND
4322 curwin->w_scbind_pos = curwin->w_topline;
4323#endif
4324 p_so = n;
4325 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4326 }
4327
4328 if (p_im)
4329 need_start_insertmode = TRUE;
4330
Bram Moolenaar15833232018-02-03 18:33:17 +01004331#ifdef FEAT_AUTOCHDIR
4332 /* Change directories when the 'acd' option is set and we aren't already in
4333 * that directory (should already be done above). Expect getcwd() to be
4334 * faster than calling shorten_fnames() unnecessarily. */
4335 if (p_acd && curbuf->b_ffname != NULL)
4336 {
4337 char_u curdir[MAXPATHL];
4338 char_u filedir[MAXPATHL];
4339
4340 vim_strncpy(filedir, curbuf->b_ffname, MAXPATHL - 1);
4341 *gettail_sep(filedir) = NUL;
4342 if (mch_dirname(curdir, MAXPATHL) != FAIL
4343 && vim_fnamecmp(curdir, filedir) != 0)
4344 do_autochdir();
4345 }
4346#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004348#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004349 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 {
4351# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004352 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4354# endif
4355# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004356 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004357 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358# endif
4359 }
4360#endif
4361
4362theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004363 if (did_inc_redrawing_disabled)
4364 --RedrawingDisabled;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004365#if defined(FEAT_EVAL)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004366 if (did_set_swapcommand)
4367 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4368#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369#ifdef FEAT_BROWSE
4370 vim_free(browse_file);
4371#endif
4372 vim_free(free_fname);
4373 return retval;
4374}
4375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004377delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378{
4379 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4380 name == NULL ? (char_u *)"" : name);
4381 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004382 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004383 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004386static int append_indent = 0; /* autoindent for first line */
4387
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388/*
4389 * ":insert" and ":append", also used by ":change"
4390 */
4391 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004392ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393{
4394 char_u *theline;
4395 int did_undo = FALSE;
4396 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004397 int indent = 0;
4398 char_u *p;
4399 int vcol;
4400 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004402 /* the ! flag toggles autoindent */
4403 if (eap->forceit)
4404 curbuf->b_p_ai = !curbuf->b_p_ai;
4405
4406 /* First autoindent comes from the line we start on */
4407 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4408 append_indent = get_indent_lnum(lnum);
4409
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 if (eap->cmdidx != CMD_append)
4411 --lnum;
4412
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004413 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004414 if (empty && lnum == 1)
4415 lnum = 0;
4416
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 State = INSERT; /* behave like in Insert mode */
4418 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4419 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004420
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004421 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 {
4423 msg_scroll = TRUE;
4424 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004425 if (curbuf->b_p_ai)
4426 {
4427 if (append_indent >= 0)
4428 {
4429 indent = append_indent;
4430 append_indent = -1;
4431 }
4432 else if (lnum > 0)
4433 indent = get_indent_lnum(lnum);
4434 }
4435 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004437 {
4438 /* No getline() function, use the lines that follow. This ends
4439 * when there is no more. */
4440 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4441 break;
4442 p = vim_strchr(eap->nextcmd, NL);
4443 if (p == NULL)
4444 p = eap->nextcmd + STRLEN(eap->nextcmd);
4445 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4446 if (*p != NUL)
4447 ++p;
4448 eap->nextcmd = p;
4449 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004451 {
4452 int save_State = State;
4453
4454 /* Set State to avoid the cursor shape to be set to INSERT mode
4455 * when getline() returns. */
4456 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 theline = eap->getline(
4458#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004459 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004461 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004462 State = save_State;
4463 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004465 if (theline == NULL)
4466 break;
4467
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004468 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4469 if (ex_keep_indent)
4470 append_indent = indent;
4471
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004472 /* Look for the "." after automatic indent. */
4473 vcol = 0;
4474 for (p = theline; indent > vcol; ++p)
4475 {
4476 if (*p == ' ')
4477 ++vcol;
4478 else if (*p == TAB)
4479 vcol += 8 - vcol % 8;
4480 else
4481 break;
4482 }
4483 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004484 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4485 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 {
4487 vim_free(theline);
4488 break;
4489 }
4490
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004491 /* don't use autoindent if nothing was typed. */
4492 if (p[0] == NUL)
4493 theline[0] = NUL;
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 did_undo = TRUE;
4496 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004497 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 vim_free(theline);
4500 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004501
4502 if (empty)
4503 {
4504 ml_delete(2L, FALSE);
4505 empty = FALSE;
4506 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 }
4508 State = NORMAL;
4509
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004510 if (eap->forceit)
4511 curbuf->b_p_ai = !curbuf->b_p_ai;
4512
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004514 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 * "end" is set to lnum when something has been appended, otherwise
4516 * it is the same than "start" -- Acevedo */
4517 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4518 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4519 if (eap->cmdidx != CMD_append)
4520 --curbuf->b_op_start.lnum;
4521 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4522 ? lnum : curbuf->b_op_start.lnum;
4523 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4524 curwin->w_cursor.lnum = lnum;
4525 check_cursor_lnum();
4526 beginline(BL_SOL | BL_FIX);
4527
4528 need_wait_return = FALSE; /* don't use wait_return() now */
4529 ex_no_reprint = TRUE;
4530}
4531
4532/*
4533 * ":change"
4534 */
4535 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004536ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537{
4538 linenr_T lnum;
4539
4540 if (eap->line2 >= eap->line1
4541 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4542 return;
4543
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004544 /* the ! flag toggles autoindent */
4545 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4546 append_indent = get_indent_lnum(eap->line1);
4547
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4549 {
4550 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4551 break;
4552 ml_delete(eap->line1, FALSE);
4553 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004554
4555 /* make sure the cursor is not beyond the end of the file now */
4556 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4558
4559 /* ":append" on the line above the deleted lines. */
4560 eap->line2 = eap->line1;
4561 ex_append(eap);
4562}
4563
4564 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004565ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566{
4567 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004568 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004569 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 int minus = 0;
4571 linenr_T start, end, curs, i;
4572 int j;
4573 linenr_T lnum = eap->line2;
4574
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004575 /* Vi compatible: ":z!" uses display height, without a count uses
4576 * 'scroll' */
4577 if (eap->forceit)
4578 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004579 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004580 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004581 else
4582 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 if (bigness < 1)
4584 bigness = 1;
4585
4586 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004587 kind = x;
4588 if (*kind == '-' || *kind == '+' || *kind == '='
4589 || *kind == '^' || *kind == '.')
4590 ++x;
4591 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 ++x;
4593
4594 if (*x != 0)
4595 {
4596 if (!VIM_ISDIGIT(*x))
4597 {
4598 EMSG(_("E144: non-numeric argument to :z"));
4599 return;
4600 }
4601 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004602 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004603 bigness = atol((char *)x);
4604
4605 /* bigness could be < 0 if atol(x) overflows. */
4606 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4607 bigness = 2 * curbuf->b_ml.ml_line_count;
4608
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004609 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004610 if (*kind == '=')
4611 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004612 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 }
4614
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004615 /* the number of '-' and '+' multiplies the distance */
4616 if (*kind == '-' || *kind == '+')
4617 for (x = kind + 1; *x == *kind; ++x)
4618 ;
4619
4620 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 {
4622 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004623 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4624 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004625 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 break;
4627
4628 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004629 start = lnum - (bigness + 1) / 2 + 1;
4630 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 curs = lnum;
4632 minus = 1;
4633 break;
4634
4635 case '^':
4636 start = lnum - bigness * 2;
4637 end = lnum - bigness;
4638 curs = lnum - bigness;
4639 break;
4640
4641 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004642 start = lnum - (bigness + 1) / 2 + 1;
4643 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 curs = end;
4645 break;
4646
4647 default: /* '+' */
4648 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004649 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004650 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004651 else if (eap->addr_count == 0)
4652 ++start;
4653 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 curs = end;
4655 break;
4656 }
4657
4658 if (start < 1)
4659 start = 1;
4660
4661 if (end > curbuf->b_ml.ml_line_count)
4662 end = curbuf->b_ml.ml_line_count;
4663
4664 if (curs > curbuf->b_ml.ml_line_count)
4665 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004666 else if (curs < 1)
4667 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668
4669 for (i = start; i <= end; i++)
4670 {
4671 if (minus && i == lnum)
4672 {
4673 msg_putchar('\n');
4674
4675 for (j = 1; j < Columns; j++)
4676 msg_putchar('-');
4677 }
4678
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004679 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
4681 if (minus && i == lnum)
4682 {
4683 msg_putchar('\n');
4684
4685 for (j = 1; j < Columns; j++)
4686 msg_putchar('-');
4687 }
4688 }
4689
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004690 if (curwin->w_cursor.lnum != curs)
4691 {
4692 curwin->w_cursor.lnum = curs;
4693 curwin->w_cursor.col = 0;
4694 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 ex_no_reprint = TRUE;
4696}
4697
4698/*
4699 * Check if the restricted flag is set.
4700 * If so, give an error message and return TRUE.
4701 * Otherwise, return FALSE.
4702 */
4703 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004704check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705{
4706 if (restricted)
4707 {
4708 EMSG(_("E145: Shell commands not allowed in rvim"));
4709 return TRUE;
4710 }
4711 return FALSE;
4712}
4713
4714/*
4715 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4716 * If so, give an error message and return TRUE.
4717 * Otherwise, return FALSE.
4718 */
4719 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004720check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721{
4722 if (secure)
4723 {
4724 secure = 2;
4725 EMSG(_(e_curdir));
4726 return TRUE;
4727 }
4728#ifdef HAVE_SANDBOX
4729 /*
4730 * In the sandbox more things are not allowed, including the things
4731 * disallowed in secure mode.
4732 */
4733 if (sandbox != 0)
4734 {
4735 EMSG(_(e_sandbox));
4736 return TRUE;
4737 }
4738#endif
4739 return FALSE;
4740}
4741
4742static char_u *old_sub = NULL; /* previous substitute pattern */
4743static int global_need_beginline; /* call beginline() after ":g" */
4744
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004745/*
4746 * Flags that are kept between calls to :substitute.
4747 */
4748typedef struct {
4749 int do_all; /* do multiple substitutions per line */
4750 int do_ask; /* ask for confirmation */
4751 int do_count; /* count only */
4752 int do_error; /* if false, ignore errors */
4753 int do_print; /* print last line with subs. */
4754 int do_list; /* list last line with subs. */
4755 int do_number; /* list last line with line nr*/
4756 int do_ic; /* ignore case flag */
4757} subflags_T;
4758
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759/* do_sub()
4760 *
4761 * Perform a substitution from line eap->line1 to line eap->line2 using the
4762 * command pointed to by eap->arg which should be of the form:
4763 *
4764 * /pattern/substitution/{flags}
4765 *
4766 * The usual escapes are supported as described in the regexp docs.
4767 */
4768 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004769do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770{
4771 linenr_T lnum;
4772 long i = 0;
4773 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004774 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4775 FALSE, FALSE, 0};
4776#ifdef FEAT_EVAL
4777 subflags_T subflags_save;
4778#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004779 int save_do_all; /* remember user specified 'g' flag */
4780 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4782 int delimiter;
4783 int sublen;
4784 int got_quit = FALSE;
4785 int got_match = FALSE;
4786 int temp;
4787 int which_pat;
4788 char_u *cmd;
4789 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004790 linenr_T first_line = 0; /* first changed line */
4791 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 * change */
4793 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4794 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004795 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004796 char_u *sub_firstline; /* allocated copy of first sub line */
4797 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004798 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004799 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004800#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004801 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004802#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803
4804 cmd = eap->arg;
4805 if (!global_busy)
4806 {
4807 sub_nsubs = 0;
4808 sub_nlines = 0;
4809 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004810 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 if (eap->cmdidx == CMD_tilde)
4813 which_pat = RE_LAST; /* use last used regexp */
4814 else
4815 which_pat = RE_SUBST; /* use last substitute regexp */
4816
4817 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004818 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4820 {
4821 /* don't accept alphanumeric for separator */
4822 if (isalpha(*cmd))
4823 {
4824 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4825 return;
4826 }
4827 /*
4828 * undocumented vi feature:
4829 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4830 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4831 */
4832 if (*cmd == '\\')
4833 {
4834 ++cmd;
4835 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4836 {
4837 EMSG(_(e_backslash));
4838 return;
4839 }
4840 if (*cmd != '&')
4841 which_pat = RE_SEARCH; /* use last '/' pattern */
4842 pat = (char_u *)""; /* empty search pattern */
4843 delimiter = *cmd++; /* remember delimiter character */
4844 }
4845 else /* find the end of the regexp */
4846 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004847#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4848 if (p_altkeymap && curwin->w_p_rl)
4849 lrF_sub(cmd);
4850#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 which_pat = RE_LAST; /* use last used regexp */
4852 delimiter = *cmd++; /* remember delimiter character */
4853 pat = cmd; /* remember start of search pat */
4854 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4855 if (cmd[0] == delimiter) /* end delimiter found */
4856 *cmd++ = NUL; /* replace it with a NUL */
4857 }
4858
4859 /*
4860 * Small incompatibility: vi sees '\n' as end of the command, but in
4861 * Vim we want to use '\n' to find/substitute a NUL.
4862 */
4863 sub = cmd; /* remember the start of the substitution */
4864
4865 while (cmd[0])
4866 {
4867 if (cmd[0] == delimiter) /* end delimiter found */
4868 {
4869 *cmd++ = NUL; /* replace it with a NUL */
4870 break;
4871 }
4872 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4873 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004874 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 }
4876
4877 if (!eap->skip)
4878 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004879 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4880 if (STRCMP(sub, "%") == 0
4881 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4882 {
4883 if (old_sub == NULL) /* there is no previous command */
4884 {
4885 EMSG(_(e_nopresub));
4886 return;
4887 }
4888 sub = old_sub;
4889 }
4890 else
4891 {
4892 vim_free(old_sub);
4893 old_sub = vim_strsave(sub);
4894 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 }
4896 }
4897 else if (!eap->skip) /* use previous pattern and substitution */
4898 {
4899 if (old_sub == NULL) /* there is no previous command */
4900 {
4901 EMSG(_(e_nopresub));
4902 return;
4903 }
4904 pat = NULL; /* search_regcomp() will use previous pattern */
4905 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004906
4907 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4908 * last column after using "$". */
4909 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 }
4911
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004912 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4913 * more efficient.
4914 * TODO: find a generic solution to make line-joining operations more
4915 * efficient, avoid allocating a string that grows in size.
4916 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004917 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004918 && *sub == NUL
4919 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4920 || *cmd == 'p' || *cmd == '#'))))
4921 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004922 linenr_T joined_lines_count;
4923
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004924 curwin->w_cursor.lnum = eap->line1;
4925 if (*cmd == 'l')
4926 eap->flags = EXFLAG_LIST;
4927 else if (*cmd == '#')
4928 eap->flags = EXFLAG_NR;
4929 else if (*cmd == 'p')
4930 eap->flags = EXFLAG_PRINT;
4931
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004932 /* The number of lines joined is the number of lines in the range plus
4933 * one. One less when the last line is included. */
4934 joined_lines_count = eap->line2 - eap->line1 + 1;
4935 if (eap->line2 < curbuf->b_ml.ml_line_count)
4936 ++joined_lines_count;
4937 if (joined_lines_count > 1)
4938 {
4939 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4940 sub_nsubs = joined_lines_count - 1;
4941 sub_nlines = 1;
4942 (void)do_sub_msg(FALSE);
4943 ex_may_print(eap);
4944 }
4945
4946 if (!cmdmod.keeppatterns)
4947 save_re_pat(RE_SUBST, pat, p_magic);
4948#ifdef FEAT_CMDHIST
4949 /* put pattern in history */
4950 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4951#endif
4952
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004953 return;
4954 }
4955
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 /*
4957 * Find trailing options. When '&' is used, keep old options.
4958 */
4959 if (*cmd == '&')
4960 ++cmd;
4961 else
4962 {
4963 if (!p_ed)
4964 {
4965 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004966 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004968 subflags.do_all = FALSE;
4969 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004971 subflags.do_error = TRUE;
4972 subflags.do_print = FALSE;
4973 subflags.do_count = FALSE;
4974 subflags.do_number = FALSE;
4975 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 }
4977 while (*cmd)
4978 {
4979 /*
4980 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4981 * 'r' is never inverted.
4982 */
4983 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004984 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004986 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004987 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004988 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004990 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 else if (*cmd == 'r') /* use last used regexp */
4992 which_pat = RE_LAST;
4993 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004994 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004995 else if (*cmd == '#')
4996 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004997 subflags.do_print = TRUE;
4998 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004999 }
5000 else if (*cmd == 'l')
5001 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005002 subflags.do_print = TRUE;
5003 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005004 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005006 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005008 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 else
5010 break;
5011 ++cmd;
5012 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005013 if (subflags.do_count)
5014 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005016 save_do_all = subflags.do_all;
5017 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005018
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 /*
5020 * check for a trailing count
5021 */
5022 cmd = skipwhite(cmd);
5023 if (VIM_ISDIGIT(*cmd))
5024 {
5025 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005026 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 {
5028 EMSG(_(e_zerocount));
5029 return;
5030 }
5031 eap->line1 = eap->line2;
5032 eap->line2 += i - 1;
5033 if (eap->line2 > curbuf->b_ml.ml_line_count)
5034 eap->line2 = curbuf->b_ml.ml_line_count;
5035 }
5036
5037 /*
5038 * check for trailing command or garbage
5039 */
5040 cmd = skipwhite(cmd);
5041 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5042 {
5043 eap->nextcmd = check_nextcmd(cmd);
5044 if (eap->nextcmd == NULL)
5045 {
5046 EMSG(_(e_trailing));
5047 return;
5048 }
5049 }
5050
5051 if (eap->skip) /* not executing commands, only parsing */
5052 return;
5053
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005054 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005055 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005056 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005057 EMSG(_(e_modifiable));
5058 return;
5059 }
5060
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5062 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005063 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 EMSG(_(e_invcmd));
5065 return;
5066 }
5067
5068 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005069 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005071 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 regmatch.rmm_ic = FALSE;
5073
5074 sub_firstline = NULL;
5075
5076 /*
5077 * ~ in the substitute pattern is replaced with the old pattern.
5078 * We do it here once to avoid it to be replaced over and over again.
5079 * But don't do it when it starts with "\=", then it's an expression.
5080 */
5081 if (!(sub[0] == '\\' && sub[1] == '='))
5082 sub = regtilde(sub, p_magic);
5083
5084 /*
5085 * Check for a match on each line.
5086 */
5087 line2 = eap->line2;
5088 for (lnum = eap->line1; lnum <= line2 && !(got_quit
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01005089#if defined(FEAT_EVAL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 || aborting()
5091#endif
5092 ); ++lnum)
5093 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005094 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005095 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 if (nmatch)
5097 {
5098 colnr_T copycol;
5099 colnr_T matchcol;
5100 colnr_T prev_matchcol = MAXCOL;
5101 char_u *new_end, *new_start = NULL;
5102 unsigned new_start_len = 0;
5103 char_u *p1;
5104 int did_sub = FALSE;
5105 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005106 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 long nmatch_tl = 0; /* nr of lines matched below lnum */
5108 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005109 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005110 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111
5112 /*
5113 * The new text is build up step by step, to avoid too much
5114 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005115 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 * copycol Column in the old text where we started
5117 * looking for a match; from here old text still
5118 * needs to be copied to the new text.
5119 * matchcol Column number of the old text where to look
5120 * for the next match. It's just after the
5121 * previous match or one further.
5122 * prev_matchcol Column just after the previous match (if any).
5123 * Mostly equal to matchcol, except for the first
5124 * match and after skipping an empty match.
5125 * regmatch.*pos Where the pattern matched in the old text.
5126 * new_start The new text, all that has been produced so
5127 * far.
5128 * new_end The new text, where to append new text.
5129 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005130 * lnum The line number where we found the start of
5131 * the match. Can be below the line we searched
5132 * when there is a \n before a \zs in the
5133 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 * sub_firstlnum The line number in the buffer where to look
5135 * for a match. Can be different from "lnum"
5136 * when the pattern or substitute string contains
5137 * line breaks.
5138 *
5139 * Special situations:
5140 * - When the substitute string contains a line break, the part up
5141 * to the line break is inserted in the text, but the copy of
5142 * the original line is kept. "sub_firstlnum" is adjusted for
5143 * the inserted lines.
5144 * - When the matched pattern contains a line break, the old line
5145 * is taken from the line at the end of the pattern. The lines
5146 * in the match are deleted later, "sub_firstlnum" is adjusted
5147 * accordingly.
5148 *
5149 * The new text is built up in new_start[]. It has some extra
5150 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005151 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 *
5153 * Make a copy of the old line, so it won't be taken away when
5154 * updating the screen or handling a multi-line match. The "old_"
5155 * pointers point into this copy.
5156 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005157 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 copycol = 0;
5159 matchcol = 0;
5160
5161 /* At first match, remember current cursor position. */
5162 if (!got_match)
5163 {
5164 setpcmark();
5165 got_match = TRUE;
5166 }
5167
5168 /*
5169 * Loop until nothing more to replace in this line.
5170 * 1. Handle match with empty string.
5171 * 2. If do_ask is set, ask for confirmation.
5172 * 3. substitute the string.
5173 * 4. if do_all is set, find next match
5174 * 5. break if there isn't another match in this line
5175 */
5176 for (;;)
5177 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005178 /* Advance "lnum" to the line where the match starts. The
5179 * match does not start in the first line when there is a line
5180 * break before \zs. */
5181 if (regmatch.startpos[0].lnum > 0)
5182 {
5183 lnum += regmatch.startpos[0].lnum;
5184 sub_firstlnum += regmatch.startpos[0].lnum;
5185 nmatch -= regmatch.startpos[0].lnum;
Bram Moolenaard23a8232018-02-10 18:45:26 +01005186 VIM_CLEAR(sub_firstline);
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005187 }
5188
5189 if (sub_firstline == NULL)
5190 {
5191 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5192 if (sub_firstline == NULL)
5193 {
5194 vim_free(new_start);
5195 goto outofmem;
5196 }
5197 }
5198
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 /* Save the line number of the last change for the final
5200 * cursor position (just like Vi). */
5201 curwin->w_cursor.lnum = lnum;
5202 do_again = FALSE;
5203
5204 /*
5205 * 1. Match empty string does not count, except for first
5206 * match. This reproduces the strange vi behaviour.
5207 * This also catches endless loops.
5208 */
5209 if (matchcol == prev_matchcol
5210 && regmatch.endpos[0].lnum == 0
5211 && matchcol == regmatch.endpos[0].col)
5212 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005213 if (sub_firstline[matchcol] == NUL)
5214 /* We already were at the end of the line. Don't look
5215 * for a match in this line again. */
5216 skip_match = TRUE;
5217 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005218 {
5219 /* search for a match at next column */
5220#ifdef FEAT_MBYTE
5221 if (has_mbyte)
5222 matchcol += mb_ptr2len(sub_firstline + matchcol);
5223 else
5224#endif
5225 ++matchcol;
5226 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 goto skip;
5228 }
5229
5230 /* Normally we continue searching for a match just after the
5231 * previous match. */
5232 matchcol = regmatch.endpos[0].col;
5233 prev_matchcol = matchcol;
5234
5235 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005236 * 2. If do_count is set only increase the counter.
5237 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005239 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005240 {
5241 /* For a multi-line match, put matchcol at the NUL at
5242 * the end of the line and set nmatch to one, so that
5243 * we continue looking for a match on the next line.
5244 * Avoids that ":s/\nB\@=//gc" get stuck. */
5245 if (nmatch > 1)
5246 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005247 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005248 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005249 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005250 }
5251 sub_nsubs++;
5252 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005253#ifdef FEAT_EVAL
5254 /* Skip the substitution, unless an expression is used,
5255 * then it is evaluated in the sandbox. */
5256 if (!(sub[0] == '\\' && sub[1] == '='))
5257#endif
5258 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005259 }
5260
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005261 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005263 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005264
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 /* change State to CONFIRM, so that the mouse works
5266 * properly */
5267 save_State = State;
5268 State = CONFIRM;
5269#ifdef FEAT_MOUSE
5270 setmouse(); /* disable mouse in xterm */
5271#endif
5272 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005273#ifdef FEAT_CURSORBIND
5274 if (curwin->w_p_crb)
5275 do_check_cursorbind();
5276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277
5278 /* When 'cpoptions' contains "u" don't sync undo when
5279 * asking for confirmation. */
5280 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5281 ++no_u_sync;
5282
5283 /*
5284 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5285 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005286 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005288 if (exmode_active)
5289 {
5290 char_u *resp;
5291 colnr_T sc, ec;
5292
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005293 print_line_no_prefix(lnum,
5294 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005295
5296 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5297 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005298 if (curwin->w_cursor.col < 0)
5299 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005300 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005301 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005302 {
5303 int numw = number_width(curwin) + 1;
5304 sc += numw;
5305 ec += numw;
5306 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005307 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005308 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005309 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005310 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005311 msg_putchar('^');
5312
5313 resp = getexmodeline('?', NULL, 0);
5314 if (resp != NULL)
5315 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005316 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005317 vim_free(resp);
5318 }
5319 }
5320 else
5321 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005322 char_u *orig_line = NULL;
5323 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005325 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005327 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005329 /* Invert the matched string.
5330 * Remove the inversion afterwards. */
5331 temp = RedrawingDisabled;
5332 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005334 if (new_start != NULL)
5335 {
5336 /* There already was a substitution, we would
5337 * like to show this to the user. We cannot
5338 * really update the line, it would change
5339 * what matches. Temporarily replace the line
5340 * and change it back afterwards. */
5341 orig_line = vim_strsave(ml_get(lnum));
5342 if (orig_line != NULL)
5343 {
5344 char_u *new_line = concat_str(new_start,
5345 sub_firstline + copycol);
5346
5347 if (new_line == NULL)
Bram Moolenaard23a8232018-02-10 18:45:26 +01005348 VIM_CLEAR(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005349 else
5350 {
5351 /* Position the cursor relative to the
5352 * end of the line, the previous
5353 * substitute may have inserted or
5354 * deleted characters before the
5355 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005356 len_change = (int)STRLEN(new_line)
5357 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005358 curwin->w_cursor.col += len_change;
5359 ml_replace(lnum, new_line, FALSE);
5360 }
5361 }
5362 }
5363
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005364 search_match_lines = regmatch.endpos[0].lnum
5365 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005366 search_match_endcol = regmatch.endpos[0].col
5367 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005368 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005370 update_topline();
5371 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005372 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005373 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005374 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375
5376#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005377 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005379 if (msg_row == Rows - 1)
5380 msg_didout = FALSE; /* avoid a scroll-up */
5381 msg_starthere();
5382 i = msg_scroll;
5383 msg_scroll = 0; /* truncate msg when
5384 needed */
5385 msg_no_more = TRUE;
5386 /* write message same highlighting as for
5387 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005388 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005389 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5390 msg_no_more = FALSE;
5391 msg_scroll = i;
5392 showruler(TRUE);
5393 windgoto(msg_row, msg_col);
5394 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395
5396#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005397 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005399 ++no_mapping; /* don't map this key */
5400 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005401 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005402 --allow_keys;
5403 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005405 /* clear the question */
5406 msg_didout = FALSE; /* don't scroll up */
5407 msg_col = 0;
5408 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005409
5410 /* restore the line */
5411 if (orig_line != NULL)
5412 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005413 }
5414
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005416 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005418 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419#endif
5420 )
5421 {
5422 got_quit = TRUE;
5423 break;
5424 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005425 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005427 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005429 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 {
5431 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005432 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 line2 = lnum;
5434 break;
5435 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005436 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005438 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 break;
5440 }
5441#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005442 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005444 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 scrolldown_clamp();
5446#endif
5447 }
5448 State = save_State;
5449#ifdef FEAT_MOUSE
5450 setmouse();
5451#endif
5452 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5453 --no_u_sync;
5454
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005455 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 {
5457 /* For a multi-line match, put matchcol at the NUL at
5458 * the end of the line and set nmatch to one, so that
5459 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005460 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5461 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 if (nmatch > 1)
5463 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005464 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005465 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 }
5467 goto skip;
5468 }
5469 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005470 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 }
5472
5473 /* Move the cursor to the start of the match, so that we can
5474 * use "\=col("."). */
5475 curwin->w_cursor.col = regmatch.startpos[0].col;
5476
5477 /*
5478 * 3. substitute the string.
5479 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005480#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005481 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005482 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005483 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005484 save_ma = curbuf->b_p_ma;
5485 curbuf->b_p_ma = FALSE;
5486 sandbox++;
5487 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005488 /* Save flags for recursion. They can change for e.g.
5489 * :s/^/\=execute("s#^##gn") */
5490 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005491#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005493 sublen = vim_regsub_multi(&regmatch,
5494 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005496#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005497 /* Don't keep flags set by a recursive call. */
5498 subflags = subflags_save;
5499 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005500 {
5501 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005502 if (sandbox > 0)
5503 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005504 goto skip;
5505 }
5506#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507
Bram Moolenaar4463f292005-09-25 22:20:24 +00005508 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005509 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005510 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5511 {
5512 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5513 skip_match = TRUE;
5514 }
5515
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 /* Need room for:
5517 * - result so far in new_start (not for first sub in line)
5518 * - original text up to match
5519 * - length of substituted part
5520 * - original text after match
5521 */
5522 if (nmatch == 1)
5523 p1 = sub_firstline;
5524 else
5525 {
5526 p1 = ml_get(sub_firstlnum + nmatch - 1);
5527 nmatch_tl += nmatch - 1;
5528 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005529 copy_len = regmatch.startpos[0].col - copycol;
5530 needed_len = copy_len + ((unsigned)STRLEN(p1)
5531 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 if (new_start == NULL)
5533 {
5534 /*
5535 * Get some space for a temporary buffer to do the
5536 * substitution into (and some extra space to avoid
5537 * too many calls to alloc()/free()).
5538 */
5539 new_start_len = needed_len + 50;
5540 if ((new_start = alloc_check(new_start_len)) == NULL)
5541 goto outofmem;
5542 *new_start = NUL;
5543 new_end = new_start;
5544 }
5545 else
5546 {
5547 /*
5548 * Check if the temporary buffer is long enough to do the
5549 * substitution into. If not, make it larger (with a bit
5550 * extra to avoid too many calls to alloc()/free()).
5551 */
5552 len = (unsigned)STRLEN(new_start);
5553 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005554 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 {
5556 new_start_len = needed_len + 50;
5557 if ((p1 = alloc_check(new_start_len)) == NULL)
5558 {
5559 vim_free(new_start);
5560 goto outofmem;
5561 }
5562 mch_memmove(p1, new_start, (size_t)(len + 1));
5563 vim_free(new_start);
5564 new_start = p1;
5565 }
5566 new_end = new_start + len;
5567 }
5568
5569 /*
5570 * copy the text up to the part that matched
5571 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005572 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5573 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005575 (void)vim_regsub_multi(&regmatch,
5576 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 sub, new_end, TRUE, p_magic, TRUE);
5578 sub_nsubs++;
5579 did_sub = TRUE;
5580
5581 /* Move the cursor to the start of the line, to avoid that it
5582 * is beyond the end of the line after the substitution. */
5583 curwin->w_cursor.col = 0;
5584
5585 /* For a multi-line match, make a copy of the last matched
5586 * line and continue in that one. */
5587 if (nmatch > 1)
5588 {
5589 sub_firstlnum += nmatch - 1;
5590 vim_free(sub_firstline);
5591 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5592 /* When going beyond the last line, stop substituting. */
5593 if (sub_firstlnum <= line2)
5594 do_again = TRUE;
5595 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005596 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 }
5598
5599 /* Remember next character to be copied. */
5600 copycol = regmatch.endpos[0].col;
5601
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005602 if (skip_match)
5603 {
5604 /* Already hit end of the buffer, sub_firstlnum is one
5605 * less than what it ought to be. */
5606 vim_free(sub_firstline);
5607 sub_firstline = vim_strsave((char_u *)"");
5608 copycol = 0;
5609 }
5610
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 /*
5612 * Now the trick is to replace CTRL-M chars with a real line
5613 * break. This would make it impossible to insert a CTRL-M in
5614 * the text. The line break can be avoided by preceding the
5615 * CTRL-M with a backslash. To be able to insert a backslash,
5616 * they must be doubled in the string and are halved here.
5617 * That is Vi compatible.
5618 */
5619 for (p1 = new_end; *p1; ++p1)
5620 {
5621 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005622 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 else if (*p1 == CAR)
5624 {
5625 if (u_inssub(lnum) == OK) /* prepare for undo */
5626 {
5627 *p1 = NUL; /* truncate up to the CR */
5628 ml_append(lnum - 1, new_start,
5629 (colnr_T)(p1 - new_start + 1), FALSE);
5630 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005631 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632 appended_lines(lnum - 1, 1L);
5633 else
5634 {
5635 if (first_line == 0)
5636 first_line = lnum;
5637 last_line = lnum + 1;
5638 }
5639 /* All line numbers increase. */
5640 ++sub_firstlnum;
5641 ++lnum;
5642 ++line2;
5643 /* move the cursor to the new line, like Vi */
5644 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005645 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005646 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 p1 = new_start - 1;
5648 }
5649 }
5650#ifdef FEAT_MBYTE
5651 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005652 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653#endif
5654 }
5655
5656 /*
5657 * 4. If do_all is set, find next match.
5658 * Prevent endless loop with patterns that match empty
5659 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5660 * But ":s/\n/#/" is OK.
5661 */
5662skip:
5663 /* We already know that we did the last subst when we are at
5664 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005665 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5666 * "line2" when there is a \zs in the pattern after a line
5667 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005668 lastone = (skip_match
5669 || got_int
5670 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005671 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005672 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005673 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5674 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 nmatch = -1;
5676
5677 /*
5678 * Replace the line in the buffer when needed. This is
5679 * skipped when there are more matches.
5680 * The check for nmatch_tl is needed for when multi-line
5681 * matching must replace the lines before trying to do another
5682 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005683 * When the match starts below where we start searching also
5684 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 */
5686 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 || nmatch_tl > 0
5688 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005689 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005690 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005691 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 {
5693 if (new_start != NULL)
5694 {
5695 /*
5696 * Copy the rest of the line, that didn't match.
5697 * "matchcol" has to be adjusted, we use the end of
5698 * the line as reference, because the substitute may
5699 * have changed the number of characters. Same for
5700 * "prev_matchcol".
5701 */
5702 STRCAT(new_start, sub_firstline + copycol);
5703 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5704 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5705 - prev_matchcol;
5706
5707 if (u_savesub(lnum) != OK)
5708 break;
5709 ml_replace(lnum, new_start, TRUE);
5710
5711 if (nmatch_tl > 0)
5712 {
5713 /*
5714 * Matched lines have now been substituted and are
5715 * useless, delete them. The part after the match
5716 * has been appended to new_start, we don't need
5717 * it in the buffer.
5718 */
5719 ++lnum;
5720 if (u_savedel(lnum, nmatch_tl) != OK)
5721 break;
5722 for (i = 0; i < nmatch_tl; ++i)
5723 ml_delete(lnum, (int)FALSE);
5724 mark_adjust(lnum, lnum + nmatch_tl - 1,
5725 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005726 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 deleted_lines(lnum, nmatch_tl);
5728 --lnum;
5729 line2 -= nmatch_tl; /* nr of lines decreases */
5730 nmatch_tl = 0;
5731 }
5732
5733 /* When asking, undo is saved each time, must also set
5734 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005735 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 changed_bytes(lnum, 0);
5737 else
5738 {
5739 if (first_line == 0)
5740 first_line = lnum;
5741 last_line = lnum + 1;
5742 }
5743
5744 sub_firstlnum = lnum;
5745 vim_free(sub_firstline); /* free the temp buffer */
5746 sub_firstline = new_start;
5747 new_start = NULL;
5748 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5749 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5750 - prev_matchcol;
5751 copycol = 0;
5752 }
5753 if (nmatch == -1 && !lastone)
5754 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005755 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756
5757 /*
5758 * 5. break if there isn't another match in this line
5759 */
5760 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005761 {
5762 /* If the match found didn't start where we were
5763 * searching, do the next search in the line where we
5764 * found the match. */
5765 if (nmatch == -1)
5766 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005768 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 }
5770
5771 line_breakcheck();
5772 }
5773
5774 if (did_sub)
5775 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005776 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaard23a8232018-02-10 18:45:26 +01005777 VIM_CLEAR(sub_firstline); /* free the copy of the original line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 }
5779
5780 line_breakcheck();
5781 }
5782
5783 if (first_line != 0)
5784 {
5785 /* Need to subtract the number of added lines from "last_line" to get
5786 * the line number before the change (same as adding the number of
5787 * deleted lines). */
5788 i = curbuf->b_ml.ml_line_count - old_line_count;
5789 changed_lines(first_line, 0, last_line - i, i);
5790 }
5791
5792outofmem:
5793 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005794
5795 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005796 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005797 curwin->w_cursor = old_cursor;
5798
Bram Moolenaar46475522010-03-23 17:36:29 +01005799 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 {
5801 /* Set the '[ and '] marks. */
5802 curbuf->b_op_start.lnum = eap->line1;
5803 curbuf->b_op_end.lnum = line2;
5804 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5805
5806 if (!global_busy)
5807 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005808 /* when interactive leave cursor on the match */
5809 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005810 {
5811 if (endcolumn)
5812 coladvance((colnr_T)MAXCOL);
5813 else
5814 beginline(BL_WHITE | BL_FIX);
5815 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005816 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 MSG("");
5818 }
5819 else
5820 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005821 if (subflags.do_print)
5822 print_line(curwin->w_cursor.lnum,
5823 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 }
5825 else if (!global_busy)
5826 {
5827 if (got_int) /* interrupted */
5828 EMSG(_(e_interr));
5829 else if (got_match) /* did find something but nothing substituted */
5830 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005831 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 EMSG2(_(e_patnotf2), get_search_pat());
5833 }
5834
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005835#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005836 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005837 /* Cursor position may require updating */
5838 changed_window_setting();
5839#endif
5840
Bram Moolenaar473de612013-06-08 18:19:48 +02005841 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005842
5843 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005844 subflags.do_all = save_do_all;
5845 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846}
5847
5848/*
5849 * Give message for number of substitutions.
5850 * Can also be used after a ":global" command.
5851 * Return TRUE if a message was given.
5852 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005853 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005854do_sub_msg(
5855 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856{
5857 /*
5858 * Only report substitutions when:
5859 * - more than 'report' substitutions
5860 * - command was typed by user, or number of changed lines > 'report'
5861 * - giving messages is not disabled by 'lazyredraw'
5862 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005863 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5864 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 && messaging())
5866 {
5867 if (got_int)
5868 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005869 else
5870 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005872 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005873 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005875 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005876 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 sub_nsubs);
5878 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005879 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005880 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005882 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005883 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005886 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 return TRUE;
5888 }
5889 if (got_int)
5890 {
5891 EMSG(_(e_interr));
5892 return TRUE;
5893 }
5894 return FALSE;
5895}
5896
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005897 static void
5898global_exe_one(char_u *cmd, linenr_T lnum)
5899{
5900 curwin->w_cursor.lnum = lnum;
5901 curwin->w_cursor.col = 0;
5902 if (*cmd == NUL || *cmd == '\n')
5903 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5904 else
5905 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5906}
5907
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908/*
5909 * Execute a global command of the form:
5910 *
5911 * g/pattern/X : execute X on all lines where pattern matches
5912 * v/pattern/X : execute X on all lines where pattern does not match
5913 *
5914 * where 'X' is an EX command
5915 *
5916 * The command character (as well as the trailing slash) is optional, and
5917 * is assumed to be 'p' if missing.
5918 *
5919 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005920 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 * for each line that has a mark. This is required because after deleting
5922 * lines we do not know where to search for the next match.
5923 */
5924 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005925ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926{
5927 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005928 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 int type; /* first char of cmd: 'v' or 'g' */
5930 char_u *cmd; /* command argument */
5931
5932 char_u delim; /* delimiter, normally '/' */
5933 char_u *pat;
5934 regmmatch_T regmatch;
5935 int match;
5936 int which_pat;
5937
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005938 /* When nesting the command works on one line. This allows for
5939 * ":g/found/v/notfound/command". */
5940 if (global_busy && (eap->line1 != 1
5941 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005943 /* will increment global_busy to break out of the loop */
5944 EMSG(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 return;
5946 }
5947
5948 if (eap->forceit) /* ":global!" is like ":vglobal" */
5949 type = 'v';
5950 else
5951 type = *eap->cmd;
5952 cmd = eap->arg;
5953 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954
5955 /*
5956 * undocumented vi feature:
5957 * "\/" and "\?": use previous search pattern.
5958 * "\&": use previous substitute pattern.
5959 */
5960 if (*cmd == '\\')
5961 {
5962 ++cmd;
5963 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5964 {
5965 EMSG(_(e_backslash));
5966 return;
5967 }
5968 if (*cmd == '&')
5969 which_pat = RE_SUBST; /* use previous substitute pattern */
5970 else
5971 which_pat = RE_SEARCH; /* use previous search pattern */
5972 ++cmd;
5973 pat = (char_u *)"";
5974 }
5975 else if (*cmd == NUL)
5976 {
5977 EMSG(_("E148: Regular expression missing from global"));
5978 return;
5979 }
5980 else
5981 {
5982 delim = *cmd; /* get the delimiter */
5983 if (delim)
5984 ++cmd; /* skip delimiter if there is one */
5985 pat = cmd; /* remember start of pattern */
5986 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5987 if (cmd[0] == delim) /* end delimiter found */
5988 *cmd++ = NUL; /* replace it with a NUL */
5989 }
5990
5991#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5992 if (p_altkeymap && curwin->w_p_rl)
5993 lrFswap(pat,0);
5994#endif
5995
5996 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5997 {
5998 EMSG(_(e_invcmd));
5999 return;
6000 }
6001
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006002 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006003 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006004 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006005 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006006 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006008 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 }
6010 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006011 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006012 /*
6013 * pass 1: set marks for each (not) matching line
6014 */
6015 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6016 {
6017 /* a match on this line? */
6018 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006019 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006020 if ((type == 'g' && match) || (type == 'v' && !match))
6021 {
6022 ml_setmarked(lnum);
6023 ndone++;
6024 }
6025 line_breakcheck();
6026 }
6027
6028 /*
6029 * pass 2: execute the command for each line that has been marked
6030 */
6031 if (got_int)
6032 MSG(_(e_interr));
6033 else if (ndone == 0)
6034 {
6035 if (type == 'v')
6036 smsg((char_u *)_("Pattern found in every line: %s"), pat);
6037 else
6038 smsg((char_u *)_("Pattern not found: %s"), pat);
6039 }
6040 else
6041 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006042#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006043 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006044#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006045 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006046#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006047 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006048#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006049 }
6050
6051 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006052 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053
Bram Moolenaar473de612013-06-08 18:19:48 +02006054 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055}
6056
6057/*
6058 * Execute "cmd" on lines marked with ml_setmarked().
6059 */
6060 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006061global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006063 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6064 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6065 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066
6067 /*
6068 * Set current position only once for a global command.
6069 * If global_busy is set, setpcmark() will not do anything.
6070 * If there is an error, global_busy will be incremented.
6071 */
6072 setpcmark();
6073
6074 /* When the command writes a message, don't overwrite the command. */
6075 msg_didout = TRUE;
6076
Bram Moolenaard25bc232010-03-23 17:49:24 +01006077 sub_nsubs = 0;
6078 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 global_need_beginline = FALSE;
6080 global_busy = 1;
6081 old_lcount = curbuf->b_ml.ml_line_count;
6082 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6083 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006084 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 ui_breakcheck();
6086 }
6087
6088 global_busy = 0;
6089 if (global_need_beginline)
6090 beginline(BL_WHITE | BL_FIX);
6091 else
6092 check_cursor(); /* cursor may be beyond the end of the line */
6093
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006094 /* the cursor may not have moved in the text but a change in a previous
6095 * line may move it on the screen */
6096 changed_line_abv_curs();
6097
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 /* If it looks like no message was written, allow overwriting the
6099 * command with the report for number of changes. */
6100 if (msg_col == 0 && msg_scrolled == 0)
6101 msg_didout = FALSE;
6102
Bram Moolenaar45667512007-05-10 19:24:43 +00006103 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006104 * number of extra or deleted lines.
6105 * Don't report extra or deleted lines in the edge case where the buffer
6106 * we are in after execution is different from the buffer we started in. */
6107 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6109}
6110
6111#ifdef FEAT_VIMINFO
6112 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006113read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006115 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 vim_free(old_sub);
6117 if (force || old_sub == NULL)
6118 old_sub = viminfo_readstring(virp, 1, TRUE);
6119 return viminfo_readline(virp);
6120}
6121
6122 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006123write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124{
6125 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6126 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006127 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 viminfo_writestring(fp, old_sub);
6129 }
6130}
6131#endif /* FEAT_VIMINFO */
6132
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006133#if defined(EXITFREE) || defined(PROTO)
6134 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006135free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006136{
6137 vim_free(old_sub);
6138}
6139#endif
6140
Bram Moolenaar4033c552017-09-16 20:54:51 +02006141#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142/*
6143 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006144 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006146 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006147prepare_tagpreview(
6148 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149{
6150 win_T *wp;
6151
6152# ifdef FEAT_GUI
6153 need_mouse_correct = TRUE;
6154# endif
6155
6156 /*
6157 * If there is already a preview window open, use that one.
6158 */
6159 if (!curwin->w_p_pvw)
6160 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006161 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 if (wp->w_p_pvw)
6163 break;
6164 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006165 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 else
6167 {
6168 /*
6169 * There is no preview window open yet. Create one.
6170 */
6171 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6172 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006173 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 curwin->w_p_pvw = TRUE;
6175 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006176 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6177 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178# ifdef FEAT_DIFF
6179 curwin->w_p_diff = FALSE; /* no 'diff' */
6180# endif
6181# ifdef FEAT_FOLDING
6182 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6183# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006184 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 }
6186 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006187 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188}
6189
6190#endif
6191
6192
6193/*
6194 * ":help": open a read-only window on a help file
6195 */
6196 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006197ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198{
6199 char_u *arg;
6200 char_u *tag;
6201 FILE *helpfd; /* file descriptor of help file */
6202 int n;
6203 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 int num_matches;
6206 char_u **matches;
6207 char_u *p;
6208 int empty_fnum = 0;
6209 int alt_fnum = 0;
6210 buf_T *buf;
6211#ifdef FEAT_MULTI_LANG
6212 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006213 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006215#ifdef FEAT_FOLDING
6216 int old_KeyTyped = KeyTyped;
6217#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218
6219 if (eap != NULL)
6220 {
6221 /*
6222 * A ":help" command ends at the first LF, or at a '|' that is
6223 * followed by some text. Set nextcmd to the following command.
6224 */
6225 for (arg = eap->arg; *arg; ++arg)
6226 {
6227 if (*arg == '\n' || *arg == '\r'
6228 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6229 {
6230 *arg++ = NUL;
6231 eap->nextcmd = arg;
6232 break;
6233 }
6234 }
6235 arg = eap->arg;
6236
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006237 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 {
6239 EMSG(_("E478: Don't panic!"));
6240 return;
6241 }
6242
6243 if (eap->skip) /* not executing commands */
6244 return;
6245 }
6246 else
6247 arg = (char_u *)"";
6248
6249 /* remove trailing blanks */
6250 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006251 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 *p-- = NUL;
6253
6254#ifdef FEAT_MULTI_LANG
6255 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006256 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257#endif
6258
6259 /* When no argument given go to the index. */
6260 if (*arg == NUL)
6261 arg = (char_u *)"help.txt";
6262
6263 /*
6264 * Check if there is a match for the argument.
6265 */
6266 n = find_help_tags(arg, &num_matches, &matches,
6267 eap != NULL && eap->forceit);
6268
6269 i = 0;
6270#ifdef FEAT_MULTI_LANG
6271 if (n != FAIL && lang != NULL)
6272 /* Find first item with the requested language. */
6273 for (i = 0; i < num_matches; ++i)
6274 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006275 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 if (len > 3 && matches[i][len - 3] == '@'
6277 && STRICMP(matches[i] + len - 2, lang) == 0)
6278 break;
6279 }
6280#endif
6281 if (i >= num_matches || n == FAIL)
6282 {
6283#ifdef FEAT_MULTI_LANG
6284 if (lang != NULL)
6285 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6286 else
6287#endif
6288 EMSG2(_("E149: Sorry, no help for %s"), arg);
6289 if (n != FAIL)
6290 FreeWild(num_matches, matches);
6291 return;
6292 }
6293
6294 /* The first match (in the requested language) is the best match. */
6295 tag = vim_strsave(matches[i]);
6296 FreeWild(num_matches, matches);
6297
6298#ifdef FEAT_GUI
6299 need_mouse_correct = TRUE;
6300#endif
6301
6302 /*
6303 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006304 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006306 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006308 if (cmdmod.tab != 0)
6309 wp = NULL;
6310 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006311 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006312 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006313 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6315 win_enter(wp, TRUE);
6316 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 {
6318 /*
6319 * There is no help window yet.
6320 * Try to open the file specified by the "helpfile" option.
6321 */
6322 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6323 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006324 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 goto erret;
6326 }
6327 fclose(helpfd);
6328
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006330 * specified, the current window is vertically split and
6331 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006334 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006337 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 if (curwin->w_height < p_hh)
6340 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341
6342 /*
6343 * Open help file (do_ecmd() will set b_help flag, readfile() will
6344 * set b_p_ro flag).
6345 * Set the alternate file to the previously edited file.
6346 */
6347 alt_fnum = curbuf->b_fnum;
6348 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006349 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006350 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006351 if (!cmdmod.keepalt)
6352 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 empty_fnum = curbuf->b_fnum;
6354 }
6355 }
6356
6357 if (!p_im)
6358 restart_edit = 0; /* don't want insert mode in help file */
6359
Bram Moolenaar8f535582011-09-30 17:30:31 +02006360#ifdef FEAT_FOLDING
6361 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6362 * It is needed for do_tag top open folds under the cursor. */
6363 KeyTyped = old_KeyTyped;
6364#endif
6365
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 if (tag != NULL)
6367 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6368
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006369 /* Delete the empty buffer if we're not using it. Careful: autocommands
6370 * may have jumped to another window, check that the buffer is not in a
6371 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6373 {
6374 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006375 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 wipe_buffer(buf, TRUE);
6377 }
6378
6379 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006380 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 curwin->w_alt_fnum = alt_fnum;
6382
6383erret:
6384 vim_free(tag);
6385}
6386
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006387/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006388 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006389 */
6390 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006391ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006392{
6393 win_T *win;
6394
6395 FOR_ALL_WINDOWS(win)
6396 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006397 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006398 {
6399 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006400 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006401 }
6402 }
6403}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006405#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6406/*
6407 * In an argument search for a language specifiers in the form "@xx".
6408 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6409 * Returns NULL if not found.
6410 */
6411 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006412check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006413{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006414 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006415
6416 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6417 && ASCII_ISALPHA(arg[len - 1]))
6418 {
6419 arg[len - 3] = NUL; /* remove the '@' */
6420 return arg + len - 2;
6421 }
6422 return NULL;
6423}
6424#endif
6425
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426/*
6427 * Return a heuristic indicating how well the given string matches. The
6428 * smaller the number, the better the match. This is the order of priorities,
6429 * from best match to worst match:
6430 * - Match with least alpha-numeric characters is better.
6431 * - Match with least total characters is better.
6432 * - Match towards the start is better.
6433 * - Match starting with "+" is worse (feature instead of command)
6434 * Assumption is made that the matched_string passed has already been found to
6435 * match some string for which help is requested. webb.
6436 */
6437 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006438help_heuristic(
6439 char_u *matched_string,
6440 int offset, /* offset for match */
6441 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442{
6443 int num_letters;
6444 char_u *p;
6445
6446 num_letters = 0;
6447 for (p = matched_string; *p; p++)
6448 if (ASCII_ISALNUM(*p))
6449 num_letters++;
6450
6451 /*
6452 * Multiply the number of letters by 100 to give it a much bigger
6453 * weighting than the number of characters.
6454 * If there only is a match while ignoring case, add 5000.
6455 * If the match starts in the middle of a word, add 10000 to put it
6456 * somewhere in the last half.
6457 * If the match is more than 2 chars from the start, multiply by 200 to
6458 * put it after matches at the start.
6459 */
6460 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6461 && ASCII_ISALNUM(matched_string[offset - 1]))
6462 offset += 10000;
6463 else if (offset > 2)
6464 offset *= 200;
6465 if (wrong_case)
6466 offset += 5000;
6467 /* Features are less interesting than the subjects themselves, but "+"
6468 * alone is not a feature. */
6469 if (matched_string[0] == '+' && matched_string[1] != NUL)
6470 offset += 100;
6471 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6472}
6473
6474/*
6475 * Compare functions for qsort() below, that checks the help heuristics number
6476 * that has been put after the tagname by find_tags().
6477 */
6478 static int
6479#ifdef __BORLANDC__
6480_RTLENTRYF
6481#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006482help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483{
6484 char *p1;
6485 char *p2;
6486
6487 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6488 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6489 return strcmp(p1, p2);
6490}
6491
6492/*
6493 * Find all help tags matching "arg", sort them and return in matches[], with
6494 * the number of matches in num_matches.
6495 * The matches will be sorted with a "best" match algorithm.
6496 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6497 */
6498 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006499find_help_tags(
6500 char_u *arg,
6501 int *num_matches,
6502 char_u ***matches,
6503 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504{
6505 char_u *s, *d;
6506 int i;
6507 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006508 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006509 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006510 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006511 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006512 "[count]", "[quotex]",
6513 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006514 "[pattern]", "\\|", "\\%$",
6515 "s/\\~", "s/\\U", "s/\\L",
6516 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006518 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006519 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006520 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006521 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006522 "\\[count]", "\\[quotex]",
6523 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006524 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006525 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006526 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 int flags;
6528
6529 d = IObuff; /* assume IObuff is long enough! */
6530
6531 /*
6532 * Recognize a few exceptions to the rule. Some strings that contain '*'
6533 * with "star". Otherwise '*' is recognized as a wildcard.
6534 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006535 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 if (STRCMP(arg, mtable[i]) == 0)
6537 {
6538 STRCPY(d, rtable[i]);
6539 break;
6540 }
6541
6542 if (i < 0) /* no match in table */
6543 {
6544 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6545 * Also replace "\%^" and "\%(", they match every tag too.
6546 * Also "\zs", "\z1", etc.
6547 * Also "\@<", "\@=", "\@<=", etc.
6548 * And also "\_$" and "\_^". */
6549 if (arg[0] == '\\'
6550 && ((arg[1] != NUL && arg[2] == NUL)
6551 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6552 && arg[2] != NUL)))
6553 {
6554 STRCPY(d, "/\\\\");
6555 STRCPY(d + 3, arg + 1);
6556 /* Check for "/\\_$", should be "/\\_\$" */
6557 if (d[3] == '_' && d[4] == '$')
6558 STRCPY(d + 4, "\\$");
6559 }
6560 else
6561 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006562 /* Replace:
6563 * "[:...:]" with "\[:...:]"
6564 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006565 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006566 */
6567 if ((arg[0] == '[' && (arg[1] == ':'
6568 || (arg[1] == '+' && arg[2] == '+')))
6569 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 *d++ = '\\';
6571
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006572 /*
6573 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6574 */
6575 if (*arg == '(' && arg[1] == '\'')
6576 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 for (s = arg; *s; ++s)
6578 {
6579 /*
6580 * Replace "|" with "bar" and '"' with "quote" to match the name of
6581 * the tags for these commands.
6582 * Replace "*" with ".*" and "?" with "." to match command line
6583 * completion.
6584 * Insert a backslash before '~', '$' and '.' to avoid their
6585 * special meaning.
6586 */
6587 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6588 break;
6589 switch (*s)
6590 {
6591 case '|': STRCPY(d, "bar");
6592 d += 3;
6593 continue;
6594 case '"': STRCPY(d, "quote");
6595 d += 5;
6596 continue;
6597 case '*': *d++ = '.';
6598 break;
6599 case '?': *d++ = '.';
6600 continue;
6601 case '$':
6602 case '.':
6603 case '~': *d++ = '\\';
6604 break;
6605 }
6606
6607 /*
6608 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6609 * ":help i_^_CTRL-D" work.
6610 * Insert '-' before and after "CTRL-X" when applicable.
6611 */
6612 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6613 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6614 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006615 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6616 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 STRCPY(d, "CTRL-");
6618 d += 5;
6619 if (*s < ' ')
6620 {
6621#ifdef EBCDIC
6622 *d++ = CtrlChar(*s);
6623#else
6624 *d++ = *s + '@';
6625#endif
6626 if (d[-1] == '\\')
6627 *d++ = '\\'; /* double a backslash */
6628 }
6629 else
6630 *d++ = *++s;
6631 if (s[1] != NUL && s[1] != '_')
6632 *d++ = '_'; /* append a '_' */
6633 continue;
6634 }
6635 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6636 *d++ = '\\';
6637
6638 /*
6639 * Insert a backslash before a backslash after a slash, for search
6640 * pattern tags: "/\|" --> "/\\|".
6641 */
6642 else if (s[0] == '\\' && s[1] != '\\'
6643 && *arg == '/' && s == arg + 1)
6644 *d++ = '\\';
6645
6646 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6647 * "CTRL-\_CTRL-N" */
6648 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6649 {
6650 STRCPY(d, "CTRL-\\\\");
6651 d += 7;
6652 s += 6;
6653 }
6654
6655 *d++ = *s;
6656
6657 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006658 * If tag contains "({" or "([", tag terminates at the "(".
6659 * This is for help on functions, e.g.: abs({expr}).
6660 */
6661 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6662 break;
6663
6664 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 * If tag starts with ', toss everything after a second '. Fixes
6666 * CTRL-] on 'option'. (would include the trailing '.').
6667 */
6668 if (*s == '\'' && s > arg && *arg == '\'')
6669 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006670 /* Also '{' and '}'. */
6671 if (*s == '}' && s > arg && *arg == '{')
6672 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 }
6674 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006675
6676 if (*IObuff == '`')
6677 {
6678 if (d > IObuff + 2 && d[-1] == '`')
6679 {
6680 /* remove the backticks from `command` */
6681 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6682 d[-2] = NUL;
6683 }
6684 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6685 {
6686 /* remove the backticks and comma from `command`, */
6687 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6688 d[-3] = NUL;
6689 }
6690 else if (d > IObuff + 4 && d[-3] == '`'
6691 && d[-2] == '\\' && d[-1] == '.')
6692 {
6693 /* remove the backticks and dot from `command`\. */
6694 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6695 d[-4] = NUL;
6696 }
6697 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 }
6699 }
6700
6701 *matches = (char_u **)"";
6702 *num_matches = 0;
6703 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6704 if (keep_lang)
6705 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006706 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006708 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 /* Sort the matches found on the heuristic number that is after the
6710 * tag name. */
6711 qsort((void *)*matches, (size_t)*num_matches,
6712 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006713 /* Delete more than TAG_MANY to reduce the size of the listing. */
6714 while (*num_matches > TAG_MANY)
6715 vim_free((*matches)[--*num_matches]);
6716 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 return OK;
6718}
6719
6720/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006721 * Called when starting to edit a buffer for a help file.
6722 */
6723 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006724prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006725{
6726 char_u *p;
6727
6728 curbuf->b_help = TRUE;
6729#ifdef FEAT_QUICKFIX
6730 set_string_option_direct((char_u *)"buftype", -1,
6731 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6732#endif
6733
6734 /*
6735 * Always set these options after jumping to a help tag, because the
6736 * user may have an autocommand that gets in the way.
6737 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6738 * latin1 word characters (for translated help files).
6739 * Only set it when needed, buf_init_chartab() is some work.
6740 */
6741 p =
6742#ifdef EBCDIC
6743 (char_u *)"65-255,^*,^|,^\"";
6744#else
6745 (char_u *)"!-~,^*,^|,^\",192-255";
6746#endif
6747 if (STRCMP(curbuf->b_p_isk, p) != 0)
6748 {
6749 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6750 check_buf_options(curbuf);
6751 (void)buf_init_chartab(curbuf, FALSE);
6752 }
6753
Bram Moolenaar0b105412014-11-30 13:34:23 +01006754#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006755 /* Don't use the global foldmethod.*/
6756 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6757 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006758#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006759
6760 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6761 curwin->w_p_list = FALSE; /* no list mode */
6762
6763 curbuf->b_p_ma = FALSE; /* not modifiable */
6764 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6765 curwin->w_p_nu = 0; /* no line numbers */
6766 curwin->w_p_rnu = 0; /* no relative line numbers */
6767 RESET_BINDING(curwin); /* no scroll or cursor binding */
6768#ifdef FEAT_ARABIC
6769 curwin->w_p_arab = FALSE; /* no arabic mode */
6770#endif
6771#ifdef FEAT_RIGHTLEFT
6772 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6773#endif
6774#ifdef FEAT_FOLDING
6775 curwin->w_p_fen = FALSE; /* No folding in the help window */
6776#endif
6777#ifdef FEAT_DIFF
6778 curwin->w_p_diff = FALSE; /* No 'diff' */
6779#endif
6780#ifdef FEAT_SPELL
6781 curwin->w_p_spell = FALSE; /* No spell checking */
6782#endif
6783
6784 set_buflisted(FALSE);
6785}
6786
6787/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 * After reading a help file: May cleanup a help buffer when syntax
6789 * highlighting is not used.
6790 */
6791 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006792fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793{
6794 linenr_T lnum;
6795 char_u *line;
6796 int in_example = FALSE;
6797 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006798 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 char_u *p;
6800 char_u *rt;
6801 int mustfree;
6802
Bram Moolenaar90492982017-06-22 14:16:31 +02006803 /* Set filetype to "help" if still needed. */
6804 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006805 {
6806 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006807 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006808 --curbuf_lock;
6809 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810
6811#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006812 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813#endif
6814 {
6815 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6816 {
6817 line = ml_get_buf(curbuf, lnum, FALSE);
6818 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006819 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 {
6821 /* End of example: non-white or '<' in first column. */
6822 if (line[0] == '<')
6823 {
6824 /* blank-out a '<' in the first column */
6825 line = ml_get_buf(curbuf, lnum, TRUE);
6826 line[0] = ' ';
6827 }
6828 in_example = FALSE;
6829 }
6830 if (!in_example && len > 0)
6831 {
6832 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6833 {
6834 /* blank-out a '>' in the last column (start of example) */
6835 line = ml_get_buf(curbuf, lnum, TRUE);
6836 line[len - 1] = ' ';
6837 in_example = TRUE;
6838 }
6839 else if (line[len - 1] == '~')
6840 {
6841 /* blank-out a '~' at the end of line (header marker) */
6842 line = ml_get_buf(curbuf, lnum, TRUE);
6843 line[len - 1] = ' ';
6844 }
6845 }
6846 }
6847 }
6848
6849 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006850 * In the "help.txt" and "help.abx" file, add the locally added help
6851 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006853 fname = gettail(curbuf->b_fname);
6854 if (fnamecmp(fname, "help.txt") == 0
6855#ifdef FEAT_MULTI_LANG
6856 || (fnamencmp(fname, "help.", 5) == 0
6857 && ASCII_ISALPHA(fname[5])
6858 && ASCII_ISALPHA(fname[6])
6859 && TOLOWER_ASC(fname[7]) == 'x'
6860 && fname[8] == NUL)
6861#endif
6862 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 {
6864 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6865 {
6866 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006867 if (strstr((char *)line, "*local-additions*") == NULL)
6868 continue;
6869
6870 /* Go through all directories in 'runtimepath', skipping
6871 * $VIMRUNTIME. */
6872 p = p_rtp;
6873 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006875 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6876 mustfree = FALSE;
6877 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
Bram Moolenaare4db7ae2018-02-13 13:12:11 +01006878 if (rt != NULL && fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006880 int fcount;
6881 char_u **fnames;
6882 FILE *fd;
6883 char_u *s;
6884 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006886 vimconv_T vc;
6887 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888#endif
6889
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006890 /* Find all "doc/ *.txt" files in this directory. */
6891 add_pathsep(NameBuff);
6892#ifdef FEAT_MULTI_LANG
6893 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006895 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006897 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6898 &fnames, EW_FILE|EW_SILENT) == OK
6899 && fcount > 0)
6900 {
6901#ifdef FEAT_MULTI_LANG
Bram Moolenaar35c5e812017-12-09 21:10:13 +01006902 int i1, i2;
6903 char_u *f1, *f2;
6904 char_u *t1, *t2;
6905 char_u *e1, *e2;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006906
6907 /* If foo.abx is found use it instead of foo.txt in
6908 * the same directory. */
6909 for (i1 = 0; i1 < fcount; ++i1)
6910 {
6911 for (i2 = 0; i2 < fcount; ++i2)
6912 {
6913 if (i1 == i2)
6914 continue;
6915 if (fnames[i1] == NULL || fnames[i2] == NULL)
6916 continue;
6917 f1 = fnames[i1];
6918 f2 = fnames[i2];
6919 t1 = gettail(f1);
Bram Moolenaar35c5e812017-12-09 21:10:13 +01006920 t2 = gettail(f2);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006921 e1 = vim_strrchr(t1, '.');
Bram Moolenaar35c5e812017-12-09 21:10:13 +01006922 e2 = vim_strrchr(t2, '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02006923 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006924 continue;
6925 if (fnamecmp(e1, ".txt") != 0
6926 && fnamecmp(e1, fname + 4) != 0)
6927 {
6928 /* Not .txt and not .abx, remove it. */
Bram Moolenaard23a8232018-02-10 18:45:26 +01006929 VIM_CLEAR(fnames[i1]);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006930 continue;
6931 }
Bram Moolenaar35c5e812017-12-09 21:10:13 +01006932 if (e1 - f1 != e2 - f2
6933 || fnamencmp(f1, f2, e1 - f1) != 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006934 continue;
6935 if (fnamecmp(e1, ".txt") == 0
6936 && fnamecmp(e2, fname + 4) == 0)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006937 /* use .abx instead of .txt */
Bram Moolenaard23a8232018-02-10 18:45:26 +01006938 VIM_CLEAR(fnames[i1]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006941#endif
6942 for (fi = 0; fi < fcount; ++fi)
6943 {
6944 if (fnames[fi] == NULL)
6945 continue;
6946 fd = mch_fopen((char *)fnames[fi], "r");
6947 if (fd != NULL)
6948 {
6949 vim_fgets(IObuff, IOSIZE, fd);
6950 if (IObuff[0] == '*'
6951 && (s = vim_strchr(IObuff + 1, '*'))
6952 != NULL)
6953 {
6954#ifdef FEAT_MBYTE
6955 int this_utf = MAYBE;
6956#endif
6957 /* Change tag definition to a
6958 * reference and remove <CR>/<NL>. */
6959 IObuff[0] = '|';
6960 *s = '|';
6961 while (*s != NUL)
6962 {
6963 if (*s == '\r' || *s == '\n')
6964 *s = NUL;
6965#ifdef FEAT_MBYTE
6966 /* The text is utf-8 when a byte
6967 * above 127 is found and no
6968 * illegal byte sequence is found.
6969 */
6970 if (*s >= 0x80 && this_utf != FALSE)
6971 {
6972 int l;
6973
6974 this_utf = TRUE;
6975 l = utf_ptr2len(s);
6976 if (l == 1)
6977 this_utf = FALSE;
6978 s += l - 1;
6979 }
6980#endif
6981 ++s;
6982 }
6983#ifdef FEAT_MBYTE
6984 /* The help file is latin1 or utf-8;
6985 * conversion to the current
6986 * 'encoding' may be required. */
6987 vc.vc_type = CONV_NONE;
6988 convert_setup(&vc, (char_u *)(
6989 this_utf == TRUE ? "utf-8"
6990 : "latin1"), p_enc);
6991 if (vc.vc_type == CONV_NONE)
6992 /* No conversion needed. */
6993 cp = IObuff;
6994 else
6995 {
6996 /* Do the conversion. If it fails
6997 * use the unconverted text. */
6998 cp = string_convert(&vc, IObuff,
6999 NULL);
7000 if (cp == NULL)
7001 cp = IObuff;
7002 }
7003 convert_setup(&vc, NULL, NULL);
7004
7005 ml_append(lnum, cp, (colnr_T)0, FALSE);
7006 if (cp != IObuff)
7007 vim_free(cp);
7008#else
7009 ml_append(lnum, IObuff, (colnr_T)0,
7010 FALSE);
7011#endif
7012 ++lnum;
7013 }
7014 fclose(fd);
7015 }
7016 }
7017 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007020 if (mustfree)
7021 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007023 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 }
7025 }
7026}
7027
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007028/*
7029 * ":exusage"
7030 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007031 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007032ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007033{
7034 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7035}
7036
7037/*
7038 * ":viusage"
7039 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007040 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007041ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007042{
7043 do_cmdline_cmd((char_u *)"help normal-index");
7044}
7045
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007047 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007050helptags_one(
7051 char_u *dir, /* doc directory */
7052 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7053 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7054 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055{
7056 FILE *fd_tags;
7057 FILE *fd;
7058 garray_T ga;
7059 int filecount;
7060 char_u **files;
7061 char_u *p1, *p2;
7062 int fi;
7063 char_u *s;
7064 int i;
7065 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007066 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067# ifdef FEAT_MBYTE
7068 int utf8 = MAYBE;
7069 int this_utf8;
7070 int firstline;
7071 int mix = FALSE; /* detected mixed encodings */
7072# endif
7073
7074 /*
7075 * Find all *.txt files.
7076 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007077 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007079 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 STRCAT(NameBuff, ext);
7081 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7082 EW_FILE|EW_SILENT) == FAIL
7083 || filecount == 0)
7084 {
7085 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007086 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 return;
7088 }
7089
7090 /*
7091 * Open the tags file for writing.
7092 * Do this before scanning through all the files.
7093 */
7094 STRCPY(NameBuff, dir);
7095 add_pathsep(NameBuff);
7096 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007097 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 if (fd_tags == NULL)
7099 {
7100 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7101 FreeWild(filecount, files);
7102 return;
7103 }
7104
7105 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007106 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7107 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 */
7109 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007110 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7111 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 {
7113 if (ga_grow(&ga, 1) == FAIL)
7114 got_int = TRUE;
7115 else
7116 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007117 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 if (s == NULL)
7119 got_int = TRUE;
7120 else
7121 {
7122 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7123 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7124 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 }
7126 }
7127 }
7128
7129 /*
7130 * Go over all the files and extract the tags.
7131 */
7132 for (fi = 0; fi < filecount && !got_int; ++fi)
7133 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007134 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 if (fd == NULL)
7136 {
7137 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7138 continue;
7139 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007140 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141
7142# ifdef FEAT_MBYTE
7143 firstline = TRUE;
7144# endif
7145 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7146 {
7147# ifdef FEAT_MBYTE
7148 if (firstline)
7149 {
7150 /* Detect utf-8 file by a non-ASCII char in the first line. */
7151 this_utf8 = MAYBE;
7152 for (s = IObuff; *s != NUL; ++s)
7153 if (*s >= 0x80)
7154 {
7155 int l;
7156
7157 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007158 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 if (l == 1)
7160 {
7161 /* Illegal UTF-8 byte sequence. */
7162 this_utf8 = FALSE;
7163 break;
7164 }
7165 s += l - 1;
7166 }
7167 if (this_utf8 == MAYBE) /* only ASCII characters found */
7168 this_utf8 = FALSE;
7169 if (utf8 == MAYBE) /* first file */
7170 utf8 = this_utf8;
7171 else if (utf8 != this_utf8)
7172 {
7173 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7174 mix = !got_int;
7175 got_int = TRUE;
7176 }
7177 firstline = FALSE;
7178 }
7179# endif
7180 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7181 while (p1 != NULL)
7182 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007183 /* Use vim_strbyte() instead of vim_strchr() so that when
7184 * 'encoding' is dbcs it still works, don't find '*' in the
7185 * second byte. */
7186 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7188 {
7189 for (s = p1 + 1; s < p2; ++s)
7190 if (*s == ' ' || *s == '\t' || *s == '|')
7191 break;
7192
7193 /*
7194 * Only accept a *tag* when it consists of valid
7195 * characters, there is white space before it and is
7196 * followed by a white character or end-of-line.
7197 */
7198 if (s == p2
7199 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7200 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7201 || s[1] == '\0'))
7202 {
7203 *p2 = '\0';
7204 ++p1;
7205 if (ga_grow(&ga, 1) == FAIL)
7206 {
7207 got_int = TRUE;
7208 break;
7209 }
7210 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7211 if (s == NULL)
7212 {
7213 got_int = TRUE;
7214 break;
7215 }
7216 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7217 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 sprintf((char *)s, "%s\t%s", p1, fname);
7219
7220 /* find next '*' */
7221 p2 = vim_strchr(p2 + 1, '*');
7222 }
7223 }
7224 p1 = p2;
7225 }
7226 line_breakcheck();
7227 }
7228
7229 fclose(fd);
7230 }
7231
7232 FreeWild(filecount, files);
7233
7234 if (!got_int)
7235 {
7236 /*
7237 * Sort the tags.
7238 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007239 if (ga.ga_data != NULL)
7240 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241
7242 /*
7243 * Check for duplicates.
7244 */
7245 for (i = 1; i < ga.ga_len; ++i)
7246 {
7247 p1 = ((char_u **)ga.ga_data)[i - 1];
7248 p2 = ((char_u **)ga.ga_data)[i];
7249 while (*p1 == *p2)
7250 {
7251 if (*p2 == '\t')
7252 {
7253 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007254 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7256 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7257 EMSG(NameBuff);
7258 *p2 = '\t';
7259 break;
7260 }
7261 ++p1;
7262 ++p2;
7263 }
7264 }
7265
7266# ifdef FEAT_MBYTE
7267 if (utf8 == TRUE)
7268 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7269# endif
7270
7271 /*
7272 * Write the tags into the file.
7273 */
7274 for (i = 0; i < ga.ga_len; ++i)
7275 {
7276 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007277 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007279 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 else
7281 {
7282 fprintf(fd_tags, "%s\t/*", s);
7283 for (p1 = s; *p1 != '\t'; ++p1)
7284 {
7285 /* insert backslash before '\\' and '/' */
7286 if (*p1 == '\\' || *p1 == '/')
7287 putc('\\', fd_tags);
7288 putc(*p1, fd_tags);
7289 }
7290 fprintf(fd_tags, "*\n");
7291 }
7292 }
7293 }
7294#ifdef FEAT_MBYTE
7295 if (mix)
7296 got_int = FALSE; /* continue with other languages */
7297#endif
7298
7299 for (i = 0; i < ga.ga_len; ++i)
7300 vim_free(((char_u **)ga.ga_data)[i]);
7301 ga_clear(&ga);
7302 fclose(fd_tags); /* there is no check for an error... */
7303}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007305/*
7306 * Generate tags in one help directory, taking care of translations.
7307 */
7308 static void
7309do_helptags(char_u *dirname, int add_help_tags)
7310{
7311#ifdef FEAT_MULTI_LANG
7312 int len;
7313 int i, j;
7314 garray_T ga;
7315 char_u lang[2];
7316 char_u ext[5];
7317 char_u fname[8];
7318 int filecount;
7319 char_u **files;
7320
7321 /* Get a list of all files in the help directory and in subdirectories. */
7322 STRCPY(NameBuff, dirname);
7323 add_pathsep(NameBuff);
7324 STRCAT(NameBuff, "**");
7325 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7326 EW_FILE|EW_SILENT) == FAIL
7327 || filecount == 0)
7328 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007329 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007330 return;
7331 }
7332
7333 /* Go over all files in the directory to find out what languages are
7334 * present. */
7335 ga_init2(&ga, 1, 10);
7336 for (i = 0; i < filecount; ++i)
7337 {
7338 len = (int)STRLEN(files[i]);
7339 if (len > 4)
7340 {
7341 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7342 {
7343 /* ".txt" -> language "en" */
7344 lang[0] = 'e';
7345 lang[1] = 'n';
7346 }
7347 else if (files[i][len - 4] == '.'
7348 && ASCII_ISALPHA(files[i][len - 3])
7349 && ASCII_ISALPHA(files[i][len - 2])
7350 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7351 {
7352 /* ".abx" -> language "ab" */
7353 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7354 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7355 }
7356 else
7357 continue;
7358
7359 /* Did we find this language already? */
7360 for (j = 0; j < ga.ga_len; j += 2)
7361 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7362 break;
7363 if (j == ga.ga_len)
7364 {
7365 /* New language, add it. */
7366 if (ga_grow(&ga, 2) == FAIL)
7367 break;
7368 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7369 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7370 }
7371 }
7372 }
7373
7374 /*
7375 * Loop over the found languages to generate a tags file for each one.
7376 */
7377 for (j = 0; j < ga.ga_len; j += 2)
7378 {
7379 STRCPY(fname, "tags-xx");
7380 fname[5] = ((char_u *)ga.ga_data)[j];
7381 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7382 if (fname[5] == 'e' && fname[6] == 'n')
7383 {
7384 /* English is an exception: use ".txt" and "tags". */
7385 fname[4] = NUL;
7386 STRCPY(ext, ".txt");
7387 }
7388 else
7389 {
7390 /* Language "ab" uses ".abx" and "tags-ab". */
7391 STRCPY(ext, ".xxx");
7392 ext[1] = fname[5];
7393 ext[2] = fname[6];
7394 }
7395 helptags_one(dirname, ext, fname, add_help_tags);
7396 }
7397
7398 ga_clear(&ga);
7399 FreeWild(filecount, files);
7400
7401#else
7402 /* No language support, just use "*.txt" and "tags". */
7403 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7404#endif
7405}
7406
7407 static void
7408helptags_cb(char_u *fname, void *cookie)
7409{
7410 do_helptags(fname, *(int *)cookie);
7411}
7412
7413/*
7414 * ":helptags"
7415 */
7416 void
7417ex_helptags(exarg_T *eap)
7418{
7419 expand_T xpc;
7420 char_u *dirname;
7421 int add_help_tags = FALSE;
7422
7423 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007424 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007425 {
7426 add_help_tags = TRUE;
7427 eap->arg = skipwhite(eap->arg + 3);
7428 }
7429
7430 if (STRCMP(eap->arg, "ALL") == 0)
7431 {
7432 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7433 helptags_cb, &add_help_tags);
7434 }
7435 else
7436 {
7437 ExpandInit(&xpc);
7438 xpc.xp_context = EXPAND_DIRECTORIES;
7439 dirname = ExpandOne(&xpc, eap->arg, NULL,
7440 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7441 if (dirname == NULL || !mch_isdir(dirname))
7442 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7443 else
7444 do_helptags(dirname, add_help_tags);
7445 vim_free(dirname);
7446 }
7447}
7448
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449#if defined(FEAT_SIGNS) || defined(PROTO)
7450
7451/*
7452 * Struct to hold the sign properties.
7453 */
7454typedef struct sign sign_T;
7455
7456struct sign
7457{
7458 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007459 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 char_u *sn_name; /* name of sign */
7461 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007462# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007464# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 char_u *sn_text; /* text used instead of pixmap */
7466 int sn_line_hl; /* highlight ID for line */
7467 int sn_text_hl; /* highlight ID for text */
7468};
7469
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007471static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007473static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7474static void sign_list_defined(sign_T *sp);
7475static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007477static char *cmds[] = {
7478 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007479# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007480 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007481# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007482 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007483# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007484 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007485# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007486 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007487# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007488 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007489# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007490 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007491# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007492};
7493
7494/*
7495 * Find index of a ":sign" subcmd from its name.
7496 * "*end_cmd" must be writable.
7497 */
7498 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007499sign_cmd_idx(
7500 char_u *begin_cmd, /* begin of sign subcmd */
7501 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007502{
7503 int idx;
7504 char save = *end_cmd;
7505
7506 *end_cmd = NUL;
7507 for (idx = 0; ; ++idx)
7508 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7509 break;
7510 *end_cmd = save;
7511 return idx;
7512}
7513
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514/*
7515 * ":sign" command
7516 */
7517 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007518ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519{
7520 char_u *arg = eap->arg;
7521 char_u *p;
7522 int idx;
7523 sign_T *sp;
7524 sign_T *sp_prev;
Bram Moolenaaraeeb6882017-11-11 16:45:19 +01007525 buf_T *buf = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526
7527 /* Parse the subcommand. */
7528 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007529 idx = sign_cmd_idx(arg, p);
7530 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007532 EMSG2(_("E160: Unknown sign command: %s"), arg);
7533 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 }
7535 arg = skipwhite(p);
7536
7537 if (idx <= SIGNCMD_LIST)
7538 {
7539 /*
7540 * Define, undefine or list signs.
7541 */
7542 if (idx == SIGNCMD_LIST && *arg == NUL)
7543 {
7544 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007545 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 sign_list_defined(sp);
7547 }
7548 else if (*arg == NUL)
7549 EMSG(_("E156: Missing sign name"));
7550 else
7551 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007552 /* Isolate the sign name. If it's a number skip leading zeroes,
7553 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 p = skiptowhite(arg);
7555 if (*p != NUL)
7556 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007557 while (arg[0] == '0' && arg[1] != NUL)
7558 ++arg;
7559
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 sp_prev = NULL;
7561 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7562 {
7563 if (STRCMP(sp->sn_name, arg) == 0)
7564 break;
7565 sp_prev = sp;
7566 }
7567 if (idx == SIGNCMD_DEFINE)
7568 {
7569 /* ":sign define {name} ...": define a sign */
7570 if (sp == NULL)
7571 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007572 sign_T *lp;
7573 int start = next_sign_typenr;
7574
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 /* Allocate a new sign. */
7576 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7577 if (sp == NULL)
7578 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007580 /* Check that next_sign_typenr is not already being used.
7581 * This only happens after wrapping around. Hopefully
7582 * another one got deleted and we can use its number. */
7583 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007585 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007587 ++next_sign_typenr;
7588 if (next_sign_typenr == MAX_TYPENR)
7589 next_sign_typenr = 1;
7590 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007592 vim_free(sp);
7593 EMSG(_("E612: Too many signs defined"));
7594 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007596 lp = first_sign; /* start all over */
7597 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007599 lp = lp->sn_next;
7600 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007602 sp->sn_typenr = next_sign_typenr;
7603 if (++next_sign_typenr == MAX_TYPENR)
7604 next_sign_typenr = 1; /* wrap around */
7605
7606 sp->sn_name = vim_strsave(arg);
7607 if (sp->sn_name == NULL) /* out of memory */
7608 {
7609 vim_free(sp);
7610 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007612
7613 /* add the new sign to the list of signs */
7614 if (sp_prev == NULL)
7615 first_sign = sp;
7616 else
7617 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 }
7619
7620 /* set values for a defined sign. */
7621 for (;;)
7622 {
7623 arg = skipwhite(p);
7624 if (*arg == NUL)
7625 break;
7626 p = skiptowhite_esc(arg);
7627 if (STRNCMP(arg, "icon=", 5) == 0)
7628 {
7629 arg += 5;
7630 vim_free(sp->sn_icon);
7631 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7632 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007633# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 if (gui.in_use)
7635 {
7636 out_flush();
7637 if (sp->sn_image != NULL)
7638 gui_mch_destroy_sign(sp->sn_image);
7639 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7640 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007641# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 }
7643 else if (STRNCMP(arg, "text=", 5) == 0)
7644 {
7645 char_u *s;
7646 int cells;
7647 int len;
7648
7649 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007650# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 /* Count cells and check for non-printable chars */
7652 if (has_mbyte)
7653 {
7654 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007655 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 {
7657 if (!vim_isprintc((*mb_ptr2char)(s)))
7658 break;
7659 cells += (*mb_ptr2cells)(s);
7660 }
7661 }
7662 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007663# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 {
7665 for (s = arg; s < p; ++s)
7666 if (!vim_isprintc(*s))
7667 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007668 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 }
7670 /* Currently must be one or two display cells */
7671 if (s != p || cells < 1 || cells > 2)
7672 {
7673 *p = NUL;
7674 EMSG2(_("E239: Invalid sign text: %s"), arg);
7675 return;
7676 }
7677
7678 vim_free(sp->sn_text);
7679 /* Allocate one byte more if we need to pad up
7680 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007681 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 sp->sn_text = vim_strnsave(arg, len);
7683
7684 if (sp->sn_text != NULL && cells == 1)
7685 STRCPY(sp->sn_text + len - 1, " ");
7686 }
7687 else if (STRNCMP(arg, "linehl=", 7) == 0)
7688 {
7689 arg += 7;
7690 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7691 }
7692 else if (STRNCMP(arg, "texthl=", 7) == 0)
7693 {
7694 arg += 7;
7695 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7696 }
7697 else
7698 {
7699 EMSG2(_(e_invarg2), arg);
7700 return;
7701 }
7702 }
7703 }
7704 else if (sp == NULL)
7705 EMSG2(_("E155: Unknown sign: %s"), arg);
7706 else if (idx == SIGNCMD_LIST)
7707 /* ":sign list {name}" */
7708 sign_list_defined(sp);
7709 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007711 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 }
7713 }
7714 else
7715 {
7716 int id = -1;
7717 linenr_T lnum = -1;
7718 char_u *sign_name = NULL;
7719 char_u *arg1;
7720
7721 if (*arg == NUL)
7722 {
7723 if (idx == SIGNCMD_PLACE)
7724 {
7725 /* ":sign place": list placed signs in all buffers */
7726 sign_list_placed(NULL);
7727 }
7728 else if (idx == SIGNCMD_UNPLACE)
7729 {
7730 /* ":sign unplace": remove placed sign at cursor */
7731 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7732 if (id > 0)
7733 {
7734 buf_delsign(curwin->w_buffer, id);
7735 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7736 }
7737 else
7738 EMSG(_("E159: Missing sign number"));
7739 }
7740 else
7741 EMSG(_(e_argreq));
7742 return;
7743 }
7744
7745 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7746 {
7747 /* ":sign unplace *": remove all placed signs */
7748 buf_delete_all_signs();
7749 return;
7750 }
7751
7752 /* first arg could be placed sign id */
7753 arg1 = arg;
7754 if (VIM_ISDIGIT(*arg))
7755 {
7756 id = getdigits(&arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01007757 if (!VIM_ISWHITE(*arg) && *arg != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 {
7759 id = -1;
7760 arg = arg1;
7761 }
7762 else
7763 {
7764 arg = skipwhite(arg);
7765 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7766 {
7767 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007768 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 if ((lnum = buf_delsign(buf, id)) != 0)
7770 update_debug_sign(buf, lnum);
7771 return;
7772 }
7773 }
7774 }
7775
7776 /*
7777 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7778 * Leave "arg" pointing to {fname}.
7779 */
7780 for (;;)
7781 {
7782 if (STRNCMP(arg, "line=", 5) == 0)
7783 {
7784 arg += 5;
7785 lnum = atoi((char *)arg);
7786 arg = skiptowhite(arg);
7787 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007788 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7789 {
7790 if (id != -1)
7791 {
7792 EMSG(_(e_invarg));
7793 return;
7794 }
7795 id = -2;
7796 arg = skiptowhite(arg + 1);
7797 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 else if (STRNCMP(arg, "name=", 5) == 0)
7799 {
7800 arg += 5;
7801 sign_name = arg;
7802 arg = skiptowhite(arg);
7803 if (*arg != NUL)
7804 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007805 while (sign_name[0] == '0' && sign_name[1] != NUL)
7806 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 }
7808 else if (STRNCMP(arg, "file=", 5) == 0)
7809 {
7810 arg += 5;
7811 buf = buflist_findname(arg);
7812 break;
7813 }
7814 else if (STRNCMP(arg, "buffer=", 7) == 0)
7815 {
7816 arg += 7;
7817 buf = buflist_findnr((int)getdigits(&arg));
7818 if (*skipwhite(arg) != NUL)
7819 EMSG(_(e_trailing));
7820 break;
7821 }
7822 else
7823 {
7824 EMSG(_(e_invarg));
7825 return;
7826 }
7827 arg = skipwhite(arg);
7828 }
7829
7830 if (buf == NULL)
7831 {
7832 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7833 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007834 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 {
7836 if (lnum >= 0 || sign_name != NULL)
7837 EMSG(_(e_invarg));
7838 else
7839 /* ":sign place file={fname}": list placed signs in one file */
7840 sign_list_placed(buf);
7841 }
7842 else if (idx == SIGNCMD_JUMP)
7843 {
7844 /* ":sign jump {id} file={fname}" */
7845 if (lnum >= 0 || sign_name != NULL)
7846 EMSG(_(e_invarg));
7847 else if ((lnum = buf_findsign(buf, id)) > 0)
7848 { /* goto a sign ... */
7849 if (buf_jump_open_win(buf) != NULL)
7850 { /* ... in a current window */
7851 curwin->w_cursor.lnum = lnum;
7852 check_cursor_lnum();
7853 beginline(BL_WHITE);
7854 }
7855 else
7856 { /* ... not currently in a window */
7857 char_u *cmd;
7858
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007859 if (buf->b_fname == NULL)
7860 {
7861 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7862 return;
7863 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7865 if (cmd == NULL)
7866 return;
7867 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7868 do_cmdline_cmd(cmd);
7869 vim_free(cmd);
7870 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007871# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007873# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 }
7875 else
7876 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7877 }
7878 else if (idx == SIGNCMD_UNPLACE)
7879 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 if (lnum >= 0 || sign_name != NULL)
7881 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007882 else if (id == -2)
7883 {
7884 /* ":sign unplace * file={fname}" */
7885 redraw_buf_later(buf, NOT_VALID);
7886 buf_delete_signs(buf);
7887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 else
7889 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007890 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 lnum = buf_delsign(buf, id);
7892 update_debug_sign(buf, lnum);
7893 }
7894 }
7895 /* idx == SIGNCMD_PLACE */
7896 else if (sign_name != NULL)
7897 {
7898 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7899 if (STRCMP(sp->sn_name, sign_name) == 0)
7900 break;
7901 if (sp == NULL)
7902 {
7903 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7904 return;
7905 }
7906 if (lnum > 0)
7907 /* ":sign place {id} line={lnum} name={name} file={fname}":
7908 * place a sign */
7909 buf_addsign(buf, id, lnum, sp->sn_typenr);
7910 else
7911 /* ":sign place {id} file={fname}": change sign type */
7912 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007913 if (lnum > 0)
7914 update_debug_sign(buf, lnum);
7915 else
7916 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 }
7918 else
7919 EMSG(_(e_invarg));
7920 }
7921}
7922
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007923# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924/*
7925 * Allocate the icons. Called when the GUI has started. Allows defining
7926 * signs before it starts.
7927 */
7928 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007929sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930{
7931 sign_T *sp;
7932
7933 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7934 if (sp->sn_icon != NULL)
7935 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7936}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007937# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938
7939/*
7940 * List one sign.
7941 */
7942 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007943sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944{
7945 char_u *p;
7946
Bram Moolenaar555b2802005-05-19 21:08:39 +00007947 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 if (sp->sn_icon != NULL)
7949 {
7950 MSG_PUTS(" icon=");
7951 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007952# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 if (sp->sn_image == NULL)
7954 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007955# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007957# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 }
7959 if (sp->sn_text != NULL)
7960 {
7961 MSG_PUTS(" text=");
7962 msg_outtrans(sp->sn_text);
7963 }
7964 if (sp->sn_line_hl > 0)
7965 {
7966 MSG_PUTS(" linehl=");
Bram Moolenaarc96272e2017-03-26 13:50:09 +02007967 p = get_highlight_name_ext(NULL, sp->sn_line_hl - 1, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 if (p == NULL)
7969 MSG_PUTS("NONE");
7970 else
7971 msg_puts(p);
7972 }
7973 if (sp->sn_text_hl > 0)
7974 {
7975 MSG_PUTS(" texthl=");
Bram Moolenaarc96272e2017-03-26 13:50:09 +02007976 p = get_highlight_name_ext(NULL, sp->sn_text_hl - 1, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 if (p == NULL)
7978 MSG_PUTS("NONE");
7979 else
7980 msg_puts(p);
7981 }
7982}
7983
7984/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007985 * Undefine a sign and free its memory.
7986 */
7987 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007988sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007989{
7990 vim_free(sp->sn_name);
7991 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007992# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007993 if (sp->sn_image != NULL)
7994 {
7995 out_flush();
7996 gui_mch_destroy_sign(sp->sn_image);
7997 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007998# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007999 vim_free(sp->sn_text);
8000 if (sp_prev == NULL)
8001 first_sign = sp->sn_next;
8002 else
8003 sp_prev->sn_next = sp->sn_next;
8004 vim_free(sp);
8005}
8006
8007/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 * Get highlighting attribute for sign "typenr".
8009 * If "line" is TRUE: line highl, if FALSE: text highl.
8010 */
8011 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008012sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013{
8014 sign_T *sp;
8015
8016 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8017 if (sp->sn_typenr == typenr)
8018 {
8019 if (line)
8020 {
8021 if (sp->sn_line_hl > 0)
8022 return syn_id2attr(sp->sn_line_hl);
8023 }
8024 else
8025 {
8026 if (sp->sn_text_hl > 0)
8027 return syn_id2attr(sp->sn_text_hl);
8028 }
8029 break;
8030 }
8031 return 0;
8032}
8033
8034/*
8035 * Get text mark for sign "typenr".
8036 * Returns NULL if there isn't one.
8037 */
8038 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008039sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040{
8041 sign_T *sp;
8042
8043 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8044 if (sp->sn_typenr == typenr)
8045 return sp->sn_text;
8046 return NULL;
8047}
8048
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008049# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008051sign_get_image(
8052 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053{
8054 sign_T *sp;
8055
8056 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8057 if (sp->sn_typenr == typenr)
8058 return sp->sn_image;
8059 return NULL;
8060}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008061# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062
8063/*
8064 * Get the name of a sign by its typenr.
8065 */
8066 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008067sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068{
8069 sign_T *sp;
8070
8071 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8072 if (sp->sn_typenr == typenr)
8073 return sp->sn_name;
8074 return (char_u *)_("[Deleted]");
8075}
8076
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008077# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008078/*
8079 * Undefine/free all signs.
8080 */
8081 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008082free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008083{
8084 while (first_sign != NULL)
8085 sign_undefine(first_sign, NULL);
8086}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008087# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008088
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008089# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008090static enum
8091{
8092 EXP_SUBCMD, /* expand :sign sub-commands */
8093 EXP_DEFINE, /* expand :sign define {name} args */
8094 EXP_PLACE, /* expand :sign place {id} args */
8095 EXP_UNPLACE, /* expand :sign unplace" */
8096 EXP_SIGN_NAMES /* expand with name of placed signs */
8097} expand_what;
8098
8099/*
8100 * Function given to ExpandGeneric() to obtain the sign command
8101 * expansion.
8102 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008103 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008104get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008105{
8106 sign_T *sp;
8107 int current_idx;
8108
8109 switch (expand_what)
8110 {
8111 case EXP_SUBCMD:
8112 return (char_u *)cmds[idx];
8113 case EXP_DEFINE:
8114 {
8115 char *define_arg[] =
8116 {
8117 "icon=", "linehl=", "text=", "texthl=", NULL
8118 };
8119 return (char_u *)define_arg[idx];
8120 }
8121 case EXP_PLACE:
8122 {
8123 char *place_arg[] =
8124 {
8125 "line=", "name=", "file=", "buffer=", NULL
8126 };
8127 return (char_u *)place_arg[idx];
8128 }
8129 case EXP_UNPLACE:
8130 {
8131 char *unplace_arg[] = { "file=", "buffer=", NULL };
8132 return (char_u *)unplace_arg[idx];
8133 }
8134 case EXP_SIGN_NAMES:
8135 /* Complete with name of signs already defined */
8136 current_idx = 0;
8137 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8138 if (current_idx++ == idx)
8139 return sp->sn_name;
8140 return NULL;
8141 default:
8142 return NULL;
8143 }
8144}
8145
8146/*
8147 * Handle command line completion for :sign command.
8148 */
8149 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008150set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008151{
8152 char_u *p;
8153 char_u *end_subcmd;
8154 char_u *last;
8155 int cmd_idx;
8156 char_u *begin_subcmd_args;
8157
8158 /* Default: expand subcommands. */
8159 xp->xp_context = EXPAND_SIGN;
8160 expand_what = EXP_SUBCMD;
8161 xp->xp_pattern = arg;
8162
8163 end_subcmd = skiptowhite(arg);
8164 if (*end_subcmd == NUL)
8165 /* expand subcmd name
8166 * :sign {subcmd}<CTRL-D>*/
8167 return;
8168
8169 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8170
8171 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008172 * |
8173 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008174 begin_subcmd_args = skipwhite(end_subcmd);
8175 p = skiptowhite(begin_subcmd_args);
8176 if (*p == NUL)
8177 {
8178 /*
8179 * Expand first argument of subcmd when possible.
8180 * For ":jump {id}" and ":unplace {id}", we could
8181 * possibly expand the ids of all signs already placed.
8182 */
8183 xp->xp_pattern = begin_subcmd_args;
8184 switch (cmd_idx)
8185 {
8186 case SIGNCMD_LIST:
8187 case SIGNCMD_UNDEFINE:
8188 /* :sign list <CTRL-D>
8189 * :sign undefine <CTRL-D> */
8190 expand_what = EXP_SIGN_NAMES;
8191 break;
8192 default:
8193 xp->xp_context = EXPAND_NOTHING;
8194 }
8195 return;
8196 }
8197
8198 /* expand last argument of subcmd */
8199
8200 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008201 * |
8202 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008203
8204 /* Loop until reaching last argument. */
8205 do
8206 {
8207 p = skipwhite(p);
8208 last = p;
8209 p = skiptowhite(p);
8210 } while (*p != NUL);
8211
8212 p = vim_strchr(last, '=');
8213
8214 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008215 * | |
8216 * last p */
Bram Moolenaar7756e742016-10-21 20:35:37 +02008217 if (p == NULL)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008218 {
8219 /* Expand last argument name (before equal sign). */
8220 xp->xp_pattern = last;
8221 switch (cmd_idx)
8222 {
8223 case SIGNCMD_DEFINE:
8224 expand_what = EXP_DEFINE;
8225 break;
8226 case SIGNCMD_PLACE:
8227 expand_what = EXP_PLACE;
8228 break;
8229 case SIGNCMD_JUMP:
8230 case SIGNCMD_UNPLACE:
8231 expand_what = EXP_UNPLACE;
8232 break;
8233 default:
8234 xp->xp_context = EXPAND_NOTHING;
8235 }
8236 }
8237 else
8238 {
8239 /* Expand last argument value (after equal sign). */
8240 xp->xp_pattern = p + 1;
8241 switch (cmd_idx)
8242 {
8243 case SIGNCMD_DEFINE:
8244 if (STRNCMP(last, "texthl", p - last) == 0 ||
8245 STRNCMP(last, "linehl", p - last) == 0)
8246 xp->xp_context = EXPAND_HIGHLIGHT;
8247 else if (STRNCMP(last, "icon", p - last) == 0)
8248 xp->xp_context = EXPAND_FILES;
8249 else
8250 xp->xp_context = EXPAND_NOTHING;
8251 break;
8252 case SIGNCMD_PLACE:
8253 if (STRNCMP(last, "name", p - last) == 0)
8254 expand_what = EXP_SIGN_NAMES;
8255 else
8256 xp->xp_context = EXPAND_NOTHING;
8257 break;
8258 default:
8259 xp->xp_context = EXPAND_NOTHING;
8260 }
8261 }
8262}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008263# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008264#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008265
8266/*
8267 * Make the user happy.
8268 */
8269 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008270ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008271{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008272 static char *code[] = {
8273 "\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$",
8274 "\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"
8275 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008276 char *p;
8277 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008278 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008279
8280 msg_start();
8281 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008282 for (i = 0; i < 2; ++i)
8283 for (p = code[i]; *p != NUL; ++p)
8284 if (*p == 'x')
8285 msg_putchar('\n');
8286 else
8287 for (n = *p++; n > 0; --n)
8288 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01008289 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008290 else
8291 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008292 msg_clr_eos();
8293}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295/*
8296 * ":drop"
8297 * Opens the first argument in a window. When there are two or more arguments
8298 * the argument list is redefined.
8299 */
8300 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008301ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302{
8303 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 win_T *wp;
8305 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008306 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307
8308 /*
8309 * Check if the first argument is already being edited in a window. If
8310 * so, jump to that window.
8311 * We would actually need to check all arguments, but that's complicated
8312 * and mostly only one file is dropped.
8313 * This also ignores wildcards, since it is very unlikely the user is
8314 * editing a file name with a wildcard character.
8315 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008316 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008318 /*
8319 * Expanding wildcards may result in an empty argument list. E.g. when
8320 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8321 * already did an error message for this.
8322 */
8323 if (ARGCOUNT == 0)
8324 return;
8325
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008326 if (cmdmod.tab)
8327 {
8328 /* ":tab drop file ...": open a tab for each argument that isn't
8329 * edited in a window yet. It's like ":tab all" but without closing
8330 * windows or tabs. */
8331 ex_all(eap);
8332 }
8333 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008334 {
8335 /* ":drop file ...": Edit the first argument. Jump to an existing
8336 * window if possible, edit in current window if the current buffer
8337 * can be abandoned, otherwise open a new window. */
8338 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8339
8340 FOR_ALL_TAB_WINDOWS(tp, wp)
8341 {
8342 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008344 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 return;
8347 }
8348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008350 /*
8351 * Check whether the current buffer is changed. If so, we will need
8352 * to split the current window or data could be lost.
8353 * Skip the check if the 'hidden' option is set, as in this case the
8354 * buffer won't be lost.
8355 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02008356 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008357 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008358 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008359 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008360 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008361 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008363 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8364 if (split)
8365 {
8366 eap->cmdidx = CMD_sfirst;
8367 eap->cmd[0] = 's';
8368 }
8369 else
8370 eap->cmdidx = CMD_first;
8371 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373}
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008374
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008375/*
8376 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8377 * Put the start of the pattern in "*s", unless "s" is NULL.
8378 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8379 * If "s" is not NULL terminate the pattern with a NUL.
8380 * Return a pointer to the char just past the pattern plus flags.
8381 */
8382 char_u *
8383skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8384{
8385 int c;
8386
8387 if (vim_isIDc(*p))
8388 {
8389 /* ":vimgrep pattern fname" */
8390 if (s != NULL)
8391 *s = p;
8392 p = skiptowhite(p);
8393 if (s != NULL && *p != NUL)
8394 *p++ = NUL;
8395 }
8396 else
8397 {
8398 /* ":vimgrep /pattern/[g][j] fname" */
8399 if (s != NULL)
8400 *s = p + 1;
8401 c = *p;
8402 p = skip_regexp(p + 1, c, TRUE, NULL);
8403 if (*p != c)
8404 return NULL;
8405
8406 /* Truncate the pattern. */
8407 if (s != NULL)
8408 *p = NUL;
8409 ++p;
8410
8411 /* Find the flags */
8412 while (*p == 'g' || *p == 'j')
8413 {
8414 if (flags != NULL)
8415 {
8416 if (*p == 'g')
8417 *flags |= VGR_GLOBAL;
8418 else
8419 *flags |= VGR_NOJUMP;
8420 }
8421 ++p;
8422 }
8423 }
8424 return p;
8425}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008426
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008427#if defined(FEAT_EVAL) || defined(PROTO)
8428/*
8429 * List v:oldfiles in a nice way.
8430 */
8431 void
8432ex_oldfiles(exarg_T *eap UNUSED)
8433{
8434 list_T *l = get_vim_var_list(VV_OLDFILES);
8435 listitem_T *li;
8436 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008437 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008438
8439 if (l == NULL)
8440 msg((char_u *)_("No old files"));
8441 else
8442 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008443 msg_start();
8444 msg_scroll = TRUE;
8445 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8446 {
8447 ++nr;
8448 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008449 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008450 {
8451 msg_outnum((long)nr);
8452 MSG_PUTS(": ");
8453 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02008454 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008455 msg_putchar('\n');
8456 out_flush(); /* output one line at a time */
8457 ui_breakcheck();
8458 }
8459 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008460
8461 /* Assume "got_int" was set to truncate the listing. */
8462 got_int = FALSE;
8463
8464# ifdef FEAT_BROWSE_CMD
8465 if (cmdmod.browse)
8466 {
8467 quit_more = FALSE;
8468 nr = prompt_for_number(FALSE);
8469 msg_starthere();
8470 if (nr > 0)
8471 {
8472 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8473 (long)nr);
8474
8475 if (p != NULL)
8476 {
8477 p = expand_env_save(p);
8478 eap->arg = p;
8479 eap->cmdidx = CMD_edit;
8480 cmdmod.browse = FALSE;
8481 do_exedit(eap, NULL);
8482 vim_free(p);
8483 }
8484 }
8485 }
8486# endif
8487 }
8488}
8489#endif