blob: 8977302740fc3fdee0f9194b2b8d9e3c590e7124 [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
802 int isFolded;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100803 win_T *win;
804 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200805
806 /* Moving lines seems to corrupt the folds, delete folding info now
807 * and recreate it when finished. Don't do this for manual folding, it
808 * would delete all folds. */
809 isFolded = hasAnyFolding(curwin) && !foldmethodIsManual(curwin);
810 if (isFolded)
811 deleteFoldRecurse(&curwin->w_folds);
812#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813
814 if (dest >= line1 && dest < line2)
815 {
816 EMSG(_("E134: Move lines into themselves"));
817 return FAIL;
818 }
819
820 num_lines = line2 - line1 + 1;
821
822 /*
823 * First we copy the old text to its new location -- webb
824 * Also copy the flag that ":global" command uses.
825 */
826 if (u_save(dest, dest + 1) == FAIL)
827 return FAIL;
828 for (extra = 0, l = line1; l <= line2; l++)
829 {
830 str = vim_strsave(ml_get(l + extra));
831 if (str != NULL)
832 {
833 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
834 vim_free(str);
835 if (dest < line1)
836 extra++;
837 }
838 }
839
840 /*
841 * Now we must be careful adjusting our marks so that we don't overlap our
842 * mark_adjust() calls.
843 *
844 * We adjust the marks within the old text so that they refer to the
845 * last lines of the file (temporarily), because we know no other marks
846 * will be set there since these line numbers did not exist until we added
847 * our new lines.
848 *
849 * Then we adjust the marks on lines between the old and new text positions
850 * (either forwards or backwards).
851 *
852 * And Finally we adjust the marks we put at the end of the file back to
853 * their final destination at the new text position -- webb
854 */
855 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100856 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857 if (dest >= line2)
858 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100859 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
860#ifdef FEAT_FOLDING
861 FOR_ALL_TAB_WINDOWS(tp, win) {
862 if (win->w_buffer == curbuf)
863 foldMoveRange(&win->w_folds, line1, line2, dest);
864 }
865#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 curbuf->b_op_start.lnum = dest - num_lines + 1;
867 curbuf->b_op_end.lnum = dest;
868 }
869 else
870 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100871 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
872#ifdef FEAT_FOLDING
873 FOR_ALL_TAB_WINDOWS(tp, win) {
874 if (win->w_buffer == curbuf)
875 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
876 }
877#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 curbuf->b_op_start.lnum = dest + 1;
879 curbuf->b_op_end.lnum = dest + num_lines;
880 }
881 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100882 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 -(last_line - dest - extra), 0L);
884
885 /*
886 * Now we delete the original text -- webb
887 */
888 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
889 return FAIL;
890
891 for (l = line1; l <= line2; l++)
892 ml_delete(line1 + extra, TRUE);
893
894 if (!global_busy && num_lines > p_report)
895 {
896 if (num_lines == 1)
897 MSG(_("1 line moved"));
898 else
899 smsg((char_u *)_("%ld lines moved"), num_lines);
900 }
901
902 /*
903 * Leave the cursor on the last of the moved lines.
904 */
905 if (dest >= line1)
906 curwin->w_cursor.lnum = dest;
907 else
908 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
909
910 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100911 {
912 dest += num_lines + 1;
913 last_line = curbuf->b_ml.ml_line_count;
914 if (dest > last_line + 1)
915 dest = last_line + 1;
916 changed_lines(line1, 0, dest, 0L);
917 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918 else
919 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
920
Bram Moolenaard5f69332015-04-15 12:43:50 +0200921#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100922 /* recreate folds */
923 if (isFolded)
924 foldUpdateAll(curwin);
Bram Moolenaard5f69332015-04-15 12:43:50 +0200925#endif
926
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 return OK;
928}
929
930/*
931 * ":copy"
932 */
933 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100934ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935{
936 linenr_T count;
937 char_u *p;
938
939 count = line2 - line1 + 1;
940 curbuf->b_op_start.lnum = n + 1;
941 curbuf->b_op_end.lnum = n + count;
942 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
943
944 /*
945 * there are three situations:
946 * 1. destination is above line1
947 * 2. destination is between line1 and line2
948 * 3. destination is below line2
949 *
950 * n = destination (when starting)
951 * curwin->w_cursor.lnum = destination (while copying)
952 * line1 = start of source (while copying)
953 * line2 = end of source (while copying)
954 */
955 if (u_save(n, n + 1) == FAIL)
956 return;
957
958 curwin->w_cursor.lnum = n;
959 while (line1 <= line2)
960 {
961 /* need to use vim_strsave() because the line will be unlocked within
962 * ml_append() */
963 p = vim_strsave(ml_get(line1));
964 if (p != NULL)
965 {
966 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
967 vim_free(p);
968 }
969 /* situation 2: skip already copied lines */
970 if (line1 == n)
971 line1 = curwin->w_cursor.lnum;
972 ++line1;
973 if (curwin->w_cursor.lnum < line1)
974 ++line1;
975 if (curwin->w_cursor.lnum < line2)
976 ++line2;
977 ++curwin->w_cursor.lnum;
978 }
979
980 appended_lines_mark(n, count);
981
982 msgmore((long)count);
983}
984
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000985static char_u *prevcmd = NULL; /* the previous command */
986
987#if defined(EXITFREE) || defined(PROTO)
988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100989free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000990{
991 vim_free(prevcmd);
992}
993#endif
994
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995/*
996 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
997 * Bangs in the argument are replaced with the previously entered command.
998 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 */
1000 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001001do_bang(
1002 int addr_count,
1003 exarg_T *eap,
1004 int forceit,
1005 int do_in,
1006 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007{
1008 char_u *arg = eap->arg; /* command */
1009 linenr_T line1 = eap->line1; /* start of range */
1010 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 char_u *newcmd = NULL; /* the new command */
1012 int free_newcmd = FALSE; /* need to free() newcmd */
1013 int ins_prevcmd;
1014 char_u *t;
1015 char_u *p;
1016 char_u *trailarg;
1017 int len;
1018 int scroll_save = msg_scroll;
1019
1020 /*
1021 * Disallow shell commands for "rvim".
1022 * Disallow shell commands from .exrc and .vimrc in current directory for
1023 * security reasons.
1024 */
1025 if (check_restricted() || check_secure())
1026 return;
1027
1028 if (addr_count == 0) /* :! */
1029 {
1030 msg_scroll = FALSE; /* don't scroll here */
1031 autowrite_all();
1032 msg_scroll = scroll_save;
1033 }
1034
1035 /*
1036 * Try to find an embedded bang, like in :!<cmd> ! [args]
1037 * (:!! is indicated by the 'forceit' variable)
1038 */
1039 ins_prevcmd = forceit;
1040 trailarg = arg;
1041 do
1042 {
1043 len = (int)STRLEN(trailarg) + 1;
1044 if (newcmd != NULL)
1045 len += (int)STRLEN(newcmd);
1046 if (ins_prevcmd)
1047 {
1048 if (prevcmd == NULL)
1049 {
1050 EMSG(_(e_noprev));
1051 vim_free(newcmd);
1052 return;
1053 }
1054 len += (int)STRLEN(prevcmd);
1055 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001056 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 {
1058 vim_free(newcmd);
1059 return;
1060 }
1061 *t = NUL;
1062 if (newcmd != NULL)
1063 STRCAT(t, newcmd);
1064 if (ins_prevcmd)
1065 STRCAT(t, prevcmd);
1066 p = t + STRLEN(t);
1067 STRCAT(t, trailarg);
1068 vim_free(newcmd);
1069 newcmd = t;
1070
1071 /*
1072 * Scan the rest of the argument for '!', which is replaced by the
1073 * previous command. "\!" is replaced by "!" (this is vi compatible).
1074 */
1075 trailarg = NULL;
1076 while (*p)
1077 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001078 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 {
1080 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001081 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 else
1083 {
1084 trailarg = p;
1085 *trailarg++ = NUL;
1086 ins_prevcmd = TRUE;
1087 break;
1088 }
1089 }
1090 ++p;
1091 }
1092 } while (trailarg != NULL);
1093
1094 vim_free(prevcmd);
1095 prevcmd = newcmd;
1096
1097 if (bangredo) /* put cmd in redo buffer for ! command */
1098 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001099 /* If % or # appears in the command, it must have been escaped.
1100 * Reescape them, so that redoing them does not substitute them by the
1101 * buffername. */
1102 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1103
1104 if (cmd != NULL)
1105 {
1106 AppendToRedobuffLit(cmd, -1);
1107 vim_free(cmd);
1108 }
1109 else
1110 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 AppendToRedobuff((char_u *)"\n");
1112 bangredo = FALSE;
1113 }
1114 /*
1115 * Add quotes around the command, for shells that need them.
1116 */
1117 if (*p_shq != NUL)
1118 {
1119 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1120 if (newcmd == NULL)
1121 return;
1122 STRCPY(newcmd, p_shq);
1123 STRCAT(newcmd, prevcmd);
1124 STRCAT(newcmd, p_shq);
1125 free_newcmd = TRUE;
1126 }
1127 if (addr_count == 0) /* :! */
1128 {
1129 /* echo the command */
1130 msg_start();
1131 msg_putchar(':');
1132 msg_putchar('!');
1133 msg_outtrans(newcmd);
1134 msg_clr_eos();
1135 windgoto(msg_row, msg_col);
1136
1137 do_shell(newcmd, 0);
1138 }
1139 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001140 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 /* Careful: This may recursively call do_bang() again! (because of
1142 * autocommands) */
1143 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001144#ifdef FEAT_AUTOCMD
1145 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1146#endif
1147 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 if (free_newcmd)
1149 vim_free(newcmd);
1150}
1151
1152/*
1153 * do_filter: filter lines through a command given by the user
1154 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001155 * We mostly use temp files and the call_shell() routine here. This would
1156 * normally be done using pipes on a UNIX machine, but this is more portable
1157 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 * to deal with redirection somehow, and should handle things like looking
1159 * at the PATH env. variable, and adding reasonable extensions to the
1160 * command name given by the user. All reasonable versions of call_shell()
1161 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001162 * Alternatively, if on Unix and redirecting input or output, but not both,
1163 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 * We use input redirection if do_in is TRUE.
1165 * We use output redirection if do_out is TRUE.
1166 */
1167 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001168do_filter(
1169 linenr_T line1,
1170 linenr_T line2,
1171 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1172 char_u *cmd,
1173 int do_in,
1174 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175{
1176 char_u *itmp = NULL;
1177 char_u *otmp = NULL;
1178 linenr_T linecount;
1179 linenr_T read_linecount;
1180 pos_T cursor_save;
1181 char_u *cmd_buf;
1182#ifdef FEAT_AUTOCMD
1183 buf_T *old_curbuf = curbuf;
1184#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001185 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186
1187 if (*cmd == NUL) /* no filter command */
1188 return;
1189
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 cursor_save = curwin->w_cursor;
1191 linecount = line2 - line1 + 1;
1192 curwin->w_cursor.lnum = line1;
1193 curwin->w_cursor.col = 0;
1194 changed_line_abv_curs();
1195 invalidate_botline();
1196
1197 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001198 * When using temp files:
1199 * 1. * Form temp file names
1200 * 2. * Write the lines to a temp file
1201 * 3. Run the filter command on the temp file
1202 * 4. * Read the output of the command into the buffer
1203 * 5. * Delete the original lines to be filtered
1204 * 6. * Remove the temp files
1205 *
1206 * When writing the input with a pipe or when catching the output with a
1207 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 */
1209
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001210 if (do_out)
1211 shell_flags |= SHELL_DOOUT;
1212
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001213#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001214 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001216 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1217 shell_flags |= SHELL_READ;
1218 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001220 else if (do_in && !do_out && !p_stmp)
1221 {
1222 /* Use a pipe to write stdin of the command, do not use a temp file. */
1223 shell_flags |= SHELL_WRITE;
1224 curbuf->b_op_start.lnum = line1;
1225 curbuf->b_op_end.lnum = line2;
1226 }
1227 else if (do_in && do_out && !p_stmp)
1228 {
1229 /* Use a pipe to write stdin and fetch stdout of the command, do not
1230 * use a temp file. */
1231 shell_flags |= SHELL_READ|SHELL_WRITE;
1232 curbuf->b_op_start.lnum = line1;
1233 curbuf->b_op_end.lnum = line2;
1234 curwin->w_cursor.lnum = line2;
1235 }
1236 else
1237#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001238 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1239 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001240 {
1241 EMSG(_(e_notmp));
1242 goto filterend;
1243 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244
1245/*
1246 * The writing and reading of temp files will not be shown.
1247 * Vi also doesn't do this and the messages are not very informative.
1248 */
1249 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001250 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 FALSE, FALSE, FALSE, TRUE) == FAIL)
1252 {
1253 msg_putchar('\n'); /* keep message from buf_write() */
1254 --no_wait_return;
1255#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1256 if (!aborting())
1257#endif
1258 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1259 goto filterend;
1260 }
1261#ifdef FEAT_AUTOCMD
1262 if (curbuf != old_curbuf)
1263 goto filterend;
1264#endif
1265
1266 if (!do_out)
1267 msg_putchar('\n');
1268
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001269 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1271 if (cmd_buf == NULL)
1272 goto filterend;
1273
1274 windgoto((int)Rows - 1, 0);
1275 cursor_on();
1276
1277 /*
1278 * When not redirecting the output the command can write anything to the
1279 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1280 * stderr output of external command. Clear the screen later.
1281 * If do_in is FALSE, this could be something like ":r !cat", which may
1282 * also mess up the screen, clear it later.
1283 */
1284 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1285 redraw_later_clear();
1286
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001287 if (do_out)
1288 {
1289 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001290 {
1291 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001292 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001293 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001294 redraw_curbuf_later(VALID);
1295 }
1296 read_linecount = curbuf->b_ml.ml_line_count;
1297
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 /*
1299 * When call_shell() fails wait_return() is called to give the user a
1300 * chance to read the error messages. Otherwise errors are ignored, so you
1301 * can see the error messages from the command that appear on stdout; use
1302 * 'u' to fix the text
1303 * Switch to cooked mode when not redirecting stdin, avoids that something
1304 * like ":r !cat" hangs.
1305 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1306 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001307 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 {
1309 redraw_later_clear();
1310 wait_return(FALSE);
1311 }
1312 vim_free(cmd_buf);
1313
1314 did_check_timestamps = FALSE;
1315 need_check_timestamps = TRUE;
1316
1317 /* When interrupting the shell command, it may still have produced some
1318 * useful output. Reset got_int here, so that readfile() won't cancel
1319 * reading. */
1320 ui_breakcheck();
1321 got_int = FALSE;
1322
1323 if (do_out)
1324 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001325 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001327 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001328 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001330#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1331 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001333 {
1334 msg_putchar('\n');
1335 EMSG2(_(e_notread), otmp);
1336 }
1337 goto error;
1338 }
1339#ifdef FEAT_AUTOCMD
1340 if (curbuf != old_curbuf)
1341 goto filterend;
1342#endif
1343 }
1344
1345 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1346
1347 if (shell_flags & SHELL_READ)
1348 {
1349 curbuf->b_op_start.lnum = line2 + 1;
1350 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1351 appended_lines_mark(line2, read_linecount);
1352 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353
1354 if (do_in)
1355 {
1356 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1357 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 if (read_linecount >= linecount)
1359 /* move all marks from old lines to new lines */
1360 mark_adjust(line1, line2, linecount, 0L);
1361 else
1362 {
1363 /* move marks from old lines to new lines, delete marks
1364 * that are in deleted lines */
1365 mark_adjust(line1, line1 + read_linecount - 1,
1366 linecount, 0L);
1367 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1368 }
1369 }
1370
1371 /*
1372 * Put cursor on first filtered line for ":range!cmd".
1373 * Adjust '[ and '] (set by buf_write()).
1374 */
1375 curwin->w_cursor.lnum = line1;
1376 del_lines(linecount, TRUE);
1377 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1378 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1379 write_lnum_adjust(-linecount); /* adjust last line
1380 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001381#ifdef FEAT_FOLDING
1382 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1383#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 }
1385 else
1386 {
1387 /*
1388 * Put cursor on last new line for ":r !cmd".
1389 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001391 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001393
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1395 --no_wait_return;
1396
1397 if (linecount > p_report)
1398 {
1399 if (do_in)
1400 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001401 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1402 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001405 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 }
1407 else
1408 msgmore((long)linecount);
1409 }
1410 }
1411 else
1412 {
1413error:
1414 /* put cursor back in same position for ":w !cmd" */
1415 curwin->w_cursor = cursor_save;
1416 --no_wait_return;
1417 wait_return(FALSE);
1418 }
1419
1420filterend:
1421
1422#ifdef FEAT_AUTOCMD
1423 if (curbuf != old_curbuf)
1424 {
1425 --no_wait_return;
1426 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1427 }
1428#endif
1429 if (itmp != NULL)
1430 mch_remove(itmp);
1431 if (otmp != NULL)
1432 mch_remove(otmp);
1433 vim_free(itmp);
1434 vim_free(otmp);
1435}
1436
1437/*
1438 * Call a shell to execute a command.
1439 * When "cmd" is NULL start an interactive shell.
1440 */
1441 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001442do_shell(
1443 char_u *cmd,
1444 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445{
1446 buf_T *buf;
1447#ifndef FEAT_GUI_MSWIN
1448 int save_nwr;
1449#endif
1450#ifdef MSWIN
1451 int winstart = FALSE;
1452#endif
1453
1454 /*
1455 * Disallow shell commands for "rvim".
1456 * Disallow shell commands from .exrc and .vimrc in current directory for
1457 * security reasons.
1458 */
1459 if (check_restricted() || check_secure())
1460 {
1461 msg_end();
1462 return;
1463 }
1464
1465#ifdef MSWIN
1466 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 * Check if ":!start" is used.
1468 */
1469 if (cmd != NULL)
1470 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1471#endif
1472
1473 /*
1474 * For autocommands we want to get the output on the current screen, to
1475 * avoid having to type return below.
1476 */
1477 msg_putchar('\r'); /* put cursor at start of line */
1478#ifdef FEAT_AUTOCMD
1479 if (!autocmd_busy)
1480#endif
1481 {
1482#ifdef MSWIN
1483 if (!winstart)
1484#endif
1485 stoptermcap();
1486 }
1487#ifdef MSWIN
1488 if (!winstart)
1489#endif
1490 msg_putchar('\n'); /* may shift screen one line up */
1491
1492 /* warning message before calling the shell */
1493 if (p_warn
1494#ifdef FEAT_AUTOCMD
1495 && !autocmd_busy
1496#endif
1497 && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001498 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 if (bufIsChanged(buf))
1500 {
1501#ifdef FEAT_GUI_MSWIN
1502 if (!winstart)
1503 starttermcap(); /* don't want a message box here */
1504#endif
1505 MSG_PUTS(_("[No write since last change]\n"));
1506#ifdef FEAT_GUI_MSWIN
1507 if (!winstart)
1508 stoptermcap();
1509#endif
1510 break;
1511 }
1512
1513 /* This windgoto is required for when the '\n' resulted in a "delete line
1514 * 1" command to the terminal. */
1515 if (!swapping_screen())
1516 windgoto(msg_row, msg_col);
1517 cursor_on();
1518 (void)call_shell(cmd, SHELL_COOKED | flags);
1519 did_check_timestamps = FALSE;
1520 need_check_timestamps = TRUE;
1521
1522 /*
1523 * put the message cursor at the end of the screen, avoids wait_return()
1524 * to overwrite the text that the external command showed
1525 */
1526 if (!swapping_screen())
1527 {
1528 msg_row = Rows - 1;
1529 msg_col = 0;
1530 }
1531
1532#ifdef FEAT_AUTOCMD
1533 if (autocmd_busy)
1534 {
1535 if (msg_silent == 0)
1536 redraw_later_clear();
1537 }
1538 else
1539#endif
1540 {
1541 /*
1542 * For ":sh" there is no need to call wait_return(), just redraw.
1543 * Also for the Win32 GUI (the output is in a console window).
1544 * Otherwise there is probably text on the screen that the user wants
1545 * to read before redrawing, so call wait_return().
1546 */
1547#ifndef FEAT_GUI_MSWIN
1548 if (cmd == NULL
1549# ifdef WIN3264
1550 || (winstart && !need_wait_return)
1551# endif
1552 )
1553 {
1554 if (msg_silent == 0)
1555 redraw_later_clear();
1556 need_wait_return = FALSE;
1557 }
1558 else
1559 {
1560 /*
1561 * If we switch screens when starttermcap() is called, we really
1562 * want to wait for "hit return to continue".
1563 */
1564 save_nwr = no_wait_return;
1565 if (swapping_screen())
1566 no_wait_return = FALSE;
1567# ifdef AMIGA
1568 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1569# else
1570 wait_return(msg_silent == 0);
1571# endif
1572 no_wait_return = save_nwr;
1573 }
1574#endif /* FEAT_GUI_W32 */
1575
1576#ifdef MSWIN
1577 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1578#endif
1579 starttermcap(); /* start termcap if not done by wait_return() */
1580
1581 /*
1582 * In an Amiga window redrawing is caused by asking the window size.
1583 * If we got an interrupt this will not work. The chance that the
1584 * window size is wrong is very small, but we need to redraw the
1585 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1586 * but it saves an extra redraw.
1587 */
1588#ifdef AMIGA
1589 if (skip_redraw) /* ':' hit in wait_return() */
1590 {
1591 if (msg_silent == 0)
1592 redraw_later_clear();
1593 }
1594 else if (term_console)
1595 {
1596 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1597 if (got_int && msg_silent == 0)
1598 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1599 else
1600 must_redraw = 0; /* no extra redraw needed */
1601 }
1602#endif
1603 }
1604
1605 /* display any error messages now */
1606 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001607
1608#ifdef FEAT_AUTOCMD
1609 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1610#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611}
1612
1613/*
1614 * Create a shell command from a command string, input redirection file and
1615 * output redirection file.
1616 * Returns an allocated string with the shell command, or NULL for failure.
1617 */
1618 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001619make_filter_cmd(
1620 char_u *cmd, /* command */
1621 char_u *itmp, /* NULL or name of input file */
1622 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623{
1624 char_u *buf;
1625 long_u len;
1626
Bram Moolenaar53076832015-12-31 19:53:21 +01001627#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001628 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001629 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001630
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001631 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001632 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1633 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001634 if (is_fish_shell)
1635 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1636 else
1637#endif
1638 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 if (itmp != NULL)
1640 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1641 if (otmp != NULL)
1642 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1643 buf = lalloc(len, TRUE);
1644 if (buf == NULL)
1645 return NULL;
1646
Bram Moolenaar53076832015-12-31 19:53:21 +01001647#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001649 * Put braces around the command (for concatenated commands) when
1650 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001652 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001653 {
1654 if (is_fish_shell)
1655 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1656 else
1657 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1658 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001659 else
1660 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 if (itmp != NULL)
1662 {
1663 STRCAT(buf, " < ");
1664 STRCAT(buf, itmp);
1665 }
1666#else
1667 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001668 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 * the use of commands in a pipe.
1670 */
1671 STRCPY(buf, cmd);
1672 if (itmp != NULL)
1673 {
1674 char_u *p;
1675
1676 /*
1677 * If there is a pipe, we have to put the '<' in front of it.
1678 * Don't do this when 'shellquote' is not empty, otherwise the
1679 * redirection would be inside the quotes.
1680 */
1681 if (*p_shq == NUL)
1682 {
1683 p = vim_strchr(buf, '|');
1684 if (p != NULL)
1685 *p = NUL;
1686 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1688 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 if (*p_shq == NUL)
1690 {
1691 p = vim_strchr(cmd, '|');
1692 if (p != NULL)
1693 {
1694 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1695 STRCAT(buf, p);
1696 }
1697 }
1698 }
1699#endif
1700 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001701 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702
1703 return buf;
1704}
1705
1706/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001707 * Append output redirection for file "fname" to the end of string buffer
1708 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 * Works with the 'shellredir' and 'shellpipe' options.
1710 * The caller should make sure that there is enough room:
1711 * STRLEN(opt) + STRLEN(fname) + 3
1712 */
1713 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001714append_redir(
1715 char_u *buf,
1716 int buflen,
1717 char_u *opt,
1718 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719{
1720 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001721 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001723 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001724 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001726 {
1727 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001729 if (p[1] == '%') /* skip %% */
1730 ++p;
1731 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 if (p != NULL)
1733 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001734 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1735 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1736 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 }
1738 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001739 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 " %s %s",
1742#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744#endif
1745 (char *)opt, (char *)fname);
1746}
1747
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001748#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001750static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001751static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001752static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001753static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754static int viminfo_errcnt;
1755
1756 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001757no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758{
1759 /* "vim -i NONE" does not read or write a viminfo file */
1760 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1761}
1762
1763/*
1764 * Report an error for reading a viminfo file.
1765 * Count the number of errors. When there are more than 10, return TRUE.
1766 */
1767 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001768viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001770 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1771 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001772 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001773 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1774 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 emsg(IObuff);
1776 if (++viminfo_errcnt >= 10)
1777 {
1778 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1779 return TRUE;
1780 }
1781 return FALSE;
1782}
1783
1784/*
1785 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001786 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 */
1788 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001789read_viminfo(
1790 char_u *file, /* file name or NULL to use default name */
1791 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792{
1793 FILE *fp;
1794 char_u *fname;
1795
1796 if (no_viminfo())
1797 return FAIL;
1798
Bram Moolenaard812df62008-11-09 12:46:09 +00001799 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 if (fname == NULL)
1801 return FAIL;
1802 fp = mch_fopen((char *)fname, READBIN);
1803
1804 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001805 {
1806 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001807 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1808 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001809 (flags & VIF_WANT_INFO) ? _(" info") : "",
1810 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1811 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001812 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001813 verbose_leave();
1814 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815
1816 vim_free(fname);
1817 if (fp == NULL)
1818 return FAIL;
1819
1820 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001821 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822
1823 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 return OK;
1825}
1826
1827/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001828 * Write the viminfo file. The old one is read in first so that effectively a
1829 * merge of current info and old info is done. This allows multiple vims to
1830 * run simultaneously, without losing any marks etc.
1831 * If "forceit" is TRUE, then the old file is not read in, and only internal
1832 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 */
1834 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001835write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836{
1837 char_u *fname;
1838 FILE *fp_in = NULL; /* input viminfo file, if any */
1839 FILE *fp_out = NULL; /* output viminfo file */
1840 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001841 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 char_u *wp;
1843#if defined(UNIX) || defined(VMS)
1844 mode_t umask_save;
1845#endif
1846#ifdef UNIX
1847 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001848 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001850#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001851 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001852#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853
1854 if (no_viminfo())
1855 return;
1856
1857 fname = viminfo_filename(file); /* may set to default if NULL */
1858 if (fname == NULL)
1859 return;
1860
1861 fp_in = mch_fopen((char *)fname, READBIN);
1862 if (fp_in == NULL)
1863 {
1864 /* if it does exist, but we can't read it, don't try writing */
1865 if (mch_stat((char *)fname, &st_new) == 0)
1866 goto end;
1867#if defined(UNIX) || defined(VMS)
1868 /*
1869 * For Unix we create the .viminfo non-accessible for others,
1870 * because it may contain text from non-accessible documents.
1871 */
1872 umask_save = umask(077);
1873#endif
1874 fp_out = mch_fopen((char *)fname, WRITEBIN);
1875#if defined(UNIX) || defined(VMS)
1876 (void)umask(umask_save);
1877#endif
1878 }
1879 else
1880 {
1881 /*
1882 * There is an existing viminfo file. Create a temporary file to
1883 * write the new viminfo into, in the same directory as the
1884 * existing viminfo file, which will be renamed later.
1885 */
1886#ifdef UNIX
1887 /*
1888 * For Unix we check the owner of the file. It's not very nice to
1889 * overwrite a user's viminfo file after a "su root", with a
1890 * viminfo file that the user can't read.
1891 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001892 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001893 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001895 if (mch_stat((char *)fname, &st_old) == 0
1896 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001897 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 ? (st_old.st_mode & 0200)
1899 : (st_old.st_gid == getgid()
1900 ? (st_old.st_mode & 0020)
1901 : (st_old.st_mode & 0002))))
1902 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001903 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904
1905 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1907 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001908 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 goto end;
1910 }
1911#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001912#ifdef WIN3264
1913 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001914 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001915#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916
1917 /*
1918 * Make tempname.
1919 * May try twice: Once normal and once with shortname set, just in
1920 * case somebody puts his viminfo file in an 8.3 filesystem.
1921 */
1922 for (;;)
1923 {
1924 tempname = buf_modname(
1925#ifdef UNIX
1926 shortname,
1927#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929#endif
1930 fname,
1931#ifdef VMS
1932 (char_u *)"-tmp",
1933#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935#endif
1936 FALSE);
1937 if (tempname == NULL) /* out of memory */
1938 break;
1939
1940 /*
1941 * Check if tempfile already exists. Never overwrite an
1942 * existing file!
1943 */
1944 if (mch_stat((char *)tempname, &st_new) == 0)
1945 {
1946#ifdef UNIX
1947 /*
1948 * Check if tempfile is same as original file. May happen
1949 * when modname() gave the same file back. E.g. silly
1950 * link, or file name-length reached. Try again with
1951 * shortname set.
1952 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001953 if (!shortname && st_new.st_dev == st_old.st_dev
1954 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 {
1956 vim_free(tempname);
1957 tempname = NULL;
1958 shortname = TRUE;
1959 continue;
1960 }
1961#endif
1962 /*
1963 * Try another name. Change one character, just before
1964 * the extension. This should also work for an 8.3
1965 * file name, when after adding the extension it still is
1966 * the same file as the original.
1967 */
1968 wp = tempname + STRLEN(tempname) - 5;
1969 if (wp < gettail(tempname)) /* empty file name? */
1970 wp = gettail(tempname);
1971 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1972 --*wp)
1973 {
1974 /*
1975 * They all exist? Must be something wrong! Don't
1976 * write the viminfo file then.
1977 */
1978 if (*wp == 'a')
1979 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001980 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1981 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 vim_free(tempname);
1983 tempname = NULL;
1984 break;
1985 }
1986 }
1987 }
1988 break;
1989 }
1990
1991 if (tempname != NULL)
1992 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001993#ifdef VMS
1994 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001995 umask_save = umask(077);
1996 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1997 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001998#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001999 int fd;
2000
2001 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002002 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002003 * Unix: same as original file, but strip s-bit. Reset umask to
2004 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002005 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00002006# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002007 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00002008 fd = mch_open((char *)tempname,
2009 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002010 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002011 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002012# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002013 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002014 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002015# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002016 if (fd < 0)
2017 fp_out = NULL;
2018 else
2019 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002020#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
2022 /*
2023 * If we can't create in the same directory, try creating a
2024 * "normal" temp file.
2025 */
2026 if (fp_out == NULL)
2027 {
2028 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002029 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2031 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002032
2033#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002035 * Make sure the owner can read/write it. This only works for
2036 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 */
2038 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002039 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040#endif
2041 }
2042 }
2043
2044 /*
2045 * Check if the new viminfo file can be written to.
2046 */
2047 if (fp_out == NULL)
2048 {
2049 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002050 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 if (fp_in != NULL)
2052 fclose(fp_in);
2053 goto end;
2054 }
2055
2056 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002057 {
2058 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002059 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002060 verbose_leave();
2061 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062
2063 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002064 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065
Bram Moolenaar927030a2016-03-15 18:23:55 +01002066 if (fclose(fp_out) == EOF)
2067 ++viminfo_errcnt;
2068
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 if (fp_in != NULL)
2070 {
2071 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002072
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002073 /* In case of an error keep the original viminfo file. Otherwise
2074 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002075 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002076 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002077 if (vim_rename(tempname, fname) == -1)
2078 {
2079 ++viminfo_errcnt;
2080 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2081 }
2082# ifdef WIN3264
2083 /* If the viminfo file was hidden then also hide the new file. */
2084 else if (hidden)
2085 mch_hide(fname);
2086# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002087 }
2088 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 mch_remove(tempname);
2090 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002091
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092end:
2093 vim_free(fname);
2094 vim_free(tempname);
2095}
2096
2097/*
2098 * Get the viminfo file name to use.
2099 * If "file" is given and not empty, use it (has already been expanded by
2100 * cmdline functions).
2101 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2102 * expand environment variables.
2103 * Returns an allocated string. NULL when out of memory.
2104 */
2105 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002106viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107{
2108 if (file == NULL || *file == NUL)
2109 {
2110 if (use_viminfo != NULL)
2111 file = use_viminfo;
2112 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2113 {
2114#ifdef VIMINFO_FILE2
2115 /* don't use $HOME when not defined (turned into "c:/"!). */
2116# ifdef VMS
2117 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2118# else
2119 if (mch_getenv((char_u *)"HOME") == NULL)
2120# endif
2121 {
2122 /* don't use $VIM when not available. */
2123 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2124 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2125 file = (char_u *)VIMINFO_FILE2;
2126 else
2127 file = (char_u *)VIMINFO_FILE;
2128 }
2129 else
2130#endif
2131 file = (char_u *)VIMINFO_FILE;
2132 }
2133 expand_env(file, NameBuff, MAXPATHL);
2134 file = NameBuff;
2135 }
2136 return vim_strsave(file);
2137}
2138
2139/*
2140 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2141 */
2142 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002143do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 int eof = FALSE;
2146 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002147 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002148 int do_copy_marks = FALSE;
2149 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150
2151 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2152 return;
2153 vir.vir_fd = fp_in;
2154#ifdef FEAT_MBYTE
2155 vir.vir_conv.vc_type = CONV_NONE;
2156#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002157 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002158 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159
2160 if (fp_in != NULL)
2161 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002162 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002163 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002164 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002165 {
2166 /* Registers and marks are read and kept separate from what
2167 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002168 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002169 prepare_viminfo_marks();
2170 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002171
Bram Moolenaard812df62008-11-09 12:46:09 +00002172 eof = read_viminfo_up_to_marks(&vir,
2173 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002174 merge = TRUE;
2175 }
2176 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 /* Skip info, find start of marks */
2178 while (!(eof = viminfo_readline(&vir))
2179 && vir.vir_line[0] != '>')
2180 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002181
2182 do_copy_marks = (flags &
2183 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002185
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 if (fp_out != NULL)
2187 {
2188 /* Write the info: */
2189 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2190 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002191 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002192 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002194 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2196#endif
2197 write_viminfo_search_pattern(fp_out);
2198 write_viminfo_sub_string(fp_out);
2199#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002200 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201#endif
2202 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002203 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204#ifdef FEAT_EVAL
2205 write_viminfo_varlist(fp_out);
2206#endif
2207 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002208 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002210 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002211
2212 if (do_copy_marks)
2213 ga_init2(&buflist, sizeof(buf_T *), 50);
2214 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002216
2217 if (do_copy_marks)
2218 {
2219 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2220 if (fp_out != NULL)
2221 ga_clear(&buflist);
2222 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223
2224 vim_free(vir.vir_line);
2225#ifdef FEAT_MBYTE
2226 if (vir.vir_conv.vc_type != CONV_NONE)
2227 convert_setup(&vir.vir_conv, NULL, NULL);
2228#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002229 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230}
2231
2232/*
2233 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2234 * first part of the viminfo file which contains everything but the marks that
2235 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2236 */
2237 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002238read_viminfo_up_to_marks(
2239 vir_T *virp,
2240 int forceit,
2241 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242{
2243 int eof;
2244 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002245 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246
2247#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002248 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002250
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 eof = viminfo_readline(virp);
2252 while (!eof && virp->vir_line[0] != '>')
2253 {
2254 switch (virp->vir_line[0])
2255 {
2256 /* Characters reserved for future expansion, ignored now */
2257 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 case '^': /* to be defined */
2259 case '<': /* long line - ignored */
2260 /* A comment or empty line. */
2261 case NUL:
2262 case '\r':
2263 case '\n':
2264 case '#':
2265 eof = viminfo_readline(virp);
2266 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002267 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002268 eof = read_viminfo_barline(virp, got_encoding,
2269 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002270 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002272 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 eof = viminfo_encoding(virp);
2274 break;
2275 case '!': /* global variable */
2276#ifdef FEAT_EVAL
2277 eof = read_viminfo_varlist(virp, writing);
2278#else
2279 eof = viminfo_readline(virp);
2280#endif
2281 break;
2282 case '%': /* entry for buffer list */
2283 eof = read_viminfo_bufferlist(virp, writing);
2284 break;
2285 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002286 /* When registers are in bar lines skip the old style register
2287 * lines. */
2288 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2289 eof = read_viminfo_register(virp, forceit);
2290 else
2291 do {
2292 eof = viminfo_readline(virp);
2293 } while (!eof && (virp->vir_line[0] == TAB
2294 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 break;
2296 case '/': /* Search string */
2297 case '&': /* Substitute search string */
2298 case '~': /* Last search string, followed by '/' or '&' */
2299 eof = read_viminfo_search_pattern(virp, forceit);
2300 break;
2301 case '$':
2302 eof = read_viminfo_sub_string(virp, forceit);
2303 break;
2304 case ':':
2305 case '?':
2306 case '=':
2307 case '@':
2308#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002309 /* When history is in bar lines skip the old style history
2310 * lines. */
2311 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2312 eof = read_viminfo_history(virp, writing);
2313 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002315 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 break;
2317 case '-':
2318 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002319 /* When file marks are in bar lines skip the old style lines. */
2320 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2321 eof = read_viminfo_filemark(virp, forceit);
2322 else
2323 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 break;
2325 default:
2326 if (viminfo_error("E575: ", _("Illegal starting char"),
2327 virp->vir_line))
2328 eof = TRUE;
2329 else
2330 eof = viminfo_readline(virp);
2331 break;
2332 }
2333 }
2334
2335#ifdef FEAT_CMDHIST
2336 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002337 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002338 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339#endif
2340
2341 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002342 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343 fmarks_check_names(buf);
2344
2345 return eof;
2346}
2347
2348/*
2349 * Compare the 'encoding' value in the viminfo file with the current value of
2350 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2351 * conversion of text with iconv() in viminfo_readstring().
2352 */
2353 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002354viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355{
2356#ifdef FEAT_MBYTE
2357 char_u *p;
2358 int i;
2359
2360 if (get_viminfo_parameter('c') != 0)
2361 {
2362 p = vim_strchr(virp->vir_line, '=');
2363 if (p != NULL)
2364 {
2365 /* remove trailing newline */
2366 ++p;
2367 for (i = 0; vim_isprintc(p[i]); ++i)
2368 ;
2369 p[i] = NUL;
2370
2371 convert_setup(&virp->vir_conv, p, p_enc);
2372 }
2373 }
2374#endif
2375 return viminfo_readline(virp);
2376}
2377
2378/*
2379 * Read a line from the viminfo file.
2380 * Returns TRUE for end-of-file;
2381 */
2382 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002383viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384{
2385 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2386}
2387
2388/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002389 * Check string read from viminfo file.
2390 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 * - replace CTRL-V CTRL-V with CTRL-V
2392 * - replace CTRL-V 'n' with '\n'
2393 *
2394 * Check for a long line as written by viminfo_writestring().
2395 *
2396 * Return the string in allocated memory (NULL when out of memory).
2397 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002399viminfo_readstring(
2400 vir_T *virp,
2401 int off, /* offset for virp->vir_line */
2402 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403{
2404 char_u *retval;
2405 char_u *s, *d;
2406 long len;
2407
2408 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2409 {
2410 len = atol((char *)virp->vir_line + off + 1);
2411 retval = lalloc(len, TRUE);
2412 if (retval == NULL)
2413 {
2414 /* Line too long? File messed up? Skip next line. */
2415 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2416 return NULL;
2417 }
2418 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2419 s = retval + 1; /* Skip the leading '<' */
2420 }
2421 else
2422 {
2423 retval = vim_strsave(virp->vir_line + off);
2424 if (retval == NULL)
2425 return NULL;
2426 s = retval;
2427 }
2428
2429 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2430 d = retval;
2431 while (*s != NUL && *s != '\n')
2432 {
2433 if (s[0] == Ctrl_V && s[1] != NUL)
2434 {
2435 if (s[1] == 'n')
2436 *d++ = '\n';
2437 else
2438 *d++ = Ctrl_V;
2439 s += 2;
2440 }
2441 else
2442 *d++ = *s++;
2443 }
2444 *d = NUL;
2445
2446#ifdef FEAT_MBYTE
2447 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2448 {
2449 d = string_convert(&virp->vir_conv, retval, NULL);
2450 if (d != NULL)
2451 {
2452 vim_free(retval);
2453 retval = d;
2454 }
2455 }
2456#endif
2457
2458 return retval;
2459}
2460
2461/*
2462 * write string to viminfo file
2463 * - replace CTRL-V with CTRL-V CTRL-V
2464 * - replace '\n' with CTRL-V 'n'
2465 * - add a '\n' at the end
2466 *
2467 * For a long line:
2468 * - write " CTRL-V <length> \n " in first line
2469 * - write " < <string> \n " in second line
2470 */
2471 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002472viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473{
2474 int c;
2475 char_u *s;
2476 int len = 0;
2477
2478 for (s = p; *s != NUL; ++s)
2479 {
2480 if (*s == Ctrl_V || *s == '\n')
2481 ++len;
2482 ++len;
2483 }
2484
2485 /* If the string will be too long, write its length and put it in the next
2486 * line. Take into account that some room is needed for what comes before
2487 * the string (e.g., variable name). Add something to the length for the
2488 * '<', NL and trailing NUL. */
2489 if (len > LSIZE / 2)
2490 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2491
2492 while ((c = *p++) != NUL)
2493 {
2494 if (c == Ctrl_V || c == '\n')
2495 {
2496 putc(Ctrl_V, fd);
2497 if (c == '\n')
2498 c = 'n';
2499 }
2500 putc(c, fd);
2501 }
2502 putc('\n', fd);
2503}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002504
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002505/*
2506 * Write a string in quotes that barline_parse() can read back.
2507 * Breaks the line in less than LSIZE pieces when needed.
2508 * Returns remaining characters in the line.
2509 */
2510 int
2511barline_writestring(FILE *fd, char_u *s, int remaining_start)
2512{
2513 char_u *p;
2514 int remaining = remaining_start;
2515 int len = 2;
2516
2517 /* Count the number of characters produced, including quotes. */
2518 for (p = s; *p != NUL; ++p)
2519 {
2520 if (*p == NL)
2521 len += 2;
2522 else if (*p == '"' || *p == '\\')
2523 len += 2;
2524 else
2525 ++len;
2526 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002527 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002528 {
2529 fprintf(fd, ">%d\n|<", len);
2530 remaining = LSIZE - 20;
2531 }
2532
2533 putc('"', fd);
2534 for (p = s; *p != NUL; ++p)
2535 {
2536 if (*p == NL)
2537 {
2538 putc('\\', fd);
2539 putc('n', fd);
2540 --remaining;
2541 }
2542 else if (*p == '"' || *p == '\\')
2543 {
2544 putc('\\', fd);
2545 putc(*p, fd);
2546 --remaining;
2547 }
2548 else
2549 putc(*p, fd);
2550 --remaining;
2551
2552 if (remaining < 3)
2553 {
2554 putc('\n', fd);
2555 putc('|', fd);
2556 putc('<', fd);
2557 /* Leave enough space for another continuation. */
2558 remaining = LSIZE - 20;
2559 }
2560 }
2561 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002562 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002563}
2564
2565/*
2566 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002567 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002568 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002569 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002570 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002571barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002572{
2573 char_u *p = text;
2574 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002575 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002576 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002577 int i;
2578 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002579 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002580#ifdef FEAT_MBYTE
2581 char_u *sconv;
2582 int converted;
2583#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002584
2585 while (*p == ',')
2586 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002587 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002588 if (ga_grow(values, 1) == FAIL)
2589 break;
2590 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002591
2592 if (*p == '>')
2593 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002594 /* Need to read a continuation line. Put strings in allocated
2595 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002596 if (!allocated)
2597 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002598 for (i = 0; i < values->ga_len; ++i)
2599 {
2600 bval_T *vp = (bval_T *)(values->ga_data) + i;
2601
2602 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002603 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002604 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2605 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002606 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002607 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002608 allocated = TRUE;
2609 }
2610
2611 if (vim_isdigit(p[1]))
2612 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002613 size_t len;
2614 size_t todo;
2615 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002616
2617 /* String value was split into lines that are each shorter
2618 * than LSIZE:
2619 * |{bartype},>{length of "{text}{text2}"}
2620 * |<"{text1}
2621 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002622 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002623 */
2624 ++p;
2625 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002626 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002627 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002628 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002629 p = buf;
2630 for (todo = len; todo > 0; todo -= n)
2631 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002632 eof = viminfo_readline(virp);
2633 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002634 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002635 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002636 /* File was truncated or garbled. Read another line if
2637 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002638 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002639 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002640 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002641 /* Get length of text, excluding |< and NL chars. */
2642 n = STRLEN(virp->vir_line);
2643 while (n > 0 && (virp->vir_line[n - 1] == NL
2644 || virp->vir_line[n - 1] == CAR))
2645 --n;
2646 n -= 2;
2647 if (n > todo)
2648 {
2649 /* more values follow after the string */
2650 nextp = virp->vir_line + 2 + todo;
2651 n = todo;
2652 }
2653 mch_memmove(p, virp->vir_line + 2, n);
2654 p += n;
2655 }
2656 *p = NUL;
2657 p = buf;
2658 }
2659 else
2660 {
2661 /* Line ending in ">" continues in the next line:
2662 * |{bartype},{lots of values},>
2663 * |<{value},{value}
2664 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002665 eof = viminfo_readline(virp);
2666 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002667 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002668 /* File was truncated or garbled. Read another line if
2669 * this one starts with '|'. */
2670 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002671 p = virp->vir_line + 2;
2672 }
2673 }
2674
2675 if (isdigit(*p))
2676 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002677 value->bv_type = BVAL_NR;
2678 value->bv_nr = getdigits(&p);
2679 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002680 }
2681 else if (*p == '"')
2682 {
2683 int len = 0;
2684 char_u *s = p;
2685
2686 /* Unescape special characters in-place. */
2687 ++p;
2688 while (*p != '"')
2689 {
2690 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002691 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002692 if (*p == '\\')
2693 {
2694 ++p;
2695 if (*p == 'n')
2696 s[len++] = '\n';
2697 else
2698 s[len++] = *p;
2699 ++p;
2700 }
2701 else
2702 s[len++] = *p++;
2703 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002704 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002705 s[len] = NUL;
2706
Bram Moolenaar01227092016-06-11 14:47:40 +02002707#ifdef FEAT_MBYTE
2708 converted = FALSE;
2709 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2710 {
2711 sconv = string_convert(&virp->vir_conv, s, NULL);
2712 if (sconv != NULL)
2713 {
2714 if (s == buf)
2715 vim_free(s);
2716 s = sconv;
2717 buf = s;
2718 converted = TRUE;
2719 }
2720 }
2721#endif
2722 /* Need to copy in allocated memory if the string wasn't allocated
2723 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002724 if (s != buf && allocated)
2725 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002726 value->bv_string = s;
2727 value->bv_type = BVAL_STRING;
2728 value->bv_len = len;
2729 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002730#ifdef FEAT_MBYTE
2731 || converted
2732#endif
2733 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002734 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002735 if (nextp != NULL)
2736 {
2737 /* values following a long string */
2738 p = nextp;
2739 nextp = NULL;
2740 }
2741 }
2742 else if (*p == ',')
2743 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002744 value->bv_type = BVAL_EMPTY;
2745 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002746 }
2747 else
2748 break;
2749 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002750 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002751}
2752
2753 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002754read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002755{
2756 char_u *p = virp->vir_line + 1;
2757 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002758 garray_T values;
2759 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002760 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002761 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002762
2763 /* The format is: |{bartype},{value},...
2764 * For a very long string:
2765 * |{bartype},>{length of "{text}{text2}"}
2766 * |<{text1}
2767 * |<{text2},{value}
2768 * For a long line not using a string
2769 * |{bartype},{lots of values},>
2770 * |<{value},{value}
2771 */
2772 if (*p == '<')
2773 {
2774 /* Continuation line of an unrecognized item. */
2775 if (writing)
2776 ga_add_string(&virp->vir_barlines, virp->vir_line);
2777 }
2778 else
2779 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002780 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002781 bartype = getdigits(&p);
2782 switch (bartype)
2783 {
2784 case BARTYPE_VERSION:
2785 /* Only use the version when it comes before the encoding.
2786 * If it comes later it was copied by a Vim version that
2787 * doesn't understand the version. */
2788 if (!got_encoding)
2789 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002790 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002791 vp = (bval_T *)values.ga_data;
2792 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2793 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002794 }
2795 break;
2796
2797 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002798 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002799 handle_viminfo_history(&values, writing);
2800 break;
2801
2802 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002803 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002804 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002805 break;
2806
Bram Moolenaar2d358992016-06-12 21:20:54 +02002807 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002808 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002809 handle_viminfo_mark(&values, force);
2810 break;
2811
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002812 default:
2813 /* copy unrecognized line (for future use) */
2814 if (writing)
2815 ga_add_string(&virp->vir_barlines, virp->vir_line);
2816 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002817 for (i = 0; i < values.ga_len; ++i)
2818 {
2819 vp = (bval_T *)values.ga_data + i;
2820 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2821 vim_free(vp->bv_string);
2822 }
2823 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002824 }
2825
Bram Moolenaarecefe712016-06-20 12:50:17 +02002826 if (read_next)
2827 return viminfo_readline(virp);
2828 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002829}
2830
2831 static void
2832write_viminfo_version(FILE *fp_out)
2833{
2834 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2835 BARTYPE_VERSION, VIMINFO_VERSION);
2836}
2837
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002838 static void
2839write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2840{
2841 int i;
2842 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002843 int seen_useful = FALSE;
2844 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002845
2846 if (gap->ga_len > 0)
2847 {
2848 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2849
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002850 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002851 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002852 {
2853 line = ((char **)(gap->ga_data))[i];
2854 if (seen_useful || line[1] != '<')
2855 {
2856 fputs(line, fp_out);
2857 seen_useful = TRUE;
2858 }
2859 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002860 }
2861}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862#endif /* FEAT_VIMINFO */
2863
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002864/*
2865 * Return the current time in seconds. Calls time(), unless test_settime()
2866 * was used.
2867 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002868 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002869vim_time(void)
2870{
2871# ifdef FEAT_EVAL
2872 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2873# else
2874 return time(NULL);
2875# endif
2876}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002877
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878/*
2879 * Implementation of ":fixdel", also used by get_stty().
2880 * <BS> resulting <Del>
2881 * ^? ^H
2882 * not ^? ^?
2883 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002885do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886{
2887 char_u *p;
2888
2889 p = find_termcode((char_u *)"kb");
2890 add_termcode((char_u *)"kD", p != NULL
2891 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2892}
2893
2894 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002895print_line_no_prefix(
2896 linenr_T lnum,
2897 int use_number,
2898 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002900 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901
2902 if (curwin->w_p_nu || use_number)
2903 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002904 vim_snprintf((char *)numbuf, sizeof(numbuf),
2905 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2907 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002908 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909}
2910
2911/*
2912 * Print a text line. Also in silent mode ("ex -s").
2913 */
2914 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002915print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916{
2917 int save_silent = silent_mode;
2918
Bram Moolenaard29459b2016-08-26 22:29:11 +02002919 /* apply :filter /pat/ */
2920 if (message_filtered(ml_get(lnum)))
2921 return;
2922
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002924 silent_mode = FALSE;
2925 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2926 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 if (save_silent)
2928 {
2929 msg_putchar('\n');
2930 cursor_on(); /* msg_start() switches it off */
2931 out_flush();
2932 silent_mode = save_silent;
2933 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002934 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935}
2936
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002937 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002938rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002939{
2940 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002941 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002942
Bram Moolenaar7e283842013-05-30 11:43:15 +02002943#ifdef FEAT_AUTOCMD
2944 buf = curbuf;
2945 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002946 /* buffer changed, don't change name now */
2947 if (buf != curbuf)
2948 return FAIL;
2949# ifdef FEAT_EVAL
2950 if (aborting()) /* autocmds may abort script processing */
2951 return FAIL;
2952# endif
2953#endif
2954 /*
2955 * The name of the current buffer will be changed.
2956 * A new (unlisted) buffer entry needs to be made to hold the old file
2957 * name, which will become the alternate file name.
2958 * But don't set the alternate file name if the buffer didn't have a
2959 * name.
2960 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002961 fname = curbuf->b_ffname;
2962 sfname = curbuf->b_sfname;
2963 xfname = curbuf->b_fname;
2964 curbuf->b_ffname = NULL;
2965 curbuf->b_sfname = NULL;
2966 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002967 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002968 curbuf->b_ffname = fname;
2969 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002970 return FAIL;
2971 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002972 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002973 if (xfname != NULL && *xfname != NUL)
2974 {
2975 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2976 if (buf != NULL && !cmdmod.keepalt)
2977 curwin->w_alt_fnum = buf->b_fnum;
2978 }
2979 vim_free(fname);
2980 vim_free(sfname);
2981#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002982 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002983#endif
2984 /* Change directories when the 'acd' option is set. */
2985 DO_AUTOCHDIR
2986 return OK;
2987}
2988
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989/*
2990 * ":file[!] [fname]".
2991 */
2992 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002993ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002995 /* ":0file" removes the file name. Check for illegal uses ":3file",
2996 * "0file name", etc. */
2997 if (eap->addr_count > 0
2998 && (*eap->arg != NUL
2999 || eap->line2 > 0
3000 || eap->addr_count > 1))
3001 {
3002 EMSG(_(e_invarg));
3003 return;
3004 }
3005
3006 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003008 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 }
3011 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01003012 if (!shortmess(SHM_FILEINFO))
3013 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014}
3015
3016/*
3017 * ":update".
3018 */
3019 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003020ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021{
3022 if (curbufIsChanged())
3023 (void)do_write(eap);
3024}
3025
3026/*
3027 * ":write" and ":saveas".
3028 */
3029 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003030ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031{
3032 if (eap->usefilter) /* input lines to shell command */
3033 do_bang(1, eap, FALSE, TRUE, FALSE);
3034 else
3035 (void)do_write(eap);
3036}
3037
3038/*
3039 * write current buffer to file 'eap->arg'
3040 * if 'eap->append' is TRUE, append to the file
3041 *
3042 * if *eap->arg == NUL write to current file
3043 *
3044 * return FAIL for failure, OK otherwise
3045 */
3046 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003047do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048{
3049 int other;
3050 char_u *fname = NULL; /* init to shut up gcc */
3051 char_u *ffname;
3052 int retval = FAIL;
3053 char_u *free_fname = NULL;
3054#ifdef FEAT_BROWSE
3055 char_u *browse_file = NULL;
3056#endif
3057 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003058 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059
3060 if (not_writing()) /* check 'write' option */
3061 return FAIL;
3062
3063 ffname = eap->arg;
3064#ifdef FEAT_BROWSE
3065 if (cmdmod.browse)
3066 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003067 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 NULL, NULL, NULL, curbuf);
3069 if (browse_file == NULL)
3070 goto theend;
3071 ffname = browse_file;
3072 }
3073#endif
3074 if (*ffname == NUL)
3075 {
3076 if (eap->cmdidx == CMD_saveas)
3077 {
3078 EMSG(_(e_argreq));
3079 goto theend;
3080 }
3081 other = FALSE;
3082 }
3083 else
3084 {
3085 fname = ffname;
3086 free_fname = fix_fname(ffname);
3087 /*
3088 * When out-of-memory, keep unexpanded file name, because we MUST be
3089 * able to write the file in this situation.
3090 */
3091 if (free_fname != NULL)
3092 ffname = free_fname;
3093 other = otherfile(ffname);
3094 }
3095
3096 /*
3097 * If we have a new file, put its name in the list of alternate file names.
3098 */
3099 if (other)
3100 {
3101 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3102 || eap->cmdidx == CMD_saveas)
3103 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3104 else
3105 alt_buf = buflist_findname(ffname);
3106 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3107 {
3108 /* Overwriting a file that is loaded in another buffer is not a
3109 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003110 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 goto theend;
3112 }
3113 }
3114
3115 /*
3116 * Writing to the current file is not allowed in readonly mode
3117 * and a file name is required.
3118 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3119 */
3120 if (!other && (
3121#ifdef FEAT_QUICKFIX
3122 bt_dontwrite_msg(curbuf) ||
3123#endif
3124 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3125 goto theend;
3126
3127 if (!other)
3128 {
3129 ffname = curbuf->b_ffname;
3130 fname = curbuf->b_fname;
3131 /*
3132 * Not writing the whole file is only allowed with '!'.
3133 */
3134 if ( (eap->line1 != 1
3135 || eap->line2 != curbuf->b_ml.ml_line_count)
3136 && !eap->forceit
3137 && !eap->append
3138 && !p_wa)
3139 {
3140#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3141 if (p_confirm || cmdmod.confirm)
3142 {
3143 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3144 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3145 goto theend;
3146 eap->forceit = TRUE;
3147 }
3148 else
3149#endif
3150 {
3151 EMSG(_("E140: Use ! to write partial buffer"));
3152 goto theend;
3153 }
3154 }
3155 }
3156
3157 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3158 {
3159 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3160 {
3161#ifdef FEAT_AUTOCMD
3162 buf_T *was_curbuf = curbuf;
3163
3164 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003165 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166# ifdef FEAT_EVAL
3167 if (curbuf != was_curbuf || aborting())
3168# else
3169 if (curbuf != was_curbuf)
3170# endif
3171 {
3172 /* buffer changed, don't change name now */
3173 retval = FAIL;
3174 goto theend;
3175 }
3176#endif
3177 /* Exchange the file names for the current and the alternate
3178 * buffer. This makes it look like we are now editing the buffer
3179 * under the new name. Must be done before buf_write(), because
3180 * if there is no file name and 'cpo' contains 'F', it will set
3181 * the file name. */
3182 fname = alt_buf->b_fname;
3183 alt_buf->b_fname = curbuf->b_fname;
3184 curbuf->b_fname = fname;
3185 fname = alt_buf->b_ffname;
3186 alt_buf->b_ffname = curbuf->b_ffname;
3187 curbuf->b_ffname = fname;
3188 fname = alt_buf->b_sfname;
3189 alt_buf->b_sfname = curbuf->b_sfname;
3190 curbuf->b_sfname = fname;
3191 buf_name_changed(curbuf);
3192#ifdef FEAT_AUTOCMD
3193 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003194 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 if (!alt_buf->b_p_bl)
3196 {
3197 alt_buf->b_p_bl = TRUE;
3198 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3199 }
3200# ifdef FEAT_EVAL
3201 if (curbuf != was_curbuf || aborting())
3202# else
3203 if (curbuf != was_curbuf)
3204# endif
3205 {
3206 /* buffer changed, don't write the file */
3207 retval = FAIL;
3208 goto theend;
3209 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003210
3211 /* If 'filetype' was empty try detecting it now. */
3212 if (*curbuf->b_p_ft == NUL)
3213 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003214 if (au_has_group((char_u *)"filetypedetect"))
3215 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003216 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003217 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003218 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003219
3220 /* Autocommands may have changed buffer names, esp. when
3221 * 'autochdir' is set. */
3222 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223#endif
3224 }
3225
Bram Moolenaar5c719942016-07-09 23:40:45 +02003226 name_was_missing = curbuf->b_ffname == NULL;
3227
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3229 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003230
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003231 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003232 if (eap->cmdidx == CMD_saveas)
3233 {
3234 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003235 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003236 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003237#ifdef FEAT_WINDOWS
3238 redraw_tabline = TRUE;
3239#endif
3240 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003241 }
3242
3243 /* Change directories when the 'acd' option is set and the file name
3244 * got changed or set. */
3245 if (eap->cmdidx == CMD_saveas || name_was_missing)
3246 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003247 DO_AUTOCHDIR
3248 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 }
3250
3251theend:
3252#ifdef FEAT_BROWSE
3253 vim_free(browse_file);
3254#endif
3255 vim_free(free_fname);
3256 return retval;
3257}
3258
3259/*
3260 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3261 * BF_NEW or BF_READERR, check for overwriting current file.
3262 * May set eap->forceit if a dialog says it's OK to overwrite.
3263 * Return OK if it's OK, FAIL if it is not.
3264 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003265 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003266check_overwrite(
3267 exarg_T *eap,
3268 buf_T *buf,
3269 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003271 char_u *ffname, /* full path version of fname */
3272 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273{
3274 /*
3275 * write to other file or b_flags set or not writing the whole file:
3276 * overwriting only allowed with '!'
3277 */
3278 if ( (other
3279 || (buf->b_flags & BF_NOTEDITED)
3280 || ((buf->b_flags & BF_NEW)
3281 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3282 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003284#ifdef FEAT_QUICKFIX
3285 && !bt_nofile(buf)
3286#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 && vim_fexists(ffname))
3288 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003289 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003291#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003292 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003293 if (mch_isdir(ffname))
3294 {
3295 EMSG2(_(e_isadir2), ffname);
3296 return FAIL;
3297 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298#endif
3299#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003300 if (p_confirm || cmdmod.confirm)
3301 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003302 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003304 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3305 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3306 return FAIL;
3307 eap->forceit = TRUE;
3308 }
3309 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003311 {
3312 EMSG(_(e_exists));
3313 return FAIL;
3314 }
3315 }
3316
3317 /* For ":w! filename" check that no swap file exists for "filename". */
3318 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003320 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003321 char_u *p;
3322 int r;
3323 char_u *swapname;
3324
3325 /* We only try the first entry in 'directory', without checking if
3326 * it's writable. If the "." directory is not writable the write
3327 * will probably fail anyway.
3328 * Use 'shortname' of the current buffer, since there is no buffer
3329 * for the written file. */
3330 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003331 {
3332 dir = alloc(5);
3333 if (dir == NULL)
3334 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003335 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003336 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003337 else
3338 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003339 dir = alloc(MAXPATHL);
3340 if (dir == NULL)
3341 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003342 p = p_dir;
3343 copy_option_part(&p, dir, MAXPATHL, ",");
3344 }
3345 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003346 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003347 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003348 if (r)
3349 {
3350#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3351 if (p_confirm || cmdmod.confirm)
3352 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003353 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003354
3355 dialog_msg(buff,
3356 _("Swap file \"%s\" exists, overwrite anyway?"),
3357 swapname);
3358 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3359 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003360 {
3361 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003362 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003363 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003364 eap->forceit = TRUE;
3365 }
3366 else
3367#endif
3368 {
3369 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3370 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003371 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003372 return FAIL;
3373 }
3374 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003375 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 }
3377 }
3378 return OK;
3379}
3380
3381/*
3382 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3383 */
3384 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003385ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386{
3387 int i;
3388
3389 if (eap->cmd[1] == 'n')
3390 i = curwin->w_arg_idx + (int)eap->line2;
3391 else
3392 i = curwin->w_arg_idx - (int)eap->line2;
3393 eap->line1 = 1;
3394 eap->line2 = curbuf->b_ml.ml_line_count;
3395 if (do_write(eap) != FAIL)
3396 do_argfile(eap, i);
3397}
3398
3399/*
3400 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3401 */
3402 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003403do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404{
3405 buf_T *buf;
3406 int error = 0;
3407 int save_forceit = eap->forceit;
3408
3409 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3410 exiting = TRUE;
3411
Bram Moolenaar29323592016-07-24 22:04:11 +02003412 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 {
3414 if (bufIsChanged(buf))
3415 {
3416 /*
3417 * Check if there is a reason the buffer cannot be written:
3418 * 1. if the 'write' option is set
3419 * 2. if there is no file name (even after browsing)
3420 * 3. if the 'readonly' is set (even after a dialog)
3421 * 4. if overwriting is allowed (even after a dialog)
3422 */
3423 if (not_writing())
3424 {
3425 ++error;
3426 break;
3427 }
3428#ifdef FEAT_BROWSE
3429 /* ":browse wall": ask for file name if there isn't one */
3430 if (buf->b_ffname == NULL && cmdmod.browse)
3431 browse_save_fname(buf);
3432#endif
3433 if (buf->b_ffname == NULL)
3434 {
3435 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3436 ++error;
3437 }
3438 else if (check_readonly(&eap->forceit, buf)
3439 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3440 FALSE) == FAIL)
3441 {
3442 ++error;
3443 }
3444 else
3445 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003446#ifdef FEAT_AUTOCMD
3447 bufref_T bufref;
3448
3449 set_bufref(&bufref, buf);
3450#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 if (buf_write_all(buf, eap->forceit) == FAIL)
3452 ++error;
3453#ifdef FEAT_AUTOCMD
3454 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003455 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 buf = firstbuf;
3457#endif
3458 }
3459 eap->forceit = save_forceit; /* check_overwrite() may set it */
3460 }
3461 }
3462 if (exiting)
3463 {
3464 if (!error)
3465 getout(0); /* exit Vim */
3466 not_exiting();
3467 }
3468}
3469
3470/*
3471 * Check the 'write' option.
3472 * Return TRUE and give a message when it's not st.
3473 */
3474 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003475not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476{
3477 if (p_write)
3478 return FALSE;
3479 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3480 return TRUE;
3481}
3482
3483/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003484 * Check if a buffer is read-only (either 'readonly' option is set or file is
3485 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3486 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 */
3488 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003489check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003491 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003492
3493 /* Handle a file being readonly when the 'readonly' option is set or when
3494 * the file exists and permissions are read-only.
3495 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3496 * important for device checks but not here. */
3497 if (!*forceit && (buf->b_p_ro
3498 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3499 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 {
3501#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3502 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3503 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003504 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505
Bram Moolenaar5386a122007-06-28 20:02:32 +00003506 if (buf->b_p_ro)
3507 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3508 buf->b_fname);
3509 else
3510 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 +00003511 buf->b_fname);
3512
3513 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3514 {
3515 /* Set forceit, to force the writing of a readonly file */
3516 *forceit = TRUE;
3517 return FALSE;
3518 }
3519 else
3520 return TRUE;
3521 }
3522 else
3523#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003524 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003526 else
3527 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3528 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 return TRUE;
3530 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003531
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 return FALSE;
3533}
3534
3535/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003536 * Try to abandon current file and edit a new or existing file.
3537 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003539 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003540 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3542 */
3543 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003544getfile(
3545 int fnum,
3546 char_u *ffname,
3547 char_u *sfname,
3548 int setpm,
3549 linenr_T lnum,
3550 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551{
3552 int other;
3553 int retval;
3554 char_u *free_me = NULL;
3555
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003556 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003558#ifdef FEAT_AUTOCMD
3559 if (curbuf_locked())
3560 return 1;
3561#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562
3563 if (fnum == 0)
3564 {
3565 /* make ffname full path, set sfname */
3566 fname_expand(curbuf, &ffname, &sfname);
3567 other = otherfile(ffname);
3568 free_me = ffname; /* has been allocated, free() later */
3569 }
3570 else
3571 other = (fnum != curbuf->b_fnum);
3572
3573 if (other)
3574 ++no_wait_return; /* don't wait for autowrite message */
3575 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3576 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3577 {
3578#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3579 if (p_confirm && p_write)
3580 dialog_changed(curbuf, FALSE);
3581 if (curbufIsChanged())
3582#endif
3583 {
3584 if (other)
3585 --no_wait_return;
3586 EMSG(_(e_nowrtmsg));
3587 retval = 2; /* file has been changed */
3588 goto theend;
3589 }
3590 }
3591 if (other)
3592 --no_wait_return;
3593 if (setpm)
3594 setpcmark();
3595 if (!other)
3596 {
3597 if (lnum != 0)
3598 curwin->w_cursor.lnum = lnum;
3599 check_cursor_lnum();
3600 beginline(BL_SOL | BL_FIX);
3601 retval = 0; /* it's in the same file */
3602 }
3603 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003604 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3605 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 retval = -1; /* opened another file */
3607 else
3608 retval = 1; /* error encountered */
3609
3610theend:
3611 vim_free(free_me);
3612 return retval;
3613}
3614
3615/*
3616 * start editing a new file
3617 *
3618 * fnum: file number; if zero use ffname/sfname
3619 * ffname: the file name
3620 * - full path if sfname used,
3621 * - any file name if sfname is NULL
3622 * - empty string to re-edit with the same file name (but may be
3623 * in a different directory)
3624 * - NULL to start an empty buffer
3625 * sfname: the short file name (or NULL)
3626 * eap: contains the command to be executed after loading the file and
3627 * forced 'ff' and 'fenc'
3628 * newlnum: if > 0: put cursor on this line number (if possible)
3629 * if ECMD_LASTL: use last position in loaded file
3630 * if ECMD_LAST: use last position in all files
3631 * if ECMD_ONE: use first line
3632 * flags:
3633 * ECMD_HIDE: if TRUE don't free the current buffer
3634 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3635 * ECMD_OLDBUF: use existing buffer if it exists
3636 * ECMD_FORCEIT: ! used for Ex command
3637 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003638 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003639 * window, NULL when splitting the window first. When not NULL info
3640 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 *
3642 * return FAIL for failure, OK otherwise
3643 */
3644 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003645do_ecmd(
3646 int fnum,
3647 char_u *ffname,
3648 char_u *sfname,
3649 exarg_T *eap, /* can be NULL! */
3650 linenr_T newlnum,
3651 int flags,
3652 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653{
3654 int other_file; /* TRUE if editing another file */
3655 int oldbuf; /* TRUE if using existing buffer */
3656#ifdef FEAT_AUTOCMD
3657 int auto_buf = FALSE; /* TRUE if autocommands brought us
3658 into the buffer unexpectedly */
3659 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003660 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661#endif
3662 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003663 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003665 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666#endif
3667 char_u *free_fname = NULL;
3668#ifdef FEAT_BROWSE
3669 char_u *browse_file = NULL;
3670#endif
3671 int retval = FAIL;
3672 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003673 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 linenr_T topline = 0;
3675 int newcol = -1;
3676 int solcol = -1;
3677 pos_T *pos;
3678#ifdef FEAT_SUN_WORKSHOP
3679 char_u *cp;
3680#endif
3681 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003682#ifdef FEAT_SPELL
3683 int did_get_winopts = FALSE;
3684#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003685 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003686 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687
3688 if (eap != NULL)
3689 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003690#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3691 set_bufref(&old_curbuf, curbuf);
3692#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693
3694 if (fnum != 0)
3695 {
3696 if (fnum == curbuf->b_fnum) /* file is already being edited */
3697 return OK; /* nothing to do */
3698 other_file = TRUE;
3699 }
3700 else
3701 {
3702#ifdef FEAT_BROWSE
3703 if (cmdmod.browse)
3704 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003705# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003706 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003707# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003708 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003709# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003710 au_has_group((char_u *)"FileExplorer"))
3711 {
3712 /* No browsing supported but we do have the file explorer:
3713 * Edit the directory. */
3714 if (ffname == NULL || !mch_isdir(ffname))
3715 ffname = (char_u *)".";
3716 }
3717 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003718# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003719 {
3720 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003722 if (browse_file == NULL)
3723 goto theend;
3724 ffname = browse_file;
3725 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 }
3727#endif
3728 /* if no short name given, use ffname for short name */
3729 if (sfname == NULL)
3730 sfname = ffname;
3731#ifdef USE_FNAME_CASE
3732# ifdef USE_LONG_FNAME
3733 if (USE_LONG_FNAME)
3734# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003735 if (sfname != NULL)
3736 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737#endif
3738
3739#ifdef FEAT_LISTCMDS
3740 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3741 goto theend;
3742#endif
3743
3744 if (ffname == NULL)
3745 other_file = TRUE;
3746 /* there is no file name */
3747 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3748 other_file = FALSE;
3749 else
3750 {
3751 if (*ffname == NUL) /* re-edit with same file name */
3752 {
3753 ffname = curbuf->b_ffname;
3754 sfname = curbuf->b_fname;
3755 }
3756 free_fname = fix_fname(ffname); /* may expand to full path name */
3757 if (free_fname != NULL)
3758 ffname = free_fname;
3759 other_file = otherfile(ffname);
3760#ifdef FEAT_SUN_WORKSHOP
3761 if (usingSunWorkShop && p_acd
3762 && (cp = vim_strrchr(sfname, '/')) != NULL)
3763 sfname = ++cp;
3764#endif
3765 }
3766 }
3767
3768 /*
3769 * if the file was changed we may not be allowed to abandon it
3770 * - if we are going to re-edit the same file
3771 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3772 */
3773 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3774 || (curbuf->b_nwindows == 1
3775 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003776 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3777 | (other_file ? 0 : CCGD_MULTWIN)
3778 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3779 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 {
3781 if (fnum == 0 && other_file && ffname != NULL)
3782 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3783 goto theend;
3784 }
3785
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 /*
3787 * End Visual mode before switching to another buffer, so the text can be
3788 * copied into the GUI selection buffer.
3789 */
3790 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003792#ifdef FEAT_AUTOCMD
3793 if ((command != NULL || newlnum > (linenr_T)0)
3794 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3795 {
3796 int len;
3797 char_u *p;
3798
3799 /* Set v:swapcommand for the SwapExists autocommands. */
3800 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003801 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003802 else
3803 len = 30;
3804 p = alloc((unsigned)len);
3805 if (p != NULL)
3806 {
3807 if (command != NULL)
3808 vim_snprintf((char *)p, len, ":%s\r", command);
3809 else
3810 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3811 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3812 did_set_swapcommand = TRUE;
3813 vim_free(p);
3814 }
3815 }
3816#endif
3817
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 /*
3819 * If we are starting to edit another file, open a (new) buffer.
3820 * Otherwise we re-use the current buffer.
3821 */
3822 if (other_file)
3823 {
3824#ifdef FEAT_LISTCMDS
3825 if (!(flags & ECMD_ADDBUF))
3826#endif
3827 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003828 if (!cmdmod.keepalt)
3829 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003830 if (oldwin != NULL)
3831 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 }
3833
3834 if (fnum)
3835 buf = buflist_findnr(fnum);
3836 else
3837 {
3838#ifdef FEAT_LISTCMDS
3839 if (flags & ECMD_ADDBUF)
3840 {
3841 linenr_T tlnum = 1L;
3842
3843 if (command != NULL)
3844 {
3845 tlnum = atol((char *)command);
3846 if (tlnum <= 0)
3847 tlnum = 1L;
3848 }
3849 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3850 goto theend;
3851 }
3852#endif
3853 buf = buflist_new(ffname, sfname, 0L,
3854 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003855#ifdef FEAT_AUTOCMD
3856 /* autocommands may change curwin and curbuf */
3857 if (oldwin != NULL)
3858 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003859 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003860#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 }
3862 if (buf == NULL)
3863 goto theend;
3864 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3865 {
3866 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 }
3868 else /* existing memfile */
3869 {
3870 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003871 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003873 /* Check if autocommands made the buffer invalid or changed the
3874 * current buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003875 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003877 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878#endif
3879 )
3880 goto theend;
3881#ifdef FEAT_EVAL
3882 if (aborting()) /* autocmds may abort script processing */
3883 goto theend;
3884#endif
3885 }
3886
3887 /* May jump to last used line number for a loaded buffer or when asked
3888 * for explicitly */
3889 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3890 {
3891 pos = buflist_findfpos(buf);
3892 newlnum = pos->lnum;
3893 solcol = pos->col;
3894 }
3895
3896 /*
3897 * Make the (new) buffer the one used by the current window.
3898 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3899 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003900 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 */
3902 if (buf != curbuf)
3903 {
3904#ifdef FEAT_AUTOCMD
3905 /*
3906 * Be careful: The autocommands may delete any buffer and change
3907 * the current buffer.
3908 * - If the buffer we are going to edit is deleted, give up.
3909 * - If the current buffer is deleted, prefer to load the new
3910 * buffer when loading a buffer is required. This avoids
3911 * loading another buffer which then must be closed again.
3912 * - If we ended up in the new buffer already, need to skip a few
3913 * things, set auto_buf.
3914 */
3915 if (buf->b_fname != NULL)
3916 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003917 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003919 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003921 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 delbuf_msg(new_name); /* frees new_name */
3923 goto theend;
3924 }
3925# ifdef FEAT_EVAL
3926 if (aborting()) /* autocmds may abort script processing */
3927 {
3928 vim_free(new_name);
3929 goto theend;
3930 }
3931# endif
3932 if (buf == curbuf) /* already in new buffer */
3933 auto_buf = TRUE;
3934 else
3935 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02003936 win_T *the_curwin = curwin;
3937
3938 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003939 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02003940 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003941 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02003942
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003943 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944#endif
3945 buf_copy_options(buf, BCO_ENTER);
3946
Bram Moolenaar5a497892016-09-03 16:29:04 +02003947 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02003948 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003949 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003950 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003951 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952
3953#ifdef FEAT_AUTOCMD
Bram Moolenaar5a497892016-09-03 16:29:04 +02003954 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003955 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01003956
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957# ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02003958 /* autocmds may abort script processing */
3959 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 {
3961 vim_free(new_name);
3962 goto theend;
3963 }
3964# endif
3965 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003966 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003968 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 delbuf_msg(new_name); /* frees new_name */
3970 goto theend;
3971 }
3972 if (buf == curbuf) /* already in new buffer */
3973 auto_buf = TRUE;
3974 else
3975#endif
3976 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003977#ifdef FEAT_SYN_HL
3978 /*
3979 * <VN> We could instead free the synblock
3980 * and re-attach to buffer, perhaps.
3981 */
Bram Moolenaarc4bfeda2016-12-14 21:42:00 +01003982 if (curwin->w_buffer != NULL
3983 && curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003984 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003985#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 curwin->w_buffer = buf;
3987 curbuf = buf;
3988 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003989
3990 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3991 if (!oldbuf && eap != NULL)
3992 {
3993 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003994#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003995 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003996#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003997 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 }
3999
4000 /* May get the window options from the last time this buffer
4001 * was in this window (or another window). If not used
4002 * before, reset the local window options to the global
4003 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004004 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004005#ifdef FEAT_SPELL
4006 did_get_winopts = TRUE;
4007#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008
4009#ifdef FEAT_AUTOCMD
4010 }
4011 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004012 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004013 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014#endif
4015 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016
4017 curwin->w_pcmark.lnum = 1;
4018 curwin->w_pcmark.col = 0;
4019 }
4020 else /* !other_file */
4021 {
4022 if (
4023#ifdef FEAT_LISTCMDS
4024 (flags & ECMD_ADDBUF) ||
4025#endif
4026 check_fname() == FAIL)
4027 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004028
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 oldbuf = (flags & ECMD_OLDBUF);
4030 }
4031
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004032 /* Don't redraw until the cursor is in the right line, otherwise
4033 * autocommands may cause ml_get errors. */
4034 ++RedrawingDisabled;
4035 did_inc_redrawing_disabled = TRUE;
4036
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004037#ifdef FEAT_AUTOCMD
4038 buf = curbuf;
4039#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4041 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004042 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 }
4044 else
4045 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 /* Don't make a buffer listed if it's a help buffer. Useful when
4047 * using CTRL-O to go back to a help file. */
4048 if (!curbuf->b_help)
4049 set_buflisted(TRUE);
4050 }
4051
4052#ifdef FEAT_AUTOCMD
4053 /* If autocommands change buffers under our fingers, forget about
4054 * editing the file. */
4055 if (buf != curbuf)
4056 goto theend;
4057# ifdef FEAT_EVAL
4058 if (aborting()) /* autocmds may abort script processing */
4059 goto theend;
4060# endif
4061
4062 /* Since we are starting to edit a file, consider the filetype to be
4063 * unset. Helps for when an autocommand changes files and expects syntax
4064 * highlighting to work in the other file. */
4065 did_filetype = FALSE;
4066#endif
4067
4068/*
4069 * other_file oldbuf
4070 * FALSE FALSE re-edit same file, buffer is re-used
4071 * FALSE TRUE re-edit same file, nothing changes
4072 * TRUE FALSE start editing new file, new buffer
4073 * TRUE TRUE start editing in existing buffer (nothing to do)
4074 */
4075 if (!other_file && !oldbuf) /* re-use the buffer */
4076 {
4077 set_last_cursor(curwin); /* may set b_last_cursor */
4078 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4079 {
4080 newlnum = curwin->w_cursor.lnum;
4081 solcol = curwin->w_cursor.col;
4082 }
4083#ifdef FEAT_AUTOCMD
4084 buf = curbuf;
4085 if (buf->b_fname != NULL)
4086 new_name = vim_strsave(buf->b_fname);
4087 else
4088 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004089 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004091 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4092 {
4093 /* Save all the text, so that the reload can be undone.
4094 * Sync first so that this is a separate undo-able action. */
4095 u_sync(FALSE);
4096 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4097 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004098 {
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004099#ifdef FEAT_AUTOCMD
Bram Moolenaar1e225822016-07-30 21:48:59 +02004100 vim_free(new_name);
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004101#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004102 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004103 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004104 u_unchanged(curbuf);
4105 buf_freeall(curbuf, BFA_KEEP_UNDO);
4106
4107 /* tell readfile() not to clear or reload undo info */
4108 readfile_flags = READ_KEEP_UNDO;
4109 }
4110 else
4111 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112#ifdef FEAT_AUTOCMD
4113 /* If autocommands deleted the buffer we were going to re-edit, give
4114 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004115 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 {
4117 delbuf_msg(new_name); /* frees new_name */
4118 goto theend;
4119 }
4120 vim_free(new_name);
4121
4122 /* If autocommands change buffers under our fingers, forget about
4123 * re-editing the file. Should do the buf_clear_file(), but perhaps
4124 * the autocommands changed the buffer... */
4125 if (buf != curbuf)
4126 goto theend;
4127# ifdef FEAT_EVAL
4128 if (aborting()) /* autocmds may abort script processing */
4129 goto theend;
4130# endif
4131#endif
4132 buf_clear_file(curbuf);
4133 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4134 curbuf->b_op_end.lnum = 0;
4135 }
4136
4137/*
4138 * If we get here we are sure to start editing
4139 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 /* Assume success now */
4141 retval = OK;
4142
4143 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 * Check if we are editing the w_arg_idx file in the argument list.
4145 */
4146 check_arg_idx(curwin);
4147
4148#ifdef FEAT_AUTOCMD
4149 if (!auto_buf)
4150#endif
4151 {
4152 /*
4153 * Set cursor and init window before reading the file and executing
4154 * autocommands. This allows for the autocommands to position the
4155 * cursor.
4156 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004157 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158
4159#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004160 /* It's possible that all lines in the buffer changed. Need to update
4161 * automatic folding for all windows where it's used. */
4162# ifdef FEAT_WINDOWS
4163 {
4164 win_T *win;
4165 tabpage_T *tp;
4166
4167 FOR_ALL_TAB_WINDOWS(tp, win)
4168 if (win->w_buffer == curbuf)
4169 foldUpdateAll(win);
4170 }
4171# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004173# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174#endif
4175
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004176 /* Change directories when the 'acd' option is set. */
4177 DO_AUTOCHDIR
4178
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 /*
4180 * Careful: open_buffer() and apply_autocmds() may change the current
4181 * buffer and window.
4182 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004183 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 topline = curwin->w_topline;
4185 if (!oldbuf) /* need to read the file */
4186 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004187#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 swap_exists_action = SEA_DIALOG;
4189#endif
4190 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4191
4192 /*
4193 * Open the buffer and read the file.
4194 */
4195#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004196 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 retval = FAIL;
4198#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004199 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200#endif
4201
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004202#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 if (swap_exists_action == SEA_QUIT)
4204 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004205 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206#endif
4207 }
4208#ifdef FEAT_AUTOCMD
4209 else
4210 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004211 /* Read the modelines, but only to set window-local options. Any
4212 * buffer-local options have already been set and may have been
4213 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004214 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004215
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4217 &retval);
4218 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4219 &retval);
4220 }
4221 check_arg_idx(curwin);
4222#endif
4223
Bram Moolenaareab316b2015-03-24 11:46:30 +01004224 /* If autocommands change the cursor position or topline, we should
4225 * keep it. Also when it moves within a line. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004226 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 {
4228 newlnum = curwin->w_cursor.lnum;
4229 newcol = curwin->w_cursor.col;
4230 }
4231 if (curwin->w_topline == topline)
4232 topline = 0;
4233
4234 /* Even when cursor didn't move we need to recompute topline. */
4235 changed_line_abv_curs();
4236
4237#ifdef FEAT_TITLE
4238 maketitle();
4239#endif
4240 }
4241
4242#ifdef FEAT_DIFF
4243 /* Tell the diff stuff that this buffer is new and/or needs updating.
4244 * Also needed when re-editing the same buffer, because unloading will
4245 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004246 if (curwin->w_p_diff)
4247 {
4248 diff_buf_add(curbuf);
4249 diff_invalidate(curbuf);
4250 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251#endif
4252
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004253#ifdef FEAT_SPELL
4254 /* If the window options were changed may need to set the spell language.
4255 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004256 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4257 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004258#endif
4259
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 if (command == NULL)
4261 {
4262 if (newcol >= 0) /* position set by autocommands */
4263 {
4264 curwin->w_cursor.lnum = newlnum;
4265 curwin->w_cursor.col = newcol;
4266 check_cursor();
4267 }
4268 else if (newlnum > 0) /* line number from caller or old position */
4269 {
4270 curwin->w_cursor.lnum = newlnum;
4271 check_cursor_lnum();
4272 if (solcol >= 0 && !p_sol)
4273 {
4274 /* 'sol' is off: Use last known column. */
4275 curwin->w_cursor.col = solcol;
4276 check_cursor_col();
4277#ifdef FEAT_VIRTUALEDIT
4278 curwin->w_cursor.coladd = 0;
4279#endif
4280 curwin->w_set_curswant = TRUE;
4281 }
4282 else
4283 beginline(BL_SOL | BL_FIX);
4284 }
4285 else /* no line number, go to last line in Ex mode */
4286 {
4287 if (exmode_active)
4288 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4289 beginline(BL_WHITE | BL_FIX);
4290 }
4291 }
4292
4293#ifdef FEAT_WINDOWS
4294 /* Check if cursors in other windows on the same buffer are still valid */
4295 check_lnums(FALSE);
4296#endif
4297
4298 /*
4299 * Did not read the file, need to show some info about the file.
4300 * Do this after setting the cursor.
4301 */
4302 if (oldbuf
4303#ifdef FEAT_AUTOCMD
4304 && !auto_buf
4305#endif
4306 )
4307 {
4308 int msg_scroll_save = msg_scroll;
4309
4310 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4311 * message. */
4312 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4313 msg_scroll = FALSE;
4314 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4315 check_for_delay(FALSE);
4316 msg_start();
4317 msg_scroll = msg_scroll_save;
4318 msg_scrolled_ign = TRUE;
4319
Bram Moolenaar426dd022016-03-15 15:09:29 +01004320 if (!shortmess(SHM_FILEINFO))
4321 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322
4323 msg_scrolled_ign = FALSE;
4324 }
4325
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004326#ifdef FEAT_VIMINFO
4327 curbuf->b_last_used = vim_time();
4328#endif
4329
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 if (command != NULL)
4331 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4332
4333#ifdef FEAT_KEYMAP
4334 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004335 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336#endif
4337
4338 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004339 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 if (!skip_redraw)
4341 {
4342 n = p_so;
4343 if (topline == 0 && command == NULL)
4344 p_so = 999; /* force cursor halfway the window */
4345 update_topline();
4346#ifdef FEAT_SCROLLBIND
4347 curwin->w_scbind_pos = curwin->w_topline;
4348#endif
4349 p_so = n;
4350 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4351 }
4352
4353 if (p_im)
4354 need_start_insertmode = TRUE;
4355
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004356 /* Change directories when the 'acd' option is set. */
4357 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004359#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004360 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 {
4362# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004363 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4365# endif
4366# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004367 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004368 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369# endif
4370 }
4371#endif
4372
4373theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004374 if (did_inc_redrawing_disabled)
4375 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004376#ifdef FEAT_AUTOCMD
4377 if (did_set_swapcommand)
4378 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4379#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380#ifdef FEAT_BROWSE
4381 vim_free(browse_file);
4382#endif
4383 vim_free(free_fname);
4384 return retval;
4385}
4386
4387#ifdef FEAT_AUTOCMD
4388 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004389delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390{
4391 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4392 name == NULL ? (char_u *)"" : name);
4393 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004394 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004395 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396}
4397#endif
4398
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004399static int append_indent = 0; /* autoindent for first line */
4400
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401/*
4402 * ":insert" and ":append", also used by ":change"
4403 */
4404 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004405ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406{
4407 char_u *theline;
4408 int did_undo = FALSE;
4409 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004410 int indent = 0;
4411 char_u *p;
4412 int vcol;
4413 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004415 /* the ! flag toggles autoindent */
4416 if (eap->forceit)
4417 curbuf->b_p_ai = !curbuf->b_p_ai;
4418
4419 /* First autoindent comes from the line we start on */
4420 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4421 append_indent = get_indent_lnum(lnum);
4422
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 if (eap->cmdidx != CMD_append)
4424 --lnum;
4425
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004426 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004427 if (empty && lnum == 1)
4428 lnum = 0;
4429
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 State = INSERT; /* behave like in Insert mode */
4431 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4432 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004433
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004434 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 {
4436 msg_scroll = TRUE;
4437 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004438 if (curbuf->b_p_ai)
4439 {
4440 if (append_indent >= 0)
4441 {
4442 indent = append_indent;
4443 append_indent = -1;
4444 }
4445 else if (lnum > 0)
4446 indent = get_indent_lnum(lnum);
4447 }
4448 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004450 {
4451 /* No getline() function, use the lines that follow. This ends
4452 * when there is no more. */
4453 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4454 break;
4455 p = vim_strchr(eap->nextcmd, NL);
4456 if (p == NULL)
4457 p = eap->nextcmd + STRLEN(eap->nextcmd);
4458 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4459 if (*p != NUL)
4460 ++p;
4461 eap->nextcmd = p;
4462 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004464 {
4465 int save_State = State;
4466
4467 /* Set State to avoid the cursor shape to be set to INSERT mode
4468 * when getline() returns. */
4469 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 theline = eap->getline(
4471#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004472 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004474 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004475 State = save_State;
4476 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004478 if (theline == NULL)
4479 break;
4480
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004481 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4482 if (ex_keep_indent)
4483 append_indent = indent;
4484
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004485 /* Look for the "." after automatic indent. */
4486 vcol = 0;
4487 for (p = theline; indent > vcol; ++p)
4488 {
4489 if (*p == ' ')
4490 ++vcol;
4491 else if (*p == TAB)
4492 vcol += 8 - vcol % 8;
4493 else
4494 break;
4495 }
4496 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004497 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4498 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 {
4500 vim_free(theline);
4501 break;
4502 }
4503
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004504 /* don't use autoindent if nothing was typed. */
4505 if (p[0] == NUL)
4506 theline[0] = NUL;
4507
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 did_undo = TRUE;
4509 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004510 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511
4512 vim_free(theline);
4513 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004514
4515 if (empty)
4516 {
4517 ml_delete(2L, FALSE);
4518 empty = FALSE;
4519 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 }
4521 State = NORMAL;
4522
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004523 if (eap->forceit)
4524 curbuf->b_p_ai = !curbuf->b_p_ai;
4525
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004527 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 * "end" is set to lnum when something has been appended, otherwise
4529 * it is the same than "start" -- Acevedo */
4530 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4531 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4532 if (eap->cmdidx != CMD_append)
4533 --curbuf->b_op_start.lnum;
4534 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4535 ? lnum : curbuf->b_op_start.lnum;
4536 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4537 curwin->w_cursor.lnum = lnum;
4538 check_cursor_lnum();
4539 beginline(BL_SOL | BL_FIX);
4540
4541 need_wait_return = FALSE; /* don't use wait_return() now */
4542 ex_no_reprint = TRUE;
4543}
4544
4545/*
4546 * ":change"
4547 */
4548 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004549ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550{
4551 linenr_T lnum;
4552
4553 if (eap->line2 >= eap->line1
4554 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4555 return;
4556
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004557 /* the ! flag toggles autoindent */
4558 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4559 append_indent = get_indent_lnum(eap->line1);
4560
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4562 {
4563 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4564 break;
4565 ml_delete(eap->line1, FALSE);
4566 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004567
4568 /* make sure the cursor is not beyond the end of the file now */
4569 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4571
4572 /* ":append" on the line above the deleted lines. */
4573 eap->line2 = eap->line1;
4574 ex_append(eap);
4575}
4576
4577 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004578ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579{
4580 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004581 int bigness;
4582 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 int minus = 0;
4584 linenr_T start, end, curs, i;
4585 int j;
4586 linenr_T lnum = eap->line2;
4587
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004588 /* Vi compatible: ":z!" uses display height, without a count uses
4589 * 'scroll' */
4590 if (eap->forceit)
4591 bigness = curwin->w_height;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004592#ifdef FEAT_WINDOWS
Bram Moolenaar459ca562016-11-10 18:16:33 +01004593 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004594 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004595#endif
Bram Moolenaar631abc32014-02-22 22:27:47 +01004596 else
4597 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 if (bigness < 1)
4599 bigness = 1;
4600
4601 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004602 kind = x;
4603 if (*kind == '-' || *kind == '+' || *kind == '='
4604 || *kind == '^' || *kind == '.')
4605 ++x;
4606 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 ++x;
4608
4609 if (*x != 0)
4610 {
4611 if (!VIM_ISDIGIT(*x))
4612 {
4613 EMSG(_("E144: non-numeric argument to :z"));
4614 return;
4615 }
4616 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004617 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004619 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004620 if (*kind == '=')
4621 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004622 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 }
4624
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004625 /* the number of '-' and '+' multiplies the distance */
4626 if (*kind == '-' || *kind == '+')
4627 for (x = kind + 1; *x == *kind; ++x)
4628 ;
4629
4630 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 {
4632 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004633 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4634 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004635 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 break;
4637
4638 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004639 start = lnum - (bigness + 1) / 2 + 1;
4640 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 curs = lnum;
4642 minus = 1;
4643 break;
4644
4645 case '^':
4646 start = lnum - bigness * 2;
4647 end = lnum - bigness;
4648 curs = lnum - bigness;
4649 break;
4650
4651 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004652 start = lnum - (bigness + 1) / 2 + 1;
4653 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 curs = end;
4655 break;
4656
4657 default: /* '+' */
4658 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004659 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004660 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004661 else if (eap->addr_count == 0)
4662 ++start;
4663 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 curs = end;
4665 break;
4666 }
4667
4668 if (start < 1)
4669 start = 1;
4670
4671 if (end > curbuf->b_ml.ml_line_count)
4672 end = curbuf->b_ml.ml_line_count;
4673
4674 if (curs > curbuf->b_ml.ml_line_count)
4675 curs = curbuf->b_ml.ml_line_count;
4676
4677 for (i = start; i <= end; i++)
4678 {
4679 if (minus && i == lnum)
4680 {
4681 msg_putchar('\n');
4682
4683 for (j = 1; j < Columns; j++)
4684 msg_putchar('-');
4685 }
4686
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004687 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
4689 if (minus && i == lnum)
4690 {
4691 msg_putchar('\n');
4692
4693 for (j = 1; j < Columns; j++)
4694 msg_putchar('-');
4695 }
4696 }
4697
4698 curwin->w_cursor.lnum = curs;
4699 ex_no_reprint = TRUE;
4700}
4701
4702/*
4703 * Check if the restricted flag is set.
4704 * If so, give an error message and return TRUE.
4705 * Otherwise, return FALSE.
4706 */
4707 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004708check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709{
4710 if (restricted)
4711 {
4712 EMSG(_("E145: Shell commands not allowed in rvim"));
4713 return TRUE;
4714 }
4715 return FALSE;
4716}
4717
4718/*
4719 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4720 * If so, give an error message and return TRUE.
4721 * Otherwise, return FALSE.
4722 */
4723 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004724check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725{
4726 if (secure)
4727 {
4728 secure = 2;
4729 EMSG(_(e_curdir));
4730 return TRUE;
4731 }
4732#ifdef HAVE_SANDBOX
4733 /*
4734 * In the sandbox more things are not allowed, including the things
4735 * disallowed in secure mode.
4736 */
4737 if (sandbox != 0)
4738 {
4739 EMSG(_(e_sandbox));
4740 return TRUE;
4741 }
4742#endif
4743 return FALSE;
4744}
4745
4746static char_u *old_sub = NULL; /* previous substitute pattern */
4747static int global_need_beginline; /* call beginline() after ":g" */
4748
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004749/*
4750 * Flags that are kept between calls to :substitute.
4751 */
4752typedef struct {
4753 int do_all; /* do multiple substitutions per line */
4754 int do_ask; /* ask for confirmation */
4755 int do_count; /* count only */
4756 int do_error; /* if false, ignore errors */
4757 int do_print; /* print last line with subs. */
4758 int do_list; /* list last line with subs. */
4759 int do_number; /* list last line with line nr*/
4760 int do_ic; /* ignore case flag */
4761} subflags_T;
4762
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763/* do_sub()
4764 *
4765 * Perform a substitution from line eap->line1 to line eap->line2 using the
4766 * command pointed to by eap->arg which should be of the form:
4767 *
4768 * /pattern/substitution/{flags}
4769 *
4770 * The usual escapes are supported as described in the regexp docs.
4771 */
4772 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004773do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774{
4775 linenr_T lnum;
4776 long i = 0;
4777 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004778 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4779 FALSE, FALSE, 0};
4780#ifdef FEAT_EVAL
4781 subflags_T subflags_save;
4782#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004783 int save_do_all; /* remember user specified 'g' flag */
4784 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4786 int delimiter;
4787 int sublen;
4788 int got_quit = FALSE;
4789 int got_match = FALSE;
4790 int temp;
4791 int which_pat;
4792 char_u *cmd;
4793 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004794 linenr_T first_line = 0; /* first changed line */
4795 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 * change */
4797 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4798 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004799 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004800 char_u *sub_firstline; /* allocated copy of first sub line */
4801 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004802 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004803 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004804#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004805 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004806#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
4808 cmd = eap->arg;
4809 if (!global_busy)
4810 {
4811 sub_nsubs = 0;
4812 sub_nlines = 0;
4813 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004814 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 if (eap->cmdidx == CMD_tilde)
4817 which_pat = RE_LAST; /* use last used regexp */
4818 else
4819 which_pat = RE_SUBST; /* use last substitute regexp */
4820
4821 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004822 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4824 {
4825 /* don't accept alphanumeric for separator */
4826 if (isalpha(*cmd))
4827 {
4828 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4829 return;
4830 }
4831 /*
4832 * undocumented vi feature:
4833 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4834 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4835 */
4836 if (*cmd == '\\')
4837 {
4838 ++cmd;
4839 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4840 {
4841 EMSG(_(e_backslash));
4842 return;
4843 }
4844 if (*cmd != '&')
4845 which_pat = RE_SEARCH; /* use last '/' pattern */
4846 pat = (char_u *)""; /* empty search pattern */
4847 delimiter = *cmd++; /* remember delimiter character */
4848 }
4849 else /* find the end of the regexp */
4850 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004851#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4852 if (p_altkeymap && curwin->w_p_rl)
4853 lrF_sub(cmd);
4854#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 which_pat = RE_LAST; /* use last used regexp */
4856 delimiter = *cmd++; /* remember delimiter character */
4857 pat = cmd; /* remember start of search pat */
4858 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4859 if (cmd[0] == delimiter) /* end delimiter found */
4860 *cmd++ = NUL; /* replace it with a NUL */
4861 }
4862
4863 /*
4864 * Small incompatibility: vi sees '\n' as end of the command, but in
4865 * Vim we want to use '\n' to find/substitute a NUL.
4866 */
4867 sub = cmd; /* remember the start of the substitution */
4868
4869 while (cmd[0])
4870 {
4871 if (cmd[0] == delimiter) /* end delimiter found */
4872 {
4873 *cmd++ = NUL; /* replace it with a NUL */
4874 break;
4875 }
4876 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4877 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004878 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 }
4880
4881 if (!eap->skip)
4882 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004883 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4884 if (STRCMP(sub, "%") == 0
4885 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4886 {
4887 if (old_sub == NULL) /* there is no previous command */
4888 {
4889 EMSG(_(e_nopresub));
4890 return;
4891 }
4892 sub = old_sub;
4893 }
4894 else
4895 {
4896 vim_free(old_sub);
4897 old_sub = vim_strsave(sub);
4898 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 }
4900 }
4901 else if (!eap->skip) /* use previous pattern and substitution */
4902 {
4903 if (old_sub == NULL) /* there is no previous command */
4904 {
4905 EMSG(_(e_nopresub));
4906 return;
4907 }
4908 pat = NULL; /* search_regcomp() will use previous pattern */
4909 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004910
4911 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4912 * last column after using "$". */
4913 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 }
4915
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004916 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4917 * more efficient.
4918 * TODO: find a generic solution to make line-joining operations more
4919 * efficient, avoid allocating a string that grows in size.
4920 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004921 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004922 && *sub == NUL
4923 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4924 || *cmd == 'p' || *cmd == '#'))))
4925 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004926 linenr_T joined_lines_count;
4927
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004928 curwin->w_cursor.lnum = eap->line1;
4929 if (*cmd == 'l')
4930 eap->flags = EXFLAG_LIST;
4931 else if (*cmd == '#')
4932 eap->flags = EXFLAG_NR;
4933 else if (*cmd == 'p')
4934 eap->flags = EXFLAG_PRINT;
4935
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004936 /* The number of lines joined is the number of lines in the range plus
4937 * one. One less when the last line is included. */
4938 joined_lines_count = eap->line2 - eap->line1 + 1;
4939 if (eap->line2 < curbuf->b_ml.ml_line_count)
4940 ++joined_lines_count;
4941 if (joined_lines_count > 1)
4942 {
4943 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4944 sub_nsubs = joined_lines_count - 1;
4945 sub_nlines = 1;
4946 (void)do_sub_msg(FALSE);
4947 ex_may_print(eap);
4948 }
4949
4950 if (!cmdmod.keeppatterns)
4951 save_re_pat(RE_SUBST, pat, p_magic);
4952#ifdef FEAT_CMDHIST
4953 /* put pattern in history */
4954 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4955#endif
4956
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004957 return;
4958 }
4959
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 /*
4961 * Find trailing options. When '&' is used, keep old options.
4962 */
4963 if (*cmd == '&')
4964 ++cmd;
4965 else
4966 {
4967 if (!p_ed)
4968 {
4969 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004970 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004972 subflags.do_all = FALSE;
4973 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004975 subflags.do_error = TRUE;
4976 subflags.do_print = FALSE;
4977 subflags.do_count = FALSE;
4978 subflags.do_number = FALSE;
4979 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 }
4981 while (*cmd)
4982 {
4983 /*
4984 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4985 * 'r' is never inverted.
4986 */
4987 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004988 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004990 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004991 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004992 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004994 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 else if (*cmd == 'r') /* use last used regexp */
4996 which_pat = RE_LAST;
4997 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004998 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004999 else if (*cmd == '#')
5000 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005001 subflags.do_print = TRUE;
5002 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005003 }
5004 else if (*cmd == 'l')
5005 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005006 subflags.do_print = TRUE;
5007 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005008 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005010 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005012 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 else
5014 break;
5015 ++cmd;
5016 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005017 if (subflags.do_count)
5018 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005020 save_do_all = subflags.do_all;
5021 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005022
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 /*
5024 * check for a trailing count
5025 */
5026 cmd = skipwhite(cmd);
5027 if (VIM_ISDIGIT(*cmd))
5028 {
5029 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005030 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 {
5032 EMSG(_(e_zerocount));
5033 return;
5034 }
5035 eap->line1 = eap->line2;
5036 eap->line2 += i - 1;
5037 if (eap->line2 > curbuf->b_ml.ml_line_count)
5038 eap->line2 = curbuf->b_ml.ml_line_count;
5039 }
5040
5041 /*
5042 * check for trailing command or garbage
5043 */
5044 cmd = skipwhite(cmd);
5045 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5046 {
5047 eap->nextcmd = check_nextcmd(cmd);
5048 if (eap->nextcmd == NULL)
5049 {
5050 EMSG(_(e_trailing));
5051 return;
5052 }
5053 }
5054
5055 if (eap->skip) /* not executing commands, only parsing */
5056 return;
5057
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005058 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005059 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005060 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005061 EMSG(_(e_modifiable));
5062 return;
5063 }
5064
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5066 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005067 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 EMSG(_(e_invcmd));
5069 return;
5070 }
5071
5072 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005073 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005075 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 regmatch.rmm_ic = FALSE;
5077
5078 sub_firstline = NULL;
5079
5080 /*
5081 * ~ in the substitute pattern is replaced with the old pattern.
5082 * We do it here once to avoid it to be replaced over and over again.
5083 * But don't do it when it starts with "\=", then it's an expression.
5084 */
5085 if (!(sub[0] == '\\' && sub[1] == '='))
5086 sub = regtilde(sub, p_magic);
5087
5088 /*
5089 * Check for a match on each line.
5090 */
5091 line2 = eap->line2;
5092 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5093#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5094 || aborting()
5095#endif
5096 ); ++lnum)
5097 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005098 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5099 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 if (nmatch)
5101 {
5102 colnr_T copycol;
5103 colnr_T matchcol;
5104 colnr_T prev_matchcol = MAXCOL;
5105 char_u *new_end, *new_start = NULL;
5106 unsigned new_start_len = 0;
5107 char_u *p1;
5108 int did_sub = FALSE;
5109 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005110 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 long nmatch_tl = 0; /* nr of lines matched below lnum */
5112 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005113 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005114 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
5116 /*
5117 * The new text is build up step by step, to avoid too much
5118 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005119 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 * copycol Column in the old text where we started
5121 * looking for a match; from here old text still
5122 * needs to be copied to the new text.
5123 * matchcol Column number of the old text where to look
5124 * for the next match. It's just after the
5125 * previous match or one further.
5126 * prev_matchcol Column just after the previous match (if any).
5127 * Mostly equal to matchcol, except for the first
5128 * match and after skipping an empty match.
5129 * regmatch.*pos Where the pattern matched in the old text.
5130 * new_start The new text, all that has been produced so
5131 * far.
5132 * new_end The new text, where to append new text.
5133 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005134 * lnum The line number where we found the start of
5135 * the match. Can be below the line we searched
5136 * when there is a \n before a \zs in the
5137 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 * sub_firstlnum The line number in the buffer where to look
5139 * for a match. Can be different from "lnum"
5140 * when the pattern or substitute string contains
5141 * line breaks.
5142 *
5143 * Special situations:
5144 * - When the substitute string contains a line break, the part up
5145 * to the line break is inserted in the text, but the copy of
5146 * the original line is kept. "sub_firstlnum" is adjusted for
5147 * the inserted lines.
5148 * - When the matched pattern contains a line break, the old line
5149 * is taken from the line at the end of the pattern. The lines
5150 * in the match are deleted later, "sub_firstlnum" is adjusted
5151 * accordingly.
5152 *
5153 * The new text is built up in new_start[]. It has some extra
5154 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005155 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 *
5157 * Make a copy of the old line, so it won't be taken away when
5158 * updating the screen or handling a multi-line match. The "old_"
5159 * pointers point into this copy.
5160 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005161 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 copycol = 0;
5163 matchcol = 0;
5164
5165 /* At first match, remember current cursor position. */
5166 if (!got_match)
5167 {
5168 setpcmark();
5169 got_match = TRUE;
5170 }
5171
5172 /*
5173 * Loop until nothing more to replace in this line.
5174 * 1. Handle match with empty string.
5175 * 2. If do_ask is set, ask for confirmation.
5176 * 3. substitute the string.
5177 * 4. if do_all is set, find next match
5178 * 5. break if there isn't another match in this line
5179 */
5180 for (;;)
5181 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005182 /* Advance "lnum" to the line where the match starts. The
5183 * match does not start in the first line when there is a line
5184 * break before \zs. */
5185 if (regmatch.startpos[0].lnum > 0)
5186 {
5187 lnum += regmatch.startpos[0].lnum;
5188 sub_firstlnum += regmatch.startpos[0].lnum;
5189 nmatch -= regmatch.startpos[0].lnum;
5190 vim_free(sub_firstline);
5191 sub_firstline = NULL;
5192 }
5193
5194 if (sub_firstline == NULL)
5195 {
5196 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5197 if (sub_firstline == NULL)
5198 {
5199 vim_free(new_start);
5200 goto outofmem;
5201 }
5202 }
5203
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 /* Save the line number of the last change for the final
5205 * cursor position (just like Vi). */
5206 curwin->w_cursor.lnum = lnum;
5207 do_again = FALSE;
5208
5209 /*
5210 * 1. Match empty string does not count, except for first
5211 * match. This reproduces the strange vi behaviour.
5212 * This also catches endless loops.
5213 */
5214 if (matchcol == prev_matchcol
5215 && regmatch.endpos[0].lnum == 0
5216 && matchcol == regmatch.endpos[0].col)
5217 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005218 if (sub_firstline[matchcol] == NUL)
5219 /* We already were at the end of the line. Don't look
5220 * for a match in this line again. */
5221 skip_match = TRUE;
5222 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005223 {
5224 /* search for a match at next column */
5225#ifdef FEAT_MBYTE
5226 if (has_mbyte)
5227 matchcol += mb_ptr2len(sub_firstline + matchcol);
5228 else
5229#endif
5230 ++matchcol;
5231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 goto skip;
5233 }
5234
5235 /* Normally we continue searching for a match just after the
5236 * previous match. */
5237 matchcol = regmatch.endpos[0].col;
5238 prev_matchcol = matchcol;
5239
5240 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005241 * 2. If do_count is set only increase the counter.
5242 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005244 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005245 {
5246 /* For a multi-line match, put matchcol at the NUL at
5247 * the end of the line and set nmatch to one, so that
5248 * we continue looking for a match on the next line.
5249 * Avoids that ":s/\nB\@=//gc" get stuck. */
5250 if (nmatch > 1)
5251 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005252 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005253 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005254 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005255 }
5256 sub_nsubs++;
5257 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005258#ifdef FEAT_EVAL
5259 /* Skip the substitution, unless an expression is used,
5260 * then it is evaluated in the sandbox. */
5261 if (!(sub[0] == '\\' && sub[1] == '='))
5262#endif
5263 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005264 }
5265
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005266 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005268 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005269
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 /* change State to CONFIRM, so that the mouse works
5271 * properly */
5272 save_State = State;
5273 State = CONFIRM;
5274#ifdef FEAT_MOUSE
5275 setmouse(); /* disable mouse in xterm */
5276#endif
5277 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005278#ifdef FEAT_CURSORBIND
5279 if (curwin->w_p_crb)
5280 do_check_cursorbind();
5281#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282
5283 /* When 'cpoptions' contains "u" don't sync undo when
5284 * asking for confirmation. */
5285 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5286 ++no_u_sync;
5287
5288 /*
5289 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5290 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005291 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005293 if (exmode_active)
5294 {
5295 char_u *resp;
5296 colnr_T sc, ec;
5297
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005298 print_line_no_prefix(lnum,
5299 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005300
5301 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5302 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005303 if (curwin->w_cursor.col < 0)
5304 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005305 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005306 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005307 {
5308 int numw = number_width(curwin) + 1;
5309 sc += numw;
5310 ec += numw;
5311 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005312 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005313 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005314 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005315 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005316 msg_putchar('^');
5317
5318 resp = getexmodeline('?', NULL, 0);
5319 if (resp != NULL)
5320 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005321 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005322 vim_free(resp);
5323 }
5324 }
5325 else
5326 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005327 char_u *orig_line = NULL;
5328 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005330 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005332 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005334 /* Invert the matched string.
5335 * Remove the inversion afterwards. */
5336 temp = RedrawingDisabled;
5337 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005339 if (new_start != NULL)
5340 {
5341 /* There already was a substitution, we would
5342 * like to show this to the user. We cannot
5343 * really update the line, it would change
5344 * what matches. Temporarily replace the line
5345 * and change it back afterwards. */
5346 orig_line = vim_strsave(ml_get(lnum));
5347 if (orig_line != NULL)
5348 {
5349 char_u *new_line = concat_str(new_start,
5350 sub_firstline + copycol);
5351
5352 if (new_line == NULL)
5353 {
5354 vim_free(orig_line);
5355 orig_line = NULL;
5356 }
5357 else
5358 {
5359 /* Position the cursor relative to the
5360 * end of the line, the previous
5361 * substitute may have inserted or
5362 * deleted characters before the
5363 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005364 len_change = (int)STRLEN(new_line)
5365 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005366 curwin->w_cursor.col += len_change;
5367 ml_replace(lnum, new_line, FALSE);
5368 }
5369 }
5370 }
5371
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005372 search_match_lines = regmatch.endpos[0].lnum
5373 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005374 search_match_endcol = regmatch.endpos[0].col
5375 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005376 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005378 update_topline();
5379 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005380 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005381 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005382 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383
5384#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005385 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005387 if (msg_row == Rows - 1)
5388 msg_didout = FALSE; /* avoid a scroll-up */
5389 msg_starthere();
5390 i = msg_scroll;
5391 msg_scroll = 0; /* truncate msg when
5392 needed */
5393 msg_no_more = TRUE;
5394 /* write message same highlighting as for
5395 * wait_return */
5396 smsg_attr(hl_attr(HLF_R),
5397 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5398 msg_no_more = FALSE;
5399 msg_scroll = i;
5400 showruler(TRUE);
5401 windgoto(msg_row, msg_col);
5402 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403
5404#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005405 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005407 ++no_mapping; /* don't map this key */
5408 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005409 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005410 --allow_keys;
5411 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005413 /* clear the question */
5414 msg_didout = FALSE; /* don't scroll up */
5415 msg_col = 0;
5416 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005417
5418 /* restore the line */
5419 if (orig_line != NULL)
5420 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005421 }
5422
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005424 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005426 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427#endif
5428 )
5429 {
5430 got_quit = TRUE;
5431 break;
5432 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005433 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005435 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005437 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 {
5439 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005440 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 line2 = lnum;
5442 break;
5443 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005444 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005446 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 break;
5448 }
5449#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005450 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005452 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 scrolldown_clamp();
5454#endif
5455 }
5456 State = save_State;
5457#ifdef FEAT_MOUSE
5458 setmouse();
5459#endif
5460 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5461 --no_u_sync;
5462
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005463 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 {
5465 /* For a multi-line match, put matchcol at the NUL at
5466 * the end of the line and set nmatch to one, so that
5467 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005468 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5469 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 if (nmatch > 1)
5471 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005472 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005473 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 }
5475 goto skip;
5476 }
5477 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005478 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 }
5480
5481 /* Move the cursor to the start of the match, so that we can
5482 * use "\=col("."). */
5483 curwin->w_cursor.col = regmatch.startpos[0].col;
5484
5485 /*
5486 * 3. substitute the string.
5487 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005488#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005489 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005490 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005491 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005492 save_ma = curbuf->b_p_ma;
5493 curbuf->b_p_ma = FALSE;
5494 sandbox++;
5495 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005496 /* Save flags for recursion. They can change for e.g.
5497 * :s/^/\=execute("s#^##gn") */
5498 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005499#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005501 sublen = vim_regsub_multi(&regmatch,
5502 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005504#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005505 /* Don't keep flags set by a recursive call. */
5506 subflags = subflags_save;
5507 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005508 {
5509 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005510 if (sandbox > 0)
5511 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005512 goto skip;
5513 }
5514#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515
Bram Moolenaar4463f292005-09-25 22:20:24 +00005516 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005517 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005518 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5519 {
5520 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5521 skip_match = TRUE;
5522 }
5523
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 /* Need room for:
5525 * - result so far in new_start (not for first sub in line)
5526 * - original text up to match
5527 * - length of substituted part
5528 * - original text after match
5529 */
5530 if (nmatch == 1)
5531 p1 = sub_firstline;
5532 else
5533 {
5534 p1 = ml_get(sub_firstlnum + nmatch - 1);
5535 nmatch_tl += nmatch - 1;
5536 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005537 copy_len = regmatch.startpos[0].col - copycol;
5538 needed_len = copy_len + ((unsigned)STRLEN(p1)
5539 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 if (new_start == NULL)
5541 {
5542 /*
5543 * Get some space for a temporary buffer to do the
5544 * substitution into (and some extra space to avoid
5545 * too many calls to alloc()/free()).
5546 */
5547 new_start_len = needed_len + 50;
5548 if ((new_start = alloc_check(new_start_len)) == NULL)
5549 goto outofmem;
5550 *new_start = NUL;
5551 new_end = new_start;
5552 }
5553 else
5554 {
5555 /*
5556 * Check if the temporary buffer is long enough to do the
5557 * substitution into. If not, make it larger (with a bit
5558 * extra to avoid too many calls to alloc()/free()).
5559 */
5560 len = (unsigned)STRLEN(new_start);
5561 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005562 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 {
5564 new_start_len = needed_len + 50;
5565 if ((p1 = alloc_check(new_start_len)) == NULL)
5566 {
5567 vim_free(new_start);
5568 goto outofmem;
5569 }
5570 mch_memmove(p1, new_start, (size_t)(len + 1));
5571 vim_free(new_start);
5572 new_start = p1;
5573 }
5574 new_end = new_start + len;
5575 }
5576
5577 /*
5578 * copy the text up to the part that matched
5579 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005580 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5581 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005583 (void)vim_regsub_multi(&regmatch,
5584 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 sub, new_end, TRUE, p_magic, TRUE);
5586 sub_nsubs++;
5587 did_sub = TRUE;
5588
5589 /* Move the cursor to the start of the line, to avoid that it
5590 * is beyond the end of the line after the substitution. */
5591 curwin->w_cursor.col = 0;
5592
5593 /* For a multi-line match, make a copy of the last matched
5594 * line and continue in that one. */
5595 if (nmatch > 1)
5596 {
5597 sub_firstlnum += nmatch - 1;
5598 vim_free(sub_firstline);
5599 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5600 /* When going beyond the last line, stop substituting. */
5601 if (sub_firstlnum <= line2)
5602 do_again = TRUE;
5603 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005604 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 }
5606
5607 /* Remember next character to be copied. */
5608 copycol = regmatch.endpos[0].col;
5609
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005610 if (skip_match)
5611 {
5612 /* Already hit end of the buffer, sub_firstlnum is one
5613 * less than what it ought to be. */
5614 vim_free(sub_firstline);
5615 sub_firstline = vim_strsave((char_u *)"");
5616 copycol = 0;
5617 }
5618
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 /*
5620 * Now the trick is to replace CTRL-M chars with a real line
5621 * break. This would make it impossible to insert a CTRL-M in
5622 * the text. The line break can be avoided by preceding the
5623 * CTRL-M with a backslash. To be able to insert a backslash,
5624 * they must be doubled in the string and are halved here.
5625 * That is Vi compatible.
5626 */
5627 for (p1 = new_end; *p1; ++p1)
5628 {
5629 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005630 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 else if (*p1 == CAR)
5632 {
5633 if (u_inssub(lnum) == OK) /* prepare for undo */
5634 {
5635 *p1 = NUL; /* truncate up to the CR */
5636 ml_append(lnum - 1, new_start,
5637 (colnr_T)(p1 - new_start + 1), FALSE);
5638 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005639 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 appended_lines(lnum - 1, 1L);
5641 else
5642 {
5643 if (first_line == 0)
5644 first_line = lnum;
5645 last_line = lnum + 1;
5646 }
5647 /* All line numbers increase. */
5648 ++sub_firstlnum;
5649 ++lnum;
5650 ++line2;
5651 /* move the cursor to the new line, like Vi */
5652 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005653 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005654 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 p1 = new_start - 1;
5656 }
5657 }
5658#ifdef FEAT_MBYTE
5659 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005660 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661#endif
5662 }
5663
5664 /*
5665 * 4. If do_all is set, find next match.
5666 * Prevent endless loop with patterns that match empty
5667 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5668 * But ":s/\n/#/" is OK.
5669 */
5670skip:
5671 /* We already know that we did the last subst when we are at
5672 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005673 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5674 * "line2" when there is a \zs in the pattern after a line
5675 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005676 lastone = (skip_match
5677 || got_int
5678 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005679 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005680 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005681 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5682 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 nmatch = -1;
5684
5685 /*
5686 * Replace the line in the buffer when needed. This is
5687 * skipped when there are more matches.
5688 * The check for nmatch_tl is needed for when multi-line
5689 * matching must replace the lines before trying to do another
5690 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005691 * When the match starts below where we start searching also
5692 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 */
5694 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 || nmatch_tl > 0
5696 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005697 curbuf, sub_firstlnum,
5698 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005699 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 {
5701 if (new_start != NULL)
5702 {
5703 /*
5704 * Copy the rest of the line, that didn't match.
5705 * "matchcol" has to be adjusted, we use the end of
5706 * the line as reference, because the substitute may
5707 * have changed the number of characters. Same for
5708 * "prev_matchcol".
5709 */
5710 STRCAT(new_start, sub_firstline + copycol);
5711 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5712 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5713 - prev_matchcol;
5714
5715 if (u_savesub(lnum) != OK)
5716 break;
5717 ml_replace(lnum, new_start, TRUE);
5718
5719 if (nmatch_tl > 0)
5720 {
5721 /*
5722 * Matched lines have now been substituted and are
5723 * useless, delete them. The part after the match
5724 * has been appended to new_start, we don't need
5725 * it in the buffer.
5726 */
5727 ++lnum;
5728 if (u_savedel(lnum, nmatch_tl) != OK)
5729 break;
5730 for (i = 0; i < nmatch_tl; ++i)
5731 ml_delete(lnum, (int)FALSE);
5732 mark_adjust(lnum, lnum + nmatch_tl - 1,
5733 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005734 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 deleted_lines(lnum, nmatch_tl);
5736 --lnum;
5737 line2 -= nmatch_tl; /* nr of lines decreases */
5738 nmatch_tl = 0;
5739 }
5740
5741 /* When asking, undo is saved each time, must also set
5742 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005743 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 changed_bytes(lnum, 0);
5745 else
5746 {
5747 if (first_line == 0)
5748 first_line = lnum;
5749 last_line = lnum + 1;
5750 }
5751
5752 sub_firstlnum = lnum;
5753 vim_free(sub_firstline); /* free the temp buffer */
5754 sub_firstline = new_start;
5755 new_start = NULL;
5756 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5757 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5758 - prev_matchcol;
5759 copycol = 0;
5760 }
5761 if (nmatch == -1 && !lastone)
5762 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005763 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764
5765 /*
5766 * 5. break if there isn't another match in this line
5767 */
5768 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005769 {
5770 /* If the match found didn't start where we were
5771 * searching, do the next search in the line where we
5772 * found the match. */
5773 if (nmatch == -1)
5774 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005776 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 }
5778
5779 line_breakcheck();
5780 }
5781
5782 if (did_sub)
5783 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005784 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 vim_free(sub_firstline); /* free the copy of the original line */
5786 sub_firstline = NULL;
5787 }
5788
5789 line_breakcheck();
5790 }
5791
5792 if (first_line != 0)
5793 {
5794 /* Need to subtract the number of added lines from "last_line" to get
5795 * the line number before the change (same as adding the number of
5796 * deleted lines). */
5797 i = curbuf->b_ml.ml_line_count - old_line_count;
5798 changed_lines(first_line, 0, last_line - i, i);
5799 }
5800
5801outofmem:
5802 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005803
5804 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005805 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005806 curwin->w_cursor = old_cursor;
5807
Bram Moolenaar46475522010-03-23 17:36:29 +01005808 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 {
5810 /* Set the '[ and '] marks. */
5811 curbuf->b_op_start.lnum = eap->line1;
5812 curbuf->b_op_end.lnum = line2;
5813 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5814
5815 if (!global_busy)
5816 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005817 /* when interactive leave cursor on the match */
5818 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005819 {
5820 if (endcolumn)
5821 coladvance((colnr_T)MAXCOL);
5822 else
5823 beginline(BL_WHITE | BL_FIX);
5824 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005825 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 MSG("");
5827 }
5828 else
5829 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005830 if (subflags.do_print)
5831 print_line(curwin->w_cursor.lnum,
5832 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 }
5834 else if (!global_busy)
5835 {
5836 if (got_int) /* interrupted */
5837 EMSG(_(e_interr));
5838 else if (got_match) /* did find something but nothing substituted */
5839 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005840 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 EMSG2(_(e_patnotf2), get_search_pat());
5842 }
5843
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005844#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005845 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005846 /* Cursor position may require updating */
5847 changed_window_setting();
5848#endif
5849
Bram Moolenaar473de612013-06-08 18:19:48 +02005850 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005851
5852 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005853 subflags.do_all = save_do_all;
5854 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855}
5856
5857/*
5858 * Give message for number of substitutions.
5859 * Can also be used after a ":global" command.
5860 * Return TRUE if a message was given.
5861 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005862 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005863do_sub_msg(
5864 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865{
5866 /*
5867 * Only report substitutions when:
5868 * - more than 'report' substitutions
5869 * - command was typed by user, or number of changed lines > 'report'
5870 * - giving messages is not disabled by 'lazyredraw'
5871 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005872 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5873 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 && messaging())
5875 {
5876 if (got_int)
5877 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005878 else
5879 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005881 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005882 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005884 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005885 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 sub_nsubs);
5887 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005888 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005889 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005891 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005892 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005895 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 return TRUE;
5897 }
5898 if (got_int)
5899 {
5900 EMSG(_(e_interr));
5901 return TRUE;
5902 }
5903 return FALSE;
5904}
5905
5906/*
5907 * Execute a global command of the form:
5908 *
5909 * g/pattern/X : execute X on all lines where pattern matches
5910 * v/pattern/X : execute X on all lines where pattern does not match
5911 *
5912 * where 'X' is an EX command
5913 *
5914 * The command character (as well as the trailing slash) is optional, and
5915 * is assumed to be 'p' if missing.
5916 *
5917 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005918 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 * for each line that has a mark. This is required because after deleting
5920 * lines we do not know where to search for the next match.
5921 */
5922 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005923ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924{
5925 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005926 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 int type; /* first char of cmd: 'v' or 'g' */
5928 char_u *cmd; /* command argument */
5929
5930 char_u delim; /* delimiter, normally '/' */
5931 char_u *pat;
5932 regmmatch_T regmatch;
5933 int match;
5934 int which_pat;
5935
5936 if (global_busy)
5937 {
5938 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5939 return;
5940 }
5941
5942 if (eap->forceit) /* ":global!" is like ":vglobal" */
5943 type = 'v';
5944 else
5945 type = *eap->cmd;
5946 cmd = eap->arg;
5947 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948
5949 /*
5950 * undocumented vi feature:
5951 * "\/" and "\?": use previous search pattern.
5952 * "\&": use previous substitute pattern.
5953 */
5954 if (*cmd == '\\')
5955 {
5956 ++cmd;
5957 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5958 {
5959 EMSG(_(e_backslash));
5960 return;
5961 }
5962 if (*cmd == '&')
5963 which_pat = RE_SUBST; /* use previous substitute pattern */
5964 else
5965 which_pat = RE_SEARCH; /* use previous search pattern */
5966 ++cmd;
5967 pat = (char_u *)"";
5968 }
5969 else if (*cmd == NUL)
5970 {
5971 EMSG(_("E148: Regular expression missing from global"));
5972 return;
5973 }
5974 else
5975 {
5976 delim = *cmd; /* get the delimiter */
5977 if (delim)
5978 ++cmd; /* skip delimiter if there is one */
5979 pat = cmd; /* remember start of pattern */
5980 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5981 if (cmd[0] == delim) /* end delimiter found */
5982 *cmd++ = NUL; /* replace it with a NUL */
5983 }
5984
5985#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5986 if (p_altkeymap && curwin->w_p_rl)
5987 lrFswap(pat,0);
5988#endif
5989
5990 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5991 {
5992 EMSG(_(e_invcmd));
5993 return;
5994 }
5995
5996 /*
5997 * pass 1: set marks for each (not) matching line
5998 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6000 {
6001 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006002 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
6003 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 if ((type == 'g' && match) || (type == 'v' && !match))
6005 {
6006 ml_setmarked(lnum);
6007 ndone++;
6008 }
6009 line_breakcheck();
6010 }
6011
6012 /*
6013 * pass 2: execute the command for each line that has been marked
6014 */
6015 if (got_int)
6016 MSG(_(e_interr));
6017 else if (ndone == 0)
6018 {
6019 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00006020 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01006022 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 }
6024 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006025 {
6026#ifdef FEAT_CLIPBOARD
6027 start_global_changes();
6028#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006030#ifdef FEAT_CLIPBOARD
6031 end_global_changes();
6032#endif
6033 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034
6035 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02006036 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037}
6038
6039/*
6040 * Execute "cmd" on lines marked with ml_setmarked().
6041 */
6042 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006043global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006045 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6046 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6047 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048
6049 /*
6050 * Set current position only once for a global command.
6051 * If global_busy is set, setpcmark() will not do anything.
6052 * If there is an error, global_busy will be incremented.
6053 */
6054 setpcmark();
6055
6056 /* When the command writes a message, don't overwrite the command. */
6057 msg_didout = TRUE;
6058
Bram Moolenaard25bc232010-03-23 17:49:24 +01006059 sub_nsubs = 0;
6060 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 global_need_beginline = FALSE;
6062 global_busy = 1;
6063 old_lcount = curbuf->b_ml.ml_line_count;
6064 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6065 {
6066 curwin->w_cursor.lnum = lnum;
6067 curwin->w_cursor.col = 0;
6068 if (*cmd == NUL || *cmd == '\n')
6069 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6070 else
6071 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6072 ui_breakcheck();
6073 }
6074
6075 global_busy = 0;
6076 if (global_need_beginline)
6077 beginline(BL_WHITE | BL_FIX);
6078 else
6079 check_cursor(); /* cursor may be beyond the end of the line */
6080
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006081 /* the cursor may not have moved in the text but a change in a previous
6082 * line may move it on the screen */
6083 changed_line_abv_curs();
6084
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 /* If it looks like no message was written, allow overwriting the
6086 * command with the report for number of changes. */
6087 if (msg_col == 0 && msg_scrolled == 0)
6088 msg_didout = FALSE;
6089
Bram Moolenaar45667512007-05-10 19:24:43 +00006090 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006091 * number of extra or deleted lines.
6092 * Don't report extra or deleted lines in the edge case where the buffer
6093 * we are in after execution is different from the buffer we started in. */
6094 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6096}
6097
6098#ifdef FEAT_VIMINFO
6099 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006100read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006102 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 vim_free(old_sub);
6104 if (force || old_sub == NULL)
6105 old_sub = viminfo_readstring(virp, 1, TRUE);
6106 return viminfo_readline(virp);
6107}
6108
6109 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006110write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111{
6112 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6113 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006114 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 viminfo_writestring(fp, old_sub);
6116 }
6117}
6118#endif /* FEAT_VIMINFO */
6119
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006120#if defined(EXITFREE) || defined(PROTO)
6121 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006122free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006123{
6124 vim_free(old_sub);
6125}
6126#endif
6127
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
6129/*
6130 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006131 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006133 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006134prepare_tagpreview(
6135 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136{
6137 win_T *wp;
6138
6139# ifdef FEAT_GUI
6140 need_mouse_correct = TRUE;
6141# endif
6142
6143 /*
6144 * If there is already a preview window open, use that one.
6145 */
6146 if (!curwin->w_p_pvw)
6147 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006148 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 if (wp->w_p_pvw)
6150 break;
6151 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006152 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 else
6154 {
6155 /*
6156 * There is no preview window open yet. Create one.
6157 */
6158 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6159 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006160 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 curwin->w_p_pvw = TRUE;
6162 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006163 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6164 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165# ifdef FEAT_DIFF
6166 curwin->w_p_diff = FALSE; /* no 'diff' */
6167# endif
6168# ifdef FEAT_FOLDING
6169 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6170# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006171 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 }
6173 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006174 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175}
6176
6177#endif
6178
6179
6180/*
6181 * ":help": open a read-only window on a help file
6182 */
6183 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006184ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185{
6186 char_u *arg;
6187 char_u *tag;
6188 FILE *helpfd; /* file descriptor of help file */
6189 int n;
6190 int i;
6191#ifdef FEAT_WINDOWS
6192 win_T *wp;
6193#endif
6194 int num_matches;
6195 char_u **matches;
6196 char_u *p;
6197 int empty_fnum = 0;
6198 int alt_fnum = 0;
6199 buf_T *buf;
6200#ifdef FEAT_MULTI_LANG
6201 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006202 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006204#ifdef FEAT_FOLDING
6205 int old_KeyTyped = KeyTyped;
6206#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207
6208 if (eap != NULL)
6209 {
6210 /*
6211 * A ":help" command ends at the first LF, or at a '|' that is
6212 * followed by some text. Set nextcmd to the following command.
6213 */
6214 for (arg = eap->arg; *arg; ++arg)
6215 {
6216 if (*arg == '\n' || *arg == '\r'
6217 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6218 {
6219 *arg++ = NUL;
6220 eap->nextcmd = arg;
6221 break;
6222 }
6223 }
6224 arg = eap->arg;
6225
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006226 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 {
6228 EMSG(_("E478: Don't panic!"));
6229 return;
6230 }
6231
6232 if (eap->skip) /* not executing commands */
6233 return;
6234 }
6235 else
6236 arg = (char_u *)"";
6237
6238 /* remove trailing blanks */
6239 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006240 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 *p-- = NUL;
6242
6243#ifdef FEAT_MULTI_LANG
6244 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006245 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246#endif
6247
6248 /* When no argument given go to the index. */
6249 if (*arg == NUL)
6250 arg = (char_u *)"help.txt";
6251
6252 /*
6253 * Check if there is a match for the argument.
6254 */
6255 n = find_help_tags(arg, &num_matches, &matches,
6256 eap != NULL && eap->forceit);
6257
6258 i = 0;
6259#ifdef FEAT_MULTI_LANG
6260 if (n != FAIL && lang != NULL)
6261 /* Find first item with the requested language. */
6262 for (i = 0; i < num_matches; ++i)
6263 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006264 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 if (len > 3 && matches[i][len - 3] == '@'
6266 && STRICMP(matches[i] + len - 2, lang) == 0)
6267 break;
6268 }
6269#endif
6270 if (i >= num_matches || n == FAIL)
6271 {
6272#ifdef FEAT_MULTI_LANG
6273 if (lang != NULL)
6274 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6275 else
6276#endif
6277 EMSG2(_("E149: Sorry, no help for %s"), arg);
6278 if (n != FAIL)
6279 FreeWild(num_matches, matches);
6280 return;
6281 }
6282
6283 /* The first match (in the requested language) is the best match. */
6284 tag = vim_strsave(matches[i]);
6285 FreeWild(num_matches, matches);
6286
6287#ifdef FEAT_GUI
6288 need_mouse_correct = TRUE;
6289#endif
6290
6291 /*
6292 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006293 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006295 if (!curwin->w_buffer->b_help
6296#ifdef FEAT_WINDOWS
6297 || cmdmod.tab != 0
6298#endif
6299 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 {
6301#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006302 if (cmdmod.tab != 0)
6303 wp = NULL;
6304 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006305 FOR_ALL_WINDOWS(wp)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006306 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
6307 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6309 win_enter(wp, TRUE);
6310 else
6311#endif
6312 {
6313 /*
6314 * There is no help window yet.
6315 * Try to open the file specified by the "helpfile" option.
6316 */
6317 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6318 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006319 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 goto erret;
6321 }
6322 fclose(helpfd);
6323
6324#ifdef FEAT_WINDOWS
6325 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006326 * specified, the current window is vertically split and
6327 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006330 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006333 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334#else
6335 /* use current window */
6336 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006338#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339
6340#ifdef FEAT_WINDOWS
6341 if (curwin->w_height < p_hh)
6342 win_setheight((int)p_hh);
6343#endif
6344
6345 /*
6346 * Open help file (do_ecmd() will set b_help flag, readfile() will
6347 * set b_p_ro flag).
6348 * Set the alternate file to the previously edited file.
6349 */
6350 alt_fnum = curbuf->b_fnum;
6351 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006352 ECMD_HIDE + ECMD_SET_HELP,
6353#ifdef FEAT_WINDOWS
6354 NULL /* buffer is still open, don't store info */
6355#else
6356 curwin
6357#endif
6358 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006359 if (!cmdmod.keepalt)
6360 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 empty_fnum = curbuf->b_fnum;
6362 }
6363 }
6364
6365 if (!p_im)
6366 restart_edit = 0; /* don't want insert mode in help file */
6367
Bram Moolenaar8f535582011-09-30 17:30:31 +02006368#ifdef FEAT_FOLDING
6369 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6370 * It is needed for do_tag top open folds under the cursor. */
6371 KeyTyped = old_KeyTyped;
6372#endif
6373
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 if (tag != NULL)
6375 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6376
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006377 /* Delete the empty buffer if we're not using it. Careful: autocommands
6378 * may have jumped to another window, check that the buffer is not in a
6379 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6381 {
6382 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006383 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 wipe_buffer(buf, TRUE);
6385 }
6386
6387 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006388 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 curwin->w_alt_fnum = alt_fnum;
6390
6391erret:
6392 vim_free(tag);
6393}
6394
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006395/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006396 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006397 */
6398 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006399ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006400{
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006401#if defined(FEAT_WINDOWS)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006402 win_T *win;
6403
6404 FOR_ALL_WINDOWS(win)
6405 {
6406 if (win->w_buffer->b_help)
6407 {
6408 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006409 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006410 }
6411 }
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006412#endif
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006413}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006415#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6416/*
6417 * In an argument search for a language specifiers in the form "@xx".
6418 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6419 * Returns NULL if not found.
6420 */
6421 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006422check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006423{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006424 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006425
6426 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6427 && ASCII_ISALPHA(arg[len - 1]))
6428 {
6429 arg[len - 3] = NUL; /* remove the '@' */
6430 return arg + len - 2;
6431 }
6432 return NULL;
6433}
6434#endif
6435
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436/*
6437 * Return a heuristic indicating how well the given string matches. The
6438 * smaller the number, the better the match. This is the order of priorities,
6439 * from best match to worst match:
6440 * - Match with least alpha-numeric characters is better.
6441 * - Match with least total characters is better.
6442 * - Match towards the start is better.
6443 * - Match starting with "+" is worse (feature instead of command)
6444 * Assumption is made that the matched_string passed has already been found to
6445 * match some string for which help is requested. webb.
6446 */
6447 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006448help_heuristic(
6449 char_u *matched_string,
6450 int offset, /* offset for match */
6451 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452{
6453 int num_letters;
6454 char_u *p;
6455
6456 num_letters = 0;
6457 for (p = matched_string; *p; p++)
6458 if (ASCII_ISALNUM(*p))
6459 num_letters++;
6460
6461 /*
6462 * Multiply the number of letters by 100 to give it a much bigger
6463 * weighting than the number of characters.
6464 * If there only is a match while ignoring case, add 5000.
6465 * If the match starts in the middle of a word, add 10000 to put it
6466 * somewhere in the last half.
6467 * If the match is more than 2 chars from the start, multiply by 200 to
6468 * put it after matches at the start.
6469 */
6470 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6471 && ASCII_ISALNUM(matched_string[offset - 1]))
6472 offset += 10000;
6473 else if (offset > 2)
6474 offset *= 200;
6475 if (wrong_case)
6476 offset += 5000;
6477 /* Features are less interesting than the subjects themselves, but "+"
6478 * alone is not a feature. */
6479 if (matched_string[0] == '+' && matched_string[1] != NUL)
6480 offset += 100;
6481 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6482}
6483
6484/*
6485 * Compare functions for qsort() below, that checks the help heuristics number
6486 * that has been put after the tagname by find_tags().
6487 */
6488 static int
6489#ifdef __BORLANDC__
6490_RTLENTRYF
6491#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006492help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493{
6494 char *p1;
6495 char *p2;
6496
6497 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6498 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6499 return strcmp(p1, p2);
6500}
6501
6502/*
6503 * Find all help tags matching "arg", sort them and return in matches[], with
6504 * the number of matches in num_matches.
6505 * The matches will be sorted with a "best" match algorithm.
6506 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6507 */
6508 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006509find_help_tags(
6510 char_u *arg,
6511 int *num_matches,
6512 char_u ***matches,
6513 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514{
6515 char_u *s, *d;
6516 int i;
6517 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006518 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006519 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006520 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006521 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006522 "[count]", "[quotex]",
6523 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006524 "[pattern]", "\\|", "\\%$",
6525 "s/\\~", "s/\\U", "s/\\L",
6526 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006528 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006529 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006530 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006531 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006532 "\\[count]", "\\[quotex]",
6533 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006534 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006535 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006536 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 int flags;
6538
6539 d = IObuff; /* assume IObuff is long enough! */
6540
6541 /*
6542 * Recognize a few exceptions to the rule. Some strings that contain '*'
6543 * with "star". Otherwise '*' is recognized as a wildcard.
6544 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006545 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 if (STRCMP(arg, mtable[i]) == 0)
6547 {
6548 STRCPY(d, rtable[i]);
6549 break;
6550 }
6551
6552 if (i < 0) /* no match in table */
6553 {
6554 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6555 * Also replace "\%^" and "\%(", they match every tag too.
6556 * Also "\zs", "\z1", etc.
6557 * Also "\@<", "\@=", "\@<=", etc.
6558 * And also "\_$" and "\_^". */
6559 if (arg[0] == '\\'
6560 && ((arg[1] != NUL && arg[2] == NUL)
6561 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6562 && arg[2] != NUL)))
6563 {
6564 STRCPY(d, "/\\\\");
6565 STRCPY(d + 3, arg + 1);
6566 /* Check for "/\\_$", should be "/\\_\$" */
6567 if (d[3] == '_' && d[4] == '$')
6568 STRCPY(d + 4, "\\$");
6569 }
6570 else
6571 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006572 /* Replace:
6573 * "[:...:]" with "\[:...:]"
6574 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006575 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006576 */
6577 if ((arg[0] == '[' && (arg[1] == ':'
6578 || (arg[1] == '+' && arg[2] == '+')))
6579 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 *d++ = '\\';
6581
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006582 /*
6583 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6584 */
6585 if (*arg == '(' && arg[1] == '\'')
6586 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 for (s = arg; *s; ++s)
6588 {
6589 /*
6590 * Replace "|" with "bar" and '"' with "quote" to match the name of
6591 * the tags for these commands.
6592 * Replace "*" with ".*" and "?" with "." to match command line
6593 * completion.
6594 * Insert a backslash before '~', '$' and '.' to avoid their
6595 * special meaning.
6596 */
6597 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6598 break;
6599 switch (*s)
6600 {
6601 case '|': STRCPY(d, "bar");
6602 d += 3;
6603 continue;
6604 case '"': STRCPY(d, "quote");
6605 d += 5;
6606 continue;
6607 case '*': *d++ = '.';
6608 break;
6609 case '?': *d++ = '.';
6610 continue;
6611 case '$':
6612 case '.':
6613 case '~': *d++ = '\\';
6614 break;
6615 }
6616
6617 /*
6618 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6619 * ":help i_^_CTRL-D" work.
6620 * Insert '-' before and after "CTRL-X" when applicable.
6621 */
6622 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6623 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6624 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006625 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6626 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 STRCPY(d, "CTRL-");
6628 d += 5;
6629 if (*s < ' ')
6630 {
6631#ifdef EBCDIC
6632 *d++ = CtrlChar(*s);
6633#else
6634 *d++ = *s + '@';
6635#endif
6636 if (d[-1] == '\\')
6637 *d++ = '\\'; /* double a backslash */
6638 }
6639 else
6640 *d++ = *++s;
6641 if (s[1] != NUL && s[1] != '_')
6642 *d++ = '_'; /* append a '_' */
6643 continue;
6644 }
6645 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6646 *d++ = '\\';
6647
6648 /*
6649 * Insert a backslash before a backslash after a slash, for search
6650 * pattern tags: "/\|" --> "/\\|".
6651 */
6652 else if (s[0] == '\\' && s[1] != '\\'
6653 && *arg == '/' && s == arg + 1)
6654 *d++ = '\\';
6655
6656 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6657 * "CTRL-\_CTRL-N" */
6658 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6659 {
6660 STRCPY(d, "CTRL-\\\\");
6661 d += 7;
6662 s += 6;
6663 }
6664
6665 *d++ = *s;
6666
6667 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006668 * If tag contains "({" or "([", tag terminates at the "(".
6669 * This is for help on functions, e.g.: abs({expr}).
6670 */
6671 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6672 break;
6673
6674 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 * If tag starts with ', toss everything after a second '. Fixes
6676 * CTRL-] on 'option'. (would include the trailing '.').
6677 */
6678 if (*s == '\'' && s > arg && *arg == '\'')
6679 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006680 /* Also '{' and '}'. */
6681 if (*s == '}' && s > arg && *arg == '{')
6682 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 }
6684 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006685
6686 if (*IObuff == '`')
6687 {
6688 if (d > IObuff + 2 && d[-1] == '`')
6689 {
6690 /* remove the backticks from `command` */
6691 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6692 d[-2] = NUL;
6693 }
6694 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6695 {
6696 /* remove the backticks and comma from `command`, */
6697 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6698 d[-3] = NUL;
6699 }
6700 else if (d > IObuff + 4 && d[-3] == '`'
6701 && d[-2] == '\\' && d[-1] == '.')
6702 {
6703 /* remove the backticks and dot from `command`\. */
6704 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6705 d[-4] = NUL;
6706 }
6707 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 }
6709 }
6710
6711 *matches = (char_u **)"";
6712 *num_matches = 0;
6713 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6714 if (keep_lang)
6715 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006716 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006718 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 /* Sort the matches found on the heuristic number that is after the
6720 * tag name. */
6721 qsort((void *)*matches, (size_t)*num_matches,
6722 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006723 /* Delete more than TAG_MANY to reduce the size of the listing. */
6724 while (*num_matches > TAG_MANY)
6725 vim_free((*matches)[--*num_matches]);
6726 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 return OK;
6728}
6729
6730/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006731 * Called when starting to edit a buffer for a help file.
6732 */
6733 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006734prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006735{
6736 char_u *p;
6737
6738 curbuf->b_help = TRUE;
6739#ifdef FEAT_QUICKFIX
6740 set_string_option_direct((char_u *)"buftype", -1,
6741 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6742#endif
6743
6744 /*
6745 * Always set these options after jumping to a help tag, because the
6746 * user may have an autocommand that gets in the way.
6747 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6748 * latin1 word characters (for translated help files).
6749 * Only set it when needed, buf_init_chartab() is some work.
6750 */
6751 p =
6752#ifdef EBCDIC
6753 (char_u *)"65-255,^*,^|,^\"";
6754#else
6755 (char_u *)"!-~,^*,^|,^\",192-255";
6756#endif
6757 if (STRCMP(curbuf->b_p_isk, p) != 0)
6758 {
6759 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6760 check_buf_options(curbuf);
6761 (void)buf_init_chartab(curbuf, FALSE);
6762 }
6763
Bram Moolenaar0b105412014-11-30 13:34:23 +01006764#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006765 /* Don't use the global foldmethod.*/
6766 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6767 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006768#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006769
6770 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6771 curwin->w_p_list = FALSE; /* no list mode */
6772
6773 curbuf->b_p_ma = FALSE; /* not modifiable */
6774 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6775 curwin->w_p_nu = 0; /* no line numbers */
6776 curwin->w_p_rnu = 0; /* no relative line numbers */
6777 RESET_BINDING(curwin); /* no scroll or cursor binding */
6778#ifdef FEAT_ARABIC
6779 curwin->w_p_arab = FALSE; /* no arabic mode */
6780#endif
6781#ifdef FEAT_RIGHTLEFT
6782 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6783#endif
6784#ifdef FEAT_FOLDING
6785 curwin->w_p_fen = FALSE; /* No folding in the help window */
6786#endif
6787#ifdef FEAT_DIFF
6788 curwin->w_p_diff = FALSE; /* No 'diff' */
6789#endif
6790#ifdef FEAT_SPELL
6791 curwin->w_p_spell = FALSE; /* No spell checking */
6792#endif
6793
6794 set_buflisted(FALSE);
6795}
6796
6797/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 * After reading a help file: May cleanup a help buffer when syntax
6799 * highlighting is not used.
6800 */
6801 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006802fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803{
6804 linenr_T lnum;
6805 char_u *line;
6806 int in_example = FALSE;
6807 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006808 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 char_u *p;
6810 char_u *rt;
6811 int mustfree;
6812
6813 /* set filetype to "help". */
6814 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6815
6816#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006817 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818#endif
6819 {
6820 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6821 {
6822 line = ml_get_buf(curbuf, lnum, FALSE);
6823 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006824 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 {
6826 /* End of example: non-white or '<' in first column. */
6827 if (line[0] == '<')
6828 {
6829 /* blank-out a '<' in the first column */
6830 line = ml_get_buf(curbuf, lnum, TRUE);
6831 line[0] = ' ';
6832 }
6833 in_example = FALSE;
6834 }
6835 if (!in_example && len > 0)
6836 {
6837 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6838 {
6839 /* blank-out a '>' in the last column (start of example) */
6840 line = ml_get_buf(curbuf, lnum, TRUE);
6841 line[len - 1] = ' ';
6842 in_example = TRUE;
6843 }
6844 else if (line[len - 1] == '~')
6845 {
6846 /* blank-out a '~' at the end of line (header marker) */
6847 line = ml_get_buf(curbuf, lnum, TRUE);
6848 line[len - 1] = ' ';
6849 }
6850 }
6851 }
6852 }
6853
6854 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006855 * In the "help.txt" and "help.abx" file, add the locally added help
6856 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006858 fname = gettail(curbuf->b_fname);
6859 if (fnamecmp(fname, "help.txt") == 0
6860#ifdef FEAT_MULTI_LANG
6861 || (fnamencmp(fname, "help.", 5) == 0
6862 && ASCII_ISALPHA(fname[5])
6863 && ASCII_ISALPHA(fname[6])
6864 && TOLOWER_ASC(fname[7]) == 'x'
6865 && fname[8] == NUL)
6866#endif
6867 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 {
6869 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6870 {
6871 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006872 if (strstr((char *)line, "*local-additions*") == NULL)
6873 continue;
6874
6875 /* Go through all directories in 'runtimepath', skipping
6876 * $VIMRUNTIME. */
6877 p = p_rtp;
6878 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006880 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6881 mustfree = FALSE;
6882 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6883 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006885 int fcount;
6886 char_u **fnames;
6887 FILE *fd;
6888 char_u *s;
6889 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006891 vimconv_T vc;
6892 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893#endif
6894
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006895 /* Find all "doc/ *.txt" files in this directory. */
6896 add_pathsep(NameBuff);
6897#ifdef FEAT_MULTI_LANG
6898 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006900 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006902 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6903 &fnames, EW_FILE|EW_SILENT) == OK
6904 && fcount > 0)
6905 {
6906#ifdef FEAT_MULTI_LANG
6907 int i1;
6908 int i2;
6909 char_u *f1;
6910 char_u *f2;
6911 char_u *t1;
6912 char_u *e1;
6913 char_u *e2;
6914
6915 /* If foo.abx is found use it instead of foo.txt in
6916 * the same directory. */
6917 for (i1 = 0; i1 < fcount; ++i1)
6918 {
6919 for (i2 = 0; i2 < fcount; ++i2)
6920 {
6921 if (i1 == i2)
6922 continue;
6923 if (fnames[i1] == NULL || fnames[i2] == NULL)
6924 continue;
6925 f1 = fnames[i1];
6926 f2 = fnames[i2];
6927 t1 = gettail(f1);
6928 if (fnamencmp(f1, f2, t1 - f1) != 0)
6929 continue;
6930 e1 = vim_strrchr(t1, '.');
6931 e2 = vim_strrchr(gettail(f2), '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02006932 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006933 continue;
6934 if (fnamecmp(e1, ".txt") != 0
6935 && fnamecmp(e1, fname + 4) != 0)
6936 {
6937 /* Not .txt and not .abx, remove it. */
6938 vim_free(fnames[i1]);
6939 fnames[i1] = NULL;
6940 continue;
6941 }
6942 if (fnamencmp(f1, f2, e1 - f1) != 0)
6943 continue;
6944 if (fnamecmp(e1, ".txt") == 0
6945 && fnamecmp(e2, fname + 4) == 0)
6946 {
6947 /* use .abx instead of .txt */
6948 vim_free(fnames[i1]);
6949 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 }
6951 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006953#endif
6954 for (fi = 0; fi < fcount; ++fi)
6955 {
6956 if (fnames[fi] == NULL)
6957 continue;
6958 fd = mch_fopen((char *)fnames[fi], "r");
6959 if (fd != NULL)
6960 {
6961 vim_fgets(IObuff, IOSIZE, fd);
6962 if (IObuff[0] == '*'
6963 && (s = vim_strchr(IObuff + 1, '*'))
6964 != NULL)
6965 {
6966#ifdef FEAT_MBYTE
6967 int this_utf = MAYBE;
6968#endif
6969 /* Change tag definition to a
6970 * reference and remove <CR>/<NL>. */
6971 IObuff[0] = '|';
6972 *s = '|';
6973 while (*s != NUL)
6974 {
6975 if (*s == '\r' || *s == '\n')
6976 *s = NUL;
6977#ifdef FEAT_MBYTE
6978 /* The text is utf-8 when a byte
6979 * above 127 is found and no
6980 * illegal byte sequence is found.
6981 */
6982 if (*s >= 0x80 && this_utf != FALSE)
6983 {
6984 int l;
6985
6986 this_utf = TRUE;
6987 l = utf_ptr2len(s);
6988 if (l == 1)
6989 this_utf = FALSE;
6990 s += l - 1;
6991 }
6992#endif
6993 ++s;
6994 }
6995#ifdef FEAT_MBYTE
6996 /* The help file is latin1 or utf-8;
6997 * conversion to the current
6998 * 'encoding' may be required. */
6999 vc.vc_type = CONV_NONE;
7000 convert_setup(&vc, (char_u *)(
7001 this_utf == TRUE ? "utf-8"
7002 : "latin1"), p_enc);
7003 if (vc.vc_type == CONV_NONE)
7004 /* No conversion needed. */
7005 cp = IObuff;
7006 else
7007 {
7008 /* Do the conversion. If it fails
7009 * use the unconverted text. */
7010 cp = string_convert(&vc, IObuff,
7011 NULL);
7012 if (cp == NULL)
7013 cp = IObuff;
7014 }
7015 convert_setup(&vc, NULL, NULL);
7016
7017 ml_append(lnum, cp, (colnr_T)0, FALSE);
7018 if (cp != IObuff)
7019 vim_free(cp);
7020#else
7021 ml_append(lnum, IObuff, (colnr_T)0,
7022 FALSE);
7023#endif
7024 ++lnum;
7025 }
7026 fclose(fd);
7027 }
7028 }
7029 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007032 if (mustfree)
7033 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007035 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 }
7037 }
7038}
7039
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007040/*
7041 * ":exusage"
7042 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007043 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007044ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007045{
7046 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7047}
7048
7049/*
7050 * ":viusage"
7051 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007052 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007053ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007054{
7055 do_cmdline_cmd((char_u *)"help normal-index");
7056}
7057
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007059 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007062helptags_one(
7063 char_u *dir, /* doc directory */
7064 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7065 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7066 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067{
7068 FILE *fd_tags;
7069 FILE *fd;
7070 garray_T ga;
7071 int filecount;
7072 char_u **files;
7073 char_u *p1, *p2;
7074 int fi;
7075 char_u *s;
7076 int i;
7077 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007078 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079# ifdef FEAT_MBYTE
7080 int utf8 = MAYBE;
7081 int this_utf8;
7082 int firstline;
7083 int mix = FALSE; /* detected mixed encodings */
7084# endif
7085
7086 /*
7087 * Find all *.txt files.
7088 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007089 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007091 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 STRCAT(NameBuff, ext);
7093 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7094 EW_FILE|EW_SILENT) == FAIL
7095 || filecount == 0)
7096 {
7097 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007098 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 return;
7100 }
7101
7102 /*
7103 * Open the tags file for writing.
7104 * Do this before scanning through all the files.
7105 */
7106 STRCPY(NameBuff, dir);
7107 add_pathsep(NameBuff);
7108 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007109 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 if (fd_tags == NULL)
7111 {
7112 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7113 FreeWild(filecount, files);
7114 return;
7115 }
7116
7117 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007118 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7119 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 */
7121 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007122 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7123 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 {
7125 if (ga_grow(&ga, 1) == FAIL)
7126 got_int = TRUE;
7127 else
7128 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007129 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 if (s == NULL)
7131 got_int = TRUE;
7132 else
7133 {
7134 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7135 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7136 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 }
7138 }
7139 }
7140
7141 /*
7142 * Go over all the files and extract the tags.
7143 */
7144 for (fi = 0; fi < filecount && !got_int; ++fi)
7145 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007146 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 if (fd == NULL)
7148 {
7149 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7150 continue;
7151 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007152 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153
7154# ifdef FEAT_MBYTE
7155 firstline = TRUE;
7156# endif
7157 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7158 {
7159# ifdef FEAT_MBYTE
7160 if (firstline)
7161 {
7162 /* Detect utf-8 file by a non-ASCII char in the first line. */
7163 this_utf8 = MAYBE;
7164 for (s = IObuff; *s != NUL; ++s)
7165 if (*s >= 0x80)
7166 {
7167 int l;
7168
7169 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007170 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 if (l == 1)
7172 {
7173 /* Illegal UTF-8 byte sequence. */
7174 this_utf8 = FALSE;
7175 break;
7176 }
7177 s += l - 1;
7178 }
7179 if (this_utf8 == MAYBE) /* only ASCII characters found */
7180 this_utf8 = FALSE;
7181 if (utf8 == MAYBE) /* first file */
7182 utf8 = this_utf8;
7183 else if (utf8 != this_utf8)
7184 {
7185 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7186 mix = !got_int;
7187 got_int = TRUE;
7188 }
7189 firstline = FALSE;
7190 }
7191# endif
7192 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7193 while (p1 != NULL)
7194 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007195 /* Use vim_strbyte() instead of vim_strchr() so that when
7196 * 'encoding' is dbcs it still works, don't find '*' in the
7197 * second byte. */
7198 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7200 {
7201 for (s = p1 + 1; s < p2; ++s)
7202 if (*s == ' ' || *s == '\t' || *s == '|')
7203 break;
7204
7205 /*
7206 * Only accept a *tag* when it consists of valid
7207 * characters, there is white space before it and is
7208 * followed by a white character or end-of-line.
7209 */
7210 if (s == p2
7211 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7212 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7213 || s[1] == '\0'))
7214 {
7215 *p2 = '\0';
7216 ++p1;
7217 if (ga_grow(&ga, 1) == FAIL)
7218 {
7219 got_int = TRUE;
7220 break;
7221 }
7222 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7223 if (s == NULL)
7224 {
7225 got_int = TRUE;
7226 break;
7227 }
7228 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7229 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 sprintf((char *)s, "%s\t%s", p1, fname);
7231
7232 /* find next '*' */
7233 p2 = vim_strchr(p2 + 1, '*');
7234 }
7235 }
7236 p1 = p2;
7237 }
7238 line_breakcheck();
7239 }
7240
7241 fclose(fd);
7242 }
7243
7244 FreeWild(filecount, files);
7245
7246 if (!got_int)
7247 {
7248 /*
7249 * Sort the tags.
7250 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007251 if (ga.ga_data != NULL)
7252 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253
7254 /*
7255 * Check for duplicates.
7256 */
7257 for (i = 1; i < ga.ga_len; ++i)
7258 {
7259 p1 = ((char_u **)ga.ga_data)[i - 1];
7260 p2 = ((char_u **)ga.ga_data)[i];
7261 while (*p1 == *p2)
7262 {
7263 if (*p2 == '\t')
7264 {
7265 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007266 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7268 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7269 EMSG(NameBuff);
7270 *p2 = '\t';
7271 break;
7272 }
7273 ++p1;
7274 ++p2;
7275 }
7276 }
7277
7278# ifdef FEAT_MBYTE
7279 if (utf8 == TRUE)
7280 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7281# endif
7282
7283 /*
7284 * Write the tags into the file.
7285 */
7286 for (i = 0; i < ga.ga_len; ++i)
7287 {
7288 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007289 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007291 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 else
7293 {
7294 fprintf(fd_tags, "%s\t/*", s);
7295 for (p1 = s; *p1 != '\t'; ++p1)
7296 {
7297 /* insert backslash before '\\' and '/' */
7298 if (*p1 == '\\' || *p1 == '/')
7299 putc('\\', fd_tags);
7300 putc(*p1, fd_tags);
7301 }
7302 fprintf(fd_tags, "*\n");
7303 }
7304 }
7305 }
7306#ifdef FEAT_MBYTE
7307 if (mix)
7308 got_int = FALSE; /* continue with other languages */
7309#endif
7310
7311 for (i = 0; i < ga.ga_len; ++i)
7312 vim_free(((char_u **)ga.ga_data)[i]);
7313 ga_clear(&ga);
7314 fclose(fd_tags); /* there is no check for an error... */
7315}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007317/*
7318 * Generate tags in one help directory, taking care of translations.
7319 */
7320 static void
7321do_helptags(char_u *dirname, int add_help_tags)
7322{
7323#ifdef FEAT_MULTI_LANG
7324 int len;
7325 int i, j;
7326 garray_T ga;
7327 char_u lang[2];
7328 char_u ext[5];
7329 char_u fname[8];
7330 int filecount;
7331 char_u **files;
7332
7333 /* Get a list of all files in the help directory and in subdirectories. */
7334 STRCPY(NameBuff, dirname);
7335 add_pathsep(NameBuff);
7336 STRCAT(NameBuff, "**");
7337 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7338 EW_FILE|EW_SILENT) == FAIL
7339 || filecount == 0)
7340 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007341 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007342 return;
7343 }
7344
7345 /* Go over all files in the directory to find out what languages are
7346 * present. */
7347 ga_init2(&ga, 1, 10);
7348 for (i = 0; i < filecount; ++i)
7349 {
7350 len = (int)STRLEN(files[i]);
7351 if (len > 4)
7352 {
7353 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7354 {
7355 /* ".txt" -> language "en" */
7356 lang[0] = 'e';
7357 lang[1] = 'n';
7358 }
7359 else if (files[i][len - 4] == '.'
7360 && ASCII_ISALPHA(files[i][len - 3])
7361 && ASCII_ISALPHA(files[i][len - 2])
7362 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7363 {
7364 /* ".abx" -> language "ab" */
7365 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7366 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7367 }
7368 else
7369 continue;
7370
7371 /* Did we find this language already? */
7372 for (j = 0; j < ga.ga_len; j += 2)
7373 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7374 break;
7375 if (j == ga.ga_len)
7376 {
7377 /* New language, add it. */
7378 if (ga_grow(&ga, 2) == FAIL)
7379 break;
7380 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7381 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7382 }
7383 }
7384 }
7385
7386 /*
7387 * Loop over the found languages to generate a tags file for each one.
7388 */
7389 for (j = 0; j < ga.ga_len; j += 2)
7390 {
7391 STRCPY(fname, "tags-xx");
7392 fname[5] = ((char_u *)ga.ga_data)[j];
7393 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7394 if (fname[5] == 'e' && fname[6] == 'n')
7395 {
7396 /* English is an exception: use ".txt" and "tags". */
7397 fname[4] = NUL;
7398 STRCPY(ext, ".txt");
7399 }
7400 else
7401 {
7402 /* Language "ab" uses ".abx" and "tags-ab". */
7403 STRCPY(ext, ".xxx");
7404 ext[1] = fname[5];
7405 ext[2] = fname[6];
7406 }
7407 helptags_one(dirname, ext, fname, add_help_tags);
7408 }
7409
7410 ga_clear(&ga);
7411 FreeWild(filecount, files);
7412
7413#else
7414 /* No language support, just use "*.txt" and "tags". */
7415 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7416#endif
7417}
7418
7419 static void
7420helptags_cb(char_u *fname, void *cookie)
7421{
7422 do_helptags(fname, *(int *)cookie);
7423}
7424
7425/*
7426 * ":helptags"
7427 */
7428 void
7429ex_helptags(exarg_T *eap)
7430{
7431 expand_T xpc;
7432 char_u *dirname;
7433 int add_help_tags = FALSE;
7434
7435 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007436 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007437 {
7438 add_help_tags = TRUE;
7439 eap->arg = skipwhite(eap->arg + 3);
7440 }
7441
7442 if (STRCMP(eap->arg, "ALL") == 0)
7443 {
7444 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7445 helptags_cb, &add_help_tags);
7446 }
7447 else
7448 {
7449 ExpandInit(&xpc);
7450 xpc.xp_context = EXPAND_DIRECTORIES;
7451 dirname = ExpandOne(&xpc, eap->arg, NULL,
7452 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7453 if (dirname == NULL || !mch_isdir(dirname))
7454 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7455 else
7456 do_helptags(dirname, add_help_tags);
7457 vim_free(dirname);
7458 }
7459}
7460
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461#if defined(FEAT_SIGNS) || defined(PROTO)
7462
7463/*
7464 * Struct to hold the sign properties.
7465 */
7466typedef struct sign sign_T;
7467
7468struct sign
7469{
7470 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007471 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 char_u *sn_name; /* name of sign */
7473 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007474# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007476# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 char_u *sn_text; /* text used instead of pixmap */
7478 int sn_line_hl; /* highlight ID for line */
7479 int sn_text_hl; /* highlight ID for text */
7480};
7481
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007483static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007485static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7486static void sign_list_defined(sign_T *sp);
7487static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007489static char *cmds[] = {
7490 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007491# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007492 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007493# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007494 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007495# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007496 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007497# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007498 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007499# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007500 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007501# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007502 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007503# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007504};
7505
7506/*
7507 * Find index of a ":sign" subcmd from its name.
7508 * "*end_cmd" must be writable.
7509 */
7510 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007511sign_cmd_idx(
7512 char_u *begin_cmd, /* begin of sign subcmd */
7513 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007514{
7515 int idx;
7516 char save = *end_cmd;
7517
7518 *end_cmd = NUL;
7519 for (idx = 0; ; ++idx)
7520 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7521 break;
7522 *end_cmd = save;
7523 return idx;
7524}
7525
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526/*
7527 * ":sign" command
7528 */
7529 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007530ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531{
7532 char_u *arg = eap->arg;
7533 char_u *p;
7534 int idx;
7535 sign_T *sp;
7536 sign_T *sp_prev;
7537 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538
7539 /* Parse the subcommand. */
7540 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007541 idx = sign_cmd_idx(arg, p);
7542 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007544 EMSG2(_("E160: Unknown sign command: %s"), arg);
7545 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 }
7547 arg = skipwhite(p);
7548
7549 if (idx <= SIGNCMD_LIST)
7550 {
7551 /*
7552 * Define, undefine or list signs.
7553 */
7554 if (idx == SIGNCMD_LIST && *arg == NUL)
7555 {
7556 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007557 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 sign_list_defined(sp);
7559 }
7560 else if (*arg == NUL)
7561 EMSG(_("E156: Missing sign name"));
7562 else
7563 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007564 /* Isolate the sign name. If it's a number skip leading zeroes,
7565 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 p = skiptowhite(arg);
7567 if (*p != NUL)
7568 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007569 while (arg[0] == '0' && arg[1] != NUL)
7570 ++arg;
7571
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 sp_prev = NULL;
7573 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7574 {
7575 if (STRCMP(sp->sn_name, arg) == 0)
7576 break;
7577 sp_prev = sp;
7578 }
7579 if (idx == SIGNCMD_DEFINE)
7580 {
7581 /* ":sign define {name} ...": define a sign */
7582 if (sp == NULL)
7583 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007584 sign_T *lp;
7585 int start = next_sign_typenr;
7586
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 /* Allocate a new sign. */
7588 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7589 if (sp == NULL)
7590 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007592 /* Check that next_sign_typenr is not already being used.
7593 * This only happens after wrapping around. Hopefully
7594 * another one got deleted and we can use its number. */
7595 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007597 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007599 ++next_sign_typenr;
7600 if (next_sign_typenr == MAX_TYPENR)
7601 next_sign_typenr = 1;
7602 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007604 vim_free(sp);
7605 EMSG(_("E612: Too many signs defined"));
7606 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007608 lp = first_sign; /* start all over */
7609 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007611 lp = lp->sn_next;
7612 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007614 sp->sn_typenr = next_sign_typenr;
7615 if (++next_sign_typenr == MAX_TYPENR)
7616 next_sign_typenr = 1; /* wrap around */
7617
7618 sp->sn_name = vim_strsave(arg);
7619 if (sp->sn_name == NULL) /* out of memory */
7620 {
7621 vim_free(sp);
7622 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007624
7625 /* add the new sign to the list of signs */
7626 if (sp_prev == NULL)
7627 first_sign = sp;
7628 else
7629 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 }
7631
7632 /* set values for a defined sign. */
7633 for (;;)
7634 {
7635 arg = skipwhite(p);
7636 if (*arg == NUL)
7637 break;
7638 p = skiptowhite_esc(arg);
7639 if (STRNCMP(arg, "icon=", 5) == 0)
7640 {
7641 arg += 5;
7642 vim_free(sp->sn_icon);
7643 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7644 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007645# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 if (gui.in_use)
7647 {
7648 out_flush();
7649 if (sp->sn_image != NULL)
7650 gui_mch_destroy_sign(sp->sn_image);
7651 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7652 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007653# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 }
7655 else if (STRNCMP(arg, "text=", 5) == 0)
7656 {
7657 char_u *s;
7658 int cells;
7659 int len;
7660
7661 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007662# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 /* Count cells and check for non-printable chars */
7664 if (has_mbyte)
7665 {
7666 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007667 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 {
7669 if (!vim_isprintc((*mb_ptr2char)(s)))
7670 break;
7671 cells += (*mb_ptr2cells)(s);
7672 }
7673 }
7674 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007675# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 {
7677 for (s = arg; s < p; ++s)
7678 if (!vim_isprintc(*s))
7679 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007680 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 }
7682 /* Currently must be one or two display cells */
7683 if (s != p || cells < 1 || cells > 2)
7684 {
7685 *p = NUL;
7686 EMSG2(_("E239: Invalid sign text: %s"), arg);
7687 return;
7688 }
7689
7690 vim_free(sp->sn_text);
7691 /* Allocate one byte more if we need to pad up
7692 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007693 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 sp->sn_text = vim_strnsave(arg, len);
7695
7696 if (sp->sn_text != NULL && cells == 1)
7697 STRCPY(sp->sn_text + len - 1, " ");
7698 }
7699 else if (STRNCMP(arg, "linehl=", 7) == 0)
7700 {
7701 arg += 7;
7702 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7703 }
7704 else if (STRNCMP(arg, "texthl=", 7) == 0)
7705 {
7706 arg += 7;
7707 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7708 }
7709 else
7710 {
7711 EMSG2(_(e_invarg2), arg);
7712 return;
7713 }
7714 }
7715 }
7716 else if (sp == NULL)
7717 EMSG2(_("E155: Unknown sign: %s"), arg);
7718 else if (idx == SIGNCMD_LIST)
7719 /* ":sign list {name}" */
7720 sign_list_defined(sp);
7721 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007723 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724 }
7725 }
7726 else
7727 {
7728 int id = -1;
7729 linenr_T lnum = -1;
7730 char_u *sign_name = NULL;
7731 char_u *arg1;
7732
7733 if (*arg == NUL)
7734 {
7735 if (idx == SIGNCMD_PLACE)
7736 {
7737 /* ":sign place": list placed signs in all buffers */
7738 sign_list_placed(NULL);
7739 }
7740 else if (idx == SIGNCMD_UNPLACE)
7741 {
7742 /* ":sign unplace": remove placed sign at cursor */
7743 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7744 if (id > 0)
7745 {
7746 buf_delsign(curwin->w_buffer, id);
7747 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7748 }
7749 else
7750 EMSG(_("E159: Missing sign number"));
7751 }
7752 else
7753 EMSG(_(e_argreq));
7754 return;
7755 }
7756
7757 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7758 {
7759 /* ":sign unplace *": remove all placed signs */
7760 buf_delete_all_signs();
7761 return;
7762 }
7763
7764 /* first arg could be placed sign id */
7765 arg1 = arg;
7766 if (VIM_ISDIGIT(*arg))
7767 {
7768 id = getdigits(&arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01007769 if (!VIM_ISWHITE(*arg) && *arg != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 {
7771 id = -1;
7772 arg = arg1;
7773 }
7774 else
7775 {
7776 arg = skipwhite(arg);
7777 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7778 {
7779 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007780 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 if ((lnum = buf_delsign(buf, id)) != 0)
7782 update_debug_sign(buf, lnum);
7783 return;
7784 }
7785 }
7786 }
7787
7788 /*
7789 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7790 * Leave "arg" pointing to {fname}.
7791 */
7792 for (;;)
7793 {
7794 if (STRNCMP(arg, "line=", 5) == 0)
7795 {
7796 arg += 5;
7797 lnum = atoi((char *)arg);
7798 arg = skiptowhite(arg);
7799 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007800 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7801 {
7802 if (id != -1)
7803 {
7804 EMSG(_(e_invarg));
7805 return;
7806 }
7807 id = -2;
7808 arg = skiptowhite(arg + 1);
7809 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007810 else if (STRNCMP(arg, "name=", 5) == 0)
7811 {
7812 arg += 5;
7813 sign_name = arg;
7814 arg = skiptowhite(arg);
7815 if (*arg != NUL)
7816 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007817 while (sign_name[0] == '0' && sign_name[1] != NUL)
7818 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 }
7820 else if (STRNCMP(arg, "file=", 5) == 0)
7821 {
7822 arg += 5;
7823 buf = buflist_findname(arg);
7824 break;
7825 }
7826 else if (STRNCMP(arg, "buffer=", 7) == 0)
7827 {
7828 arg += 7;
7829 buf = buflist_findnr((int)getdigits(&arg));
7830 if (*skipwhite(arg) != NUL)
7831 EMSG(_(e_trailing));
7832 break;
7833 }
7834 else
7835 {
7836 EMSG(_(e_invarg));
7837 return;
7838 }
7839 arg = skipwhite(arg);
7840 }
7841
7842 if (buf == NULL)
7843 {
7844 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7845 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007846 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 {
7848 if (lnum >= 0 || sign_name != NULL)
7849 EMSG(_(e_invarg));
7850 else
7851 /* ":sign place file={fname}": list placed signs in one file */
7852 sign_list_placed(buf);
7853 }
7854 else if (idx == SIGNCMD_JUMP)
7855 {
7856 /* ":sign jump {id} file={fname}" */
7857 if (lnum >= 0 || sign_name != NULL)
7858 EMSG(_(e_invarg));
7859 else if ((lnum = buf_findsign(buf, id)) > 0)
7860 { /* goto a sign ... */
7861 if (buf_jump_open_win(buf) != NULL)
7862 { /* ... in a current window */
7863 curwin->w_cursor.lnum = lnum;
7864 check_cursor_lnum();
7865 beginline(BL_WHITE);
7866 }
7867 else
7868 { /* ... not currently in a window */
7869 char_u *cmd;
7870
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007871 if (buf->b_fname == NULL)
7872 {
7873 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7874 return;
7875 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7877 if (cmd == NULL)
7878 return;
7879 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7880 do_cmdline_cmd(cmd);
7881 vim_free(cmd);
7882 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007883# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007885# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 }
7887 else
7888 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7889 }
7890 else if (idx == SIGNCMD_UNPLACE)
7891 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 if (lnum >= 0 || sign_name != NULL)
7893 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007894 else if (id == -2)
7895 {
7896 /* ":sign unplace * file={fname}" */
7897 redraw_buf_later(buf, NOT_VALID);
7898 buf_delete_signs(buf);
7899 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 else
7901 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007902 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 lnum = buf_delsign(buf, id);
7904 update_debug_sign(buf, lnum);
7905 }
7906 }
7907 /* idx == SIGNCMD_PLACE */
7908 else if (sign_name != NULL)
7909 {
7910 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7911 if (STRCMP(sp->sn_name, sign_name) == 0)
7912 break;
7913 if (sp == NULL)
7914 {
7915 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7916 return;
7917 }
7918 if (lnum > 0)
7919 /* ":sign place {id} line={lnum} name={name} file={fname}":
7920 * place a sign */
7921 buf_addsign(buf, id, lnum, sp->sn_typenr);
7922 else
7923 /* ":sign place {id} file={fname}": change sign type */
7924 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007925 if (lnum > 0)
7926 update_debug_sign(buf, lnum);
7927 else
7928 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 }
7930 else
7931 EMSG(_(e_invarg));
7932 }
7933}
7934
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007935# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936/*
7937 * Allocate the icons. Called when the GUI has started. Allows defining
7938 * signs before it starts.
7939 */
7940 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007941sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007942{
7943 sign_T *sp;
7944
7945 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7946 if (sp->sn_icon != NULL)
7947 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7948}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007949# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950
7951/*
7952 * List one sign.
7953 */
7954 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007955sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956{
7957 char_u *p;
7958
Bram Moolenaar555b2802005-05-19 21:08:39 +00007959 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 if (sp->sn_icon != NULL)
7961 {
7962 MSG_PUTS(" icon=");
7963 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007964# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 if (sp->sn_image == NULL)
7966 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007967# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007969# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 }
7971 if (sp->sn_text != NULL)
7972 {
7973 MSG_PUTS(" text=");
7974 msg_outtrans(sp->sn_text);
7975 }
7976 if (sp->sn_line_hl > 0)
7977 {
7978 MSG_PUTS(" linehl=");
7979 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7980 if (p == NULL)
7981 MSG_PUTS("NONE");
7982 else
7983 msg_puts(p);
7984 }
7985 if (sp->sn_text_hl > 0)
7986 {
7987 MSG_PUTS(" texthl=");
7988 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7989 if (p == NULL)
7990 MSG_PUTS("NONE");
7991 else
7992 msg_puts(p);
7993 }
7994}
7995
7996/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007997 * Undefine a sign and free its memory.
7998 */
7999 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008000sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008001{
8002 vim_free(sp->sn_name);
8003 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008004# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008005 if (sp->sn_image != NULL)
8006 {
8007 out_flush();
8008 gui_mch_destroy_sign(sp->sn_image);
8009 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008010# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008011 vim_free(sp->sn_text);
8012 if (sp_prev == NULL)
8013 first_sign = sp->sn_next;
8014 else
8015 sp_prev->sn_next = sp->sn_next;
8016 vim_free(sp);
8017}
8018
8019/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 * Get highlighting attribute for sign "typenr".
8021 * If "line" is TRUE: line highl, if FALSE: text highl.
8022 */
8023 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008024sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025{
8026 sign_T *sp;
8027
8028 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8029 if (sp->sn_typenr == typenr)
8030 {
8031 if (line)
8032 {
8033 if (sp->sn_line_hl > 0)
8034 return syn_id2attr(sp->sn_line_hl);
8035 }
8036 else
8037 {
8038 if (sp->sn_text_hl > 0)
8039 return syn_id2attr(sp->sn_text_hl);
8040 }
8041 break;
8042 }
8043 return 0;
8044}
8045
8046/*
8047 * Get text mark for sign "typenr".
8048 * Returns NULL if there isn't one.
8049 */
8050 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008051sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052{
8053 sign_T *sp;
8054
8055 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8056 if (sp->sn_typenr == typenr)
8057 return sp->sn_text;
8058 return NULL;
8059}
8060
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008061# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008063sign_get_image(
8064 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065{
8066 sign_T *sp;
8067
8068 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8069 if (sp->sn_typenr == typenr)
8070 return sp->sn_image;
8071 return NULL;
8072}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008073# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074
8075/*
8076 * Get the name of a sign by its typenr.
8077 */
8078 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008079sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080{
8081 sign_T *sp;
8082
8083 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8084 if (sp->sn_typenr == typenr)
8085 return sp->sn_name;
8086 return (char_u *)_("[Deleted]");
8087}
8088
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008089# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008090/*
8091 * Undefine/free all signs.
8092 */
8093 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008094free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008095{
8096 while (first_sign != NULL)
8097 sign_undefine(first_sign, NULL);
8098}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008099# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008100
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008101# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008102static enum
8103{
8104 EXP_SUBCMD, /* expand :sign sub-commands */
8105 EXP_DEFINE, /* expand :sign define {name} args */
8106 EXP_PLACE, /* expand :sign place {id} args */
8107 EXP_UNPLACE, /* expand :sign unplace" */
8108 EXP_SIGN_NAMES /* expand with name of placed signs */
8109} expand_what;
8110
8111/*
8112 * Function given to ExpandGeneric() to obtain the sign command
8113 * expansion.
8114 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008115 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008116get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008117{
8118 sign_T *sp;
8119 int current_idx;
8120
8121 switch (expand_what)
8122 {
8123 case EXP_SUBCMD:
8124 return (char_u *)cmds[idx];
8125 case EXP_DEFINE:
8126 {
8127 char *define_arg[] =
8128 {
8129 "icon=", "linehl=", "text=", "texthl=", NULL
8130 };
8131 return (char_u *)define_arg[idx];
8132 }
8133 case EXP_PLACE:
8134 {
8135 char *place_arg[] =
8136 {
8137 "line=", "name=", "file=", "buffer=", NULL
8138 };
8139 return (char_u *)place_arg[idx];
8140 }
8141 case EXP_UNPLACE:
8142 {
8143 char *unplace_arg[] = { "file=", "buffer=", NULL };
8144 return (char_u *)unplace_arg[idx];
8145 }
8146 case EXP_SIGN_NAMES:
8147 /* Complete with name of signs already defined */
8148 current_idx = 0;
8149 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8150 if (current_idx++ == idx)
8151 return sp->sn_name;
8152 return NULL;
8153 default:
8154 return NULL;
8155 }
8156}
8157
8158/*
8159 * Handle command line completion for :sign command.
8160 */
8161 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008162set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008163{
8164 char_u *p;
8165 char_u *end_subcmd;
8166 char_u *last;
8167 int cmd_idx;
8168 char_u *begin_subcmd_args;
8169
8170 /* Default: expand subcommands. */
8171 xp->xp_context = EXPAND_SIGN;
8172 expand_what = EXP_SUBCMD;
8173 xp->xp_pattern = arg;
8174
8175 end_subcmd = skiptowhite(arg);
8176 if (*end_subcmd == NUL)
8177 /* expand subcmd name
8178 * :sign {subcmd}<CTRL-D>*/
8179 return;
8180
8181 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8182
8183 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008184 * |
8185 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008186 begin_subcmd_args = skipwhite(end_subcmd);
8187 p = skiptowhite(begin_subcmd_args);
8188 if (*p == NUL)
8189 {
8190 /*
8191 * Expand first argument of subcmd when possible.
8192 * For ":jump {id}" and ":unplace {id}", we could
8193 * possibly expand the ids of all signs already placed.
8194 */
8195 xp->xp_pattern = begin_subcmd_args;
8196 switch (cmd_idx)
8197 {
8198 case SIGNCMD_LIST:
8199 case SIGNCMD_UNDEFINE:
8200 /* :sign list <CTRL-D>
8201 * :sign undefine <CTRL-D> */
8202 expand_what = EXP_SIGN_NAMES;
8203 break;
8204 default:
8205 xp->xp_context = EXPAND_NOTHING;
8206 }
8207 return;
8208 }
8209
8210 /* expand last argument of subcmd */
8211
8212 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008213 * |
8214 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008215
8216 /* Loop until reaching last argument. */
8217 do
8218 {
8219 p = skipwhite(p);
8220 last = p;
8221 p = skiptowhite(p);
8222 } while (*p != NUL);
8223
8224 p = vim_strchr(last, '=');
8225
8226 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008227 * | |
8228 * last p */
Bram Moolenaar7756e742016-10-21 20:35:37 +02008229 if (p == NULL)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008230 {
8231 /* Expand last argument name (before equal sign). */
8232 xp->xp_pattern = last;
8233 switch (cmd_idx)
8234 {
8235 case SIGNCMD_DEFINE:
8236 expand_what = EXP_DEFINE;
8237 break;
8238 case SIGNCMD_PLACE:
8239 expand_what = EXP_PLACE;
8240 break;
8241 case SIGNCMD_JUMP:
8242 case SIGNCMD_UNPLACE:
8243 expand_what = EXP_UNPLACE;
8244 break;
8245 default:
8246 xp->xp_context = EXPAND_NOTHING;
8247 }
8248 }
8249 else
8250 {
8251 /* Expand last argument value (after equal sign). */
8252 xp->xp_pattern = p + 1;
8253 switch (cmd_idx)
8254 {
8255 case SIGNCMD_DEFINE:
8256 if (STRNCMP(last, "texthl", p - last) == 0 ||
8257 STRNCMP(last, "linehl", p - last) == 0)
8258 xp->xp_context = EXPAND_HIGHLIGHT;
8259 else if (STRNCMP(last, "icon", p - last) == 0)
8260 xp->xp_context = EXPAND_FILES;
8261 else
8262 xp->xp_context = EXPAND_NOTHING;
8263 break;
8264 case SIGNCMD_PLACE:
8265 if (STRNCMP(last, "name", p - last) == 0)
8266 expand_what = EXP_SIGN_NAMES;
8267 else
8268 xp->xp_context = EXPAND_NOTHING;
8269 break;
8270 default:
8271 xp->xp_context = EXPAND_NOTHING;
8272 }
8273 }
8274}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008275# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008276#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008277
8278/*
8279 * Make the user happy.
8280 */
8281 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008282ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008283{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008284 static char *code[] = {
8285 "\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$",
8286 "\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"
8287 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008288 char *p;
8289 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008290 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008291
8292 msg_start();
8293 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008294 for (i = 0; i < 2; ++i)
8295 for (p = code[i]; *p != NUL; ++p)
8296 if (*p == 'x')
8297 msg_putchar('\n');
8298 else
8299 for (n = *p++; n > 0; --n)
8300 if (*p == 'o' || *p == '$')
8301 msg_putchar_attr(*p, hl_attr(HLF_L));
8302 else
8303 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008304 msg_clr_eos();
8305}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306
8307#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8308/*
8309 * ":drop"
8310 * Opens the first argument in a window. When there are two or more arguments
8311 * the argument list is redefined.
8312 */
8313 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008314ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315{
8316 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 win_T *wp;
8318 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008319# ifdef FEAT_WINDOWS
8320 tabpage_T *tp;
8321# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322
8323 /*
8324 * Check if the first argument is already being edited in a window. If
8325 * so, jump to that window.
8326 * We would actually need to check all arguments, but that's complicated
8327 * and mostly only one file is dropped.
8328 * This also ignores wildcards, since it is very unlikely the user is
8329 * editing a file name with a wildcard character.
8330 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008331 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008333 /*
8334 * Expanding wildcards may result in an empty argument list. E.g. when
8335 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8336 * already did an error message for this.
8337 */
8338 if (ARGCOUNT == 0)
8339 return;
8340
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008341# ifdef FEAT_WINDOWS
8342 if (cmdmod.tab)
8343 {
8344 /* ":tab drop file ...": open a tab for each argument that isn't
8345 * edited in a window yet. It's like ":tab all" but without closing
8346 * windows or tabs. */
8347 ex_all(eap);
8348 }
8349 else
8350# endif
8351 {
8352 /* ":drop file ...": Edit the first argument. Jump to an existing
8353 * window if possible, edit in current window if the current buffer
8354 * can be abandoned, otherwise open a new window. */
8355 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8356
8357 FOR_ALL_TAB_WINDOWS(tp, wp)
8358 {
8359 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008361# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008362 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008363# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365 return;
8366 }
8367 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008369 /*
8370 * Check whether the current buffer is changed. If so, we will need
8371 * to split the current window or data could be lost.
8372 * Skip the check if the 'hidden' option is set, as in this case the
8373 * buffer won't be lost.
8374 */
8375 if (!P_HID(curbuf))
8376 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008378 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379# endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008380 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008382 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008384 if (split)
8385 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008387 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008389 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8390 if (split)
8391 {
8392 eap->cmdidx = CMD_sfirst;
8393 eap->cmd[0] = 's';
8394 }
8395 else
8396 eap->cmdidx = CMD_first;
8397 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399}
8400#endif
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008401
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008402/*
8403 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8404 * Put the start of the pattern in "*s", unless "s" is NULL.
8405 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8406 * If "s" is not NULL terminate the pattern with a NUL.
8407 * Return a pointer to the char just past the pattern plus flags.
8408 */
8409 char_u *
8410skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8411{
8412 int c;
8413
8414 if (vim_isIDc(*p))
8415 {
8416 /* ":vimgrep pattern fname" */
8417 if (s != NULL)
8418 *s = p;
8419 p = skiptowhite(p);
8420 if (s != NULL && *p != NUL)
8421 *p++ = NUL;
8422 }
8423 else
8424 {
8425 /* ":vimgrep /pattern/[g][j] fname" */
8426 if (s != NULL)
8427 *s = p + 1;
8428 c = *p;
8429 p = skip_regexp(p + 1, c, TRUE, NULL);
8430 if (*p != c)
8431 return NULL;
8432
8433 /* Truncate the pattern. */
8434 if (s != NULL)
8435 *p = NUL;
8436 ++p;
8437
8438 /* Find the flags */
8439 while (*p == 'g' || *p == 'j')
8440 {
8441 if (flags != NULL)
8442 {
8443 if (*p == 'g')
8444 *flags |= VGR_GLOBAL;
8445 else
8446 *flags |= VGR_NOJUMP;
8447 }
8448 ++p;
8449 }
8450 }
8451 return p;
8452}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008453
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008454#if defined(FEAT_EVAL) || defined(PROTO)
8455/*
8456 * List v:oldfiles in a nice way.
8457 */
8458 void
8459ex_oldfiles(exarg_T *eap UNUSED)
8460{
8461 list_T *l = get_vim_var_list(VV_OLDFILES);
8462 listitem_T *li;
8463 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008464 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008465
8466 if (l == NULL)
8467 msg((char_u *)_("No old files"));
8468 else
8469 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008470 msg_start();
8471 msg_scroll = TRUE;
8472 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8473 {
8474 ++nr;
8475 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008476 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008477 {
8478 msg_outnum((long)nr);
8479 MSG_PUTS(": ");
8480 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02008481 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008482 msg_putchar('\n');
8483 out_flush(); /* output one line at a time */
8484 ui_breakcheck();
8485 }
8486 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008487
8488 /* Assume "got_int" was set to truncate the listing. */
8489 got_int = FALSE;
8490
8491# ifdef FEAT_BROWSE_CMD
8492 if (cmdmod.browse)
8493 {
8494 quit_more = FALSE;
8495 nr = prompt_for_number(FALSE);
8496 msg_starthere();
8497 if (nr > 0)
8498 {
8499 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8500 (long)nr);
8501
8502 if (p != NULL)
8503 {
8504 p = expand_env_save(p);
8505 eap->arg = p;
8506 eap->cmdidx = CMD_edit;
8507 cmdmod.browse = FALSE;
8508 do_exedit(eap, NULL);
8509 vim_free(p);
8510 }
8511 }
8512 }
8513# endif
8514 }
8515}
8516#endif
8517