blob: df35f52da8b83fdc1c70ae664eb317d872f2b03f [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 Moolenaar071d4272004-06-13 20:20:40 +000031#ifdef FEAT_AUTOCMD
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010032static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000033#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000034static int
35#ifdef __BORLANDC__
36 _RTLENTRYF
37#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010038 help_compare(const void *s1, const void *s2);
39static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040
41/*
42 * ":ascii" and "ga".
43 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010045do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000046{
47 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000048 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000049 char buf1[20];
50 char buf2[20];
51 char_u buf3[7];
52#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000053 int cc[MAX_MCO];
54 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 int len;
56
57 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000058 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 else
60#endif
61 c = gchar_cursor();
62 if (c == NUL)
63 {
64 MSG("NUL");
65 return;
66 }
67
68#ifdef FEAT_MBYTE
69 IObuff[0] = NUL;
70 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
71#endif
72 {
73 if (c == NL) /* NUL is stored as NL */
74 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000075 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
76 cval = NL; /* NL is stored as CR */
77 else
78 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 if (vim_isprintc_strict(c) && (c < ' '
80#ifndef EBCDIC
81 || c > '~'
82#endif
83 ))
84 {
85 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000086 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 }
88 else
89 buf1[0] = NUL;
90#ifndef EBCDIC
91 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000092 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
93 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 else
95#endif
96 buf2[0] = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +000097 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000099 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000101 if (enc_utf8)
102 c = cc[ci++];
103 else
104 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105#endif
106 }
107
108#ifdef FEAT_MBYTE
109 /* Repeat for combining characters. */
110 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
111 {
112 len = (int)STRLEN(IObuff);
113 /* This assumes every multi-byte char is printable... */
114 if (len > 0)
115 IObuff[len++] = ' ';
116 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000117 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000118# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 )
122 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000123 len += (*mb_char2bytes)(c, IObuff + len);
124 vim_snprintf((char *)IObuff + len, IOSIZE - len,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
126 : _("> %d, Hex %08x, Octal %o"), c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000127 if (ci == MAX_MCO)
128 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000129 if (enc_utf8)
130 c = cc[ci++];
131 else
132 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 }
134#endif
135
136 msg(IObuff);
137}
138
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139/*
140 * ":left", ":center" and ":right": align text.
141 */
142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100143ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144{
145 pos_T save_curpos;
146 int len;
147 int indent = 0;
148 int new_indent;
149 int has_tab;
150 int width;
151
152#ifdef FEAT_RIGHTLEFT
153 if (curwin->w_p_rl)
154 {
155 /* switch left and right aligning */
156 if (eap->cmdidx == CMD_right)
157 eap->cmdidx = CMD_left;
158 else if (eap->cmdidx == CMD_left)
159 eap->cmdidx = CMD_right;
160 }
161#endif
162
163 width = atoi((char *)eap->arg);
164 save_curpos = curwin->w_cursor;
165 if (eap->cmdidx == CMD_left) /* width is used for new indent */
166 {
167 if (width >= 0)
168 indent = width;
169 }
170 else
171 {
172 /*
173 * if 'textwidth' set, use it
174 * else if 'wrapmargin' set, use it
175 * if invalid value, use 80
176 */
177 if (width <= 0)
178 width = curbuf->b_p_tw;
179 if (width == 0 && curbuf->b_p_wm > 0)
180 width = W_WIDTH(curwin) - curbuf->b_p_wm;
181 if (width <= 0)
182 width = 80;
183 }
184
185 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
186 return;
187
188 for (curwin->w_cursor.lnum = eap->line1;
189 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
190 {
191 if (eap->cmdidx == CMD_left) /* left align */
192 new_indent = indent;
193 else
194 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000195 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 len = linelen(eap->cmdidx == CMD_right ? &has_tab
197 : NULL) - get_indent();
198
199 if (len <= 0) /* skip blank lines */
200 continue;
201
202 if (eap->cmdidx == CMD_center)
203 new_indent = (width - len) / 2;
204 else
205 {
206 new_indent = width - len; /* right align */
207
208 /*
209 * Make sure that embedded TABs don't make the text go too far
210 * to the right.
211 */
212 if (has_tab)
213 while (new_indent > 0)
214 {
215 (void)set_indent(new_indent, 0);
216 if (linelen(NULL) <= width)
217 {
218 /*
219 * Now try to move the line as much as possible to
220 * the right. Stop when it moves too far.
221 */
222 do
223 (void)set_indent(++new_indent, 0);
224 while (linelen(NULL) <= width);
225 --new_indent;
226 break;
227 }
228 --new_indent;
229 }
230 }
231 }
232 if (new_indent < 0)
233 new_indent = 0;
234 (void)set_indent(new_indent, 0); /* set indent */
235 }
236 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
237 curwin->w_cursor = save_curpos;
238 beginline(BL_WHITE | BL_FIX);
239}
240
241/*
242 * Get the length of the current line, excluding trailing white space.
243 */
244 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100245linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246{
247 char_u *line;
248 char_u *first;
249 char_u *last;
250 int save;
251 int len;
252
253 /* find the first non-blank character */
254 line = ml_get_curline();
255 first = skipwhite(line);
256
257 /* find the character after the last non-blank character */
258 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100259 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 ;
261 save = *last;
262 *last = NUL;
263 len = linetabsize(line); /* get line length */
264 if (has_tab != NULL) /* check for embedded TAB */
265 *has_tab = (vim_strrchr(first, TAB) != NULL);
266 *last = save;
267
268 return len;
269}
270
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000271/* Buffer for two lines used during sorting. They are allocated to
272 * contain the longest line being sorted. */
273static char_u *sortbuf1;
274static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000275
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100276static int sort_ic; /* ignore case */
277static int sort_nr; /* sort on number */
278static int sort_rx; /* sort on regex instead of skipping it */
279#ifdef FEAT_FLOAT
280static int sort_flt; /* sort on floating number */
281#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100283static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000284
285/* Struct to store info to be sorted. */
286typedef struct
287{
288 linenr_T lnum; /* line number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100289 union {
290 struct
291 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200292 varnumber_T start_col_nr; /* starting column number */
293 varnumber_T end_col_nr; /* ending column number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100294 } line;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200295 varnumber_T value; /* value if sorting by integer */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100296#ifdef FEAT_FLOAT
297 float_T value_flt; /* value if sorting by float */
298#endif
299 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000300} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000301
302static int
303#ifdef __BORLANDC__
304_RTLENTRYF
305#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100306sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000307
308 static int
309#ifdef __BORLANDC__
310_RTLENTRYF
311#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100312sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000313{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000314 sorti_T l1 = *(sorti_T *)s1;
315 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000316 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000317
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000318 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000319 * if we return 0 every time, qsort will assume it's done sorting and
320 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000321 if (sort_abort)
322 return 0;
323 fast_breakcheck();
324 if (got_int)
325 sort_abort = TRUE;
326
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000327 /* When sorting numbers "start_col_nr" is the number, not the column
328 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 if (sort_nr)
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100330 result = l1.st_u.value == l2.st_u.value ? 0
331 : l1.st_u.value > l2.st_u.value ? 1 : -1;
332#ifdef FEAT_FLOAT
333 else if (sort_flt)
334 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
335 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
336#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 else
338 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000339 /* We need to copy one line into "sortbuf1", because there is no
340 * guarantee that the first pointer becomes invalid when obtaining the
341 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100342 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
343 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
344 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
345 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
346 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
347 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000348
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000349 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
350 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000351 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000352
353 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000354 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000355 return (int)(l1.lnum - l2.lnum);
356 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000357}
358
359/*
360 * ":sort".
361 */
362 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100363ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000364{
365 regmatch_T regmatch;
366 int len;
367 linenr_T lnum;
368 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000369 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000370 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000371 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000372 char_u *p;
373 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000374 char_u *s2;
375 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000376 int unique = FALSE;
377 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000378 colnr_T start_col;
379 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100380 int sort_what = 0;
381 int format_found = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382
Bram Moolenaar48c99162008-02-18 18:42:52 +0000383 /* Sorting one line is really quick! */
384 if (count <= 1)
385 return;
386
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000387 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
388 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000389 sortbuf1 = NULL;
390 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000391 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000392 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000393 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000394 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000395
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100396 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100397#ifdef FEAT_FLOAT
398 sort_flt = 0;
399#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000400
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401 for (p = eap->arg; *p != NUL; ++p)
402 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100403 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000404 ;
405 else if (*p == 'i')
406 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000407 else if (*p == 'r')
408 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000409 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100410 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100411 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100412 ++format_found;
413 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100414#ifdef FEAT_FLOAT
415 else if (*p == 'f')
416 {
417 sort_flt = 1;
418 ++format_found;
419 }
420#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100421 else if (*p == 'b')
422 {
423 sort_what = STR2NR_BIN + STR2NR_FORCE;
424 ++format_found;
425 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000426 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100427 {
428 sort_what = STR2NR_OCT + STR2NR_FORCE;
429 ++format_found;
430 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000431 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100432 {
433 sort_what = STR2NR_HEX + STR2NR_FORCE;
434 ++format_found;
435 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000436 else if (*p == 'u')
437 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000438 else if (*p == '"') /* comment start */
439 break;
440 else if (check_nextcmd(p) != NULL)
441 {
442 eap->nextcmd = check_nextcmd(p);
443 break;
444 }
445 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000446 {
447 s = skip_regexp(p + 1, *p, TRUE, NULL);
448 if (*s != *p)
449 {
450 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000451 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000452 }
453 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000454 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100455 if (s == p + 1)
456 {
457 if (last_search_pat() == NULL)
458 {
459 EMSG(_(e_noprevre));
460 goto sortend;
461 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000462 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100463 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000464 else
465 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000466 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000467 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000468 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000469 regmatch.rm_ic = p_ic;
470 }
471 else
472 {
473 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000475 }
476 }
477
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100478 /* Can only have one of 'n', 'b', 'o' and 'x'. */
479 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000480 {
481 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000482 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000483 }
484
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100485 /* From here on "sort_nr" is used as a flag for any integer number
486 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100487 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000488
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000489 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000491 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000492 * When sorting on strings "start_col_nr" is the offset in the line, for
493 * numbers sorting it's the number to sort on. This means the pattern
494 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000496 */
497 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
498 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000499 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000500 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000501 if (maxlen < len)
502 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000503
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000504 start_col = 0;
505 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000506 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000507 {
508 if (sort_rx)
509 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000510 start_col = (colnr_T)(regmatch.startp[0] - s);
511 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000512 }
513 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000514 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000515 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000516 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000517 if (regmatch.regprog != NULL)
518 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000519
Bram Moolenaar937204a2016-01-30 23:37:38 +0100520 if (sort_nr
521#ifdef FEAT_FLOAT
522 || sort_flt
523#endif
524 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 /* Make sure vim_str2nr doesn't read any digits past the end
527 * of the match, by temporarily terminating the string there */
528 s2 = s + end_col;
529 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200530 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000531 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000532 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100533 if (sort_nr)
534 {
535 if (sort_what & STR2NR_HEX)
536 s = skiptohex(p);
537 else if (sort_what & STR2NR_BIN)
538 s = skiptobin(p);
539 else
540 s = skiptodigit(p);
541 if (s > p && s[-1] == '-')
542 --s; /* include preceding negative sign */
543 if (*s == NUL)
544 /* empty line should sort before any number */
545 nrs[lnum - eap->line1].st_u.value = -MAXLNUM;
546 else
547 vim_str2nr(s, NULL, NULL, sort_what,
548 &nrs[lnum - eap->line1].st_u.value, NULL, 0);
549 }
550#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000551 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 {
553 s = skipwhite(p);
554 if (*s == '+')
555 s = skipwhite(s + 1);
556
557 if (*s == NUL)
558 /* empty line should sort before any number */
559 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
560 else
561 nrs[lnum - eap->line1].st_u.value_flt =
562 strtod((char *)s, NULL);
563 }
564#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200565 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000566 }
567 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000568 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000569 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100570 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
571 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000572 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000573
574 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000575
576 if (regmatch.regprog != NULL)
577 fast_breakcheck();
578 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000579 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000580 }
581
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000582 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000583 sortbuf1 = alloc((unsigned)maxlen + 1);
584 if (sortbuf1 == NULL)
585 goto sortend;
586 sortbuf2 = alloc((unsigned)maxlen + 1);
587 if (sortbuf2 == NULL)
588 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000589
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000590 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000592
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 if (sort_abort)
594 goto sortend;
595
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000596 /* Insert the lines in the sorted order below the last one. */
597 lnum = eap->line2;
598 for (i = 0; i < count; ++i)
599 {
600 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
601 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000602 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603 {
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100604 /* Copy the line into a buffer, it may become invalid in
605 * ml_append(). And it's needed for "unique". */
606 STRCPY(sortbuf1, s);
607 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000609 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000610 fast_breakcheck();
611 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000612 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000613 }
614
615 /* delete the original lines if appending worked */
616 if (i == count)
617 for (i = 0; i < count; ++i)
618 ml_delete(eap->line1, FALSE);
619 else
620 count = 0;
621
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000622 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000623 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 if (deleted > 0)
625 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
626 else if (deleted < 0)
627 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
628 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000629
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000630 curwin->w_cursor.lnum = eap->line1;
631 beginline(BL_WHITE | BL_FIX);
632
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000633sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000635 vim_free(sortbuf1);
636 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200637 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000638 if (got_int)
639 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640}
641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642/*
643 * ":retab".
644 */
645 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100646ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647{
648 linenr_T lnum;
649 int got_tab = FALSE;
650 long num_spaces = 0;
651 long num_tabs;
652 long len;
653 long col;
654 long vcol;
655 long start_col = 0; /* For start of white-space string */
656 long start_vcol = 0; /* For start of white-space string */
657 int temp;
658 long old_len;
659 char_u *ptr;
660 char_u *new_line = (char_u *)1; /* init to non-NULL */
661 int did_undo; /* called u_save for current line */
662 int new_ts;
663 int save_list;
664 linenr_T first_line = 0; /* first changed line */
665 linenr_T last_line = 0; /* last changed line */
666
667 save_list = curwin->w_p_list;
668 curwin->w_p_list = 0; /* don't want list mode here */
669
670 new_ts = getdigits(&(eap->arg));
671 if (new_ts < 0)
672 {
673 EMSG(_(e_positive));
674 return;
675 }
676 if (new_ts == 0)
677 new_ts = curbuf->b_p_ts;
678 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
679 {
680 ptr = ml_get(lnum);
681 col = 0;
682 vcol = 0;
683 did_undo = FALSE;
684 for (;;)
685 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100686 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 {
688 if (!got_tab && num_spaces == 0)
689 {
690 /* First consecutive white-space */
691 start_vcol = vcol;
692 start_col = col;
693 }
694 if (ptr[col] == ' ')
695 num_spaces++;
696 else
697 got_tab = TRUE;
698 }
699 else
700 {
701 if (got_tab || (eap->forceit && num_spaces > 1))
702 {
703 /* Retabulate this string of white-space */
704
705 /* len is virtual length of white string */
706 len = num_spaces = vcol - start_vcol;
707 num_tabs = 0;
708 if (!curbuf->b_p_et)
709 {
710 temp = new_ts - (start_vcol % new_ts);
711 if (num_spaces >= temp)
712 {
713 num_spaces -= temp;
714 num_tabs++;
715 }
716 num_tabs += num_spaces / new_ts;
717 num_spaces -= (num_spaces / new_ts) * new_ts;
718 }
719 if (curbuf->b_p_et || got_tab ||
720 (num_spaces + num_tabs < len))
721 {
722 if (did_undo == FALSE)
723 {
724 did_undo = TRUE;
725 if (u_save((linenr_T)(lnum - 1),
726 (linenr_T)(lnum + 1)) == FAIL)
727 {
728 new_line = NULL; /* flag out-of-memory */
729 break;
730 }
731 }
732
733 /* len is actual number of white characters used */
734 len = num_spaces + num_tabs;
735 old_len = (long)STRLEN(ptr);
736 new_line = lalloc(old_len - col + start_col + len + 1,
737 TRUE);
738 if (new_line == NULL)
739 break;
740 if (start_col > 0)
741 mch_memmove(new_line, ptr, (size_t)start_col);
742 mch_memmove(new_line + start_col + len,
743 ptr + col, (size_t)(old_len - col + 1));
744 ptr = new_line + start_col;
745 for (col = 0; col < len; col++)
746 ptr[col] = (col < num_tabs) ? '\t' : ' ';
747 ml_replace(lnum, new_line, FALSE);
748 if (first_line == 0)
749 first_line = lnum;
750 last_line = lnum;
751 ptr = new_line;
752 col = start_col + len;
753 }
754 }
755 got_tab = FALSE;
756 num_spaces = 0;
757 }
758 if (ptr[col] == NUL)
759 break;
760 vcol += chartabsize(ptr + col, (colnr_T)vcol);
761#ifdef FEAT_MBYTE
762 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000763 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 else
765#endif
766 ++col;
767 }
768 if (new_line == NULL) /* out of memory */
769 break;
770 line_breakcheck();
771 }
772 if (got_int)
773 EMSG(_(e_interr));
774
775 if (curbuf->b_p_ts != new_ts)
776 redraw_curbuf_later(NOT_VALID);
777 if (first_line != 0)
778 changed_lines(first_line, 0, last_line + 1, 0L);
779
780 curwin->w_p_list = save_list; /* restore 'list' */
781
782 curbuf->b_p_ts = new_ts;
783 coladvance(curwin->w_curswant);
784
785 u_clearline();
786}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788/*
789 * :move command - move lines line1-line2 to line dest
790 *
791 * return FAIL for failure, OK otherwise
792 */
793 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100794do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795{
796 char_u *str;
797 linenr_T l;
798 linenr_T extra; /* Num lines added before line1 */
799 linenr_T num_lines; /* Num lines moved */
800 linenr_T last_line; /* Last line in file after adding new text */
Bram Moolenaard5f69332015-04-15 12:43:50 +0200801#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100802 win_T *win;
803 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200804#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
806 if (dest >= line1 && dest < line2)
807 {
808 EMSG(_("E134: Move lines into themselves"));
809 return FAIL;
810 }
811
812 num_lines = line2 - line1 + 1;
813
814 /*
815 * First we copy the old text to its new location -- webb
816 * Also copy the flag that ":global" command uses.
817 */
818 if (u_save(dest, dest + 1) == FAIL)
819 return FAIL;
820 for (extra = 0, l = line1; l <= line2; l++)
821 {
822 str = vim_strsave(ml_get(l + extra));
823 if (str != NULL)
824 {
825 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
826 vim_free(str);
827 if (dest < line1)
828 extra++;
829 }
830 }
831
832 /*
833 * Now we must be careful adjusting our marks so that we don't overlap our
834 * mark_adjust() calls.
835 *
836 * We adjust the marks within the old text so that they refer to the
837 * last lines of the file (temporarily), because we know no other marks
838 * will be set there since these line numbers did not exist until we added
839 * our new lines.
840 *
841 * Then we adjust the marks on lines between the old and new text positions
842 * (either forwards or backwards).
843 *
844 * And Finally we adjust the marks we put at the end of the file back to
845 * their final destination at the new text position -- webb
846 */
847 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100848 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 if (dest >= line2)
850 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100851 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
852#ifdef FEAT_FOLDING
853 FOR_ALL_TAB_WINDOWS(tp, win) {
854 if (win->w_buffer == curbuf)
855 foldMoveRange(&win->w_folds, line1, line2, dest);
856 }
857#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 curbuf->b_op_start.lnum = dest - num_lines + 1;
859 curbuf->b_op_end.lnum = dest;
860 }
861 else
862 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100863 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
864#ifdef FEAT_FOLDING
865 FOR_ALL_TAB_WINDOWS(tp, win) {
866 if (win->w_buffer == curbuf)
867 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
868 }
869#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 curbuf->b_op_start.lnum = dest + 1;
871 curbuf->b_op_end.lnum = dest + num_lines;
872 }
873 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100874 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 -(last_line - dest - extra), 0L);
876
877 /*
878 * Now we delete the original text -- webb
879 */
880 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
881 return FAIL;
882
883 for (l = line1; l <= line2; l++)
884 ml_delete(line1 + extra, TRUE);
885
886 if (!global_busy && num_lines > p_report)
887 {
888 if (num_lines == 1)
889 MSG(_("1 line moved"));
890 else
891 smsg((char_u *)_("%ld lines moved"), num_lines);
892 }
893
894 /*
895 * Leave the cursor on the last of the moved lines.
896 */
897 if (dest >= line1)
898 curwin->w_cursor.lnum = dest;
899 else
900 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
901
902 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100903 {
904 dest += num_lines + 1;
905 last_line = curbuf->b_ml.ml_line_count;
906 if (dest > last_line + 1)
907 dest = last_line + 1;
908 changed_lines(line1, 0, dest, 0L);
909 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 else
911 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
912
913 return OK;
914}
915
916/*
917 * ":copy"
918 */
919 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100920ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921{
922 linenr_T count;
923 char_u *p;
924
925 count = line2 - line1 + 1;
926 curbuf->b_op_start.lnum = n + 1;
927 curbuf->b_op_end.lnum = n + count;
928 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
929
930 /*
931 * there are three situations:
932 * 1. destination is above line1
933 * 2. destination is between line1 and line2
934 * 3. destination is below line2
935 *
936 * n = destination (when starting)
937 * curwin->w_cursor.lnum = destination (while copying)
938 * line1 = start of source (while copying)
939 * line2 = end of source (while copying)
940 */
941 if (u_save(n, n + 1) == FAIL)
942 return;
943
944 curwin->w_cursor.lnum = n;
945 while (line1 <= line2)
946 {
947 /* need to use vim_strsave() because the line will be unlocked within
948 * ml_append() */
949 p = vim_strsave(ml_get(line1));
950 if (p != NULL)
951 {
952 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
953 vim_free(p);
954 }
955 /* situation 2: skip already copied lines */
956 if (line1 == n)
957 line1 = curwin->w_cursor.lnum;
958 ++line1;
959 if (curwin->w_cursor.lnum < line1)
960 ++line1;
961 if (curwin->w_cursor.lnum < line2)
962 ++line2;
963 ++curwin->w_cursor.lnum;
964 }
965
966 appended_lines_mark(n, count);
967
968 msgmore((long)count);
969}
970
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000971static char_u *prevcmd = NULL; /* the previous command */
972
973#if defined(EXITFREE) || defined(PROTO)
974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100975free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000976{
977 vim_free(prevcmd);
978}
979#endif
980
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981/*
982 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
983 * Bangs in the argument are replaced with the previously entered command.
984 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 */
986 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100987do_bang(
988 int addr_count,
989 exarg_T *eap,
990 int forceit,
991 int do_in,
992 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993{
994 char_u *arg = eap->arg; /* command */
995 linenr_T line1 = eap->line1; /* start of range */
996 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 char_u *newcmd = NULL; /* the new command */
998 int free_newcmd = FALSE; /* need to free() newcmd */
999 int ins_prevcmd;
1000 char_u *t;
1001 char_u *p;
1002 char_u *trailarg;
1003 int len;
1004 int scroll_save = msg_scroll;
1005
1006 /*
1007 * Disallow shell commands for "rvim".
1008 * Disallow shell commands from .exrc and .vimrc in current directory for
1009 * security reasons.
1010 */
1011 if (check_restricted() || check_secure())
1012 return;
1013
1014 if (addr_count == 0) /* :! */
1015 {
1016 msg_scroll = FALSE; /* don't scroll here */
1017 autowrite_all();
1018 msg_scroll = scroll_save;
1019 }
1020
1021 /*
1022 * Try to find an embedded bang, like in :!<cmd> ! [args]
1023 * (:!! is indicated by the 'forceit' variable)
1024 */
1025 ins_prevcmd = forceit;
1026 trailarg = arg;
1027 do
1028 {
1029 len = (int)STRLEN(trailarg) + 1;
1030 if (newcmd != NULL)
1031 len += (int)STRLEN(newcmd);
1032 if (ins_prevcmd)
1033 {
1034 if (prevcmd == NULL)
1035 {
1036 EMSG(_(e_noprev));
1037 vim_free(newcmd);
1038 return;
1039 }
1040 len += (int)STRLEN(prevcmd);
1041 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001042 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 {
1044 vim_free(newcmd);
1045 return;
1046 }
1047 *t = NUL;
1048 if (newcmd != NULL)
1049 STRCAT(t, newcmd);
1050 if (ins_prevcmd)
1051 STRCAT(t, prevcmd);
1052 p = t + STRLEN(t);
1053 STRCAT(t, trailarg);
1054 vim_free(newcmd);
1055 newcmd = t;
1056
1057 /*
1058 * Scan the rest of the argument for '!', which is replaced by the
1059 * previous command. "\!" is replaced by "!" (this is vi compatible).
1060 */
1061 trailarg = NULL;
1062 while (*p)
1063 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001064 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065 {
1066 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001067 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 else
1069 {
1070 trailarg = p;
1071 *trailarg++ = NUL;
1072 ins_prevcmd = TRUE;
1073 break;
1074 }
1075 }
1076 ++p;
1077 }
1078 } while (trailarg != NULL);
1079
1080 vim_free(prevcmd);
1081 prevcmd = newcmd;
1082
1083 if (bangredo) /* put cmd in redo buffer for ! command */
1084 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001085 /* If % or # appears in the command, it must have been escaped.
1086 * Reescape them, so that redoing them does not substitute them by the
1087 * buffername. */
1088 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1089
1090 if (cmd != NULL)
1091 {
1092 AppendToRedobuffLit(cmd, -1);
1093 vim_free(cmd);
1094 }
1095 else
1096 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 AppendToRedobuff((char_u *)"\n");
1098 bangredo = FALSE;
1099 }
1100 /*
1101 * Add quotes around the command, for shells that need them.
1102 */
1103 if (*p_shq != NUL)
1104 {
1105 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1106 if (newcmd == NULL)
1107 return;
1108 STRCPY(newcmd, p_shq);
1109 STRCAT(newcmd, prevcmd);
1110 STRCAT(newcmd, p_shq);
1111 free_newcmd = TRUE;
1112 }
1113 if (addr_count == 0) /* :! */
1114 {
1115 /* echo the command */
1116 msg_start();
1117 msg_putchar(':');
1118 msg_putchar('!');
1119 msg_outtrans(newcmd);
1120 msg_clr_eos();
1121 windgoto(msg_row, msg_col);
1122
1123 do_shell(newcmd, 0);
1124 }
1125 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001126 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 /* Careful: This may recursively call do_bang() again! (because of
1128 * autocommands) */
1129 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001130#ifdef FEAT_AUTOCMD
1131 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1132#endif
1133 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134 if (free_newcmd)
1135 vim_free(newcmd);
1136}
1137
1138/*
1139 * do_filter: filter lines through a command given by the user
1140 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001141 * We mostly use temp files and the call_shell() routine here. This would
1142 * normally be done using pipes on a UNIX machine, but this is more portable
1143 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 * to deal with redirection somehow, and should handle things like looking
1145 * at the PATH env. variable, and adding reasonable extensions to the
1146 * command name given by the user. All reasonable versions of call_shell()
1147 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001148 * Alternatively, if on Unix and redirecting input or output, but not both,
1149 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 * We use input redirection if do_in is TRUE.
1151 * We use output redirection if do_out is TRUE.
1152 */
1153 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001154do_filter(
1155 linenr_T line1,
1156 linenr_T line2,
1157 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1158 char_u *cmd,
1159 int do_in,
1160 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161{
1162 char_u *itmp = NULL;
1163 char_u *otmp = NULL;
1164 linenr_T linecount;
1165 linenr_T read_linecount;
1166 pos_T cursor_save;
1167 char_u *cmd_buf;
1168#ifdef FEAT_AUTOCMD
1169 buf_T *old_curbuf = curbuf;
1170#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001171 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172
1173 if (*cmd == NUL) /* no filter command */
1174 return;
1175
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 cursor_save = curwin->w_cursor;
1177 linecount = line2 - line1 + 1;
1178 curwin->w_cursor.lnum = line1;
1179 curwin->w_cursor.col = 0;
1180 changed_line_abv_curs();
1181 invalidate_botline();
1182
1183 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001184 * When using temp files:
1185 * 1. * Form temp file names
1186 * 2. * Write the lines to a temp file
1187 * 3. Run the filter command on the temp file
1188 * 4. * Read the output of the command into the buffer
1189 * 5. * Delete the original lines to be filtered
1190 * 6. * Remove the temp files
1191 *
1192 * When writing the input with a pipe or when catching the output with a
1193 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 */
1195
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001196 if (do_out)
1197 shell_flags |= SHELL_DOOUT;
1198
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001199#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001200 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001202 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1203 shell_flags |= SHELL_READ;
1204 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001206 else if (do_in && !do_out && !p_stmp)
1207 {
1208 /* Use a pipe to write stdin of the command, do not use a temp file. */
1209 shell_flags |= SHELL_WRITE;
1210 curbuf->b_op_start.lnum = line1;
1211 curbuf->b_op_end.lnum = line2;
1212 }
1213 else if (do_in && do_out && !p_stmp)
1214 {
1215 /* Use a pipe to write stdin and fetch stdout of the command, do not
1216 * use a temp file. */
1217 shell_flags |= SHELL_READ|SHELL_WRITE;
1218 curbuf->b_op_start.lnum = line1;
1219 curbuf->b_op_end.lnum = line2;
1220 curwin->w_cursor.lnum = line2;
1221 }
1222 else
1223#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001224 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1225 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001226 {
1227 EMSG(_(e_notmp));
1228 goto filterend;
1229 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230
1231/*
1232 * The writing and reading of temp files will not be shown.
1233 * Vi also doesn't do this and the messages are not very informative.
1234 */
1235 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 FALSE, FALSE, FALSE, TRUE) == FAIL)
1238 {
1239 msg_putchar('\n'); /* keep message from buf_write() */
1240 --no_wait_return;
1241#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1242 if (!aborting())
1243#endif
1244 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1245 goto filterend;
1246 }
1247#ifdef FEAT_AUTOCMD
1248 if (curbuf != old_curbuf)
1249 goto filterend;
1250#endif
1251
1252 if (!do_out)
1253 msg_putchar('\n');
1254
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001255 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1257 if (cmd_buf == NULL)
1258 goto filterend;
1259
1260 windgoto((int)Rows - 1, 0);
1261 cursor_on();
1262
1263 /*
1264 * When not redirecting the output the command can write anything to the
1265 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1266 * stderr output of external command. Clear the screen later.
1267 * If do_in is FALSE, this could be something like ":r !cat", which may
1268 * also mess up the screen, clear it later.
1269 */
1270 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1271 redraw_later_clear();
1272
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001273 if (do_out)
1274 {
1275 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001276 {
1277 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001278 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001279 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001280 redraw_curbuf_later(VALID);
1281 }
1282 read_linecount = curbuf->b_ml.ml_line_count;
1283
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 /*
1285 * When call_shell() fails wait_return() is called to give the user a
1286 * chance to read the error messages. Otherwise errors are ignored, so you
1287 * can see the error messages from the command that appear on stdout; use
1288 * 'u' to fix the text
1289 * Switch to cooked mode when not redirecting stdin, avoids that something
1290 * like ":r !cat" hangs.
1291 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1292 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001293 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 {
1295 redraw_later_clear();
1296 wait_return(FALSE);
1297 }
1298 vim_free(cmd_buf);
1299
1300 did_check_timestamps = FALSE;
1301 need_check_timestamps = TRUE;
1302
1303 /* When interrupting the shell command, it may still have produced some
1304 * useful output. Reset got_int here, so that readfile() won't cancel
1305 * reading. */
1306 ui_breakcheck();
1307 got_int = FALSE;
1308
1309 if (do_out)
1310 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001311 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001313 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001314 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001316#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1317 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001319 {
1320 msg_putchar('\n');
1321 EMSG2(_(e_notread), otmp);
1322 }
1323 goto error;
1324 }
1325#ifdef FEAT_AUTOCMD
1326 if (curbuf != old_curbuf)
1327 goto filterend;
1328#endif
1329 }
1330
1331 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1332
1333 if (shell_flags & SHELL_READ)
1334 {
1335 curbuf->b_op_start.lnum = line2 + 1;
1336 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1337 appended_lines_mark(line2, read_linecount);
1338 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339
1340 if (do_in)
1341 {
1342 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1343 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 if (read_linecount >= linecount)
1345 /* move all marks from old lines to new lines */
1346 mark_adjust(line1, line2, linecount, 0L);
1347 else
1348 {
1349 /* move marks from old lines to new lines, delete marks
1350 * that are in deleted lines */
1351 mark_adjust(line1, line1 + read_linecount - 1,
1352 linecount, 0L);
1353 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1354 }
1355 }
1356
1357 /*
1358 * Put cursor on first filtered line for ":range!cmd".
1359 * Adjust '[ and '] (set by buf_write()).
1360 */
1361 curwin->w_cursor.lnum = line1;
1362 del_lines(linecount, TRUE);
1363 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1364 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1365 write_lnum_adjust(-linecount); /* adjust last line
1366 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001367#ifdef FEAT_FOLDING
1368 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1369#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 }
1371 else
1372 {
1373 /*
1374 * Put cursor on last new line for ":r !cmd".
1375 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001377 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001379
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1381 --no_wait_return;
1382
1383 if (linecount > p_report)
1384 {
1385 if (do_in)
1386 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001387 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1388 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001391 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 }
1393 else
1394 msgmore((long)linecount);
1395 }
1396 }
1397 else
1398 {
1399error:
1400 /* put cursor back in same position for ":w !cmd" */
1401 curwin->w_cursor = cursor_save;
1402 --no_wait_return;
1403 wait_return(FALSE);
1404 }
1405
1406filterend:
1407
1408#ifdef FEAT_AUTOCMD
1409 if (curbuf != old_curbuf)
1410 {
1411 --no_wait_return;
1412 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1413 }
1414#endif
1415 if (itmp != NULL)
1416 mch_remove(itmp);
1417 if (otmp != NULL)
1418 mch_remove(otmp);
1419 vim_free(itmp);
1420 vim_free(otmp);
1421}
1422
1423/*
1424 * Call a shell to execute a command.
1425 * When "cmd" is NULL start an interactive shell.
1426 */
1427 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001428do_shell(
1429 char_u *cmd,
1430 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431{
1432 buf_T *buf;
1433#ifndef FEAT_GUI_MSWIN
1434 int save_nwr;
1435#endif
1436#ifdef MSWIN
1437 int winstart = FALSE;
1438#endif
1439
1440 /*
1441 * Disallow shell commands for "rvim".
1442 * Disallow shell commands from .exrc and .vimrc in current directory for
1443 * security reasons.
1444 */
1445 if (check_restricted() || check_secure())
1446 {
1447 msg_end();
1448 return;
1449 }
1450
1451#ifdef MSWIN
1452 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 * Check if ":!start" is used.
1454 */
1455 if (cmd != NULL)
1456 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1457#endif
1458
1459 /*
1460 * For autocommands we want to get the output on the current screen, to
1461 * avoid having to type return below.
1462 */
1463 msg_putchar('\r'); /* put cursor at start of line */
1464#ifdef FEAT_AUTOCMD
1465 if (!autocmd_busy)
1466#endif
1467 {
1468#ifdef MSWIN
1469 if (!winstart)
1470#endif
1471 stoptermcap();
1472 }
1473#ifdef MSWIN
1474 if (!winstart)
1475#endif
1476 msg_putchar('\n'); /* may shift screen one line up */
1477
1478 /* warning message before calling the shell */
1479 if (p_warn
1480#ifdef FEAT_AUTOCMD
1481 && !autocmd_busy
1482#endif
1483 && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001484 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 if (bufIsChanged(buf))
1486 {
1487#ifdef FEAT_GUI_MSWIN
1488 if (!winstart)
1489 starttermcap(); /* don't want a message box here */
1490#endif
1491 MSG_PUTS(_("[No write since last change]\n"));
1492#ifdef FEAT_GUI_MSWIN
1493 if (!winstart)
1494 stoptermcap();
1495#endif
1496 break;
1497 }
1498
1499 /* This windgoto is required for when the '\n' resulted in a "delete line
1500 * 1" command to the terminal. */
1501 if (!swapping_screen())
1502 windgoto(msg_row, msg_col);
1503 cursor_on();
1504 (void)call_shell(cmd, SHELL_COOKED | flags);
1505 did_check_timestamps = FALSE;
1506 need_check_timestamps = TRUE;
1507
1508 /*
1509 * put the message cursor at the end of the screen, avoids wait_return()
1510 * to overwrite the text that the external command showed
1511 */
1512 if (!swapping_screen())
1513 {
1514 msg_row = Rows - 1;
1515 msg_col = 0;
1516 }
1517
1518#ifdef FEAT_AUTOCMD
1519 if (autocmd_busy)
1520 {
1521 if (msg_silent == 0)
1522 redraw_later_clear();
1523 }
1524 else
1525#endif
1526 {
1527 /*
1528 * For ":sh" there is no need to call wait_return(), just redraw.
1529 * Also for the Win32 GUI (the output is in a console window).
1530 * Otherwise there is probably text on the screen that the user wants
1531 * to read before redrawing, so call wait_return().
1532 */
1533#ifndef FEAT_GUI_MSWIN
1534 if (cmd == NULL
1535# ifdef WIN3264
1536 || (winstart && !need_wait_return)
1537# endif
1538 )
1539 {
1540 if (msg_silent == 0)
1541 redraw_later_clear();
1542 need_wait_return = FALSE;
1543 }
1544 else
1545 {
1546 /*
1547 * If we switch screens when starttermcap() is called, we really
1548 * want to wait for "hit return to continue".
1549 */
1550 save_nwr = no_wait_return;
1551 if (swapping_screen())
1552 no_wait_return = FALSE;
1553# ifdef AMIGA
1554 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1555# else
1556 wait_return(msg_silent == 0);
1557# endif
1558 no_wait_return = save_nwr;
1559 }
1560#endif /* FEAT_GUI_W32 */
1561
1562#ifdef MSWIN
1563 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1564#endif
1565 starttermcap(); /* start termcap if not done by wait_return() */
1566
1567 /*
1568 * In an Amiga window redrawing is caused by asking the window size.
1569 * If we got an interrupt this will not work. The chance that the
1570 * window size is wrong is very small, but we need to redraw the
1571 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1572 * but it saves an extra redraw.
1573 */
1574#ifdef AMIGA
1575 if (skip_redraw) /* ':' hit in wait_return() */
1576 {
1577 if (msg_silent == 0)
1578 redraw_later_clear();
1579 }
1580 else if (term_console)
1581 {
1582 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1583 if (got_int && msg_silent == 0)
1584 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1585 else
1586 must_redraw = 0; /* no extra redraw needed */
1587 }
1588#endif
1589 }
1590
1591 /* display any error messages now */
1592 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001593
1594#ifdef FEAT_AUTOCMD
1595 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1596#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597}
1598
1599/*
1600 * Create a shell command from a command string, input redirection file and
1601 * output redirection file.
1602 * Returns an allocated string with the shell command, or NULL for failure.
1603 */
1604 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001605make_filter_cmd(
1606 char_u *cmd, /* command */
1607 char_u *itmp, /* NULL or name of input file */
1608 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609{
1610 char_u *buf;
1611 long_u len;
1612
Bram Moolenaar53076832015-12-31 19:53:21 +01001613#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001614 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001615 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001616
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001617 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001618 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1619 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001620 if (is_fish_shell)
1621 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1622 else
1623#endif
1624 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 if (itmp != NULL)
1626 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1627 if (otmp != NULL)
1628 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1629 buf = lalloc(len, TRUE);
1630 if (buf == NULL)
1631 return NULL;
1632
Bram Moolenaar53076832015-12-31 19:53:21 +01001633#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001635 * Put braces around the command (for concatenated commands) when
1636 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001638 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001639 {
1640 if (is_fish_shell)
1641 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1642 else
1643 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1644 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001645 else
1646 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 if (itmp != NULL)
1648 {
1649 STRCAT(buf, " < ");
1650 STRCAT(buf, itmp);
1651 }
1652#else
1653 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001654 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 * the use of commands in a pipe.
1656 */
1657 STRCPY(buf, cmd);
1658 if (itmp != NULL)
1659 {
1660 char_u *p;
1661
1662 /*
1663 * If there is a pipe, we have to put the '<' in front of it.
1664 * Don't do this when 'shellquote' is not empty, otherwise the
1665 * redirection would be inside the quotes.
1666 */
1667 if (*p_shq == NUL)
1668 {
1669 p = vim_strchr(buf, '|');
1670 if (p != NULL)
1671 *p = NUL;
1672 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1674 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 if (*p_shq == NUL)
1676 {
1677 p = vim_strchr(cmd, '|');
1678 if (p != NULL)
1679 {
1680 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1681 STRCAT(buf, p);
1682 }
1683 }
1684 }
1685#endif
1686 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001687 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688
1689 return buf;
1690}
1691
1692/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001693 * Append output redirection for file "fname" to the end of string buffer
1694 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 * Works with the 'shellredir' and 'shellpipe' options.
1696 * The caller should make sure that there is enough room:
1697 * STRLEN(opt) + STRLEN(fname) + 3
1698 */
1699 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001700append_redir(
1701 char_u *buf,
1702 int buflen,
1703 char_u *opt,
1704 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705{
1706 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001707 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001709 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001710 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001712 {
1713 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001715 if (p[1] == '%') /* skip %% */
1716 ++p;
1717 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 if (p != NULL)
1719 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001720 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1721 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1722 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 }
1724 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001725 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 " %s %s",
1728#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730#endif
1731 (char *)opt, (char *)fname);
1732}
1733
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001734#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001736static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001737static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001738static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001739static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740static int viminfo_errcnt;
1741
1742 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001743no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744{
1745 /* "vim -i NONE" does not read or write a viminfo file */
1746 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1747}
1748
1749/*
1750 * Report an error for reading a viminfo file.
1751 * Count the number of errors. When there are more than 10, return TRUE.
1752 */
1753 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001754viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001756 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1757 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001758 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001759 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1760 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 emsg(IObuff);
1762 if (++viminfo_errcnt >= 10)
1763 {
1764 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1765 return TRUE;
1766 }
1767 return FALSE;
1768}
1769
1770/*
1771 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001772 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 */
1774 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001775read_viminfo(
1776 char_u *file, /* file name or NULL to use default name */
1777 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778{
1779 FILE *fp;
1780 char_u *fname;
1781
1782 if (no_viminfo())
1783 return FAIL;
1784
Bram Moolenaard812df62008-11-09 12:46:09 +00001785 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 if (fname == NULL)
1787 return FAIL;
1788 fp = mch_fopen((char *)fname, READBIN);
1789
1790 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001791 {
1792 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001793 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1794 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001795 (flags & VIF_WANT_INFO) ? _(" info") : "",
1796 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1797 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001798 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001799 verbose_leave();
1800 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801
1802 vim_free(fname);
1803 if (fp == NULL)
1804 return FAIL;
1805
1806 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001807 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
1809 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 return OK;
1811}
1812
1813/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001814 * Write the viminfo file. The old one is read in first so that effectively a
1815 * merge of current info and old info is done. This allows multiple vims to
1816 * run simultaneously, without losing any marks etc.
1817 * If "forceit" is TRUE, then the old file is not read in, and only internal
1818 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 */
1820 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001821write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822{
1823 char_u *fname;
1824 FILE *fp_in = NULL; /* input viminfo file, if any */
1825 FILE *fp_out = NULL; /* output viminfo file */
1826 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001827 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 char_u *wp;
1829#if defined(UNIX) || defined(VMS)
1830 mode_t umask_save;
1831#endif
1832#ifdef UNIX
1833 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001834 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001836#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001837 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001838#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 if (no_viminfo())
1841 return;
1842
1843 fname = viminfo_filename(file); /* may set to default if NULL */
1844 if (fname == NULL)
1845 return;
1846
1847 fp_in = mch_fopen((char *)fname, READBIN);
1848 if (fp_in == NULL)
1849 {
1850 /* 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;
1853#if defined(UNIX) || defined(VMS)
1854 /*
1855 * For Unix we create the .viminfo non-accessible for others,
1856 * because it may contain text from non-accessible documents.
1857 */
1858 umask_save = umask(077);
1859#endif
1860 fp_out = mch_fopen((char *)fname, WRITEBIN);
1861#if defined(UNIX) || defined(VMS)
1862 (void)umask(umask_save);
1863#endif
1864 }
1865 else
1866 {
1867 /*
1868 * There is an existing viminfo file. Create a temporary file to
1869 * write the new viminfo into, in the same directory as the
1870 * existing viminfo file, which will be renamed later.
1871 */
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 /*
1904 * Make tempname.
1905 * May try twice: Once normal and once with shortname set, just in
1906 * case somebody puts his viminfo file in an 8.3 filesystem.
1907 */
1908 for (;;)
1909 {
1910 tempname = buf_modname(
1911#ifdef UNIX
1912 shortname,
1913#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915#endif
1916 fname,
1917#ifdef VMS
1918 (char_u *)"-tmp",
1919#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921#endif
1922 FALSE);
1923 if (tempname == NULL) /* out of memory */
1924 break;
1925
1926 /*
1927 * Check if tempfile already exists. Never overwrite an
1928 * existing file!
1929 */
1930 if (mch_stat((char *)tempname, &st_new) == 0)
1931 {
1932#ifdef UNIX
1933 /*
1934 * Check if tempfile is same as original file. May happen
1935 * when modname() gave the same file back. E.g. silly
1936 * link, or file name-length reached. Try again with
1937 * shortname set.
1938 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001939 if (!shortname && st_new.st_dev == st_old.st_dev
1940 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 {
1942 vim_free(tempname);
1943 tempname = NULL;
1944 shortname = TRUE;
1945 continue;
1946 }
1947#endif
1948 /*
1949 * Try another name. Change one character, just before
1950 * the extension. This should also work for an 8.3
1951 * file name, when after adding the extension it still is
1952 * the same file as the original.
1953 */
1954 wp = tempname + STRLEN(tempname) - 5;
1955 if (wp < gettail(tempname)) /* empty file name? */
1956 wp = gettail(tempname);
1957 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1958 --*wp)
1959 {
1960 /*
1961 * They all exist? Must be something wrong! Don't
1962 * write the viminfo file then.
1963 */
1964 if (*wp == 'a')
1965 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001966 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1967 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 vim_free(tempname);
1969 tempname = NULL;
1970 break;
1971 }
1972 }
1973 }
1974 break;
1975 }
1976
1977 if (tempname != NULL)
1978 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001979#ifdef VMS
1980 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001981 umask_save = umask(077);
1982 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1983 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001984#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001985 int fd;
1986
1987 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001988 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001989 * Unix: same as original file, but strip s-bit. Reset umask to
1990 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001991 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001992# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001993 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001994 fd = mch_open((char *)tempname,
1995 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001996 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001997 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001998# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001999 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002000 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002001# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002002 if (fd < 0)
2003 fp_out = NULL;
2004 else
2005 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002006#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007
2008 /*
2009 * If we can't create in the same directory, try creating a
2010 * "normal" temp file.
2011 */
2012 if (fp_out == NULL)
2013 {
2014 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002015 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2017 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002018
2019#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002021 * Make sure the owner can read/write it. This only works for
2022 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 */
2024 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002025 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026#endif
2027 }
2028 }
2029
2030 /*
2031 * Check if the new viminfo file can be written to.
2032 */
2033 if (fp_out == NULL)
2034 {
2035 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002036 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 if (fp_in != NULL)
2038 fclose(fp_in);
2039 goto end;
2040 }
2041
2042 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002043 {
2044 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002045 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002046 verbose_leave();
2047 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048
2049 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002050 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
Bram Moolenaar927030a2016-03-15 18:23:55 +01002052 if (fclose(fp_out) == EOF)
2053 ++viminfo_errcnt;
2054
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 if (fp_in != NULL)
2056 {
2057 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002058
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002059 /* In case of an error keep the original viminfo file. Otherwise
2060 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002061 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002062 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002063 if (vim_rename(tempname, fname) == -1)
2064 {
2065 ++viminfo_errcnt;
2066 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2067 }
2068# ifdef WIN3264
2069 /* If the viminfo file was hidden then also hide the new file. */
2070 else if (hidden)
2071 mch_hide(fname);
2072# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002073 }
2074 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 mch_remove(tempname);
2076 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002077
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078end:
2079 vim_free(fname);
2080 vim_free(tempname);
2081}
2082
2083/*
2084 * Get the viminfo file name to use.
2085 * If "file" is given and not empty, use it (has already been expanded by
2086 * cmdline functions).
2087 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2088 * expand environment variables.
2089 * Returns an allocated string. NULL when out of memory.
2090 */
2091 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002092viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093{
2094 if (file == NULL || *file == NUL)
2095 {
2096 if (use_viminfo != NULL)
2097 file = use_viminfo;
2098 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2099 {
2100#ifdef VIMINFO_FILE2
2101 /* don't use $HOME when not defined (turned into "c:/"!). */
2102# ifdef VMS
2103 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2104# else
2105 if (mch_getenv((char_u *)"HOME") == NULL)
2106# endif
2107 {
2108 /* don't use $VIM when not available. */
2109 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2110 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2111 file = (char_u *)VIMINFO_FILE2;
2112 else
2113 file = (char_u *)VIMINFO_FILE;
2114 }
2115 else
2116#endif
2117 file = (char_u *)VIMINFO_FILE;
2118 }
2119 expand_env(file, NameBuff, MAXPATHL);
2120 file = NameBuff;
2121 }
2122 return vim_strsave(file);
2123}
2124
2125/*
2126 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2127 */
2128 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002129do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 int eof = FALSE;
2132 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002133 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002134 int do_copy_marks = FALSE;
2135 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136
2137 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2138 return;
2139 vir.vir_fd = fp_in;
2140#ifdef FEAT_MBYTE
2141 vir.vir_conv.vc_type = CONV_NONE;
2142#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002143 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002144 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145
2146 if (fp_in != NULL)
2147 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002148 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002149 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002150 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002151 {
2152 /* Registers and marks are read and kept separate from what
2153 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002154 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002155 prepare_viminfo_marks();
2156 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002157
Bram Moolenaard812df62008-11-09 12:46:09 +00002158 eof = read_viminfo_up_to_marks(&vir,
2159 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002160 merge = TRUE;
2161 }
2162 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 /* Skip info, find start of marks */
2164 while (!(eof = viminfo_readline(&vir))
2165 && vir.vir_line[0] != '>')
2166 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002167
2168 do_copy_marks = (flags &
2169 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002171
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 if (fp_out != NULL)
2173 {
2174 /* Write the info: */
2175 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2176 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002177 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002178 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002180 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2182#endif
2183 write_viminfo_search_pattern(fp_out);
2184 write_viminfo_sub_string(fp_out);
2185#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002186 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187#endif
2188 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002189 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190#ifdef FEAT_EVAL
2191 write_viminfo_varlist(fp_out);
2192#endif
2193 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002194 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002196 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002197
2198 if (do_copy_marks)
2199 ga_init2(&buflist, sizeof(buf_T *), 50);
2200 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002202
2203 if (do_copy_marks)
2204 {
2205 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2206 if (fp_out != NULL)
2207 ga_clear(&buflist);
2208 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209
2210 vim_free(vir.vir_line);
2211#ifdef FEAT_MBYTE
2212 if (vir.vir_conv.vc_type != CONV_NONE)
2213 convert_setup(&vir.vir_conv, NULL, NULL);
2214#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002215 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216}
2217
2218/*
2219 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2220 * first part of the viminfo file which contains everything but the marks that
2221 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2222 */
2223 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002224read_viminfo_up_to_marks(
2225 vir_T *virp,
2226 int forceit,
2227 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228{
2229 int eof;
2230 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002231 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232
2233#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002234 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002236
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 eof = viminfo_readline(virp);
2238 while (!eof && virp->vir_line[0] != '>')
2239 {
2240 switch (virp->vir_line[0])
2241 {
2242 /* Characters reserved for future expansion, ignored now */
2243 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 case '^': /* to be defined */
2245 case '<': /* long line - ignored */
2246 /* A comment or empty line. */
2247 case NUL:
2248 case '\r':
2249 case '\n':
2250 case '#':
2251 eof = viminfo_readline(virp);
2252 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002253 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002254 eof = read_viminfo_barline(virp, got_encoding,
2255 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002256 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002258 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 eof = viminfo_encoding(virp);
2260 break;
2261 case '!': /* global variable */
2262#ifdef FEAT_EVAL
2263 eof = read_viminfo_varlist(virp, writing);
2264#else
2265 eof = viminfo_readline(virp);
2266#endif
2267 break;
2268 case '%': /* entry for buffer list */
2269 eof = read_viminfo_bufferlist(virp, writing);
2270 break;
2271 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002272 /* When registers are in bar lines skip the old style register
2273 * lines. */
2274 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2275 eof = read_viminfo_register(virp, forceit);
2276 else
2277 do {
2278 eof = viminfo_readline(virp);
2279 } while (!eof && (virp->vir_line[0] == TAB
2280 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 break;
2282 case '/': /* Search string */
2283 case '&': /* Substitute search string */
2284 case '~': /* Last search string, followed by '/' or '&' */
2285 eof = read_viminfo_search_pattern(virp, forceit);
2286 break;
2287 case '$':
2288 eof = read_viminfo_sub_string(virp, forceit);
2289 break;
2290 case ':':
2291 case '?':
2292 case '=':
2293 case '@':
2294#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002295 /* When history is in bar lines skip the old style history
2296 * lines. */
2297 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2298 eof = read_viminfo_history(virp, writing);
2299 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002301 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 break;
2303 case '-':
2304 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002305 /* When file marks are in bar lines skip the old style lines. */
2306 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2307 eof = read_viminfo_filemark(virp, forceit);
2308 else
2309 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 break;
2311 default:
2312 if (viminfo_error("E575: ", _("Illegal starting char"),
2313 virp->vir_line))
2314 eof = TRUE;
2315 else
2316 eof = viminfo_readline(virp);
2317 break;
2318 }
2319 }
2320
2321#ifdef FEAT_CMDHIST
2322 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002323 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002324 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325#endif
2326
2327 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002328 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 fmarks_check_names(buf);
2330
2331 return eof;
2332}
2333
2334/*
2335 * Compare the 'encoding' value in the viminfo file with the current value of
2336 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2337 * conversion of text with iconv() in viminfo_readstring().
2338 */
2339 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002340viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341{
2342#ifdef FEAT_MBYTE
2343 char_u *p;
2344 int i;
2345
2346 if (get_viminfo_parameter('c') != 0)
2347 {
2348 p = vim_strchr(virp->vir_line, '=');
2349 if (p != NULL)
2350 {
2351 /* remove trailing newline */
2352 ++p;
2353 for (i = 0; vim_isprintc(p[i]); ++i)
2354 ;
2355 p[i] = NUL;
2356
2357 convert_setup(&virp->vir_conv, p, p_enc);
2358 }
2359 }
2360#endif
2361 return viminfo_readline(virp);
2362}
2363
2364/*
2365 * Read a line from the viminfo file.
2366 * Returns TRUE for end-of-file;
2367 */
2368 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002369viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370{
2371 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2372}
2373
2374/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002375 * Check string read from viminfo file.
2376 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 * - replace CTRL-V CTRL-V with CTRL-V
2378 * - replace CTRL-V 'n' with '\n'
2379 *
2380 * Check for a long line as written by viminfo_writestring().
2381 *
2382 * Return the string in allocated memory (NULL when out of memory).
2383 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002385viminfo_readstring(
2386 vir_T *virp,
2387 int off, /* offset for virp->vir_line */
2388 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389{
2390 char_u *retval;
2391 char_u *s, *d;
2392 long len;
2393
2394 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2395 {
2396 len = atol((char *)virp->vir_line + off + 1);
2397 retval = lalloc(len, TRUE);
2398 if (retval == NULL)
2399 {
2400 /* Line too long? File messed up? Skip next line. */
2401 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2402 return NULL;
2403 }
2404 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2405 s = retval + 1; /* Skip the leading '<' */
2406 }
2407 else
2408 {
2409 retval = vim_strsave(virp->vir_line + off);
2410 if (retval == NULL)
2411 return NULL;
2412 s = retval;
2413 }
2414
2415 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2416 d = retval;
2417 while (*s != NUL && *s != '\n')
2418 {
2419 if (s[0] == Ctrl_V && s[1] != NUL)
2420 {
2421 if (s[1] == 'n')
2422 *d++ = '\n';
2423 else
2424 *d++ = Ctrl_V;
2425 s += 2;
2426 }
2427 else
2428 *d++ = *s++;
2429 }
2430 *d = NUL;
2431
2432#ifdef FEAT_MBYTE
2433 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2434 {
2435 d = string_convert(&virp->vir_conv, retval, NULL);
2436 if (d != NULL)
2437 {
2438 vim_free(retval);
2439 retval = d;
2440 }
2441 }
2442#endif
2443
2444 return retval;
2445}
2446
2447/*
2448 * write string to viminfo file
2449 * - replace CTRL-V with CTRL-V CTRL-V
2450 * - replace '\n' with CTRL-V 'n'
2451 * - add a '\n' at the end
2452 *
2453 * For a long line:
2454 * - write " CTRL-V <length> \n " in first line
2455 * - write " < <string> \n " in second line
2456 */
2457 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002458viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459{
2460 int c;
2461 char_u *s;
2462 int len = 0;
2463
2464 for (s = p; *s != NUL; ++s)
2465 {
2466 if (*s == Ctrl_V || *s == '\n')
2467 ++len;
2468 ++len;
2469 }
2470
2471 /* If the string will be too long, write its length and put it in the next
2472 * line. Take into account that some room is needed for what comes before
2473 * the string (e.g., variable name). Add something to the length for the
2474 * '<', NL and trailing NUL. */
2475 if (len > LSIZE / 2)
2476 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2477
2478 while ((c = *p++) != NUL)
2479 {
2480 if (c == Ctrl_V || c == '\n')
2481 {
2482 putc(Ctrl_V, fd);
2483 if (c == '\n')
2484 c = 'n';
2485 }
2486 putc(c, fd);
2487 }
2488 putc('\n', fd);
2489}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002490
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002491/*
2492 * Write a string in quotes that barline_parse() can read back.
2493 * Breaks the line in less than LSIZE pieces when needed.
2494 * Returns remaining characters in the line.
2495 */
2496 int
2497barline_writestring(FILE *fd, char_u *s, int remaining_start)
2498{
2499 char_u *p;
2500 int remaining = remaining_start;
2501 int len = 2;
2502
2503 /* Count the number of characters produced, including quotes. */
2504 for (p = s; *p != NUL; ++p)
2505 {
2506 if (*p == NL)
2507 len += 2;
2508 else if (*p == '"' || *p == '\\')
2509 len += 2;
2510 else
2511 ++len;
2512 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002513 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002514 {
2515 fprintf(fd, ">%d\n|<", len);
2516 remaining = LSIZE - 20;
2517 }
2518
2519 putc('"', fd);
2520 for (p = s; *p != NUL; ++p)
2521 {
2522 if (*p == NL)
2523 {
2524 putc('\\', fd);
2525 putc('n', fd);
2526 --remaining;
2527 }
2528 else if (*p == '"' || *p == '\\')
2529 {
2530 putc('\\', fd);
2531 putc(*p, fd);
2532 --remaining;
2533 }
2534 else
2535 putc(*p, fd);
2536 --remaining;
2537
2538 if (remaining < 3)
2539 {
2540 putc('\n', fd);
2541 putc('|', fd);
2542 putc('<', fd);
2543 /* Leave enough space for another continuation. */
2544 remaining = LSIZE - 20;
2545 }
2546 }
2547 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002548 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002549}
2550
2551/*
2552 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002553 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002554 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002555 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002556 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002557barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002558{
2559 char_u *p = text;
2560 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002561 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002562 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002563 int i;
2564 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002565 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002566#ifdef FEAT_MBYTE
2567 char_u *sconv;
2568 int converted;
2569#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002570
2571 while (*p == ',')
2572 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002573 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002574 if (ga_grow(values, 1) == FAIL)
2575 break;
2576 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002577
2578 if (*p == '>')
2579 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002580 /* Need to read a continuation line. Put strings in allocated
2581 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002582 if (!allocated)
2583 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002584 for (i = 0; i < values->ga_len; ++i)
2585 {
2586 bval_T *vp = (bval_T *)(values->ga_data) + i;
2587
2588 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002589 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002590 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2591 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002592 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002593 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002594 allocated = TRUE;
2595 }
2596
2597 if (vim_isdigit(p[1]))
2598 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002599 size_t len;
2600 size_t todo;
2601 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002602
2603 /* String value was split into lines that are each shorter
2604 * than LSIZE:
2605 * |{bartype},>{length of "{text}{text2}"}
2606 * |<"{text1}
2607 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002608 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002609 */
2610 ++p;
2611 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002612 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002613 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002614 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002615 p = buf;
2616 for (todo = len; todo > 0; todo -= n)
2617 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002618 eof = viminfo_readline(virp);
2619 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002620 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002621 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002622 /* File was truncated or garbled. Read another line if
2623 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002624 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002625 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002626 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002627 /* Get length of text, excluding |< and NL chars. */
2628 n = STRLEN(virp->vir_line);
2629 while (n > 0 && (virp->vir_line[n - 1] == NL
2630 || virp->vir_line[n - 1] == CAR))
2631 --n;
2632 n -= 2;
2633 if (n > todo)
2634 {
2635 /* more values follow after the string */
2636 nextp = virp->vir_line + 2 + todo;
2637 n = todo;
2638 }
2639 mch_memmove(p, virp->vir_line + 2, n);
2640 p += n;
2641 }
2642 *p = NUL;
2643 p = buf;
2644 }
2645 else
2646 {
2647 /* Line ending in ">" continues in the next line:
2648 * |{bartype},{lots of values},>
2649 * |<{value},{value}
2650 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002651 eof = viminfo_readline(virp);
2652 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002653 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002654 /* File was truncated or garbled. Read another line if
2655 * this one starts with '|'. */
2656 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002657 p = virp->vir_line + 2;
2658 }
2659 }
2660
2661 if (isdigit(*p))
2662 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002663 value->bv_type = BVAL_NR;
2664 value->bv_nr = getdigits(&p);
2665 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002666 }
2667 else if (*p == '"')
2668 {
2669 int len = 0;
2670 char_u *s = p;
2671
2672 /* Unescape special characters in-place. */
2673 ++p;
2674 while (*p != '"')
2675 {
2676 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002677 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002678 if (*p == '\\')
2679 {
2680 ++p;
2681 if (*p == 'n')
2682 s[len++] = '\n';
2683 else
2684 s[len++] = *p;
2685 ++p;
2686 }
2687 else
2688 s[len++] = *p++;
2689 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002690 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002691 s[len] = NUL;
2692
Bram Moolenaar01227092016-06-11 14:47:40 +02002693#ifdef FEAT_MBYTE
2694 converted = FALSE;
2695 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2696 {
2697 sconv = string_convert(&virp->vir_conv, s, NULL);
2698 if (sconv != NULL)
2699 {
2700 if (s == buf)
2701 vim_free(s);
2702 s = sconv;
2703 buf = s;
2704 converted = TRUE;
2705 }
2706 }
2707#endif
2708 /* Need to copy in allocated memory if the string wasn't allocated
2709 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002710 if (s != buf && allocated)
2711 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002712 value->bv_string = s;
2713 value->bv_type = BVAL_STRING;
2714 value->bv_len = len;
2715 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002716#ifdef FEAT_MBYTE
2717 || converted
2718#endif
2719 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002720 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002721 if (nextp != NULL)
2722 {
2723 /* values following a long string */
2724 p = nextp;
2725 nextp = NULL;
2726 }
2727 }
2728 else if (*p == ',')
2729 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002730 value->bv_type = BVAL_EMPTY;
2731 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002732 }
2733 else
2734 break;
2735 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002736 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002737}
2738
2739 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002740read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002741{
2742 char_u *p = virp->vir_line + 1;
2743 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002744 garray_T values;
2745 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002746 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002747 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002748
2749 /* The format is: |{bartype},{value},...
2750 * For a very long string:
2751 * |{bartype},>{length of "{text}{text2}"}
2752 * |<{text1}
2753 * |<{text2},{value}
2754 * For a long line not using a string
2755 * |{bartype},{lots of values},>
2756 * |<{value},{value}
2757 */
2758 if (*p == '<')
2759 {
2760 /* Continuation line of an unrecognized item. */
2761 if (writing)
2762 ga_add_string(&virp->vir_barlines, virp->vir_line);
2763 }
2764 else
2765 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002766 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002767 bartype = getdigits(&p);
2768 switch (bartype)
2769 {
2770 case BARTYPE_VERSION:
2771 /* Only use the version when it comes before the encoding.
2772 * If it comes later it was copied by a Vim version that
2773 * doesn't understand the version. */
2774 if (!got_encoding)
2775 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002776 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002777 vp = (bval_T *)values.ga_data;
2778 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2779 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002780 }
2781 break;
2782
2783 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002784 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002785 handle_viminfo_history(&values, writing);
2786 break;
2787
2788 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002789 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002790 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002791 break;
2792
Bram Moolenaar2d358992016-06-12 21:20:54 +02002793 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002794 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002795 handle_viminfo_mark(&values, force);
2796 break;
2797
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002798 default:
2799 /* copy unrecognized line (for future use) */
2800 if (writing)
2801 ga_add_string(&virp->vir_barlines, virp->vir_line);
2802 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002803 for (i = 0; i < values.ga_len; ++i)
2804 {
2805 vp = (bval_T *)values.ga_data + i;
2806 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2807 vim_free(vp->bv_string);
2808 }
2809 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002810 }
2811
Bram Moolenaarecefe712016-06-20 12:50:17 +02002812 if (read_next)
2813 return viminfo_readline(virp);
2814 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002815}
2816
2817 static void
2818write_viminfo_version(FILE *fp_out)
2819{
2820 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2821 BARTYPE_VERSION, VIMINFO_VERSION);
2822}
2823
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002824 static void
2825write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2826{
2827 int i;
2828 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002829 int seen_useful = FALSE;
2830 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002831
2832 if (gap->ga_len > 0)
2833 {
2834 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2835
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002836 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002837 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002838 {
2839 line = ((char **)(gap->ga_data))[i];
2840 if (seen_useful || line[1] != '<')
2841 {
2842 fputs(line, fp_out);
2843 seen_useful = TRUE;
2844 }
2845 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002846 }
2847}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848#endif /* FEAT_VIMINFO */
2849
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002850/*
2851 * Return the current time in seconds. Calls time(), unless test_settime()
2852 * was used.
2853 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002854 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002855vim_time(void)
2856{
2857# ifdef FEAT_EVAL
2858 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2859# else
2860 return time(NULL);
2861# endif
2862}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002863
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864/*
2865 * Implementation of ":fixdel", also used by get_stty().
2866 * <BS> resulting <Del>
2867 * ^? ^H
2868 * not ^? ^?
2869 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002871do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872{
2873 char_u *p;
2874
2875 p = find_termcode((char_u *)"kb");
2876 add_termcode((char_u *)"kD", p != NULL
2877 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2878}
2879
2880 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002881print_line_no_prefix(
2882 linenr_T lnum,
2883 int use_number,
2884 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002886 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887
2888 if (curwin->w_p_nu || use_number)
2889 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002890 vim_snprintf((char *)numbuf, sizeof(numbuf),
2891 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2893 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002894 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895}
2896
2897/*
2898 * Print a text line. Also in silent mode ("ex -s").
2899 */
2900 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002901print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902{
2903 int save_silent = silent_mode;
2904
Bram Moolenaard29459b2016-08-26 22:29:11 +02002905 /* apply :filter /pat/ */
2906 if (message_filtered(ml_get(lnum)))
2907 return;
2908
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002910 silent_mode = FALSE;
2911 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2912 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 if (save_silent)
2914 {
2915 msg_putchar('\n');
2916 cursor_on(); /* msg_start() switches it off */
2917 out_flush();
2918 silent_mode = save_silent;
2919 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002920 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921}
2922
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002923 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002924rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002925{
2926 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002927 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002928
Bram Moolenaar7e283842013-05-30 11:43:15 +02002929#ifdef FEAT_AUTOCMD
2930 buf = curbuf;
2931 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002932 /* buffer changed, don't change name now */
2933 if (buf != curbuf)
2934 return FAIL;
2935# ifdef FEAT_EVAL
2936 if (aborting()) /* autocmds may abort script processing */
2937 return FAIL;
2938# endif
2939#endif
2940 /*
2941 * The name of the current buffer will be changed.
2942 * A new (unlisted) buffer entry needs to be made to hold the old file
2943 * name, which will become the alternate file name.
2944 * But don't set the alternate file name if the buffer didn't have a
2945 * name.
2946 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002947 fname = curbuf->b_ffname;
2948 sfname = curbuf->b_sfname;
2949 xfname = curbuf->b_fname;
2950 curbuf->b_ffname = NULL;
2951 curbuf->b_sfname = NULL;
2952 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002953 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002954 curbuf->b_ffname = fname;
2955 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002956 return FAIL;
2957 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002958 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002959 if (xfname != NULL && *xfname != NUL)
2960 {
2961 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2962 if (buf != NULL && !cmdmod.keepalt)
2963 curwin->w_alt_fnum = buf->b_fnum;
2964 }
2965 vim_free(fname);
2966 vim_free(sfname);
2967#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002968 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002969#endif
2970 /* Change directories when the 'acd' option is set. */
2971 DO_AUTOCHDIR
2972 return OK;
2973}
2974
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975/*
2976 * ":file[!] [fname]".
2977 */
2978 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002979ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002981 /* ":0file" removes the file name. Check for illegal uses ":3file",
2982 * "0file name", etc. */
2983 if (eap->addr_count > 0
2984 && (*eap->arg != NUL
2985 || eap->line2 > 0
2986 || eap->addr_count > 1))
2987 {
2988 EMSG(_(e_invarg));
2989 return;
2990 }
2991
2992 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002994 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 }
2997 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01002998 if (!shortmess(SHM_FILEINFO))
2999 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000}
3001
3002/*
3003 * ":update".
3004 */
3005 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003006ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007{
3008 if (curbufIsChanged())
3009 (void)do_write(eap);
3010}
3011
3012/*
3013 * ":write" and ":saveas".
3014 */
3015 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003016ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017{
3018 if (eap->usefilter) /* input lines to shell command */
3019 do_bang(1, eap, FALSE, TRUE, FALSE);
3020 else
3021 (void)do_write(eap);
3022}
3023
3024/*
3025 * write current buffer to file 'eap->arg'
3026 * if 'eap->append' is TRUE, append to the file
3027 *
3028 * if *eap->arg == NUL write to current file
3029 *
3030 * return FAIL for failure, OK otherwise
3031 */
3032 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003033do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034{
3035 int other;
3036 char_u *fname = NULL; /* init to shut up gcc */
3037 char_u *ffname;
3038 int retval = FAIL;
3039 char_u *free_fname = NULL;
3040#ifdef FEAT_BROWSE
3041 char_u *browse_file = NULL;
3042#endif
3043 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003044 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045
3046 if (not_writing()) /* check 'write' option */
3047 return FAIL;
3048
3049 ffname = eap->arg;
3050#ifdef FEAT_BROWSE
3051 if (cmdmod.browse)
3052 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003053 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 NULL, NULL, NULL, curbuf);
3055 if (browse_file == NULL)
3056 goto theend;
3057 ffname = browse_file;
3058 }
3059#endif
3060 if (*ffname == NUL)
3061 {
3062 if (eap->cmdidx == CMD_saveas)
3063 {
3064 EMSG(_(e_argreq));
3065 goto theend;
3066 }
3067 other = FALSE;
3068 }
3069 else
3070 {
3071 fname = ffname;
3072 free_fname = fix_fname(ffname);
3073 /*
3074 * When out-of-memory, keep unexpanded file name, because we MUST be
3075 * able to write the file in this situation.
3076 */
3077 if (free_fname != NULL)
3078 ffname = free_fname;
3079 other = otherfile(ffname);
3080 }
3081
3082 /*
3083 * If we have a new file, put its name in the list of alternate file names.
3084 */
3085 if (other)
3086 {
3087 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3088 || eap->cmdidx == CMD_saveas)
3089 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3090 else
3091 alt_buf = buflist_findname(ffname);
3092 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3093 {
3094 /* Overwriting a file that is loaded in another buffer is not a
3095 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003096 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 goto theend;
3098 }
3099 }
3100
3101 /*
3102 * Writing to the current file is not allowed in readonly mode
3103 * and a file name is required.
3104 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3105 */
3106 if (!other && (
3107#ifdef FEAT_QUICKFIX
3108 bt_dontwrite_msg(curbuf) ||
3109#endif
3110 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3111 goto theend;
3112
3113 if (!other)
3114 {
3115 ffname = curbuf->b_ffname;
3116 fname = curbuf->b_fname;
3117 /*
3118 * Not writing the whole file is only allowed with '!'.
3119 */
3120 if ( (eap->line1 != 1
3121 || eap->line2 != curbuf->b_ml.ml_line_count)
3122 && !eap->forceit
3123 && !eap->append
3124 && !p_wa)
3125 {
3126#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3127 if (p_confirm || cmdmod.confirm)
3128 {
3129 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3130 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3131 goto theend;
3132 eap->forceit = TRUE;
3133 }
3134 else
3135#endif
3136 {
3137 EMSG(_("E140: Use ! to write partial buffer"));
3138 goto theend;
3139 }
3140 }
3141 }
3142
3143 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3144 {
3145 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3146 {
3147#ifdef FEAT_AUTOCMD
3148 buf_T *was_curbuf = curbuf;
3149
3150 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003151 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152# ifdef FEAT_EVAL
3153 if (curbuf != was_curbuf || aborting())
3154# else
3155 if (curbuf != was_curbuf)
3156# endif
3157 {
3158 /* buffer changed, don't change name now */
3159 retval = FAIL;
3160 goto theend;
3161 }
3162#endif
3163 /* Exchange the file names for the current and the alternate
3164 * buffer. This makes it look like we are now editing the buffer
3165 * under the new name. Must be done before buf_write(), because
3166 * if there is no file name and 'cpo' contains 'F', it will set
3167 * the file name. */
3168 fname = alt_buf->b_fname;
3169 alt_buf->b_fname = curbuf->b_fname;
3170 curbuf->b_fname = fname;
3171 fname = alt_buf->b_ffname;
3172 alt_buf->b_ffname = curbuf->b_ffname;
3173 curbuf->b_ffname = fname;
3174 fname = alt_buf->b_sfname;
3175 alt_buf->b_sfname = curbuf->b_sfname;
3176 curbuf->b_sfname = fname;
3177 buf_name_changed(curbuf);
3178#ifdef FEAT_AUTOCMD
3179 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003180 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 if (!alt_buf->b_p_bl)
3182 {
3183 alt_buf->b_p_bl = TRUE;
3184 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3185 }
3186# ifdef FEAT_EVAL
3187 if (curbuf != was_curbuf || aborting())
3188# else
3189 if (curbuf != was_curbuf)
3190# endif
3191 {
3192 /* buffer changed, don't write the file */
3193 retval = FAIL;
3194 goto theend;
3195 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003196
3197 /* If 'filetype' was empty try detecting it now. */
3198 if (*curbuf->b_p_ft == NUL)
3199 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003200 if (au_has_group((char_u *)"filetypedetect"))
3201 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003202 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003203 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003204 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003205
3206 /* Autocommands may have changed buffer names, esp. when
3207 * 'autochdir' is set. */
3208 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209#endif
3210 }
3211
Bram Moolenaar5c719942016-07-09 23:40:45 +02003212 name_was_missing = curbuf->b_ffname == NULL;
3213
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3215 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003216
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003217 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003218 if (eap->cmdidx == CMD_saveas)
3219 {
3220 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003221 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003222 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003223#ifdef FEAT_WINDOWS
3224 redraw_tabline = TRUE;
3225#endif
3226 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003227 }
3228
3229 /* Change directories when the 'acd' option is set and the file name
3230 * got changed or set. */
3231 if (eap->cmdidx == CMD_saveas || name_was_missing)
3232 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003233 DO_AUTOCHDIR
3234 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 }
3236
3237theend:
3238#ifdef FEAT_BROWSE
3239 vim_free(browse_file);
3240#endif
3241 vim_free(free_fname);
3242 return retval;
3243}
3244
3245/*
3246 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3247 * BF_NEW or BF_READERR, check for overwriting current file.
3248 * May set eap->forceit if a dialog says it's OK to overwrite.
3249 * Return OK if it's OK, FAIL if it is not.
3250 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003251 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003252check_overwrite(
3253 exarg_T *eap,
3254 buf_T *buf,
3255 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003257 char_u *ffname, /* full path version of fname */
3258 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259{
3260 /*
3261 * write to other file or b_flags set or not writing the whole file:
3262 * overwriting only allowed with '!'
3263 */
3264 if ( (other
3265 || (buf->b_flags & BF_NOTEDITED)
3266 || ((buf->b_flags & BF_NEW)
3267 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3268 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003270#ifdef FEAT_QUICKFIX
3271 && !bt_nofile(buf)
3272#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 && vim_fexists(ffname))
3274 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003275 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003277#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003278 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003279 if (mch_isdir(ffname))
3280 {
3281 EMSG2(_(e_isadir2), ffname);
3282 return FAIL;
3283 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284#endif
3285#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003286 if (p_confirm || cmdmod.confirm)
3287 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003288 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003290 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3291 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3292 return FAIL;
3293 eap->forceit = TRUE;
3294 }
3295 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003297 {
3298 EMSG(_(e_exists));
3299 return FAIL;
3300 }
3301 }
3302
3303 /* For ":w! filename" check that no swap file exists for "filename". */
3304 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003306 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003307 char_u *p;
3308 int r;
3309 char_u *swapname;
3310
3311 /* We only try the first entry in 'directory', without checking if
3312 * it's writable. If the "." directory is not writable the write
3313 * will probably fail anyway.
3314 * Use 'shortname' of the current buffer, since there is no buffer
3315 * for the written file. */
3316 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003317 {
3318 dir = alloc(5);
3319 if (dir == NULL)
3320 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003321 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003322 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003323 else
3324 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003325 dir = alloc(MAXPATHL);
3326 if (dir == NULL)
3327 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003328 p = p_dir;
3329 copy_option_part(&p, dir, MAXPATHL, ",");
3330 }
3331 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003332 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003333 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003334 if (r)
3335 {
3336#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3337 if (p_confirm || cmdmod.confirm)
3338 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003339 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003340
3341 dialog_msg(buff,
3342 _("Swap file \"%s\" exists, overwrite anyway?"),
3343 swapname);
3344 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3345 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003346 {
3347 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003348 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003349 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003350 eap->forceit = TRUE;
3351 }
3352 else
3353#endif
3354 {
3355 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3356 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003357 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003358 return FAIL;
3359 }
3360 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003361 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 }
3363 }
3364 return OK;
3365}
3366
3367/*
3368 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3369 */
3370 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003371ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372{
3373 int i;
3374
3375 if (eap->cmd[1] == 'n')
3376 i = curwin->w_arg_idx + (int)eap->line2;
3377 else
3378 i = curwin->w_arg_idx - (int)eap->line2;
3379 eap->line1 = 1;
3380 eap->line2 = curbuf->b_ml.ml_line_count;
3381 if (do_write(eap) != FAIL)
3382 do_argfile(eap, i);
3383}
3384
3385/*
3386 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3387 */
3388 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003389do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390{
3391 buf_T *buf;
3392 int error = 0;
3393 int save_forceit = eap->forceit;
3394
3395 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3396 exiting = TRUE;
3397
Bram Moolenaar29323592016-07-24 22:04:11 +02003398 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 {
3400 if (bufIsChanged(buf))
3401 {
3402 /*
3403 * Check if there is a reason the buffer cannot be written:
3404 * 1. if the 'write' option is set
3405 * 2. if there is no file name (even after browsing)
3406 * 3. if the 'readonly' is set (even after a dialog)
3407 * 4. if overwriting is allowed (even after a dialog)
3408 */
3409 if (not_writing())
3410 {
3411 ++error;
3412 break;
3413 }
3414#ifdef FEAT_BROWSE
3415 /* ":browse wall": ask for file name if there isn't one */
3416 if (buf->b_ffname == NULL && cmdmod.browse)
3417 browse_save_fname(buf);
3418#endif
3419 if (buf->b_ffname == NULL)
3420 {
3421 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3422 ++error;
3423 }
3424 else if (check_readonly(&eap->forceit, buf)
3425 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3426 FALSE) == FAIL)
3427 {
3428 ++error;
3429 }
3430 else
3431 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003432#ifdef FEAT_AUTOCMD
3433 bufref_T bufref;
3434
3435 set_bufref(&bufref, buf);
3436#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 if (buf_write_all(buf, eap->forceit) == FAIL)
3438 ++error;
3439#ifdef FEAT_AUTOCMD
3440 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003441 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 buf = firstbuf;
3443#endif
3444 }
3445 eap->forceit = save_forceit; /* check_overwrite() may set it */
3446 }
3447 }
3448 if (exiting)
3449 {
3450 if (!error)
3451 getout(0); /* exit Vim */
3452 not_exiting();
3453 }
3454}
3455
3456/*
3457 * Check the 'write' option.
3458 * Return TRUE and give a message when it's not st.
3459 */
3460 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003461not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462{
3463 if (p_write)
3464 return FALSE;
3465 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3466 return TRUE;
3467}
3468
3469/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003470 * Check if a buffer is read-only (either 'readonly' option is set or file is
3471 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3472 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 */
3474 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003475check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003477 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003478
3479 /* Handle a file being readonly when the 'readonly' option is set or when
3480 * the file exists and permissions are read-only.
3481 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3482 * important for device checks but not here. */
3483 if (!*forceit && (buf->b_p_ro
3484 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3485 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 {
3487#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3488 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3489 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003490 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491
Bram Moolenaar5386a122007-06-28 20:02:32 +00003492 if (buf->b_p_ro)
3493 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3494 buf->b_fname);
3495 else
3496 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 +00003497 buf->b_fname);
3498
3499 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3500 {
3501 /* Set forceit, to force the writing of a readonly file */
3502 *forceit = TRUE;
3503 return FALSE;
3504 }
3505 else
3506 return TRUE;
3507 }
3508 else
3509#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003510 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003512 else
3513 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3514 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 return TRUE;
3516 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003517
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 return FALSE;
3519}
3520
3521/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003522 * Try to abandon current file and edit a new or existing file.
3523 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003525 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003526 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3528 */
3529 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003530getfile(
3531 int fnum,
3532 char_u *ffname,
3533 char_u *sfname,
3534 int setpm,
3535 linenr_T lnum,
3536 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537{
3538 int other;
3539 int retval;
3540 char_u *free_me = NULL;
3541
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003542 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003544#ifdef FEAT_AUTOCMD
3545 if (curbuf_locked())
3546 return 1;
3547#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548
3549 if (fnum == 0)
3550 {
3551 /* make ffname full path, set sfname */
3552 fname_expand(curbuf, &ffname, &sfname);
3553 other = otherfile(ffname);
3554 free_me = ffname; /* has been allocated, free() later */
3555 }
3556 else
3557 other = (fnum != curbuf->b_fnum);
3558
3559 if (other)
3560 ++no_wait_return; /* don't wait for autowrite message */
3561 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3562 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3563 {
3564#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3565 if (p_confirm && p_write)
3566 dialog_changed(curbuf, FALSE);
3567 if (curbufIsChanged())
3568#endif
3569 {
3570 if (other)
3571 --no_wait_return;
3572 EMSG(_(e_nowrtmsg));
3573 retval = 2; /* file has been changed */
3574 goto theend;
3575 }
3576 }
3577 if (other)
3578 --no_wait_return;
3579 if (setpm)
3580 setpcmark();
3581 if (!other)
3582 {
3583 if (lnum != 0)
3584 curwin->w_cursor.lnum = lnum;
3585 check_cursor_lnum();
3586 beginline(BL_SOL | BL_FIX);
3587 retval = 0; /* it's in the same file */
3588 }
3589 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003590 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3591 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 retval = -1; /* opened another file */
3593 else
3594 retval = 1; /* error encountered */
3595
3596theend:
3597 vim_free(free_me);
3598 return retval;
3599}
3600
3601/*
3602 * start editing a new file
3603 *
3604 * fnum: file number; if zero use ffname/sfname
3605 * ffname: the file name
3606 * - full path if sfname used,
3607 * - any file name if sfname is NULL
3608 * - empty string to re-edit with the same file name (but may be
3609 * in a different directory)
3610 * - NULL to start an empty buffer
3611 * sfname: the short file name (or NULL)
3612 * eap: contains the command to be executed after loading the file and
3613 * forced 'ff' and 'fenc'
3614 * newlnum: if > 0: put cursor on this line number (if possible)
3615 * if ECMD_LASTL: use last position in loaded file
3616 * if ECMD_LAST: use last position in all files
3617 * if ECMD_ONE: use first line
3618 * flags:
3619 * ECMD_HIDE: if TRUE don't free the current buffer
3620 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3621 * ECMD_OLDBUF: use existing buffer if it exists
3622 * ECMD_FORCEIT: ! used for Ex command
3623 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003624 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003625 * window, NULL when splitting the window first. When not NULL info
3626 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 *
3628 * return FAIL for failure, OK otherwise
3629 */
3630 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003631do_ecmd(
3632 int fnum,
3633 char_u *ffname,
3634 char_u *sfname,
3635 exarg_T *eap, /* can be NULL! */
3636 linenr_T newlnum,
3637 int flags,
3638 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639{
3640 int other_file; /* TRUE if editing another file */
3641 int oldbuf; /* TRUE if using existing buffer */
3642#ifdef FEAT_AUTOCMD
3643 int auto_buf = FALSE; /* TRUE if autocommands brought us
3644 into the buffer unexpectedly */
3645 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003646 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647#endif
3648 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003649 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003651 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652#endif
3653 char_u *free_fname = NULL;
3654#ifdef FEAT_BROWSE
3655 char_u *browse_file = NULL;
3656#endif
3657 int retval = FAIL;
3658 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003659 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 linenr_T topline = 0;
3661 int newcol = -1;
3662 int solcol = -1;
3663 pos_T *pos;
3664#ifdef FEAT_SUN_WORKSHOP
3665 char_u *cp;
3666#endif
3667 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003668#ifdef FEAT_SPELL
3669 int did_get_winopts = FALSE;
3670#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003671 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003672 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673
3674 if (eap != NULL)
3675 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003676#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3677 set_bufref(&old_curbuf, curbuf);
3678#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679
3680 if (fnum != 0)
3681 {
3682 if (fnum == curbuf->b_fnum) /* file is already being edited */
3683 return OK; /* nothing to do */
3684 other_file = TRUE;
3685 }
3686 else
3687 {
3688#ifdef FEAT_BROWSE
3689 if (cmdmod.browse)
3690 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003691# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003692 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003693# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003694 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003695# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003696 au_has_group((char_u *)"FileExplorer"))
3697 {
3698 /* No browsing supported but we do have the file explorer:
3699 * Edit the directory. */
3700 if (ffname == NULL || !mch_isdir(ffname))
3701 ffname = (char_u *)".";
3702 }
3703 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003704# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003705 {
3706 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003708 if (browse_file == NULL)
3709 goto theend;
3710 ffname = browse_file;
3711 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 }
3713#endif
3714 /* if no short name given, use ffname for short name */
3715 if (sfname == NULL)
3716 sfname = ffname;
3717#ifdef USE_FNAME_CASE
3718# ifdef USE_LONG_FNAME
3719 if (USE_LONG_FNAME)
3720# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003721 if (sfname != NULL)
3722 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723#endif
3724
3725#ifdef FEAT_LISTCMDS
3726 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3727 goto theend;
3728#endif
3729
3730 if (ffname == NULL)
3731 other_file = TRUE;
3732 /* there is no file name */
3733 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3734 other_file = FALSE;
3735 else
3736 {
3737 if (*ffname == NUL) /* re-edit with same file name */
3738 {
3739 ffname = curbuf->b_ffname;
3740 sfname = curbuf->b_fname;
3741 }
3742 free_fname = fix_fname(ffname); /* may expand to full path name */
3743 if (free_fname != NULL)
3744 ffname = free_fname;
3745 other_file = otherfile(ffname);
3746#ifdef FEAT_SUN_WORKSHOP
3747 if (usingSunWorkShop && p_acd
3748 && (cp = vim_strrchr(sfname, '/')) != NULL)
3749 sfname = ++cp;
3750#endif
3751 }
3752 }
3753
3754 /*
3755 * if the file was changed we may not be allowed to abandon it
3756 * - if we are going to re-edit the same file
3757 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3758 */
3759 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3760 || (curbuf->b_nwindows == 1
3761 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003762 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3763 | (other_file ? 0 : CCGD_MULTWIN)
3764 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3765 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 {
3767 if (fnum == 0 && other_file && ffname != NULL)
3768 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3769 goto theend;
3770 }
3771
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 /*
3773 * End Visual mode before switching to another buffer, so the text can be
3774 * copied into the GUI selection buffer.
3775 */
3776 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003778#ifdef FEAT_AUTOCMD
3779 if ((command != NULL || newlnum > (linenr_T)0)
3780 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3781 {
3782 int len;
3783 char_u *p;
3784
3785 /* Set v:swapcommand for the SwapExists autocommands. */
3786 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003787 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003788 else
3789 len = 30;
3790 p = alloc((unsigned)len);
3791 if (p != NULL)
3792 {
3793 if (command != NULL)
3794 vim_snprintf((char *)p, len, ":%s\r", command);
3795 else
3796 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3797 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3798 did_set_swapcommand = TRUE;
3799 vim_free(p);
3800 }
3801 }
3802#endif
3803
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 /*
3805 * If we are starting to edit another file, open a (new) buffer.
3806 * Otherwise we re-use the current buffer.
3807 */
3808 if (other_file)
3809 {
3810#ifdef FEAT_LISTCMDS
3811 if (!(flags & ECMD_ADDBUF))
3812#endif
3813 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003814 if (!cmdmod.keepalt)
3815 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003816 if (oldwin != NULL)
3817 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 }
3819
3820 if (fnum)
3821 buf = buflist_findnr(fnum);
3822 else
3823 {
3824#ifdef FEAT_LISTCMDS
3825 if (flags & ECMD_ADDBUF)
3826 {
3827 linenr_T tlnum = 1L;
3828
3829 if (command != NULL)
3830 {
3831 tlnum = atol((char *)command);
3832 if (tlnum <= 0)
3833 tlnum = 1L;
3834 }
3835 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3836 goto theend;
3837 }
3838#endif
3839 buf = buflist_new(ffname, sfname, 0L,
3840 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003841#ifdef FEAT_AUTOCMD
3842 /* autocommands may change curwin and curbuf */
3843 if (oldwin != NULL)
3844 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003845 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003846#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 }
3848 if (buf == NULL)
3849 goto theend;
3850 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3851 {
3852 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 }
3854 else /* existing memfile */
3855 {
3856 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003857 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003859 /* Check if autocommands made the buffer invalid or changed the
3860 * current buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003861 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003863 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864#endif
3865 )
3866 goto theend;
3867#ifdef FEAT_EVAL
3868 if (aborting()) /* autocmds may abort script processing */
3869 goto theend;
3870#endif
3871 }
3872
3873 /* May jump to last used line number for a loaded buffer or when asked
3874 * for explicitly */
3875 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3876 {
3877 pos = buflist_findfpos(buf);
3878 newlnum = pos->lnum;
3879 solcol = pos->col;
3880 }
3881
3882 /*
3883 * Make the (new) buffer the one used by the current window.
3884 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3885 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003886 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 */
3888 if (buf != curbuf)
3889 {
3890#ifdef FEAT_AUTOCMD
3891 /*
3892 * Be careful: The autocommands may delete any buffer and change
3893 * the current buffer.
3894 * - If the buffer we are going to edit is deleted, give up.
3895 * - If the current buffer is deleted, prefer to load the new
3896 * buffer when loading a buffer is required. This avoids
3897 * loading another buffer which then must be closed again.
3898 * - If we ended up in the new buffer already, need to skip a few
3899 * things, set auto_buf.
3900 */
3901 if (buf->b_fname != NULL)
3902 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003903 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003905 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003907 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 delbuf_msg(new_name); /* frees new_name */
3909 goto theend;
3910 }
3911# ifdef FEAT_EVAL
3912 if (aborting()) /* autocmds may abort script processing */
3913 {
3914 vim_free(new_name);
3915 goto theend;
3916 }
3917# endif
3918 if (buf == curbuf) /* already in new buffer */
3919 auto_buf = TRUE;
3920 else
3921 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02003922 win_T *the_curwin = curwin;
3923
3924 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003925 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02003926 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003927 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02003928
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003929 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930#endif
3931 buf_copy_options(buf, BCO_ENTER);
3932
Bram Moolenaar5a497892016-09-03 16:29:04 +02003933 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02003934 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003935 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003936 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003937 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938
3939#ifdef FEAT_AUTOCMD
Bram Moolenaar5a497892016-09-03 16:29:04 +02003940 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003941 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01003942
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943# ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02003944 /* autocmds may abort script processing */
3945 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 {
3947 vim_free(new_name);
3948 goto theend;
3949 }
3950# endif
3951 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003952 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003954 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 delbuf_msg(new_name); /* frees new_name */
3956 goto theend;
3957 }
3958 if (buf == curbuf) /* already in new buffer */
3959 auto_buf = TRUE;
3960 else
3961#endif
3962 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003963#ifdef FEAT_SYN_HL
3964 /*
3965 * <VN> We could instead free the synblock
3966 * and re-attach to buffer, perhaps.
3967 */
Bram Moolenaarc4bfeda2016-12-14 21:42:00 +01003968 if (curwin->w_buffer != NULL
3969 && curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003970 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003971#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 curwin->w_buffer = buf;
3973 curbuf = buf;
3974 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003975
3976 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3977 if (!oldbuf && eap != NULL)
3978 {
3979 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003980#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003981 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003982#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003983 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 }
3985
3986 /* May get the window options from the last time this buffer
3987 * was in this window (or another window). If not used
3988 * before, reset the local window options to the global
3989 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003990 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003991#ifdef FEAT_SPELL
3992 did_get_winopts = TRUE;
3993#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994
3995#ifdef FEAT_AUTOCMD
3996 }
3997 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003998 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02003999 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000#endif
4001 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002
4003 curwin->w_pcmark.lnum = 1;
4004 curwin->w_pcmark.col = 0;
4005 }
4006 else /* !other_file */
4007 {
4008 if (
4009#ifdef FEAT_LISTCMDS
4010 (flags & ECMD_ADDBUF) ||
4011#endif
4012 check_fname() == FAIL)
4013 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004014
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 oldbuf = (flags & ECMD_OLDBUF);
4016 }
4017
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004018 /* Don't redraw until the cursor is in the right line, otherwise
4019 * autocommands may cause ml_get errors. */
4020 ++RedrawingDisabled;
4021 did_inc_redrawing_disabled = TRUE;
4022
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004023#ifdef FEAT_AUTOCMD
4024 buf = curbuf;
4025#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4027 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004028 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 }
4030 else
4031 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 /* Don't make a buffer listed if it's a help buffer. Useful when
4033 * using CTRL-O to go back to a help file. */
4034 if (!curbuf->b_help)
4035 set_buflisted(TRUE);
4036 }
4037
4038#ifdef FEAT_AUTOCMD
4039 /* If autocommands change buffers under our fingers, forget about
4040 * editing the file. */
4041 if (buf != curbuf)
4042 goto theend;
4043# ifdef FEAT_EVAL
4044 if (aborting()) /* autocmds may abort script processing */
4045 goto theend;
4046# endif
4047
4048 /* Since we are starting to edit a file, consider the filetype to be
4049 * unset. Helps for when an autocommand changes files and expects syntax
4050 * highlighting to work in the other file. */
4051 did_filetype = FALSE;
4052#endif
4053
4054/*
4055 * other_file oldbuf
4056 * FALSE FALSE re-edit same file, buffer is re-used
4057 * FALSE TRUE re-edit same file, nothing changes
4058 * TRUE FALSE start editing new file, new buffer
4059 * TRUE TRUE start editing in existing buffer (nothing to do)
4060 */
4061 if (!other_file && !oldbuf) /* re-use the buffer */
4062 {
4063 set_last_cursor(curwin); /* may set b_last_cursor */
4064 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4065 {
4066 newlnum = curwin->w_cursor.lnum;
4067 solcol = curwin->w_cursor.col;
4068 }
4069#ifdef FEAT_AUTOCMD
4070 buf = curbuf;
4071 if (buf->b_fname != NULL)
4072 new_name = vim_strsave(buf->b_fname);
4073 else
4074 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004075 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004077 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4078 {
4079 /* Save all the text, so that the reload can be undone.
4080 * Sync first so that this is a separate undo-able action. */
4081 u_sync(FALSE);
4082 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4083 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004084 {
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004085#ifdef FEAT_AUTOCMD
Bram Moolenaar1e225822016-07-30 21:48:59 +02004086 vim_free(new_name);
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004087#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004088 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004089 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004090 u_unchanged(curbuf);
4091 buf_freeall(curbuf, BFA_KEEP_UNDO);
4092
4093 /* tell readfile() not to clear or reload undo info */
4094 readfile_flags = READ_KEEP_UNDO;
4095 }
4096 else
4097 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098#ifdef FEAT_AUTOCMD
4099 /* If autocommands deleted the buffer we were going to re-edit, give
4100 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004101 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 {
4103 delbuf_msg(new_name); /* frees new_name */
4104 goto theend;
4105 }
4106 vim_free(new_name);
4107
4108 /* If autocommands change buffers under our fingers, forget about
4109 * re-editing the file. Should do the buf_clear_file(), but perhaps
4110 * the autocommands changed the buffer... */
4111 if (buf != curbuf)
4112 goto theend;
4113# ifdef FEAT_EVAL
4114 if (aborting()) /* autocmds may abort script processing */
4115 goto theend;
4116# endif
4117#endif
4118 buf_clear_file(curbuf);
4119 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4120 curbuf->b_op_end.lnum = 0;
4121 }
4122
4123/*
4124 * If we get here we are sure to start editing
4125 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 /* Assume success now */
4127 retval = OK;
4128
4129 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 * Check if we are editing the w_arg_idx file in the argument list.
4131 */
4132 check_arg_idx(curwin);
4133
4134#ifdef FEAT_AUTOCMD
4135 if (!auto_buf)
4136#endif
4137 {
4138 /*
4139 * Set cursor and init window before reading the file and executing
4140 * autocommands. This allows for the autocommands to position the
4141 * cursor.
4142 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004143 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144
4145#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004146 /* It's possible that all lines in the buffer changed. Need to update
4147 * automatic folding for all windows where it's used. */
4148# ifdef FEAT_WINDOWS
4149 {
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 }
4157# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004159# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160#endif
4161
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004162 /* Change directories when the 'acd' option is set. */
4163 DO_AUTOCHDIR
4164
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 /*
4166 * Careful: open_buffer() and apply_autocmds() may change the current
4167 * buffer and window.
4168 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004169 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 topline = curwin->w_topline;
4171 if (!oldbuf) /* need to read the file */
4172 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004173#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 swap_exists_action = SEA_DIALOG;
4175#endif
4176 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4177
4178 /*
4179 * Open the buffer and read the file.
4180 */
4181#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004182 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 retval = FAIL;
4184#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004185 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186#endif
4187
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004188#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 if (swap_exists_action == SEA_QUIT)
4190 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004191 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192#endif
4193 }
4194#ifdef FEAT_AUTOCMD
4195 else
4196 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004197 /* Read the modelines, but only to set window-local options. Any
4198 * buffer-local options have already been set and may have been
4199 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004200 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004201
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4203 &retval);
4204 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4205 &retval);
4206 }
4207 check_arg_idx(curwin);
4208#endif
4209
Bram Moolenaareab316b2015-03-24 11:46:30 +01004210 /* If autocommands change the cursor position or topline, we should
4211 * keep it. Also when it moves within a line. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004212 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 {
4214 newlnum = curwin->w_cursor.lnum;
4215 newcol = curwin->w_cursor.col;
4216 }
4217 if (curwin->w_topline == topline)
4218 topline = 0;
4219
4220 /* Even when cursor didn't move we need to recompute topline. */
4221 changed_line_abv_curs();
4222
4223#ifdef FEAT_TITLE
4224 maketitle();
4225#endif
4226 }
4227
4228#ifdef FEAT_DIFF
4229 /* Tell the diff stuff that this buffer is new and/or needs updating.
4230 * Also needed when re-editing the same buffer, because unloading will
4231 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004232 if (curwin->w_p_diff)
4233 {
4234 diff_buf_add(curbuf);
4235 diff_invalidate(curbuf);
4236 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237#endif
4238
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004239#ifdef FEAT_SPELL
4240 /* If the window options were changed may need to set the spell language.
4241 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004242 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4243 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004244#endif
4245
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 if (command == NULL)
4247 {
4248 if (newcol >= 0) /* position set by autocommands */
4249 {
4250 curwin->w_cursor.lnum = newlnum;
4251 curwin->w_cursor.col = newcol;
4252 check_cursor();
4253 }
4254 else if (newlnum > 0) /* line number from caller or old position */
4255 {
4256 curwin->w_cursor.lnum = newlnum;
4257 check_cursor_lnum();
4258 if (solcol >= 0 && !p_sol)
4259 {
4260 /* 'sol' is off: Use last known column. */
4261 curwin->w_cursor.col = solcol;
4262 check_cursor_col();
4263#ifdef FEAT_VIRTUALEDIT
4264 curwin->w_cursor.coladd = 0;
4265#endif
4266 curwin->w_set_curswant = TRUE;
4267 }
4268 else
4269 beginline(BL_SOL | BL_FIX);
4270 }
4271 else /* no line number, go to last line in Ex mode */
4272 {
4273 if (exmode_active)
4274 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4275 beginline(BL_WHITE | BL_FIX);
4276 }
4277 }
4278
4279#ifdef FEAT_WINDOWS
4280 /* Check if cursors in other windows on the same buffer are still valid */
4281 check_lnums(FALSE);
4282#endif
4283
4284 /*
4285 * Did not read the file, need to show some info about the file.
4286 * Do this after setting the cursor.
4287 */
4288 if (oldbuf
4289#ifdef FEAT_AUTOCMD
4290 && !auto_buf
4291#endif
4292 )
4293 {
4294 int msg_scroll_save = msg_scroll;
4295
4296 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4297 * message. */
4298 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4299 msg_scroll = FALSE;
4300 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4301 check_for_delay(FALSE);
4302 msg_start();
4303 msg_scroll = msg_scroll_save;
4304 msg_scrolled_ign = TRUE;
4305
Bram Moolenaar426dd022016-03-15 15:09:29 +01004306 if (!shortmess(SHM_FILEINFO))
4307 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308
4309 msg_scrolled_ign = FALSE;
4310 }
4311
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004312#ifdef FEAT_VIMINFO
4313 curbuf->b_last_used = vim_time();
4314#endif
4315
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 if (command != NULL)
4317 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4318
4319#ifdef FEAT_KEYMAP
4320 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004321 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322#endif
4323
4324 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004325 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 if (!skip_redraw)
4327 {
4328 n = p_so;
4329 if (topline == 0 && command == NULL)
4330 p_so = 999; /* force cursor halfway the window */
4331 update_topline();
4332#ifdef FEAT_SCROLLBIND
4333 curwin->w_scbind_pos = curwin->w_topline;
4334#endif
4335 p_so = n;
4336 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4337 }
4338
4339 if (p_im)
4340 need_start_insertmode = TRUE;
4341
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004342 /* Change directories when the 'acd' option is set. */
4343 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004345#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004346 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 {
4348# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004349 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4351# endif
4352# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004353 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004354 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355# endif
4356 }
4357#endif
4358
4359theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004360 if (did_inc_redrawing_disabled)
4361 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004362#ifdef FEAT_AUTOCMD
4363 if (did_set_swapcommand)
4364 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4365#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366#ifdef FEAT_BROWSE
4367 vim_free(browse_file);
4368#endif
4369 vim_free(free_fname);
4370 return retval;
4371}
4372
4373#ifdef FEAT_AUTOCMD
4374 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004375delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376{
4377 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4378 name == NULL ? (char_u *)"" : name);
4379 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004380 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004381 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382}
4383#endif
4384
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004385static int append_indent = 0; /* autoindent for first line */
4386
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387/*
4388 * ":insert" and ":append", also used by ":change"
4389 */
4390 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004391ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392{
4393 char_u *theline;
4394 int did_undo = FALSE;
4395 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004396 int indent = 0;
4397 char_u *p;
4398 int vcol;
4399 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004401 /* the ! flag toggles autoindent */
4402 if (eap->forceit)
4403 curbuf->b_p_ai = !curbuf->b_p_ai;
4404
4405 /* First autoindent comes from the line we start on */
4406 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4407 append_indent = get_indent_lnum(lnum);
4408
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 if (eap->cmdidx != CMD_append)
4410 --lnum;
4411
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004412 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004413 if (empty && lnum == 1)
4414 lnum = 0;
4415
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 State = INSERT; /* behave like in Insert mode */
4417 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4418 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004419
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004420 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 {
4422 msg_scroll = TRUE;
4423 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004424 if (curbuf->b_p_ai)
4425 {
4426 if (append_indent >= 0)
4427 {
4428 indent = append_indent;
4429 append_indent = -1;
4430 }
4431 else if (lnum > 0)
4432 indent = get_indent_lnum(lnum);
4433 }
4434 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004436 {
4437 /* No getline() function, use the lines that follow. This ends
4438 * when there is no more. */
4439 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4440 break;
4441 p = vim_strchr(eap->nextcmd, NL);
4442 if (p == NULL)
4443 p = eap->nextcmd + STRLEN(eap->nextcmd);
4444 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4445 if (*p != NUL)
4446 ++p;
4447 eap->nextcmd = p;
4448 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004450 {
4451 int save_State = State;
4452
4453 /* Set State to avoid the cursor shape to be set to INSERT mode
4454 * when getline() returns. */
4455 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 theline = eap->getline(
4457#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004458 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004460 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004461 State = save_State;
4462 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004464 if (theline == NULL)
4465 break;
4466
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004467 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4468 if (ex_keep_indent)
4469 append_indent = indent;
4470
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004471 /* Look for the "." after automatic indent. */
4472 vcol = 0;
4473 for (p = theline; indent > vcol; ++p)
4474 {
4475 if (*p == ' ')
4476 ++vcol;
4477 else if (*p == TAB)
4478 vcol += 8 - vcol % 8;
4479 else
4480 break;
4481 }
4482 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004483 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4484 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 {
4486 vim_free(theline);
4487 break;
4488 }
4489
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004490 /* don't use autoindent if nothing was typed. */
4491 if (p[0] == NUL)
4492 theline[0] = NUL;
4493
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 did_undo = TRUE;
4495 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004496 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497
4498 vim_free(theline);
4499 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004500
4501 if (empty)
4502 {
4503 ml_delete(2L, FALSE);
4504 empty = FALSE;
4505 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 }
4507 State = NORMAL;
4508
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004509 if (eap->forceit)
4510 curbuf->b_p_ai = !curbuf->b_p_ai;
4511
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004513 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 * "end" is set to lnum when something has been appended, otherwise
4515 * it is the same than "start" -- Acevedo */
4516 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4517 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4518 if (eap->cmdidx != CMD_append)
4519 --curbuf->b_op_start.lnum;
4520 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4521 ? lnum : curbuf->b_op_start.lnum;
4522 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4523 curwin->w_cursor.lnum = lnum;
4524 check_cursor_lnum();
4525 beginline(BL_SOL | BL_FIX);
4526
4527 need_wait_return = FALSE; /* don't use wait_return() now */
4528 ex_no_reprint = TRUE;
4529}
4530
4531/*
4532 * ":change"
4533 */
4534 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004535ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536{
4537 linenr_T lnum;
4538
4539 if (eap->line2 >= eap->line1
4540 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4541 return;
4542
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004543 /* the ! flag toggles autoindent */
4544 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4545 append_indent = get_indent_lnum(eap->line1);
4546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4548 {
4549 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4550 break;
4551 ml_delete(eap->line1, FALSE);
4552 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004553
4554 /* make sure the cursor is not beyond the end of the file now */
4555 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4557
4558 /* ":append" on the line above the deleted lines. */
4559 eap->line2 = eap->line1;
4560 ex_append(eap);
4561}
4562
4563 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004564ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565{
4566 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004567 int bigness;
4568 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 int minus = 0;
4570 linenr_T start, end, curs, i;
4571 int j;
4572 linenr_T lnum = eap->line2;
4573
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004574 /* Vi compatible: ":z!" uses display height, without a count uses
4575 * 'scroll' */
4576 if (eap->forceit)
4577 bigness = curwin->w_height;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004578#ifdef FEAT_WINDOWS
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 Moolenaar78a15312009-05-15 19:33:18 +00004581#endif
Bram Moolenaar631abc32014-02-22 22:27:47 +01004582 else
4583 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 if (bigness < 1)
4585 bigness = 1;
4586
4587 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004588 kind = x;
4589 if (*kind == '-' || *kind == '+' || *kind == '='
4590 || *kind == '^' || *kind == '.')
4591 ++x;
4592 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 ++x;
4594
4595 if (*x != 0)
4596 {
4597 if (!VIM_ISDIGIT(*x))
4598 {
4599 EMSG(_("E144: non-numeric argument to :z"));
4600 return;
4601 }
4602 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004603 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004605 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004606 if (*kind == '=')
4607 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004608 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 }
4610
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004611 /* the number of '-' and '+' multiplies the distance */
4612 if (*kind == '-' || *kind == '+')
4613 for (x = kind + 1; *x == *kind; ++x)
4614 ;
4615
4616 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 {
4618 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004619 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4620 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004621 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 break;
4623
4624 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004625 start = lnum - (bigness + 1) / 2 + 1;
4626 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 curs = lnum;
4628 minus = 1;
4629 break;
4630
4631 case '^':
4632 start = lnum - bigness * 2;
4633 end = lnum - bigness;
4634 curs = lnum - bigness;
4635 break;
4636
4637 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004638 start = lnum - (bigness + 1) / 2 + 1;
4639 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 curs = end;
4641 break;
4642
4643 default: /* '+' */
4644 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004645 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004646 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004647 else if (eap->addr_count == 0)
4648 ++start;
4649 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 curs = end;
4651 break;
4652 }
4653
4654 if (start < 1)
4655 start = 1;
4656
4657 if (end > curbuf->b_ml.ml_line_count)
4658 end = curbuf->b_ml.ml_line_count;
4659
4660 if (curs > curbuf->b_ml.ml_line_count)
4661 curs = curbuf->b_ml.ml_line_count;
4662
4663 for (i = start; i <= end; i++)
4664 {
4665 if (minus && i == lnum)
4666 {
4667 msg_putchar('\n');
4668
4669 for (j = 1; j < Columns; j++)
4670 msg_putchar('-');
4671 }
4672
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004673 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674
4675 if (minus && i == lnum)
4676 {
4677 msg_putchar('\n');
4678
4679 for (j = 1; j < Columns; j++)
4680 msg_putchar('-');
4681 }
4682 }
4683
4684 curwin->w_cursor.lnum = curs;
4685 ex_no_reprint = TRUE;
4686}
4687
4688/*
4689 * Check if the restricted flag is set.
4690 * If so, give an error message and return TRUE.
4691 * Otherwise, return FALSE.
4692 */
4693 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004694check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695{
4696 if (restricted)
4697 {
4698 EMSG(_("E145: Shell commands not allowed in rvim"));
4699 return TRUE;
4700 }
4701 return FALSE;
4702}
4703
4704/*
4705 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4706 * If so, give an error message and return TRUE.
4707 * Otherwise, return FALSE.
4708 */
4709 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004710check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711{
4712 if (secure)
4713 {
4714 secure = 2;
4715 EMSG(_(e_curdir));
4716 return TRUE;
4717 }
4718#ifdef HAVE_SANDBOX
4719 /*
4720 * In the sandbox more things are not allowed, including the things
4721 * disallowed in secure mode.
4722 */
4723 if (sandbox != 0)
4724 {
4725 EMSG(_(e_sandbox));
4726 return TRUE;
4727 }
4728#endif
4729 return FALSE;
4730}
4731
4732static char_u *old_sub = NULL; /* previous substitute pattern */
4733static int global_need_beginline; /* call beginline() after ":g" */
4734
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004735/*
4736 * Flags that are kept between calls to :substitute.
4737 */
4738typedef struct {
4739 int do_all; /* do multiple substitutions per line */
4740 int do_ask; /* ask for confirmation */
4741 int do_count; /* count only */
4742 int do_error; /* if false, ignore errors */
4743 int do_print; /* print last line with subs. */
4744 int do_list; /* list last line with subs. */
4745 int do_number; /* list last line with line nr*/
4746 int do_ic; /* ignore case flag */
4747} subflags_T;
4748
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749/* do_sub()
4750 *
4751 * Perform a substitution from line eap->line1 to line eap->line2 using the
4752 * command pointed to by eap->arg which should be of the form:
4753 *
4754 * /pattern/substitution/{flags}
4755 *
4756 * The usual escapes are supported as described in the regexp docs.
4757 */
4758 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004759do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760{
4761 linenr_T lnum;
4762 long i = 0;
4763 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004764 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4765 FALSE, FALSE, 0};
4766#ifdef FEAT_EVAL
4767 subflags_T subflags_save;
4768#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004769 int save_do_all; /* remember user specified 'g' flag */
4770 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4772 int delimiter;
4773 int sublen;
4774 int got_quit = FALSE;
4775 int got_match = FALSE;
4776 int temp;
4777 int which_pat;
4778 char_u *cmd;
4779 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004780 linenr_T first_line = 0; /* first changed line */
4781 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 * change */
4783 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4784 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004785 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004786 char_u *sub_firstline; /* allocated copy of first sub line */
4787 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004788 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004789 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004790#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004791 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004792#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793
4794 cmd = eap->arg;
4795 if (!global_busy)
4796 {
4797 sub_nsubs = 0;
4798 sub_nlines = 0;
4799 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004800 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 if (eap->cmdidx == CMD_tilde)
4803 which_pat = RE_LAST; /* use last used regexp */
4804 else
4805 which_pat = RE_SUBST; /* use last substitute regexp */
4806
4807 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004808 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4810 {
4811 /* don't accept alphanumeric for separator */
4812 if (isalpha(*cmd))
4813 {
4814 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4815 return;
4816 }
4817 /*
4818 * undocumented vi feature:
4819 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4820 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4821 */
4822 if (*cmd == '\\')
4823 {
4824 ++cmd;
4825 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4826 {
4827 EMSG(_(e_backslash));
4828 return;
4829 }
4830 if (*cmd != '&')
4831 which_pat = RE_SEARCH; /* use last '/' pattern */
4832 pat = (char_u *)""; /* empty search pattern */
4833 delimiter = *cmd++; /* remember delimiter character */
4834 }
4835 else /* find the end of the regexp */
4836 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004837#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4838 if (p_altkeymap && curwin->w_p_rl)
4839 lrF_sub(cmd);
4840#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 which_pat = RE_LAST; /* use last used regexp */
4842 delimiter = *cmd++; /* remember delimiter character */
4843 pat = cmd; /* remember start of search pat */
4844 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4845 if (cmd[0] == delimiter) /* end delimiter found */
4846 *cmd++ = NUL; /* replace it with a NUL */
4847 }
4848
4849 /*
4850 * Small incompatibility: vi sees '\n' as end of the command, but in
4851 * Vim we want to use '\n' to find/substitute a NUL.
4852 */
4853 sub = cmd; /* remember the start of the substitution */
4854
4855 while (cmd[0])
4856 {
4857 if (cmd[0] == delimiter) /* end delimiter found */
4858 {
4859 *cmd++ = NUL; /* replace it with a NUL */
4860 break;
4861 }
4862 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4863 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004864 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 }
4866
4867 if (!eap->skip)
4868 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004869 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4870 if (STRCMP(sub, "%") == 0
4871 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4872 {
4873 if (old_sub == NULL) /* there is no previous command */
4874 {
4875 EMSG(_(e_nopresub));
4876 return;
4877 }
4878 sub = old_sub;
4879 }
4880 else
4881 {
4882 vim_free(old_sub);
4883 old_sub = vim_strsave(sub);
4884 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 }
4886 }
4887 else if (!eap->skip) /* use previous pattern and substitution */
4888 {
4889 if (old_sub == NULL) /* there is no previous command */
4890 {
4891 EMSG(_(e_nopresub));
4892 return;
4893 }
4894 pat = NULL; /* search_regcomp() will use previous pattern */
4895 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004896
4897 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4898 * last column after using "$". */
4899 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 }
4901
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004902 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4903 * more efficient.
4904 * TODO: find a generic solution to make line-joining operations more
4905 * efficient, avoid allocating a string that grows in size.
4906 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004907 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004908 && *sub == NUL
4909 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4910 || *cmd == 'p' || *cmd == '#'))))
4911 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004912 linenr_T joined_lines_count;
4913
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004914 curwin->w_cursor.lnum = eap->line1;
4915 if (*cmd == 'l')
4916 eap->flags = EXFLAG_LIST;
4917 else if (*cmd == '#')
4918 eap->flags = EXFLAG_NR;
4919 else if (*cmd == 'p')
4920 eap->flags = EXFLAG_PRINT;
4921
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004922 /* The number of lines joined is the number of lines in the range plus
4923 * one. One less when the last line is included. */
4924 joined_lines_count = eap->line2 - eap->line1 + 1;
4925 if (eap->line2 < curbuf->b_ml.ml_line_count)
4926 ++joined_lines_count;
4927 if (joined_lines_count > 1)
4928 {
4929 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4930 sub_nsubs = joined_lines_count - 1;
4931 sub_nlines = 1;
4932 (void)do_sub_msg(FALSE);
4933 ex_may_print(eap);
4934 }
4935
4936 if (!cmdmod.keeppatterns)
4937 save_re_pat(RE_SUBST, pat, p_magic);
4938#ifdef FEAT_CMDHIST
4939 /* put pattern in history */
4940 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4941#endif
4942
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004943 return;
4944 }
4945
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 /*
4947 * Find trailing options. When '&' is used, keep old options.
4948 */
4949 if (*cmd == '&')
4950 ++cmd;
4951 else
4952 {
4953 if (!p_ed)
4954 {
4955 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004956 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004958 subflags.do_all = FALSE;
4959 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004961 subflags.do_error = TRUE;
4962 subflags.do_print = FALSE;
4963 subflags.do_count = FALSE;
4964 subflags.do_number = FALSE;
4965 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 }
4967 while (*cmd)
4968 {
4969 /*
4970 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4971 * 'r' is never inverted.
4972 */
4973 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004974 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004976 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004977 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004978 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004980 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 else if (*cmd == 'r') /* use last used regexp */
4982 which_pat = RE_LAST;
4983 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004984 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004985 else if (*cmd == '#')
4986 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004987 subflags.do_print = TRUE;
4988 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004989 }
4990 else if (*cmd == 'l')
4991 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004992 subflags.do_print = TRUE;
4993 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004994 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004996 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004998 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 else
5000 break;
5001 ++cmd;
5002 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005003 if (subflags.do_count)
5004 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005006 save_do_all = subflags.do_all;
5007 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005008
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 /*
5010 * check for a trailing count
5011 */
5012 cmd = skipwhite(cmd);
5013 if (VIM_ISDIGIT(*cmd))
5014 {
5015 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005016 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 {
5018 EMSG(_(e_zerocount));
5019 return;
5020 }
5021 eap->line1 = eap->line2;
5022 eap->line2 += i - 1;
5023 if (eap->line2 > curbuf->b_ml.ml_line_count)
5024 eap->line2 = curbuf->b_ml.ml_line_count;
5025 }
5026
5027 /*
5028 * check for trailing command or garbage
5029 */
5030 cmd = skipwhite(cmd);
5031 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5032 {
5033 eap->nextcmd = check_nextcmd(cmd);
5034 if (eap->nextcmd == NULL)
5035 {
5036 EMSG(_(e_trailing));
5037 return;
5038 }
5039 }
5040
5041 if (eap->skip) /* not executing commands, only parsing */
5042 return;
5043
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005044 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005045 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005046 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005047 EMSG(_(e_modifiable));
5048 return;
5049 }
5050
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5052 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005053 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 EMSG(_(e_invcmd));
5055 return;
5056 }
5057
5058 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005059 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005061 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 regmatch.rmm_ic = FALSE;
5063
5064 sub_firstline = NULL;
5065
5066 /*
5067 * ~ in the substitute pattern is replaced with the old pattern.
5068 * We do it here once to avoid it to be replaced over and over again.
5069 * But don't do it when it starts with "\=", then it's an expression.
5070 */
5071 if (!(sub[0] == '\\' && sub[1] == '='))
5072 sub = regtilde(sub, p_magic);
5073
5074 /*
5075 * Check for a match on each line.
5076 */
5077 line2 = eap->line2;
5078 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5079#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5080 || aborting()
5081#endif
5082 ); ++lnum)
5083 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005084 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5085 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 if (nmatch)
5087 {
5088 colnr_T copycol;
5089 colnr_T matchcol;
5090 colnr_T prev_matchcol = MAXCOL;
5091 char_u *new_end, *new_start = NULL;
5092 unsigned new_start_len = 0;
5093 char_u *p1;
5094 int did_sub = FALSE;
5095 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005096 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 long nmatch_tl = 0; /* nr of lines matched below lnum */
5098 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005099 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005100 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101
5102 /*
5103 * The new text is build up step by step, to avoid too much
5104 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005105 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 * copycol Column in the old text where we started
5107 * looking for a match; from here old text still
5108 * needs to be copied to the new text.
5109 * matchcol Column number of the old text where to look
5110 * for the next match. It's just after the
5111 * previous match or one further.
5112 * prev_matchcol Column just after the previous match (if any).
5113 * Mostly equal to matchcol, except for the first
5114 * match and after skipping an empty match.
5115 * regmatch.*pos Where the pattern matched in the old text.
5116 * new_start The new text, all that has been produced so
5117 * far.
5118 * new_end The new text, where to append new text.
5119 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005120 * lnum The line number where we found the start of
5121 * the match. Can be below the line we searched
5122 * when there is a \n before a \zs in the
5123 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 * sub_firstlnum The line number in the buffer where to look
5125 * for a match. Can be different from "lnum"
5126 * when the pattern or substitute string contains
5127 * line breaks.
5128 *
5129 * Special situations:
5130 * - When the substitute string contains a line break, the part up
5131 * to the line break is inserted in the text, but the copy of
5132 * the original line is kept. "sub_firstlnum" is adjusted for
5133 * the inserted lines.
5134 * - When the matched pattern contains a line break, the old line
5135 * is taken from the line at the end of the pattern. The lines
5136 * in the match are deleted later, "sub_firstlnum" is adjusted
5137 * accordingly.
5138 *
5139 * The new text is built up in new_start[]. It has some extra
5140 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005141 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 *
5143 * Make a copy of the old line, so it won't be taken away when
5144 * updating the screen or handling a multi-line match. The "old_"
5145 * pointers point into this copy.
5146 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005147 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 copycol = 0;
5149 matchcol = 0;
5150
5151 /* At first match, remember current cursor position. */
5152 if (!got_match)
5153 {
5154 setpcmark();
5155 got_match = TRUE;
5156 }
5157
5158 /*
5159 * Loop until nothing more to replace in this line.
5160 * 1. Handle match with empty string.
5161 * 2. If do_ask is set, ask for confirmation.
5162 * 3. substitute the string.
5163 * 4. if do_all is set, find next match
5164 * 5. break if there isn't another match in this line
5165 */
5166 for (;;)
5167 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005168 /* Advance "lnum" to the line where the match starts. The
5169 * match does not start in the first line when there is a line
5170 * break before \zs. */
5171 if (regmatch.startpos[0].lnum > 0)
5172 {
5173 lnum += regmatch.startpos[0].lnum;
5174 sub_firstlnum += regmatch.startpos[0].lnum;
5175 nmatch -= regmatch.startpos[0].lnum;
5176 vim_free(sub_firstline);
5177 sub_firstline = NULL;
5178 }
5179
5180 if (sub_firstline == NULL)
5181 {
5182 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5183 if (sub_firstline == NULL)
5184 {
5185 vim_free(new_start);
5186 goto outofmem;
5187 }
5188 }
5189
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 /* Save the line number of the last change for the final
5191 * cursor position (just like Vi). */
5192 curwin->w_cursor.lnum = lnum;
5193 do_again = FALSE;
5194
5195 /*
5196 * 1. Match empty string does not count, except for first
5197 * match. This reproduces the strange vi behaviour.
5198 * This also catches endless loops.
5199 */
5200 if (matchcol == prev_matchcol
5201 && regmatch.endpos[0].lnum == 0
5202 && matchcol == regmatch.endpos[0].col)
5203 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005204 if (sub_firstline[matchcol] == NUL)
5205 /* We already were at the end of the line. Don't look
5206 * for a match in this line again. */
5207 skip_match = TRUE;
5208 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005209 {
5210 /* search for a match at next column */
5211#ifdef FEAT_MBYTE
5212 if (has_mbyte)
5213 matchcol += mb_ptr2len(sub_firstline + matchcol);
5214 else
5215#endif
5216 ++matchcol;
5217 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 goto skip;
5219 }
5220
5221 /* Normally we continue searching for a match just after the
5222 * previous match. */
5223 matchcol = regmatch.endpos[0].col;
5224 prev_matchcol = matchcol;
5225
5226 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005227 * 2. If do_count is set only increase the counter.
5228 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005230 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005231 {
5232 /* For a multi-line match, put matchcol at the NUL at
5233 * the end of the line and set nmatch to one, so that
5234 * we continue looking for a match on the next line.
5235 * Avoids that ":s/\nB\@=//gc" get stuck. */
5236 if (nmatch > 1)
5237 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005238 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005239 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005240 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005241 }
5242 sub_nsubs++;
5243 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005244#ifdef FEAT_EVAL
5245 /* Skip the substitution, unless an expression is used,
5246 * then it is evaluated in the sandbox. */
5247 if (!(sub[0] == '\\' && sub[1] == '='))
5248#endif
5249 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005250 }
5251
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005252 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005254 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005255
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 /* change State to CONFIRM, so that the mouse works
5257 * properly */
5258 save_State = State;
5259 State = CONFIRM;
5260#ifdef FEAT_MOUSE
5261 setmouse(); /* disable mouse in xterm */
5262#endif
5263 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005264#ifdef FEAT_CURSORBIND
5265 if (curwin->w_p_crb)
5266 do_check_cursorbind();
5267#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
5269 /* When 'cpoptions' contains "u" don't sync undo when
5270 * asking for confirmation. */
5271 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5272 ++no_u_sync;
5273
5274 /*
5275 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5276 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005277 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005279 if (exmode_active)
5280 {
5281 char_u *resp;
5282 colnr_T sc, ec;
5283
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005284 print_line_no_prefix(lnum,
5285 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005286
5287 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5288 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005289 if (curwin->w_cursor.col < 0)
5290 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005291 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005292 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005293 {
5294 int numw = number_width(curwin) + 1;
5295 sc += numw;
5296 ec += numw;
5297 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005298 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005299 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005300 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005301 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005302 msg_putchar('^');
5303
5304 resp = getexmodeline('?', NULL, 0);
5305 if (resp != NULL)
5306 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005307 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005308 vim_free(resp);
5309 }
5310 }
5311 else
5312 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005313 char_u *orig_line = NULL;
5314 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005316 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005318 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005320 /* Invert the matched string.
5321 * Remove the inversion afterwards. */
5322 temp = RedrawingDisabled;
5323 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005325 if (new_start != NULL)
5326 {
5327 /* There already was a substitution, we would
5328 * like to show this to the user. We cannot
5329 * really update the line, it would change
5330 * what matches. Temporarily replace the line
5331 * and change it back afterwards. */
5332 orig_line = vim_strsave(ml_get(lnum));
5333 if (orig_line != NULL)
5334 {
5335 char_u *new_line = concat_str(new_start,
5336 sub_firstline + copycol);
5337
5338 if (new_line == NULL)
5339 {
5340 vim_free(orig_line);
5341 orig_line = NULL;
5342 }
5343 else
5344 {
5345 /* Position the cursor relative to the
5346 * end of the line, the previous
5347 * substitute may have inserted or
5348 * deleted characters before the
5349 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005350 len_change = (int)STRLEN(new_line)
5351 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005352 curwin->w_cursor.col += len_change;
5353 ml_replace(lnum, new_line, FALSE);
5354 }
5355 }
5356 }
5357
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005358 search_match_lines = regmatch.endpos[0].lnum
5359 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005360 search_match_endcol = regmatch.endpos[0].col
5361 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005362 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005364 update_topline();
5365 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005366 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005367 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005368 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369
5370#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005371 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005373 if (msg_row == Rows - 1)
5374 msg_didout = FALSE; /* avoid a scroll-up */
5375 msg_starthere();
5376 i = msg_scroll;
5377 msg_scroll = 0; /* truncate msg when
5378 needed */
5379 msg_no_more = TRUE;
5380 /* write message same highlighting as for
5381 * wait_return */
5382 smsg_attr(hl_attr(HLF_R),
5383 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5384 msg_no_more = FALSE;
5385 msg_scroll = i;
5386 showruler(TRUE);
5387 windgoto(msg_row, msg_col);
5388 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389
5390#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005391 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005393 ++no_mapping; /* don't map this key */
5394 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005395 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005396 --allow_keys;
5397 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005399 /* clear the question */
5400 msg_didout = FALSE; /* don't scroll up */
5401 msg_col = 0;
5402 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005403
5404 /* restore the line */
5405 if (orig_line != NULL)
5406 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005407 }
5408
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005410 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005412 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413#endif
5414 )
5415 {
5416 got_quit = TRUE;
5417 break;
5418 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005419 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005421 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005423 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 {
5425 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005426 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 line2 = lnum;
5428 break;
5429 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005430 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005432 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 break;
5434 }
5435#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005436 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005438 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 scrolldown_clamp();
5440#endif
5441 }
5442 State = save_State;
5443#ifdef FEAT_MOUSE
5444 setmouse();
5445#endif
5446 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5447 --no_u_sync;
5448
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005449 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 {
5451 /* For a multi-line match, put matchcol at the NUL at
5452 * the end of the line and set nmatch to one, so that
5453 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005454 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5455 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 if (nmatch > 1)
5457 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005458 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005459 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 }
5461 goto skip;
5462 }
5463 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005464 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 }
5466
5467 /* Move the cursor to the start of the match, so that we can
5468 * use "\=col("."). */
5469 curwin->w_cursor.col = regmatch.startpos[0].col;
5470
5471 /*
5472 * 3. substitute the string.
5473 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005474#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005475 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005476 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005477 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005478 save_ma = curbuf->b_p_ma;
5479 curbuf->b_p_ma = FALSE;
5480 sandbox++;
5481 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005482 /* Save flags for recursion. They can change for e.g.
5483 * :s/^/\=execute("s#^##gn") */
5484 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005485#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005487 sublen = vim_regsub_multi(&regmatch,
5488 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005490#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005491 /* Don't keep flags set by a recursive call. */
5492 subflags = subflags_save;
5493 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005494 {
5495 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005496 if (sandbox > 0)
5497 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005498 goto skip;
5499 }
5500#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501
Bram Moolenaar4463f292005-09-25 22:20:24 +00005502 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005503 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005504 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5505 {
5506 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5507 skip_match = TRUE;
5508 }
5509
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 /* Need room for:
5511 * - result so far in new_start (not for first sub in line)
5512 * - original text up to match
5513 * - length of substituted part
5514 * - original text after match
5515 */
5516 if (nmatch == 1)
5517 p1 = sub_firstline;
5518 else
5519 {
5520 p1 = ml_get(sub_firstlnum + nmatch - 1);
5521 nmatch_tl += nmatch - 1;
5522 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005523 copy_len = regmatch.startpos[0].col - copycol;
5524 needed_len = copy_len + ((unsigned)STRLEN(p1)
5525 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 if (new_start == NULL)
5527 {
5528 /*
5529 * Get some space for a temporary buffer to do the
5530 * substitution into (and some extra space to avoid
5531 * too many calls to alloc()/free()).
5532 */
5533 new_start_len = needed_len + 50;
5534 if ((new_start = alloc_check(new_start_len)) == NULL)
5535 goto outofmem;
5536 *new_start = NUL;
5537 new_end = new_start;
5538 }
5539 else
5540 {
5541 /*
5542 * Check if the temporary buffer is long enough to do the
5543 * substitution into. If not, make it larger (with a bit
5544 * extra to avoid too many calls to alloc()/free()).
5545 */
5546 len = (unsigned)STRLEN(new_start);
5547 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005548 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 {
5550 new_start_len = needed_len + 50;
5551 if ((p1 = alloc_check(new_start_len)) == NULL)
5552 {
5553 vim_free(new_start);
5554 goto outofmem;
5555 }
5556 mch_memmove(p1, new_start, (size_t)(len + 1));
5557 vim_free(new_start);
5558 new_start = p1;
5559 }
5560 new_end = new_start + len;
5561 }
5562
5563 /*
5564 * copy the text up to the part that matched
5565 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005566 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5567 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005569 (void)vim_regsub_multi(&regmatch,
5570 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 sub, new_end, TRUE, p_magic, TRUE);
5572 sub_nsubs++;
5573 did_sub = TRUE;
5574
5575 /* Move the cursor to the start of the line, to avoid that it
5576 * is beyond the end of the line after the substitution. */
5577 curwin->w_cursor.col = 0;
5578
5579 /* For a multi-line match, make a copy of the last matched
5580 * line and continue in that one. */
5581 if (nmatch > 1)
5582 {
5583 sub_firstlnum += nmatch - 1;
5584 vim_free(sub_firstline);
5585 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5586 /* When going beyond the last line, stop substituting. */
5587 if (sub_firstlnum <= line2)
5588 do_again = TRUE;
5589 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005590 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 }
5592
5593 /* Remember next character to be copied. */
5594 copycol = regmatch.endpos[0].col;
5595
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005596 if (skip_match)
5597 {
5598 /* Already hit end of the buffer, sub_firstlnum is one
5599 * less than what it ought to be. */
5600 vim_free(sub_firstline);
5601 sub_firstline = vim_strsave((char_u *)"");
5602 copycol = 0;
5603 }
5604
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 /*
5606 * Now the trick is to replace CTRL-M chars with a real line
5607 * break. This would make it impossible to insert a CTRL-M in
5608 * the text. The line break can be avoided by preceding the
5609 * CTRL-M with a backslash. To be able to insert a backslash,
5610 * they must be doubled in the string and are halved here.
5611 * That is Vi compatible.
5612 */
5613 for (p1 = new_end; *p1; ++p1)
5614 {
5615 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005616 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 else if (*p1 == CAR)
5618 {
5619 if (u_inssub(lnum) == OK) /* prepare for undo */
5620 {
5621 *p1 = NUL; /* truncate up to the CR */
5622 ml_append(lnum - 1, new_start,
5623 (colnr_T)(p1 - new_start + 1), FALSE);
5624 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005625 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 appended_lines(lnum - 1, 1L);
5627 else
5628 {
5629 if (first_line == 0)
5630 first_line = lnum;
5631 last_line = lnum + 1;
5632 }
5633 /* All line numbers increase. */
5634 ++sub_firstlnum;
5635 ++lnum;
5636 ++line2;
5637 /* move the cursor to the new line, like Vi */
5638 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005639 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005640 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 p1 = new_start - 1;
5642 }
5643 }
5644#ifdef FEAT_MBYTE
5645 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005646 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647#endif
5648 }
5649
5650 /*
5651 * 4. If do_all is set, find next match.
5652 * Prevent endless loop with patterns that match empty
5653 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5654 * But ":s/\n/#/" is OK.
5655 */
5656skip:
5657 /* We already know that we did the last subst when we are at
5658 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005659 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5660 * "line2" when there is a \zs in the pattern after a line
5661 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005662 lastone = (skip_match
5663 || got_int
5664 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005665 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005666 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005667 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5668 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 nmatch = -1;
5670
5671 /*
5672 * Replace the line in the buffer when needed. This is
5673 * skipped when there are more matches.
5674 * The check for nmatch_tl is needed for when multi-line
5675 * matching must replace the lines before trying to do another
5676 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005677 * When the match starts below where we start searching also
5678 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 */
5680 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 || nmatch_tl > 0
5682 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005683 curbuf, sub_firstlnum,
5684 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005685 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 {
5687 if (new_start != NULL)
5688 {
5689 /*
5690 * Copy the rest of the line, that didn't match.
5691 * "matchcol" has to be adjusted, we use the end of
5692 * the line as reference, because the substitute may
5693 * have changed the number of characters. Same for
5694 * "prev_matchcol".
5695 */
5696 STRCAT(new_start, sub_firstline + copycol);
5697 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5698 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5699 - prev_matchcol;
5700
5701 if (u_savesub(lnum) != OK)
5702 break;
5703 ml_replace(lnum, new_start, TRUE);
5704
5705 if (nmatch_tl > 0)
5706 {
5707 /*
5708 * Matched lines have now been substituted and are
5709 * useless, delete them. The part after the match
5710 * has been appended to new_start, we don't need
5711 * it in the buffer.
5712 */
5713 ++lnum;
5714 if (u_savedel(lnum, nmatch_tl) != OK)
5715 break;
5716 for (i = 0; i < nmatch_tl; ++i)
5717 ml_delete(lnum, (int)FALSE);
5718 mark_adjust(lnum, lnum + nmatch_tl - 1,
5719 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005720 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 deleted_lines(lnum, nmatch_tl);
5722 --lnum;
5723 line2 -= nmatch_tl; /* nr of lines decreases */
5724 nmatch_tl = 0;
5725 }
5726
5727 /* When asking, undo is saved each time, must also set
5728 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005729 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 changed_bytes(lnum, 0);
5731 else
5732 {
5733 if (first_line == 0)
5734 first_line = lnum;
5735 last_line = lnum + 1;
5736 }
5737
5738 sub_firstlnum = lnum;
5739 vim_free(sub_firstline); /* free the temp buffer */
5740 sub_firstline = new_start;
5741 new_start = NULL;
5742 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5743 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5744 - prev_matchcol;
5745 copycol = 0;
5746 }
5747 if (nmatch == -1 && !lastone)
5748 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005749 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750
5751 /*
5752 * 5. break if there isn't another match in this line
5753 */
5754 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005755 {
5756 /* If the match found didn't start where we were
5757 * searching, do the next search in the line where we
5758 * found the match. */
5759 if (nmatch == -1)
5760 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005762 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 }
5764
5765 line_breakcheck();
5766 }
5767
5768 if (did_sub)
5769 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005770 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 vim_free(sub_firstline); /* free the copy of the original line */
5772 sub_firstline = NULL;
5773 }
5774
5775 line_breakcheck();
5776 }
5777
5778 if (first_line != 0)
5779 {
5780 /* Need to subtract the number of added lines from "last_line" to get
5781 * the line number before the change (same as adding the number of
5782 * deleted lines). */
5783 i = curbuf->b_ml.ml_line_count - old_line_count;
5784 changed_lines(first_line, 0, last_line - i, i);
5785 }
5786
5787outofmem:
5788 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005789
5790 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005791 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005792 curwin->w_cursor = old_cursor;
5793
Bram Moolenaar46475522010-03-23 17:36:29 +01005794 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 {
5796 /* Set the '[ and '] marks. */
5797 curbuf->b_op_start.lnum = eap->line1;
5798 curbuf->b_op_end.lnum = line2;
5799 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5800
5801 if (!global_busy)
5802 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005803 /* when interactive leave cursor on the match */
5804 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005805 {
5806 if (endcolumn)
5807 coladvance((colnr_T)MAXCOL);
5808 else
5809 beginline(BL_WHITE | BL_FIX);
5810 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005811 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 MSG("");
5813 }
5814 else
5815 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005816 if (subflags.do_print)
5817 print_line(curwin->w_cursor.lnum,
5818 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 }
5820 else if (!global_busy)
5821 {
5822 if (got_int) /* interrupted */
5823 EMSG(_(e_interr));
5824 else if (got_match) /* did find something but nothing substituted */
5825 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005826 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 EMSG2(_(e_patnotf2), get_search_pat());
5828 }
5829
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005830#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005831 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005832 /* Cursor position may require updating */
5833 changed_window_setting();
5834#endif
5835
Bram Moolenaar473de612013-06-08 18:19:48 +02005836 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005837
5838 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005839 subflags.do_all = save_do_all;
5840 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841}
5842
5843/*
5844 * Give message for number of substitutions.
5845 * Can also be used after a ":global" command.
5846 * Return TRUE if a message was given.
5847 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005848 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005849do_sub_msg(
5850 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851{
5852 /*
5853 * Only report substitutions when:
5854 * - more than 'report' substitutions
5855 * - command was typed by user, or number of changed lines > 'report'
5856 * - giving messages is not disabled by 'lazyredraw'
5857 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005858 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5859 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 && messaging())
5861 {
5862 if (got_int)
5863 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005864 else
5865 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005867 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005868 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005870 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005871 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 sub_nsubs);
5873 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005874 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005875 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005877 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005878 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005881 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 return TRUE;
5883 }
5884 if (got_int)
5885 {
5886 EMSG(_(e_interr));
5887 return TRUE;
5888 }
5889 return FALSE;
5890}
5891
5892/*
5893 * Execute a global command of the form:
5894 *
5895 * g/pattern/X : execute X on all lines where pattern matches
5896 * v/pattern/X : execute X on all lines where pattern does not match
5897 *
5898 * where 'X' is an EX command
5899 *
5900 * The command character (as well as the trailing slash) is optional, and
5901 * is assumed to be 'p' if missing.
5902 *
5903 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005904 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 * for each line that has a mark. This is required because after deleting
5906 * lines we do not know where to search for the next match.
5907 */
5908 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005909ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910{
5911 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005912 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 int type; /* first char of cmd: 'v' or 'g' */
5914 char_u *cmd; /* command argument */
5915
5916 char_u delim; /* delimiter, normally '/' */
5917 char_u *pat;
5918 regmmatch_T regmatch;
5919 int match;
5920 int which_pat;
5921
5922 if (global_busy)
5923 {
5924 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5925 return;
5926 }
5927
5928 if (eap->forceit) /* ":global!" is like ":vglobal" */
5929 type = 'v';
5930 else
5931 type = *eap->cmd;
5932 cmd = eap->arg;
5933 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934
5935 /*
5936 * undocumented vi feature:
5937 * "\/" and "\?": use previous search pattern.
5938 * "\&": use previous substitute pattern.
5939 */
5940 if (*cmd == '\\')
5941 {
5942 ++cmd;
5943 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5944 {
5945 EMSG(_(e_backslash));
5946 return;
5947 }
5948 if (*cmd == '&')
5949 which_pat = RE_SUBST; /* use previous substitute pattern */
5950 else
5951 which_pat = RE_SEARCH; /* use previous search pattern */
5952 ++cmd;
5953 pat = (char_u *)"";
5954 }
5955 else if (*cmd == NUL)
5956 {
5957 EMSG(_("E148: Regular expression missing from global"));
5958 return;
5959 }
5960 else
5961 {
5962 delim = *cmd; /* get the delimiter */
5963 if (delim)
5964 ++cmd; /* skip delimiter if there is one */
5965 pat = cmd; /* remember start of pattern */
5966 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5967 if (cmd[0] == delim) /* end delimiter found */
5968 *cmd++ = NUL; /* replace it with a NUL */
5969 }
5970
5971#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5972 if (p_altkeymap && curwin->w_p_rl)
5973 lrFswap(pat,0);
5974#endif
5975
5976 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5977 {
5978 EMSG(_(e_invcmd));
5979 return;
5980 }
5981
5982 /*
5983 * pass 1: set marks for each (not) matching line
5984 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5986 {
5987 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005988 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5989 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 if ((type == 'g' && match) || (type == 'v' && !match))
5991 {
5992 ml_setmarked(lnum);
5993 ndone++;
5994 }
5995 line_breakcheck();
5996 }
5997
5998 /*
5999 * pass 2: execute the command for each line that has been marked
6000 */
6001 if (got_int)
6002 MSG(_(e_interr));
6003 else if (ndone == 0)
6004 {
6005 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00006006 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01006008 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 }
6010 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006011 {
6012#ifdef FEAT_CLIPBOARD
6013 start_global_changes();
6014#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006016#ifdef FEAT_CLIPBOARD
6017 end_global_changes();
6018#endif
6019 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
6021 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02006022 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023}
6024
6025/*
6026 * Execute "cmd" on lines marked with ml_setmarked().
6027 */
6028 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006029global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006031 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6032 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6033 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034
6035 /*
6036 * Set current position only once for a global command.
6037 * If global_busy is set, setpcmark() will not do anything.
6038 * If there is an error, global_busy will be incremented.
6039 */
6040 setpcmark();
6041
6042 /* When the command writes a message, don't overwrite the command. */
6043 msg_didout = TRUE;
6044
Bram Moolenaard25bc232010-03-23 17:49:24 +01006045 sub_nsubs = 0;
6046 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 global_need_beginline = FALSE;
6048 global_busy = 1;
6049 old_lcount = curbuf->b_ml.ml_line_count;
6050 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6051 {
6052 curwin->w_cursor.lnum = lnum;
6053 curwin->w_cursor.col = 0;
6054 if (*cmd == NUL || *cmd == '\n')
6055 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6056 else
6057 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6058 ui_breakcheck();
6059 }
6060
6061 global_busy = 0;
6062 if (global_need_beginline)
6063 beginline(BL_WHITE | BL_FIX);
6064 else
6065 check_cursor(); /* cursor may be beyond the end of the line */
6066
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006067 /* the cursor may not have moved in the text but a change in a previous
6068 * line may move it on the screen */
6069 changed_line_abv_curs();
6070
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 /* If it looks like no message was written, allow overwriting the
6072 * command with the report for number of changes. */
6073 if (msg_col == 0 && msg_scrolled == 0)
6074 msg_didout = FALSE;
6075
Bram Moolenaar45667512007-05-10 19:24:43 +00006076 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006077 * number of extra or deleted lines.
6078 * Don't report extra or deleted lines in the edge case where the buffer
6079 * we are in after execution is different from the buffer we started in. */
6080 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6082}
6083
6084#ifdef FEAT_VIMINFO
6085 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006086read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006088 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 vim_free(old_sub);
6090 if (force || old_sub == NULL)
6091 old_sub = viminfo_readstring(virp, 1, TRUE);
6092 return viminfo_readline(virp);
6093}
6094
6095 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006096write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097{
6098 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6099 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006100 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 viminfo_writestring(fp, old_sub);
6102 }
6103}
6104#endif /* FEAT_VIMINFO */
6105
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006106#if defined(EXITFREE) || defined(PROTO)
6107 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006108free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006109{
6110 vim_free(old_sub);
6111}
6112#endif
6113
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
6115/*
6116 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006117 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006119 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006120prepare_tagpreview(
6121 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122{
6123 win_T *wp;
6124
6125# ifdef FEAT_GUI
6126 need_mouse_correct = TRUE;
6127# endif
6128
6129 /*
6130 * If there is already a preview window open, use that one.
6131 */
6132 if (!curwin->w_p_pvw)
6133 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006134 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 if (wp->w_p_pvw)
6136 break;
6137 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006138 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 else
6140 {
6141 /*
6142 * There is no preview window open yet. Create one.
6143 */
6144 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6145 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006146 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 curwin->w_p_pvw = TRUE;
6148 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006149 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6150 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151# ifdef FEAT_DIFF
6152 curwin->w_p_diff = FALSE; /* no 'diff' */
6153# endif
6154# ifdef FEAT_FOLDING
6155 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6156# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006157 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 }
6159 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006160 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161}
6162
6163#endif
6164
6165
6166/*
6167 * ":help": open a read-only window on a help file
6168 */
6169 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006170ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171{
6172 char_u *arg;
6173 char_u *tag;
6174 FILE *helpfd; /* file descriptor of help file */
6175 int n;
6176 int i;
6177#ifdef FEAT_WINDOWS
6178 win_T *wp;
6179#endif
6180 int num_matches;
6181 char_u **matches;
6182 char_u *p;
6183 int empty_fnum = 0;
6184 int alt_fnum = 0;
6185 buf_T *buf;
6186#ifdef FEAT_MULTI_LANG
6187 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006188 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006190#ifdef FEAT_FOLDING
6191 int old_KeyTyped = KeyTyped;
6192#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193
6194 if (eap != NULL)
6195 {
6196 /*
6197 * A ":help" command ends at the first LF, or at a '|' that is
6198 * followed by some text. Set nextcmd to the following command.
6199 */
6200 for (arg = eap->arg; *arg; ++arg)
6201 {
6202 if (*arg == '\n' || *arg == '\r'
6203 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6204 {
6205 *arg++ = NUL;
6206 eap->nextcmd = arg;
6207 break;
6208 }
6209 }
6210 arg = eap->arg;
6211
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006212 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 {
6214 EMSG(_("E478: Don't panic!"));
6215 return;
6216 }
6217
6218 if (eap->skip) /* not executing commands */
6219 return;
6220 }
6221 else
6222 arg = (char_u *)"";
6223
6224 /* remove trailing blanks */
6225 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006226 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 *p-- = NUL;
6228
6229#ifdef FEAT_MULTI_LANG
6230 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006231 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232#endif
6233
6234 /* When no argument given go to the index. */
6235 if (*arg == NUL)
6236 arg = (char_u *)"help.txt";
6237
6238 /*
6239 * Check if there is a match for the argument.
6240 */
6241 n = find_help_tags(arg, &num_matches, &matches,
6242 eap != NULL && eap->forceit);
6243
6244 i = 0;
6245#ifdef FEAT_MULTI_LANG
6246 if (n != FAIL && lang != NULL)
6247 /* Find first item with the requested language. */
6248 for (i = 0; i < num_matches; ++i)
6249 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006250 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 if (len > 3 && matches[i][len - 3] == '@'
6252 && STRICMP(matches[i] + len - 2, lang) == 0)
6253 break;
6254 }
6255#endif
6256 if (i >= num_matches || n == FAIL)
6257 {
6258#ifdef FEAT_MULTI_LANG
6259 if (lang != NULL)
6260 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6261 else
6262#endif
6263 EMSG2(_("E149: Sorry, no help for %s"), arg);
6264 if (n != FAIL)
6265 FreeWild(num_matches, matches);
6266 return;
6267 }
6268
6269 /* The first match (in the requested language) is the best match. */
6270 tag = vim_strsave(matches[i]);
6271 FreeWild(num_matches, matches);
6272
6273#ifdef FEAT_GUI
6274 need_mouse_correct = TRUE;
6275#endif
6276
6277 /*
6278 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006279 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006281 if (!curwin->w_buffer->b_help
6282#ifdef FEAT_WINDOWS
6283 || cmdmod.tab != 0
6284#endif
6285 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 {
6287#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006288 if (cmdmod.tab != 0)
6289 wp = NULL;
6290 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006291 FOR_ALL_WINDOWS(wp)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006292 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
6293 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6295 win_enter(wp, TRUE);
6296 else
6297#endif
6298 {
6299 /*
6300 * There is no help window yet.
6301 * Try to open the file specified by the "helpfile" option.
6302 */
6303 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6304 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006305 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 goto erret;
6307 }
6308 fclose(helpfd);
6309
6310#ifdef FEAT_WINDOWS
6311 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006312 * specified, the current window is vertically split and
6313 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006316 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006319 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320#else
6321 /* use current window */
6322 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006324#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325
6326#ifdef FEAT_WINDOWS
6327 if (curwin->w_height < p_hh)
6328 win_setheight((int)p_hh);
6329#endif
6330
6331 /*
6332 * Open help file (do_ecmd() will set b_help flag, readfile() will
6333 * set b_p_ro flag).
6334 * Set the alternate file to the previously edited file.
6335 */
6336 alt_fnum = curbuf->b_fnum;
6337 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006338 ECMD_HIDE + ECMD_SET_HELP,
6339#ifdef FEAT_WINDOWS
6340 NULL /* buffer is still open, don't store info */
6341#else
6342 curwin
6343#endif
6344 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006345 if (!cmdmod.keepalt)
6346 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 empty_fnum = curbuf->b_fnum;
6348 }
6349 }
6350
6351 if (!p_im)
6352 restart_edit = 0; /* don't want insert mode in help file */
6353
Bram Moolenaar8f535582011-09-30 17:30:31 +02006354#ifdef FEAT_FOLDING
6355 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6356 * It is needed for do_tag top open folds under the cursor. */
6357 KeyTyped = old_KeyTyped;
6358#endif
6359
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 if (tag != NULL)
6361 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6362
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006363 /* Delete the empty buffer if we're not using it. Careful: autocommands
6364 * may have jumped to another window, check that the buffer is not in a
6365 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6367 {
6368 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006369 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 wipe_buffer(buf, TRUE);
6371 }
6372
6373 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006374 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 curwin->w_alt_fnum = alt_fnum;
6376
6377erret:
6378 vim_free(tag);
6379}
6380
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006381/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006382 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006383 */
6384 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006385ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006386{
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006387#if defined(FEAT_WINDOWS)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006388 win_T *win;
6389
6390 FOR_ALL_WINDOWS(win)
6391 {
6392 if (win->w_buffer->b_help)
6393 {
6394 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006395 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006396 }
6397 }
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006398#endif
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006399}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006401#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6402/*
6403 * In an argument search for a language specifiers in the form "@xx".
6404 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6405 * Returns NULL if not found.
6406 */
6407 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006408check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006409{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006410 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006411
6412 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6413 && ASCII_ISALPHA(arg[len - 1]))
6414 {
6415 arg[len - 3] = NUL; /* remove the '@' */
6416 return arg + len - 2;
6417 }
6418 return NULL;
6419}
6420#endif
6421
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422/*
6423 * Return a heuristic indicating how well the given string matches. The
6424 * smaller the number, the better the match. This is the order of priorities,
6425 * from best match to worst match:
6426 * - Match with least alpha-numeric characters is better.
6427 * - Match with least total characters is better.
6428 * - Match towards the start is better.
6429 * - Match starting with "+" is worse (feature instead of command)
6430 * Assumption is made that the matched_string passed has already been found to
6431 * match some string for which help is requested. webb.
6432 */
6433 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006434help_heuristic(
6435 char_u *matched_string,
6436 int offset, /* offset for match */
6437 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438{
6439 int num_letters;
6440 char_u *p;
6441
6442 num_letters = 0;
6443 for (p = matched_string; *p; p++)
6444 if (ASCII_ISALNUM(*p))
6445 num_letters++;
6446
6447 /*
6448 * Multiply the number of letters by 100 to give it a much bigger
6449 * weighting than the number of characters.
6450 * If there only is a match while ignoring case, add 5000.
6451 * If the match starts in the middle of a word, add 10000 to put it
6452 * somewhere in the last half.
6453 * If the match is more than 2 chars from the start, multiply by 200 to
6454 * put it after matches at the start.
6455 */
6456 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6457 && ASCII_ISALNUM(matched_string[offset - 1]))
6458 offset += 10000;
6459 else if (offset > 2)
6460 offset *= 200;
6461 if (wrong_case)
6462 offset += 5000;
6463 /* Features are less interesting than the subjects themselves, but "+"
6464 * alone is not a feature. */
6465 if (matched_string[0] == '+' && matched_string[1] != NUL)
6466 offset += 100;
6467 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6468}
6469
6470/*
6471 * Compare functions for qsort() below, that checks the help heuristics number
6472 * that has been put after the tagname by find_tags().
6473 */
6474 static int
6475#ifdef __BORLANDC__
6476_RTLENTRYF
6477#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006478help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479{
6480 char *p1;
6481 char *p2;
6482
6483 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6484 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6485 return strcmp(p1, p2);
6486}
6487
6488/*
6489 * Find all help tags matching "arg", sort them and return in matches[], with
6490 * the number of matches in num_matches.
6491 * The matches will be sorted with a "best" match algorithm.
6492 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6493 */
6494 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006495find_help_tags(
6496 char_u *arg,
6497 int *num_matches,
6498 char_u ***matches,
6499 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500{
6501 char_u *s, *d;
6502 int i;
6503 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006504 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006505 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006506 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006507 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006508 "[count]", "[quotex]",
6509 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006510 "[pattern]", "\\|", "\\%$",
6511 "s/\\~", "s/\\U", "s/\\L",
6512 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006514 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006515 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006516 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006517 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006518 "\\[count]", "\\[quotex]",
6519 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006520 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006521 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006522 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 int flags;
6524
6525 d = IObuff; /* assume IObuff is long enough! */
6526
6527 /*
6528 * Recognize a few exceptions to the rule. Some strings that contain '*'
6529 * with "star". Otherwise '*' is recognized as a wildcard.
6530 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006531 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 if (STRCMP(arg, mtable[i]) == 0)
6533 {
6534 STRCPY(d, rtable[i]);
6535 break;
6536 }
6537
6538 if (i < 0) /* no match in table */
6539 {
6540 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6541 * Also replace "\%^" and "\%(", they match every tag too.
6542 * Also "\zs", "\z1", etc.
6543 * Also "\@<", "\@=", "\@<=", etc.
6544 * And also "\_$" and "\_^". */
6545 if (arg[0] == '\\'
6546 && ((arg[1] != NUL && arg[2] == NUL)
6547 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6548 && arg[2] != NUL)))
6549 {
6550 STRCPY(d, "/\\\\");
6551 STRCPY(d + 3, arg + 1);
6552 /* Check for "/\\_$", should be "/\\_\$" */
6553 if (d[3] == '_' && d[4] == '$')
6554 STRCPY(d + 4, "\\$");
6555 }
6556 else
6557 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006558 /* Replace:
6559 * "[:...:]" with "\[:...:]"
6560 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006561 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006562 */
6563 if ((arg[0] == '[' && (arg[1] == ':'
6564 || (arg[1] == '+' && arg[2] == '+')))
6565 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 *d++ = '\\';
6567
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006568 /*
6569 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6570 */
6571 if (*arg == '(' && arg[1] == '\'')
6572 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 for (s = arg; *s; ++s)
6574 {
6575 /*
6576 * Replace "|" with "bar" and '"' with "quote" to match the name of
6577 * the tags for these commands.
6578 * Replace "*" with ".*" and "?" with "." to match command line
6579 * completion.
6580 * Insert a backslash before '~', '$' and '.' to avoid their
6581 * special meaning.
6582 */
6583 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6584 break;
6585 switch (*s)
6586 {
6587 case '|': STRCPY(d, "bar");
6588 d += 3;
6589 continue;
6590 case '"': STRCPY(d, "quote");
6591 d += 5;
6592 continue;
6593 case '*': *d++ = '.';
6594 break;
6595 case '?': *d++ = '.';
6596 continue;
6597 case '$':
6598 case '.':
6599 case '~': *d++ = '\\';
6600 break;
6601 }
6602
6603 /*
6604 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6605 * ":help i_^_CTRL-D" work.
6606 * Insert '-' before and after "CTRL-X" when applicable.
6607 */
6608 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6609 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6610 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006611 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6612 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 STRCPY(d, "CTRL-");
6614 d += 5;
6615 if (*s < ' ')
6616 {
6617#ifdef EBCDIC
6618 *d++ = CtrlChar(*s);
6619#else
6620 *d++ = *s + '@';
6621#endif
6622 if (d[-1] == '\\')
6623 *d++ = '\\'; /* double a backslash */
6624 }
6625 else
6626 *d++ = *++s;
6627 if (s[1] != NUL && s[1] != '_')
6628 *d++ = '_'; /* append a '_' */
6629 continue;
6630 }
6631 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6632 *d++ = '\\';
6633
6634 /*
6635 * Insert a backslash before a backslash after a slash, for search
6636 * pattern tags: "/\|" --> "/\\|".
6637 */
6638 else if (s[0] == '\\' && s[1] != '\\'
6639 && *arg == '/' && s == arg + 1)
6640 *d++ = '\\';
6641
6642 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6643 * "CTRL-\_CTRL-N" */
6644 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6645 {
6646 STRCPY(d, "CTRL-\\\\");
6647 d += 7;
6648 s += 6;
6649 }
6650
6651 *d++ = *s;
6652
6653 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006654 * If tag contains "({" or "([", tag terminates at the "(".
6655 * This is for help on functions, e.g.: abs({expr}).
6656 */
6657 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6658 break;
6659
6660 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 * If tag starts with ', toss everything after a second '. Fixes
6662 * CTRL-] on 'option'. (would include the trailing '.').
6663 */
6664 if (*s == '\'' && s > arg && *arg == '\'')
6665 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006666 /* Also '{' and '}'. */
6667 if (*s == '}' && s > arg && *arg == '{')
6668 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 }
6670 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006671
6672 if (*IObuff == '`')
6673 {
6674 if (d > IObuff + 2 && d[-1] == '`')
6675 {
6676 /* remove the backticks from `command` */
6677 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6678 d[-2] = NUL;
6679 }
6680 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6681 {
6682 /* remove the backticks and comma from `command`, */
6683 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6684 d[-3] = NUL;
6685 }
6686 else if (d > IObuff + 4 && d[-3] == '`'
6687 && d[-2] == '\\' && d[-1] == '.')
6688 {
6689 /* remove the backticks and dot from `command`\. */
6690 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6691 d[-4] = NUL;
6692 }
6693 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 }
6695 }
6696
6697 *matches = (char_u **)"";
6698 *num_matches = 0;
6699 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6700 if (keep_lang)
6701 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006702 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006704 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 /* Sort the matches found on the heuristic number that is after the
6706 * tag name. */
6707 qsort((void *)*matches, (size_t)*num_matches,
6708 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006709 /* Delete more than TAG_MANY to reduce the size of the listing. */
6710 while (*num_matches > TAG_MANY)
6711 vim_free((*matches)[--*num_matches]);
6712 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 return OK;
6714}
6715
6716/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006717 * Called when starting to edit a buffer for a help file.
6718 */
6719 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006720prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006721{
6722 char_u *p;
6723
6724 curbuf->b_help = TRUE;
6725#ifdef FEAT_QUICKFIX
6726 set_string_option_direct((char_u *)"buftype", -1,
6727 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6728#endif
6729
6730 /*
6731 * Always set these options after jumping to a help tag, because the
6732 * user may have an autocommand that gets in the way.
6733 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6734 * latin1 word characters (for translated help files).
6735 * Only set it when needed, buf_init_chartab() is some work.
6736 */
6737 p =
6738#ifdef EBCDIC
6739 (char_u *)"65-255,^*,^|,^\"";
6740#else
6741 (char_u *)"!-~,^*,^|,^\",192-255";
6742#endif
6743 if (STRCMP(curbuf->b_p_isk, p) != 0)
6744 {
6745 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6746 check_buf_options(curbuf);
6747 (void)buf_init_chartab(curbuf, FALSE);
6748 }
6749
Bram Moolenaar0b105412014-11-30 13:34:23 +01006750#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006751 /* Don't use the global foldmethod.*/
6752 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6753 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006754#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006755
6756 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6757 curwin->w_p_list = FALSE; /* no list mode */
6758
6759 curbuf->b_p_ma = FALSE; /* not modifiable */
6760 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6761 curwin->w_p_nu = 0; /* no line numbers */
6762 curwin->w_p_rnu = 0; /* no relative line numbers */
6763 RESET_BINDING(curwin); /* no scroll or cursor binding */
6764#ifdef FEAT_ARABIC
6765 curwin->w_p_arab = FALSE; /* no arabic mode */
6766#endif
6767#ifdef FEAT_RIGHTLEFT
6768 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6769#endif
6770#ifdef FEAT_FOLDING
6771 curwin->w_p_fen = FALSE; /* No folding in the help window */
6772#endif
6773#ifdef FEAT_DIFF
6774 curwin->w_p_diff = FALSE; /* No 'diff' */
6775#endif
6776#ifdef FEAT_SPELL
6777 curwin->w_p_spell = FALSE; /* No spell checking */
6778#endif
6779
6780 set_buflisted(FALSE);
6781}
6782
6783/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 * After reading a help file: May cleanup a help buffer when syntax
6785 * highlighting is not used.
6786 */
6787 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006788fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789{
6790 linenr_T lnum;
6791 char_u *line;
6792 int in_example = FALSE;
6793 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006794 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 char_u *p;
6796 char_u *rt;
6797 int mustfree;
6798
6799 /* set filetype to "help". */
6800 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6801
6802#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006803 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804#endif
6805 {
6806 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6807 {
6808 line = ml_get_buf(curbuf, lnum, FALSE);
6809 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006810 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 {
6812 /* End of example: non-white or '<' in first column. */
6813 if (line[0] == '<')
6814 {
6815 /* blank-out a '<' in the first column */
6816 line = ml_get_buf(curbuf, lnum, TRUE);
6817 line[0] = ' ';
6818 }
6819 in_example = FALSE;
6820 }
6821 if (!in_example && len > 0)
6822 {
6823 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6824 {
6825 /* blank-out a '>' in the last column (start of example) */
6826 line = ml_get_buf(curbuf, lnum, TRUE);
6827 line[len - 1] = ' ';
6828 in_example = TRUE;
6829 }
6830 else if (line[len - 1] == '~')
6831 {
6832 /* blank-out a '~' at the end of line (header marker) */
6833 line = ml_get_buf(curbuf, lnum, TRUE);
6834 line[len - 1] = ' ';
6835 }
6836 }
6837 }
6838 }
6839
6840 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006841 * In the "help.txt" and "help.abx" file, add the locally added help
6842 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006844 fname = gettail(curbuf->b_fname);
6845 if (fnamecmp(fname, "help.txt") == 0
6846#ifdef FEAT_MULTI_LANG
6847 || (fnamencmp(fname, "help.", 5) == 0
6848 && ASCII_ISALPHA(fname[5])
6849 && ASCII_ISALPHA(fname[6])
6850 && TOLOWER_ASC(fname[7]) == 'x'
6851 && fname[8] == NUL)
6852#endif
6853 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 {
6855 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6856 {
6857 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006858 if (strstr((char *)line, "*local-additions*") == NULL)
6859 continue;
6860
6861 /* Go through all directories in 'runtimepath', skipping
6862 * $VIMRUNTIME. */
6863 p = p_rtp;
6864 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006866 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6867 mustfree = FALSE;
6868 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6869 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006871 int fcount;
6872 char_u **fnames;
6873 FILE *fd;
6874 char_u *s;
6875 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006877 vimconv_T vc;
6878 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879#endif
6880
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006881 /* Find all "doc/ *.txt" files in this directory. */
6882 add_pathsep(NameBuff);
6883#ifdef FEAT_MULTI_LANG
6884 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006886 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006888 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6889 &fnames, EW_FILE|EW_SILENT) == OK
6890 && fcount > 0)
6891 {
6892#ifdef FEAT_MULTI_LANG
6893 int i1;
6894 int i2;
6895 char_u *f1;
6896 char_u *f2;
6897 char_u *t1;
6898 char_u *e1;
6899 char_u *e2;
6900
6901 /* If foo.abx is found use it instead of foo.txt in
6902 * the same directory. */
6903 for (i1 = 0; i1 < fcount; ++i1)
6904 {
6905 for (i2 = 0; i2 < fcount; ++i2)
6906 {
6907 if (i1 == i2)
6908 continue;
6909 if (fnames[i1] == NULL || fnames[i2] == NULL)
6910 continue;
6911 f1 = fnames[i1];
6912 f2 = fnames[i2];
6913 t1 = gettail(f1);
6914 if (fnamencmp(f1, f2, t1 - f1) != 0)
6915 continue;
6916 e1 = vim_strrchr(t1, '.');
6917 e2 = vim_strrchr(gettail(f2), '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02006918 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006919 continue;
6920 if (fnamecmp(e1, ".txt") != 0
6921 && fnamecmp(e1, fname + 4) != 0)
6922 {
6923 /* Not .txt and not .abx, remove it. */
6924 vim_free(fnames[i1]);
6925 fnames[i1] = NULL;
6926 continue;
6927 }
6928 if (fnamencmp(f1, f2, e1 - f1) != 0)
6929 continue;
6930 if (fnamecmp(e1, ".txt") == 0
6931 && fnamecmp(e2, fname + 4) == 0)
6932 {
6933 /* use .abx instead of .txt */
6934 vim_free(fnames[i1]);
6935 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 }
6937 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006939#endif
6940 for (fi = 0; fi < fcount; ++fi)
6941 {
6942 if (fnames[fi] == NULL)
6943 continue;
6944 fd = mch_fopen((char *)fnames[fi], "r");
6945 if (fd != NULL)
6946 {
6947 vim_fgets(IObuff, IOSIZE, fd);
6948 if (IObuff[0] == '*'
6949 && (s = vim_strchr(IObuff + 1, '*'))
6950 != NULL)
6951 {
6952#ifdef FEAT_MBYTE
6953 int this_utf = MAYBE;
6954#endif
6955 /* Change tag definition to a
6956 * reference and remove <CR>/<NL>. */
6957 IObuff[0] = '|';
6958 *s = '|';
6959 while (*s != NUL)
6960 {
6961 if (*s == '\r' || *s == '\n')
6962 *s = NUL;
6963#ifdef FEAT_MBYTE
6964 /* The text is utf-8 when a byte
6965 * above 127 is found and no
6966 * illegal byte sequence is found.
6967 */
6968 if (*s >= 0x80 && this_utf != FALSE)
6969 {
6970 int l;
6971
6972 this_utf = TRUE;
6973 l = utf_ptr2len(s);
6974 if (l == 1)
6975 this_utf = FALSE;
6976 s += l - 1;
6977 }
6978#endif
6979 ++s;
6980 }
6981#ifdef FEAT_MBYTE
6982 /* The help file is latin1 or utf-8;
6983 * conversion to the current
6984 * 'encoding' may be required. */
6985 vc.vc_type = CONV_NONE;
6986 convert_setup(&vc, (char_u *)(
6987 this_utf == TRUE ? "utf-8"
6988 : "latin1"), p_enc);
6989 if (vc.vc_type == CONV_NONE)
6990 /* No conversion needed. */
6991 cp = IObuff;
6992 else
6993 {
6994 /* Do the conversion. If it fails
6995 * use the unconverted text. */
6996 cp = string_convert(&vc, IObuff,
6997 NULL);
6998 if (cp == NULL)
6999 cp = IObuff;
7000 }
7001 convert_setup(&vc, NULL, NULL);
7002
7003 ml_append(lnum, cp, (colnr_T)0, FALSE);
7004 if (cp != IObuff)
7005 vim_free(cp);
7006#else
7007 ml_append(lnum, IObuff, (colnr_T)0,
7008 FALSE);
7009#endif
7010 ++lnum;
7011 }
7012 fclose(fd);
7013 }
7014 }
7015 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007018 if (mustfree)
7019 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007021 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 }
7023 }
7024}
7025
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007026/*
7027 * ":exusage"
7028 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007029 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007030ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007031{
7032 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7033}
7034
7035/*
7036 * ":viusage"
7037 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007038 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007039ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007040{
7041 do_cmdline_cmd((char_u *)"help normal-index");
7042}
7043
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007045 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007048helptags_one(
7049 char_u *dir, /* doc directory */
7050 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7051 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7052 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053{
7054 FILE *fd_tags;
7055 FILE *fd;
7056 garray_T ga;
7057 int filecount;
7058 char_u **files;
7059 char_u *p1, *p2;
7060 int fi;
7061 char_u *s;
7062 int i;
7063 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007064 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065# ifdef FEAT_MBYTE
7066 int utf8 = MAYBE;
7067 int this_utf8;
7068 int firstline;
7069 int mix = FALSE; /* detected mixed encodings */
7070# endif
7071
7072 /*
7073 * Find all *.txt files.
7074 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007075 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007077 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 STRCAT(NameBuff, ext);
7079 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7080 EW_FILE|EW_SILENT) == FAIL
7081 || filecount == 0)
7082 {
7083 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007084 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 return;
7086 }
7087
7088 /*
7089 * Open the tags file for writing.
7090 * Do this before scanning through all the files.
7091 */
7092 STRCPY(NameBuff, dir);
7093 add_pathsep(NameBuff);
7094 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007095 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 if (fd_tags == NULL)
7097 {
7098 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7099 FreeWild(filecount, files);
7100 return;
7101 }
7102
7103 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007104 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7105 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 */
7107 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007108 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7109 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 {
7111 if (ga_grow(&ga, 1) == FAIL)
7112 got_int = TRUE;
7113 else
7114 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007115 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 if (s == NULL)
7117 got_int = TRUE;
7118 else
7119 {
7120 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7121 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7122 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 }
7124 }
7125 }
7126
7127 /*
7128 * Go over all the files and extract the tags.
7129 */
7130 for (fi = 0; fi < filecount && !got_int; ++fi)
7131 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007132 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 if (fd == NULL)
7134 {
7135 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7136 continue;
7137 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007138 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139
7140# ifdef FEAT_MBYTE
7141 firstline = TRUE;
7142# endif
7143 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7144 {
7145# ifdef FEAT_MBYTE
7146 if (firstline)
7147 {
7148 /* Detect utf-8 file by a non-ASCII char in the first line. */
7149 this_utf8 = MAYBE;
7150 for (s = IObuff; *s != NUL; ++s)
7151 if (*s >= 0x80)
7152 {
7153 int l;
7154
7155 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007156 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 if (l == 1)
7158 {
7159 /* Illegal UTF-8 byte sequence. */
7160 this_utf8 = FALSE;
7161 break;
7162 }
7163 s += l - 1;
7164 }
7165 if (this_utf8 == MAYBE) /* only ASCII characters found */
7166 this_utf8 = FALSE;
7167 if (utf8 == MAYBE) /* first file */
7168 utf8 = this_utf8;
7169 else if (utf8 != this_utf8)
7170 {
7171 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7172 mix = !got_int;
7173 got_int = TRUE;
7174 }
7175 firstline = FALSE;
7176 }
7177# endif
7178 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7179 while (p1 != NULL)
7180 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007181 /* Use vim_strbyte() instead of vim_strchr() so that when
7182 * 'encoding' is dbcs it still works, don't find '*' in the
7183 * second byte. */
7184 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7186 {
7187 for (s = p1 + 1; s < p2; ++s)
7188 if (*s == ' ' || *s == '\t' || *s == '|')
7189 break;
7190
7191 /*
7192 * Only accept a *tag* when it consists of valid
7193 * characters, there is white space before it and is
7194 * followed by a white character or end-of-line.
7195 */
7196 if (s == p2
7197 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7198 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7199 || s[1] == '\0'))
7200 {
7201 *p2 = '\0';
7202 ++p1;
7203 if (ga_grow(&ga, 1) == FAIL)
7204 {
7205 got_int = TRUE;
7206 break;
7207 }
7208 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7209 if (s == NULL)
7210 {
7211 got_int = TRUE;
7212 break;
7213 }
7214 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7215 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 sprintf((char *)s, "%s\t%s", p1, fname);
7217
7218 /* find next '*' */
7219 p2 = vim_strchr(p2 + 1, '*');
7220 }
7221 }
7222 p1 = p2;
7223 }
7224 line_breakcheck();
7225 }
7226
7227 fclose(fd);
7228 }
7229
7230 FreeWild(filecount, files);
7231
7232 if (!got_int)
7233 {
7234 /*
7235 * Sort the tags.
7236 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007237 if (ga.ga_data != NULL)
7238 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239
7240 /*
7241 * Check for duplicates.
7242 */
7243 for (i = 1; i < ga.ga_len; ++i)
7244 {
7245 p1 = ((char_u **)ga.ga_data)[i - 1];
7246 p2 = ((char_u **)ga.ga_data)[i];
7247 while (*p1 == *p2)
7248 {
7249 if (*p2 == '\t')
7250 {
7251 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007252 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7254 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7255 EMSG(NameBuff);
7256 *p2 = '\t';
7257 break;
7258 }
7259 ++p1;
7260 ++p2;
7261 }
7262 }
7263
7264# ifdef FEAT_MBYTE
7265 if (utf8 == TRUE)
7266 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7267# endif
7268
7269 /*
7270 * Write the tags into the file.
7271 */
7272 for (i = 0; i < ga.ga_len; ++i)
7273 {
7274 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007275 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007277 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 else
7279 {
7280 fprintf(fd_tags, "%s\t/*", s);
7281 for (p1 = s; *p1 != '\t'; ++p1)
7282 {
7283 /* insert backslash before '\\' and '/' */
7284 if (*p1 == '\\' || *p1 == '/')
7285 putc('\\', fd_tags);
7286 putc(*p1, fd_tags);
7287 }
7288 fprintf(fd_tags, "*\n");
7289 }
7290 }
7291 }
7292#ifdef FEAT_MBYTE
7293 if (mix)
7294 got_int = FALSE; /* continue with other languages */
7295#endif
7296
7297 for (i = 0; i < ga.ga_len; ++i)
7298 vim_free(((char_u **)ga.ga_data)[i]);
7299 ga_clear(&ga);
7300 fclose(fd_tags); /* there is no check for an error... */
7301}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007303/*
7304 * Generate tags in one help directory, taking care of translations.
7305 */
7306 static void
7307do_helptags(char_u *dirname, int add_help_tags)
7308{
7309#ifdef FEAT_MULTI_LANG
7310 int len;
7311 int i, j;
7312 garray_T ga;
7313 char_u lang[2];
7314 char_u ext[5];
7315 char_u fname[8];
7316 int filecount;
7317 char_u **files;
7318
7319 /* Get a list of all files in the help directory and in subdirectories. */
7320 STRCPY(NameBuff, dirname);
7321 add_pathsep(NameBuff);
7322 STRCAT(NameBuff, "**");
7323 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7324 EW_FILE|EW_SILENT) == FAIL
7325 || filecount == 0)
7326 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007327 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007328 return;
7329 }
7330
7331 /* Go over all files in the directory to find out what languages are
7332 * present. */
7333 ga_init2(&ga, 1, 10);
7334 for (i = 0; i < filecount; ++i)
7335 {
7336 len = (int)STRLEN(files[i]);
7337 if (len > 4)
7338 {
7339 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7340 {
7341 /* ".txt" -> language "en" */
7342 lang[0] = 'e';
7343 lang[1] = 'n';
7344 }
7345 else if (files[i][len - 4] == '.'
7346 && ASCII_ISALPHA(files[i][len - 3])
7347 && ASCII_ISALPHA(files[i][len - 2])
7348 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7349 {
7350 /* ".abx" -> language "ab" */
7351 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7352 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7353 }
7354 else
7355 continue;
7356
7357 /* Did we find this language already? */
7358 for (j = 0; j < ga.ga_len; j += 2)
7359 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7360 break;
7361 if (j == ga.ga_len)
7362 {
7363 /* New language, add it. */
7364 if (ga_grow(&ga, 2) == FAIL)
7365 break;
7366 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7367 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7368 }
7369 }
7370 }
7371
7372 /*
7373 * Loop over the found languages to generate a tags file for each one.
7374 */
7375 for (j = 0; j < ga.ga_len; j += 2)
7376 {
7377 STRCPY(fname, "tags-xx");
7378 fname[5] = ((char_u *)ga.ga_data)[j];
7379 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7380 if (fname[5] == 'e' && fname[6] == 'n')
7381 {
7382 /* English is an exception: use ".txt" and "tags". */
7383 fname[4] = NUL;
7384 STRCPY(ext, ".txt");
7385 }
7386 else
7387 {
7388 /* Language "ab" uses ".abx" and "tags-ab". */
7389 STRCPY(ext, ".xxx");
7390 ext[1] = fname[5];
7391 ext[2] = fname[6];
7392 }
7393 helptags_one(dirname, ext, fname, add_help_tags);
7394 }
7395
7396 ga_clear(&ga);
7397 FreeWild(filecount, files);
7398
7399#else
7400 /* No language support, just use "*.txt" and "tags". */
7401 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7402#endif
7403}
7404
7405 static void
7406helptags_cb(char_u *fname, void *cookie)
7407{
7408 do_helptags(fname, *(int *)cookie);
7409}
7410
7411/*
7412 * ":helptags"
7413 */
7414 void
7415ex_helptags(exarg_T *eap)
7416{
7417 expand_T xpc;
7418 char_u *dirname;
7419 int add_help_tags = FALSE;
7420
7421 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007422 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007423 {
7424 add_help_tags = TRUE;
7425 eap->arg = skipwhite(eap->arg + 3);
7426 }
7427
7428 if (STRCMP(eap->arg, "ALL") == 0)
7429 {
7430 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7431 helptags_cb, &add_help_tags);
7432 }
7433 else
7434 {
7435 ExpandInit(&xpc);
7436 xpc.xp_context = EXPAND_DIRECTORIES;
7437 dirname = ExpandOne(&xpc, eap->arg, NULL,
7438 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7439 if (dirname == NULL || !mch_isdir(dirname))
7440 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7441 else
7442 do_helptags(dirname, add_help_tags);
7443 vim_free(dirname);
7444 }
7445}
7446
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447#if defined(FEAT_SIGNS) || defined(PROTO)
7448
7449/*
7450 * Struct to hold the sign properties.
7451 */
7452typedef struct sign sign_T;
7453
7454struct sign
7455{
7456 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007457 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 char_u *sn_name; /* name of sign */
7459 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007460# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007462# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 char_u *sn_text; /* text used instead of pixmap */
7464 int sn_line_hl; /* highlight ID for line */
7465 int sn_text_hl; /* highlight ID for text */
7466};
7467
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007469static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007471static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7472static void sign_list_defined(sign_T *sp);
7473static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007475static char *cmds[] = {
7476 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007477# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007478 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007479# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007480 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007481# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007482 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007483# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007484 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007485# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007486 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007487# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007488 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007489# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007490};
7491
7492/*
7493 * Find index of a ":sign" subcmd from its name.
7494 * "*end_cmd" must be writable.
7495 */
7496 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007497sign_cmd_idx(
7498 char_u *begin_cmd, /* begin of sign subcmd */
7499 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007500{
7501 int idx;
7502 char save = *end_cmd;
7503
7504 *end_cmd = NUL;
7505 for (idx = 0; ; ++idx)
7506 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7507 break;
7508 *end_cmd = save;
7509 return idx;
7510}
7511
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512/*
7513 * ":sign" command
7514 */
7515 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007516ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517{
7518 char_u *arg = eap->arg;
7519 char_u *p;
7520 int idx;
7521 sign_T *sp;
7522 sign_T *sp_prev;
7523 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524
7525 /* Parse the subcommand. */
7526 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007527 idx = sign_cmd_idx(arg, p);
7528 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007530 EMSG2(_("E160: Unknown sign command: %s"), arg);
7531 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 }
7533 arg = skipwhite(p);
7534
7535 if (idx <= SIGNCMD_LIST)
7536 {
7537 /*
7538 * Define, undefine or list signs.
7539 */
7540 if (idx == SIGNCMD_LIST && *arg == NUL)
7541 {
7542 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007543 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 sign_list_defined(sp);
7545 }
7546 else if (*arg == NUL)
7547 EMSG(_("E156: Missing sign name"));
7548 else
7549 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007550 /* Isolate the sign name. If it's a number skip leading zeroes,
7551 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 p = skiptowhite(arg);
7553 if (*p != NUL)
7554 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007555 while (arg[0] == '0' && arg[1] != NUL)
7556 ++arg;
7557
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 sp_prev = NULL;
7559 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7560 {
7561 if (STRCMP(sp->sn_name, arg) == 0)
7562 break;
7563 sp_prev = sp;
7564 }
7565 if (idx == SIGNCMD_DEFINE)
7566 {
7567 /* ":sign define {name} ...": define a sign */
7568 if (sp == NULL)
7569 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007570 sign_T *lp;
7571 int start = next_sign_typenr;
7572
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 /* Allocate a new sign. */
7574 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7575 if (sp == NULL)
7576 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007578 /* Check that next_sign_typenr is not already being used.
7579 * This only happens after wrapping around. Hopefully
7580 * another one got deleted and we can use its number. */
7581 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007583 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007585 ++next_sign_typenr;
7586 if (next_sign_typenr == MAX_TYPENR)
7587 next_sign_typenr = 1;
7588 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007590 vim_free(sp);
7591 EMSG(_("E612: Too many signs defined"));
7592 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007594 lp = first_sign; /* start all over */
7595 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007597 lp = lp->sn_next;
7598 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007600 sp->sn_typenr = next_sign_typenr;
7601 if (++next_sign_typenr == MAX_TYPENR)
7602 next_sign_typenr = 1; /* wrap around */
7603
7604 sp->sn_name = vim_strsave(arg);
7605 if (sp->sn_name == NULL) /* out of memory */
7606 {
7607 vim_free(sp);
7608 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007610
7611 /* add the new sign to the list of signs */
7612 if (sp_prev == NULL)
7613 first_sign = sp;
7614 else
7615 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 }
7617
7618 /* set values for a defined sign. */
7619 for (;;)
7620 {
7621 arg = skipwhite(p);
7622 if (*arg == NUL)
7623 break;
7624 p = skiptowhite_esc(arg);
7625 if (STRNCMP(arg, "icon=", 5) == 0)
7626 {
7627 arg += 5;
7628 vim_free(sp->sn_icon);
7629 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7630 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007631# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 if (gui.in_use)
7633 {
7634 out_flush();
7635 if (sp->sn_image != NULL)
7636 gui_mch_destroy_sign(sp->sn_image);
7637 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7638 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007639# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 }
7641 else if (STRNCMP(arg, "text=", 5) == 0)
7642 {
7643 char_u *s;
7644 int cells;
7645 int len;
7646
7647 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007648# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 /* Count cells and check for non-printable chars */
7650 if (has_mbyte)
7651 {
7652 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007653 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 {
7655 if (!vim_isprintc((*mb_ptr2char)(s)))
7656 break;
7657 cells += (*mb_ptr2cells)(s);
7658 }
7659 }
7660 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007661# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 {
7663 for (s = arg; s < p; ++s)
7664 if (!vim_isprintc(*s))
7665 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007666 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 }
7668 /* Currently must be one or two display cells */
7669 if (s != p || cells < 1 || cells > 2)
7670 {
7671 *p = NUL;
7672 EMSG2(_("E239: Invalid sign text: %s"), arg);
7673 return;
7674 }
7675
7676 vim_free(sp->sn_text);
7677 /* Allocate one byte more if we need to pad up
7678 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007679 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 sp->sn_text = vim_strnsave(arg, len);
7681
7682 if (sp->sn_text != NULL && cells == 1)
7683 STRCPY(sp->sn_text + len - 1, " ");
7684 }
7685 else if (STRNCMP(arg, "linehl=", 7) == 0)
7686 {
7687 arg += 7;
7688 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7689 }
7690 else if (STRNCMP(arg, "texthl=", 7) == 0)
7691 {
7692 arg += 7;
7693 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7694 }
7695 else
7696 {
7697 EMSG2(_(e_invarg2), arg);
7698 return;
7699 }
7700 }
7701 }
7702 else if (sp == NULL)
7703 EMSG2(_("E155: Unknown sign: %s"), arg);
7704 else if (idx == SIGNCMD_LIST)
7705 /* ":sign list {name}" */
7706 sign_list_defined(sp);
7707 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007709 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 }
7711 }
7712 else
7713 {
7714 int id = -1;
7715 linenr_T lnum = -1;
7716 char_u *sign_name = NULL;
7717 char_u *arg1;
7718
7719 if (*arg == NUL)
7720 {
7721 if (idx == SIGNCMD_PLACE)
7722 {
7723 /* ":sign place": list placed signs in all buffers */
7724 sign_list_placed(NULL);
7725 }
7726 else if (idx == SIGNCMD_UNPLACE)
7727 {
7728 /* ":sign unplace": remove placed sign at cursor */
7729 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7730 if (id > 0)
7731 {
7732 buf_delsign(curwin->w_buffer, id);
7733 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7734 }
7735 else
7736 EMSG(_("E159: Missing sign number"));
7737 }
7738 else
7739 EMSG(_(e_argreq));
7740 return;
7741 }
7742
7743 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7744 {
7745 /* ":sign unplace *": remove all placed signs */
7746 buf_delete_all_signs();
7747 return;
7748 }
7749
7750 /* first arg could be placed sign id */
7751 arg1 = arg;
7752 if (VIM_ISDIGIT(*arg))
7753 {
7754 id = getdigits(&arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01007755 if (!VIM_ISWHITE(*arg) && *arg != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756 {
7757 id = -1;
7758 arg = arg1;
7759 }
7760 else
7761 {
7762 arg = skipwhite(arg);
7763 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7764 {
7765 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007766 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 if ((lnum = buf_delsign(buf, id)) != 0)
7768 update_debug_sign(buf, lnum);
7769 return;
7770 }
7771 }
7772 }
7773
7774 /*
7775 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7776 * Leave "arg" pointing to {fname}.
7777 */
7778 for (;;)
7779 {
7780 if (STRNCMP(arg, "line=", 5) == 0)
7781 {
7782 arg += 5;
7783 lnum = atoi((char *)arg);
7784 arg = skiptowhite(arg);
7785 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007786 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7787 {
7788 if (id != -1)
7789 {
7790 EMSG(_(e_invarg));
7791 return;
7792 }
7793 id = -2;
7794 arg = skiptowhite(arg + 1);
7795 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 else if (STRNCMP(arg, "name=", 5) == 0)
7797 {
7798 arg += 5;
7799 sign_name = arg;
7800 arg = skiptowhite(arg);
7801 if (*arg != NUL)
7802 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007803 while (sign_name[0] == '0' && sign_name[1] != NUL)
7804 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 }
7806 else if (STRNCMP(arg, "file=", 5) == 0)
7807 {
7808 arg += 5;
7809 buf = buflist_findname(arg);
7810 break;
7811 }
7812 else if (STRNCMP(arg, "buffer=", 7) == 0)
7813 {
7814 arg += 7;
7815 buf = buflist_findnr((int)getdigits(&arg));
7816 if (*skipwhite(arg) != NUL)
7817 EMSG(_(e_trailing));
7818 break;
7819 }
7820 else
7821 {
7822 EMSG(_(e_invarg));
7823 return;
7824 }
7825 arg = skipwhite(arg);
7826 }
7827
7828 if (buf == NULL)
7829 {
7830 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7831 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007832 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 {
7834 if (lnum >= 0 || sign_name != NULL)
7835 EMSG(_(e_invarg));
7836 else
7837 /* ":sign place file={fname}": list placed signs in one file */
7838 sign_list_placed(buf);
7839 }
7840 else if (idx == SIGNCMD_JUMP)
7841 {
7842 /* ":sign jump {id} file={fname}" */
7843 if (lnum >= 0 || sign_name != NULL)
7844 EMSG(_(e_invarg));
7845 else if ((lnum = buf_findsign(buf, id)) > 0)
7846 { /* goto a sign ... */
7847 if (buf_jump_open_win(buf) != NULL)
7848 { /* ... in a current window */
7849 curwin->w_cursor.lnum = lnum;
7850 check_cursor_lnum();
7851 beginline(BL_WHITE);
7852 }
7853 else
7854 { /* ... not currently in a window */
7855 char_u *cmd;
7856
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007857 if (buf->b_fname == NULL)
7858 {
7859 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7860 return;
7861 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7863 if (cmd == NULL)
7864 return;
7865 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7866 do_cmdline_cmd(cmd);
7867 vim_free(cmd);
7868 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007869# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007871# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 }
7873 else
7874 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7875 }
7876 else if (idx == SIGNCMD_UNPLACE)
7877 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 if (lnum >= 0 || sign_name != NULL)
7879 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007880 else if (id == -2)
7881 {
7882 /* ":sign unplace * file={fname}" */
7883 redraw_buf_later(buf, NOT_VALID);
7884 buf_delete_signs(buf);
7885 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 else
7887 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007888 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 lnum = buf_delsign(buf, id);
7890 update_debug_sign(buf, lnum);
7891 }
7892 }
7893 /* idx == SIGNCMD_PLACE */
7894 else if (sign_name != NULL)
7895 {
7896 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7897 if (STRCMP(sp->sn_name, sign_name) == 0)
7898 break;
7899 if (sp == NULL)
7900 {
7901 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7902 return;
7903 }
7904 if (lnum > 0)
7905 /* ":sign place {id} line={lnum} name={name} file={fname}":
7906 * place a sign */
7907 buf_addsign(buf, id, lnum, sp->sn_typenr);
7908 else
7909 /* ":sign place {id} file={fname}": change sign type */
7910 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007911 if (lnum > 0)
7912 update_debug_sign(buf, lnum);
7913 else
7914 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 }
7916 else
7917 EMSG(_(e_invarg));
7918 }
7919}
7920
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007921# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922/*
7923 * Allocate the icons. Called when the GUI has started. Allows defining
7924 * signs before it starts.
7925 */
7926 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007927sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928{
7929 sign_T *sp;
7930
7931 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7932 if (sp->sn_icon != NULL)
7933 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7934}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007935# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936
7937/*
7938 * List one sign.
7939 */
7940 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007941sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942{
7943 char_u *p;
7944
Bram Moolenaar555b2802005-05-19 21:08:39 +00007945 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 if (sp->sn_icon != NULL)
7947 {
7948 MSG_PUTS(" icon=");
7949 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007950# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 if (sp->sn_image == NULL)
7952 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007953# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007955# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 }
7957 if (sp->sn_text != NULL)
7958 {
7959 MSG_PUTS(" text=");
7960 msg_outtrans(sp->sn_text);
7961 }
7962 if (sp->sn_line_hl > 0)
7963 {
7964 MSG_PUTS(" linehl=");
7965 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7966 if (p == NULL)
7967 MSG_PUTS("NONE");
7968 else
7969 msg_puts(p);
7970 }
7971 if (sp->sn_text_hl > 0)
7972 {
7973 MSG_PUTS(" texthl=");
7974 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7975 if (p == NULL)
7976 MSG_PUTS("NONE");
7977 else
7978 msg_puts(p);
7979 }
7980}
7981
7982/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007983 * Undefine a sign and free its memory.
7984 */
7985 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007986sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007987{
7988 vim_free(sp->sn_name);
7989 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007990# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007991 if (sp->sn_image != NULL)
7992 {
7993 out_flush();
7994 gui_mch_destroy_sign(sp->sn_image);
7995 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007996# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007997 vim_free(sp->sn_text);
7998 if (sp_prev == NULL)
7999 first_sign = sp->sn_next;
8000 else
8001 sp_prev->sn_next = sp->sn_next;
8002 vim_free(sp);
8003}
8004
8005/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 * Get highlighting attribute for sign "typenr".
8007 * If "line" is TRUE: line highl, if FALSE: text highl.
8008 */
8009 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008010sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011{
8012 sign_T *sp;
8013
8014 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8015 if (sp->sn_typenr == typenr)
8016 {
8017 if (line)
8018 {
8019 if (sp->sn_line_hl > 0)
8020 return syn_id2attr(sp->sn_line_hl);
8021 }
8022 else
8023 {
8024 if (sp->sn_text_hl > 0)
8025 return syn_id2attr(sp->sn_text_hl);
8026 }
8027 break;
8028 }
8029 return 0;
8030}
8031
8032/*
8033 * Get text mark for sign "typenr".
8034 * Returns NULL if there isn't one.
8035 */
8036 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008037sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038{
8039 sign_T *sp;
8040
8041 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8042 if (sp->sn_typenr == typenr)
8043 return sp->sn_text;
8044 return NULL;
8045}
8046
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008047# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008049sign_get_image(
8050 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051{
8052 sign_T *sp;
8053
8054 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8055 if (sp->sn_typenr == typenr)
8056 return sp->sn_image;
8057 return NULL;
8058}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008059# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060
8061/*
8062 * Get the name of a sign by its typenr.
8063 */
8064 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008065sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066{
8067 sign_T *sp;
8068
8069 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8070 if (sp->sn_typenr == typenr)
8071 return sp->sn_name;
8072 return (char_u *)_("[Deleted]");
8073}
8074
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008075# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008076/*
8077 * Undefine/free all signs.
8078 */
8079 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008080free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008081{
8082 while (first_sign != NULL)
8083 sign_undefine(first_sign, NULL);
8084}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008085# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008086
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008087# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008088static enum
8089{
8090 EXP_SUBCMD, /* expand :sign sub-commands */
8091 EXP_DEFINE, /* expand :sign define {name} args */
8092 EXP_PLACE, /* expand :sign place {id} args */
8093 EXP_UNPLACE, /* expand :sign unplace" */
8094 EXP_SIGN_NAMES /* expand with name of placed signs */
8095} expand_what;
8096
8097/*
8098 * Function given to ExpandGeneric() to obtain the sign command
8099 * expansion.
8100 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008101 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008102get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008103{
8104 sign_T *sp;
8105 int current_idx;
8106
8107 switch (expand_what)
8108 {
8109 case EXP_SUBCMD:
8110 return (char_u *)cmds[idx];
8111 case EXP_DEFINE:
8112 {
8113 char *define_arg[] =
8114 {
8115 "icon=", "linehl=", "text=", "texthl=", NULL
8116 };
8117 return (char_u *)define_arg[idx];
8118 }
8119 case EXP_PLACE:
8120 {
8121 char *place_arg[] =
8122 {
8123 "line=", "name=", "file=", "buffer=", NULL
8124 };
8125 return (char_u *)place_arg[idx];
8126 }
8127 case EXP_UNPLACE:
8128 {
8129 char *unplace_arg[] = { "file=", "buffer=", NULL };
8130 return (char_u *)unplace_arg[idx];
8131 }
8132 case EXP_SIGN_NAMES:
8133 /* Complete with name of signs already defined */
8134 current_idx = 0;
8135 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8136 if (current_idx++ == idx)
8137 return sp->sn_name;
8138 return NULL;
8139 default:
8140 return NULL;
8141 }
8142}
8143
8144/*
8145 * Handle command line completion for :sign command.
8146 */
8147 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008148set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008149{
8150 char_u *p;
8151 char_u *end_subcmd;
8152 char_u *last;
8153 int cmd_idx;
8154 char_u *begin_subcmd_args;
8155
8156 /* Default: expand subcommands. */
8157 xp->xp_context = EXPAND_SIGN;
8158 expand_what = EXP_SUBCMD;
8159 xp->xp_pattern = arg;
8160
8161 end_subcmd = skiptowhite(arg);
8162 if (*end_subcmd == NUL)
8163 /* expand subcmd name
8164 * :sign {subcmd}<CTRL-D>*/
8165 return;
8166
8167 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8168
8169 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008170 * |
8171 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008172 begin_subcmd_args = skipwhite(end_subcmd);
8173 p = skiptowhite(begin_subcmd_args);
8174 if (*p == NUL)
8175 {
8176 /*
8177 * Expand first argument of subcmd when possible.
8178 * For ":jump {id}" and ":unplace {id}", we could
8179 * possibly expand the ids of all signs already placed.
8180 */
8181 xp->xp_pattern = begin_subcmd_args;
8182 switch (cmd_idx)
8183 {
8184 case SIGNCMD_LIST:
8185 case SIGNCMD_UNDEFINE:
8186 /* :sign list <CTRL-D>
8187 * :sign undefine <CTRL-D> */
8188 expand_what = EXP_SIGN_NAMES;
8189 break;
8190 default:
8191 xp->xp_context = EXPAND_NOTHING;
8192 }
8193 return;
8194 }
8195
8196 /* expand last argument of subcmd */
8197
8198 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008199 * |
8200 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008201
8202 /* Loop until reaching last argument. */
8203 do
8204 {
8205 p = skipwhite(p);
8206 last = p;
8207 p = skiptowhite(p);
8208 } while (*p != NUL);
8209
8210 p = vim_strchr(last, '=');
8211
8212 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008213 * | |
8214 * last p */
Bram Moolenaar7756e742016-10-21 20:35:37 +02008215 if (p == NULL)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008216 {
8217 /* Expand last argument name (before equal sign). */
8218 xp->xp_pattern = last;
8219 switch (cmd_idx)
8220 {
8221 case SIGNCMD_DEFINE:
8222 expand_what = EXP_DEFINE;
8223 break;
8224 case SIGNCMD_PLACE:
8225 expand_what = EXP_PLACE;
8226 break;
8227 case SIGNCMD_JUMP:
8228 case SIGNCMD_UNPLACE:
8229 expand_what = EXP_UNPLACE;
8230 break;
8231 default:
8232 xp->xp_context = EXPAND_NOTHING;
8233 }
8234 }
8235 else
8236 {
8237 /* Expand last argument value (after equal sign). */
8238 xp->xp_pattern = p + 1;
8239 switch (cmd_idx)
8240 {
8241 case SIGNCMD_DEFINE:
8242 if (STRNCMP(last, "texthl", p - last) == 0 ||
8243 STRNCMP(last, "linehl", p - last) == 0)
8244 xp->xp_context = EXPAND_HIGHLIGHT;
8245 else if (STRNCMP(last, "icon", p - last) == 0)
8246 xp->xp_context = EXPAND_FILES;
8247 else
8248 xp->xp_context = EXPAND_NOTHING;
8249 break;
8250 case SIGNCMD_PLACE:
8251 if (STRNCMP(last, "name", p - last) == 0)
8252 expand_what = EXP_SIGN_NAMES;
8253 else
8254 xp->xp_context = EXPAND_NOTHING;
8255 break;
8256 default:
8257 xp->xp_context = EXPAND_NOTHING;
8258 }
8259 }
8260}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008261# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008262#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008263
8264/*
8265 * Make the user happy.
8266 */
8267 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008268ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008269{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008270 static char *code[] = {
8271 "\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$",
8272 "\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"
8273 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008274 char *p;
8275 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008276 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008277
8278 msg_start();
8279 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008280 for (i = 0; i < 2; ++i)
8281 for (p = code[i]; *p != NUL; ++p)
8282 if (*p == 'x')
8283 msg_putchar('\n');
8284 else
8285 for (n = *p++; n > 0; --n)
8286 if (*p == 'o' || *p == '$')
8287 msg_putchar_attr(*p, hl_attr(HLF_L));
8288 else
8289 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008290 msg_clr_eos();
8291}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292
8293#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8294/*
8295 * ":drop"
8296 * Opens the first argument in a window. When there are two or more arguments
8297 * the argument list is redefined.
8298 */
8299 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008300ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301{
8302 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 win_T *wp;
8304 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008305# ifdef FEAT_WINDOWS
8306 tabpage_T *tp;
8307# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308
8309 /*
8310 * Check if the first argument is already being edited in a window. If
8311 * so, jump to that window.
8312 * We would actually need to check all arguments, but that's complicated
8313 * and mostly only one file is dropped.
8314 * This also ignores wildcards, since it is very unlikely the user is
8315 * editing a file name with a wildcard character.
8316 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008317 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008319 /*
8320 * Expanding wildcards may result in an empty argument list. E.g. when
8321 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8322 * already did an error message for this.
8323 */
8324 if (ARGCOUNT == 0)
8325 return;
8326
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008327# ifdef FEAT_WINDOWS
8328 if (cmdmod.tab)
8329 {
8330 /* ":tab drop file ...": open a tab for each argument that isn't
8331 * edited in a window yet. It's like ":tab all" but without closing
8332 * windows or tabs. */
8333 ex_all(eap);
8334 }
8335 else
8336# endif
8337 {
8338 /* ":drop file ...": Edit the first argument. Jump to an existing
8339 * window if possible, edit in current window if the current buffer
8340 * can be abandoned, otherwise open a new window. */
8341 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8342
8343 FOR_ALL_TAB_WINDOWS(tp, wp)
8344 {
8345 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008347# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008348 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008349# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 return;
8352 }
8353 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008355 /*
8356 * Check whether the current buffer is changed. If so, we will need
8357 * to split the current window or data could be lost.
8358 * Skip the check if the 'hidden' option is set, as in this case the
8359 * buffer won't be lost.
8360 */
8361 if (!P_HID(curbuf))
8362 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008364 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365# endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008366 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008368 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008370 if (split)
8371 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008373 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008375 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8376 if (split)
8377 {
8378 eap->cmdidx = CMD_sfirst;
8379 eap->cmd[0] = 's';
8380 }
8381 else
8382 eap->cmdidx = CMD_first;
8383 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385}
8386#endif
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008387
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008388/*
8389 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8390 * Put the start of the pattern in "*s", unless "s" is NULL.
8391 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8392 * If "s" is not NULL terminate the pattern with a NUL.
8393 * Return a pointer to the char just past the pattern plus flags.
8394 */
8395 char_u *
8396skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8397{
8398 int c;
8399
8400 if (vim_isIDc(*p))
8401 {
8402 /* ":vimgrep pattern fname" */
8403 if (s != NULL)
8404 *s = p;
8405 p = skiptowhite(p);
8406 if (s != NULL && *p != NUL)
8407 *p++ = NUL;
8408 }
8409 else
8410 {
8411 /* ":vimgrep /pattern/[g][j] fname" */
8412 if (s != NULL)
8413 *s = p + 1;
8414 c = *p;
8415 p = skip_regexp(p + 1, c, TRUE, NULL);
8416 if (*p != c)
8417 return NULL;
8418
8419 /* Truncate the pattern. */
8420 if (s != NULL)
8421 *p = NUL;
8422 ++p;
8423
8424 /* Find the flags */
8425 while (*p == 'g' || *p == 'j')
8426 {
8427 if (flags != NULL)
8428 {
8429 if (*p == 'g')
8430 *flags |= VGR_GLOBAL;
8431 else
8432 *flags |= VGR_NOJUMP;
8433 }
8434 ++p;
8435 }
8436 }
8437 return p;
8438}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008439
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008440#if defined(FEAT_EVAL) || defined(PROTO)
8441/*
8442 * List v:oldfiles in a nice way.
8443 */
8444 void
8445ex_oldfiles(exarg_T *eap UNUSED)
8446{
8447 list_T *l = get_vim_var_list(VV_OLDFILES);
8448 listitem_T *li;
8449 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008450 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008451
8452 if (l == NULL)
8453 msg((char_u *)_("No old files"));
8454 else
8455 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008456 msg_start();
8457 msg_scroll = TRUE;
8458 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8459 {
8460 ++nr;
8461 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008462 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008463 {
8464 msg_outnum((long)nr);
8465 MSG_PUTS(": ");
8466 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02008467 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008468 msg_putchar('\n');
8469 out_flush(); /* output one line at a time */
8470 ui_breakcheck();
8471 }
8472 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008473
8474 /* Assume "got_int" was set to truncate the listing. */
8475 got_int = FALSE;
8476
8477# ifdef FEAT_BROWSE_CMD
8478 if (cmdmod.browse)
8479 {
8480 quit_more = FALSE;
8481 nr = prompt_for_number(FALSE);
8482 msg_starthere();
8483 if (nr > 0)
8484 {
8485 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8486 (long)nr);
8487
8488 if (p != NULL)
8489 {
8490 p = expand_env_save(p);
8491 eap->arg = p;
8492 eap->cmdidx = CMD_edit;
8493 cmdmod.browse = FALSE;
8494 do_exedit(eap, NULL);
8495 vim_free(p);
8496 }
8497 }
8498 }
8499# endif
8500 }
8501}
8502#endif
8503