blob: 206ead18527c928bed6f1cbf5de40607e7cf076e [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);
259 last > first && vim_iswhite(last[-1]); --last)
260 ;
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 {
403 if (vim_iswhite(*p))
404 ;
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 {
686 if (vim_iswhite(ptr[col]))
687 {
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;
803
804 /* Moving lines seems to corrupt the folds, delete folding info now
805 * and recreate it when finished. Don't do this for manual folding, it
806 * would delete all folds. */
807 isFolded = hasAnyFolding(curwin) && !foldmethodIsManual(curwin);
808 if (isFolded)
809 deleteFoldRecurse(&curwin->w_folds);
810#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812 if (dest >= line1 && dest < line2)
813 {
814 EMSG(_("E134: Move lines into themselves"));
815 return FAIL;
816 }
817
818 num_lines = line2 - line1 + 1;
819
820 /*
821 * First we copy the old text to its new location -- webb
822 * Also copy the flag that ":global" command uses.
823 */
824 if (u_save(dest, dest + 1) == FAIL)
825 return FAIL;
826 for (extra = 0, l = line1; l <= line2; l++)
827 {
828 str = vim_strsave(ml_get(l + extra));
829 if (str != NULL)
830 {
831 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
832 vim_free(str);
833 if (dest < line1)
834 extra++;
835 }
836 }
837
838 /*
839 * Now we must be careful adjusting our marks so that we don't overlap our
840 * mark_adjust() calls.
841 *
842 * We adjust the marks within the old text so that they refer to the
843 * last lines of the file (temporarily), because we know no other marks
844 * will be set there since these line numbers did not exist until we added
845 * our new lines.
846 *
847 * Then we adjust the marks on lines between the old and new text positions
848 * (either forwards or backwards).
849 *
850 * And Finally we adjust the marks we put at the end of the file back to
851 * their final destination at the new text position -- webb
852 */
853 last_line = curbuf->b_ml.ml_line_count;
854 mark_adjust(line1, line2, last_line - line2, 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200855 changed_lines(last_line - num_lines + 1, 0, last_line + 1, num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (dest >= line2)
857 {
858 mark_adjust(line2 + 1, dest, -num_lines, 0L);
859 curbuf->b_op_start.lnum = dest - num_lines + 1;
860 curbuf->b_op_end.lnum = dest;
861 }
862 else
863 {
864 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
865 curbuf->b_op_start.lnum = dest + 1;
866 curbuf->b_op_end.lnum = dest + num_lines;
867 }
868 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
869 mark_adjust(last_line - num_lines + 1, last_line,
870 -(last_line - dest - extra), 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200871 changed_lines(last_line - num_lines + 1, 0, last_line + 1, -extra);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 /*
874 * Now we delete the original text -- webb
875 */
876 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
877 return FAIL;
878
879 for (l = line1; l <= line2; l++)
880 ml_delete(line1 + extra, TRUE);
881
882 if (!global_busy && num_lines > p_report)
883 {
884 if (num_lines == 1)
885 MSG(_("1 line moved"));
886 else
887 smsg((char_u *)_("%ld lines moved"), num_lines);
888 }
889
890 /*
891 * Leave the cursor on the last of the moved lines.
892 */
893 if (dest >= line1)
894 curwin->w_cursor.lnum = dest;
895 else
896 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
897
898 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100899 {
900 dest += num_lines + 1;
901 last_line = curbuf->b_ml.ml_line_count;
902 if (dest > last_line + 1)
903 dest = last_line + 1;
904 changed_lines(line1, 0, dest, 0L);
905 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 else
907 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
908
Bram Moolenaard5f69332015-04-15 12:43:50 +0200909#ifdef FEAT_FOLDING
910 /* recreate folds */
911 if (isFolded)
912 foldUpdateAll(curwin);
913#endif
914
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 return OK;
916}
917
918/*
919 * ":copy"
920 */
921 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100922ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923{
924 linenr_T count;
925 char_u *p;
926
927 count = line2 - line1 + 1;
928 curbuf->b_op_start.lnum = n + 1;
929 curbuf->b_op_end.lnum = n + count;
930 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
931
932 /*
933 * there are three situations:
934 * 1. destination is above line1
935 * 2. destination is between line1 and line2
936 * 3. destination is below line2
937 *
938 * n = destination (when starting)
939 * curwin->w_cursor.lnum = destination (while copying)
940 * line1 = start of source (while copying)
941 * line2 = end of source (while copying)
942 */
943 if (u_save(n, n + 1) == FAIL)
944 return;
945
946 curwin->w_cursor.lnum = n;
947 while (line1 <= line2)
948 {
949 /* need to use vim_strsave() because the line will be unlocked within
950 * ml_append() */
951 p = vim_strsave(ml_get(line1));
952 if (p != NULL)
953 {
954 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
955 vim_free(p);
956 }
957 /* situation 2: skip already copied lines */
958 if (line1 == n)
959 line1 = curwin->w_cursor.lnum;
960 ++line1;
961 if (curwin->w_cursor.lnum < line1)
962 ++line1;
963 if (curwin->w_cursor.lnum < line2)
964 ++line2;
965 ++curwin->w_cursor.lnum;
966 }
967
968 appended_lines_mark(n, count);
969
970 msgmore((long)count);
971}
972
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000973static char_u *prevcmd = NULL; /* the previous command */
974
975#if defined(EXITFREE) || defined(PROTO)
976 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100977free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000978{
979 vim_free(prevcmd);
980}
981#endif
982
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983/*
984 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
985 * Bangs in the argument are replaced with the previously entered command.
986 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 */
988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100989do_bang(
990 int addr_count,
991 exarg_T *eap,
992 int forceit,
993 int do_in,
994 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995{
996 char_u *arg = eap->arg; /* command */
997 linenr_T line1 = eap->line1; /* start of range */
998 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 char_u *newcmd = NULL; /* the new command */
1000 int free_newcmd = FALSE; /* need to free() newcmd */
1001 int ins_prevcmd;
1002 char_u *t;
1003 char_u *p;
1004 char_u *trailarg;
1005 int len;
1006 int scroll_save = msg_scroll;
1007
1008 /*
1009 * Disallow shell commands for "rvim".
1010 * Disallow shell commands from .exrc and .vimrc in current directory for
1011 * security reasons.
1012 */
1013 if (check_restricted() || check_secure())
1014 return;
1015
1016 if (addr_count == 0) /* :! */
1017 {
1018 msg_scroll = FALSE; /* don't scroll here */
1019 autowrite_all();
1020 msg_scroll = scroll_save;
1021 }
1022
1023 /*
1024 * Try to find an embedded bang, like in :!<cmd> ! [args]
1025 * (:!! is indicated by the 'forceit' variable)
1026 */
1027 ins_prevcmd = forceit;
1028 trailarg = arg;
1029 do
1030 {
1031 len = (int)STRLEN(trailarg) + 1;
1032 if (newcmd != NULL)
1033 len += (int)STRLEN(newcmd);
1034 if (ins_prevcmd)
1035 {
1036 if (prevcmd == NULL)
1037 {
1038 EMSG(_(e_noprev));
1039 vim_free(newcmd);
1040 return;
1041 }
1042 len += (int)STRLEN(prevcmd);
1043 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001044 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 {
1046 vim_free(newcmd);
1047 return;
1048 }
1049 *t = NUL;
1050 if (newcmd != NULL)
1051 STRCAT(t, newcmd);
1052 if (ins_prevcmd)
1053 STRCAT(t, prevcmd);
1054 p = t + STRLEN(t);
1055 STRCAT(t, trailarg);
1056 vim_free(newcmd);
1057 newcmd = t;
1058
1059 /*
1060 * Scan the rest of the argument for '!', which is replaced by the
1061 * previous command. "\!" is replaced by "!" (this is vi compatible).
1062 */
1063 trailarg = NULL;
1064 while (*p)
1065 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001066 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 {
1068 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001069 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 else
1071 {
1072 trailarg = p;
1073 *trailarg++ = NUL;
1074 ins_prevcmd = TRUE;
1075 break;
1076 }
1077 }
1078 ++p;
1079 }
1080 } while (trailarg != NULL);
1081
1082 vim_free(prevcmd);
1083 prevcmd = newcmd;
1084
1085 if (bangredo) /* put cmd in redo buffer for ! command */
1086 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001087 /* If % or # appears in the command, it must have been escaped.
1088 * Reescape them, so that redoing them does not substitute them by the
1089 * buffername. */
1090 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1091
1092 if (cmd != NULL)
1093 {
1094 AppendToRedobuffLit(cmd, -1);
1095 vim_free(cmd);
1096 }
1097 else
1098 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 AppendToRedobuff((char_u *)"\n");
1100 bangredo = FALSE;
1101 }
1102 /*
1103 * Add quotes around the command, for shells that need them.
1104 */
1105 if (*p_shq != NUL)
1106 {
1107 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1108 if (newcmd == NULL)
1109 return;
1110 STRCPY(newcmd, p_shq);
1111 STRCAT(newcmd, prevcmd);
1112 STRCAT(newcmd, p_shq);
1113 free_newcmd = TRUE;
1114 }
1115 if (addr_count == 0) /* :! */
1116 {
1117 /* echo the command */
1118 msg_start();
1119 msg_putchar(':');
1120 msg_putchar('!');
1121 msg_outtrans(newcmd);
1122 msg_clr_eos();
1123 windgoto(msg_row, msg_col);
1124
1125 do_shell(newcmd, 0);
1126 }
1127 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001128 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 /* Careful: This may recursively call do_bang() again! (because of
1130 * autocommands) */
1131 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001132#ifdef FEAT_AUTOCMD
1133 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1134#endif
1135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 if (free_newcmd)
1137 vim_free(newcmd);
1138}
1139
1140/*
1141 * do_filter: filter lines through a command given by the user
1142 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001143 * We mostly use temp files and the call_shell() routine here. This would
1144 * normally be done using pipes on a UNIX machine, but this is more portable
1145 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 * to deal with redirection somehow, and should handle things like looking
1147 * at the PATH env. variable, and adding reasonable extensions to the
1148 * command name given by the user. All reasonable versions of call_shell()
1149 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001150 * Alternatively, if on Unix and redirecting input or output, but not both,
1151 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 * We use input redirection if do_in is TRUE.
1153 * We use output redirection if do_out is TRUE.
1154 */
1155 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001156do_filter(
1157 linenr_T line1,
1158 linenr_T line2,
1159 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1160 char_u *cmd,
1161 int do_in,
1162 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163{
1164 char_u *itmp = NULL;
1165 char_u *otmp = NULL;
1166 linenr_T linecount;
1167 linenr_T read_linecount;
1168 pos_T cursor_save;
1169 char_u *cmd_buf;
1170#ifdef FEAT_AUTOCMD
1171 buf_T *old_curbuf = curbuf;
1172#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001173 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174
1175 if (*cmd == NUL) /* no filter command */
1176 return;
1177
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 cursor_save = curwin->w_cursor;
1179 linecount = line2 - line1 + 1;
1180 curwin->w_cursor.lnum = line1;
1181 curwin->w_cursor.col = 0;
1182 changed_line_abv_curs();
1183 invalidate_botline();
1184
1185 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001186 * When using temp files:
1187 * 1. * Form temp file names
1188 * 2. * Write the lines to a temp file
1189 * 3. Run the filter command on the temp file
1190 * 4. * Read the output of the command into the buffer
1191 * 5. * Delete the original lines to be filtered
1192 * 6. * Remove the temp files
1193 *
1194 * When writing the input with a pipe or when catching the output with a
1195 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 */
1197
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001198 if (do_out)
1199 shell_flags |= SHELL_DOOUT;
1200
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001201#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001202 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001204 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1205 shell_flags |= SHELL_READ;
1206 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001208 else if (do_in && !do_out && !p_stmp)
1209 {
1210 /* Use a pipe to write stdin of the command, do not use a temp file. */
1211 shell_flags |= SHELL_WRITE;
1212 curbuf->b_op_start.lnum = line1;
1213 curbuf->b_op_end.lnum = line2;
1214 }
1215 else if (do_in && do_out && !p_stmp)
1216 {
1217 /* Use a pipe to write stdin and fetch stdout of the command, do not
1218 * use a temp file. */
1219 shell_flags |= SHELL_READ|SHELL_WRITE;
1220 curbuf->b_op_start.lnum = line1;
1221 curbuf->b_op_end.lnum = line2;
1222 curwin->w_cursor.lnum = line2;
1223 }
1224 else
1225#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001226 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1227 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001228 {
1229 EMSG(_(e_notmp));
1230 goto filterend;
1231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232
1233/*
1234 * The writing and reading of temp files will not be shown.
1235 * Vi also doesn't do this and the messages are not very informative.
1236 */
1237 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001238 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 FALSE, FALSE, FALSE, TRUE) == FAIL)
1240 {
1241 msg_putchar('\n'); /* keep message from buf_write() */
1242 --no_wait_return;
1243#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1244 if (!aborting())
1245#endif
1246 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1247 goto filterend;
1248 }
1249#ifdef FEAT_AUTOCMD
1250 if (curbuf != old_curbuf)
1251 goto filterend;
1252#endif
1253
1254 if (!do_out)
1255 msg_putchar('\n');
1256
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001257 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1259 if (cmd_buf == NULL)
1260 goto filterend;
1261
1262 windgoto((int)Rows - 1, 0);
1263 cursor_on();
1264
1265 /*
1266 * When not redirecting the output the command can write anything to the
1267 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1268 * stderr output of external command. Clear the screen later.
1269 * If do_in is FALSE, this could be something like ":r !cat", which may
1270 * also mess up the screen, clear it later.
1271 */
1272 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1273 redraw_later_clear();
1274
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001275 if (do_out)
1276 {
1277 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001278 {
1279 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001280 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001281 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001282 redraw_curbuf_later(VALID);
1283 }
1284 read_linecount = curbuf->b_ml.ml_line_count;
1285
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286 /*
1287 * When call_shell() fails wait_return() is called to give the user a
1288 * chance to read the error messages. Otherwise errors are ignored, so you
1289 * can see the error messages from the command that appear on stdout; use
1290 * 'u' to fix the text
1291 * Switch to cooked mode when not redirecting stdin, avoids that something
1292 * like ":r !cat" hangs.
1293 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1294 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001295 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 {
1297 redraw_later_clear();
1298 wait_return(FALSE);
1299 }
1300 vim_free(cmd_buf);
1301
1302 did_check_timestamps = FALSE;
1303 need_check_timestamps = TRUE;
1304
1305 /* When interrupting the shell command, it may still have produced some
1306 * useful output. Reset got_int here, so that readfile() won't cancel
1307 * reading. */
1308 ui_breakcheck();
1309 got_int = FALSE;
1310
1311 if (do_out)
1312 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001313 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001315 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1316 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001318#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1319 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001321 {
1322 msg_putchar('\n');
1323 EMSG2(_(e_notread), otmp);
1324 }
1325 goto error;
1326 }
1327#ifdef FEAT_AUTOCMD
1328 if (curbuf != old_curbuf)
1329 goto filterend;
1330#endif
1331 }
1332
1333 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1334
1335 if (shell_flags & SHELL_READ)
1336 {
1337 curbuf->b_op_start.lnum = line2 + 1;
1338 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1339 appended_lines_mark(line2, read_linecount);
1340 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341
1342 if (do_in)
1343 {
1344 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1345 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 if (read_linecount >= linecount)
1347 /* move all marks from old lines to new lines */
1348 mark_adjust(line1, line2, linecount, 0L);
1349 else
1350 {
1351 /* move marks from old lines to new lines, delete marks
1352 * that are in deleted lines */
1353 mark_adjust(line1, line1 + read_linecount - 1,
1354 linecount, 0L);
1355 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1356 }
1357 }
1358
1359 /*
1360 * Put cursor on first filtered line for ":range!cmd".
1361 * Adjust '[ and '] (set by buf_write()).
1362 */
1363 curwin->w_cursor.lnum = line1;
1364 del_lines(linecount, TRUE);
1365 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1366 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1367 write_lnum_adjust(-linecount); /* adjust last line
1368 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001369#ifdef FEAT_FOLDING
1370 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1371#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372 }
1373 else
1374 {
1375 /*
1376 * Put cursor on last new line for ":r !cmd".
1377 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001379 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001381
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1383 --no_wait_return;
1384
1385 if (linecount > p_report)
1386 {
1387 if (do_in)
1388 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001389 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1390 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001393 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 }
1395 else
1396 msgmore((long)linecount);
1397 }
1398 }
1399 else
1400 {
1401error:
1402 /* put cursor back in same position for ":w !cmd" */
1403 curwin->w_cursor = cursor_save;
1404 --no_wait_return;
1405 wait_return(FALSE);
1406 }
1407
1408filterend:
1409
1410#ifdef FEAT_AUTOCMD
1411 if (curbuf != old_curbuf)
1412 {
1413 --no_wait_return;
1414 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1415 }
1416#endif
1417 if (itmp != NULL)
1418 mch_remove(itmp);
1419 if (otmp != NULL)
1420 mch_remove(otmp);
1421 vim_free(itmp);
1422 vim_free(otmp);
1423}
1424
1425/*
1426 * Call a shell to execute a command.
1427 * When "cmd" is NULL start an interactive shell.
1428 */
1429 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001430do_shell(
1431 char_u *cmd,
1432 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433{
1434 buf_T *buf;
1435#ifndef FEAT_GUI_MSWIN
1436 int save_nwr;
1437#endif
1438#ifdef MSWIN
1439 int winstart = FALSE;
1440#endif
1441
1442 /*
1443 * Disallow shell commands for "rvim".
1444 * Disallow shell commands from .exrc and .vimrc in current directory for
1445 * security reasons.
1446 */
1447 if (check_restricted() || check_secure())
1448 {
1449 msg_end();
1450 return;
1451 }
1452
1453#ifdef MSWIN
1454 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 * Check if ":!start" is used.
1456 */
1457 if (cmd != NULL)
1458 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1459#endif
1460
1461 /*
1462 * For autocommands we want to get the output on the current screen, to
1463 * avoid having to type return below.
1464 */
1465 msg_putchar('\r'); /* put cursor at start of line */
1466#ifdef FEAT_AUTOCMD
1467 if (!autocmd_busy)
1468#endif
1469 {
1470#ifdef MSWIN
1471 if (!winstart)
1472#endif
1473 stoptermcap();
1474 }
1475#ifdef MSWIN
1476 if (!winstart)
1477#endif
1478 msg_putchar('\n'); /* may shift screen one line up */
1479
1480 /* warning message before calling the shell */
1481 if (p_warn
1482#ifdef FEAT_AUTOCMD
1483 && !autocmd_busy
1484#endif
1485 && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001486 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 if (bufIsChanged(buf))
1488 {
1489#ifdef FEAT_GUI_MSWIN
1490 if (!winstart)
1491 starttermcap(); /* don't want a message box here */
1492#endif
1493 MSG_PUTS(_("[No write since last change]\n"));
1494#ifdef FEAT_GUI_MSWIN
1495 if (!winstart)
1496 stoptermcap();
1497#endif
1498 break;
1499 }
1500
1501 /* This windgoto is required for when the '\n' resulted in a "delete line
1502 * 1" command to the terminal. */
1503 if (!swapping_screen())
1504 windgoto(msg_row, msg_col);
1505 cursor_on();
1506 (void)call_shell(cmd, SHELL_COOKED | flags);
1507 did_check_timestamps = FALSE;
1508 need_check_timestamps = TRUE;
1509
1510 /*
1511 * put the message cursor at the end of the screen, avoids wait_return()
1512 * to overwrite the text that the external command showed
1513 */
1514 if (!swapping_screen())
1515 {
1516 msg_row = Rows - 1;
1517 msg_col = 0;
1518 }
1519
1520#ifdef FEAT_AUTOCMD
1521 if (autocmd_busy)
1522 {
1523 if (msg_silent == 0)
1524 redraw_later_clear();
1525 }
1526 else
1527#endif
1528 {
1529 /*
1530 * For ":sh" there is no need to call wait_return(), just redraw.
1531 * Also for the Win32 GUI (the output is in a console window).
1532 * Otherwise there is probably text on the screen that the user wants
1533 * to read before redrawing, so call wait_return().
1534 */
1535#ifndef FEAT_GUI_MSWIN
1536 if (cmd == NULL
1537# ifdef WIN3264
1538 || (winstart && !need_wait_return)
1539# endif
1540 )
1541 {
1542 if (msg_silent == 0)
1543 redraw_later_clear();
1544 need_wait_return = FALSE;
1545 }
1546 else
1547 {
1548 /*
1549 * If we switch screens when starttermcap() is called, we really
1550 * want to wait for "hit return to continue".
1551 */
1552 save_nwr = no_wait_return;
1553 if (swapping_screen())
1554 no_wait_return = FALSE;
1555# ifdef AMIGA
1556 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1557# else
1558 wait_return(msg_silent == 0);
1559# endif
1560 no_wait_return = save_nwr;
1561 }
1562#endif /* FEAT_GUI_W32 */
1563
1564#ifdef MSWIN
1565 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1566#endif
1567 starttermcap(); /* start termcap if not done by wait_return() */
1568
1569 /*
1570 * In an Amiga window redrawing is caused by asking the window size.
1571 * If we got an interrupt this will not work. The chance that the
1572 * window size is wrong is very small, but we need to redraw the
1573 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1574 * but it saves an extra redraw.
1575 */
1576#ifdef AMIGA
1577 if (skip_redraw) /* ':' hit in wait_return() */
1578 {
1579 if (msg_silent == 0)
1580 redraw_later_clear();
1581 }
1582 else if (term_console)
1583 {
1584 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1585 if (got_int && msg_silent == 0)
1586 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1587 else
1588 must_redraw = 0; /* no extra redraw needed */
1589 }
1590#endif
1591 }
1592
1593 /* display any error messages now */
1594 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001595
1596#ifdef FEAT_AUTOCMD
1597 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1598#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599}
1600
1601/*
1602 * Create a shell command from a command string, input redirection file and
1603 * output redirection file.
1604 * Returns an allocated string with the shell command, or NULL for failure.
1605 */
1606 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001607make_filter_cmd(
1608 char_u *cmd, /* command */
1609 char_u *itmp, /* NULL or name of input file */
1610 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611{
1612 char_u *buf;
1613 long_u len;
1614
Bram Moolenaar53076832015-12-31 19:53:21 +01001615#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001616 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001617 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001618
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001619 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001620 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1621 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001622 if (is_fish_shell)
1623 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1624 else
1625#endif
1626 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 if (itmp != NULL)
1628 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1629 if (otmp != NULL)
1630 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1631 buf = lalloc(len, TRUE);
1632 if (buf == NULL)
1633 return NULL;
1634
Bram Moolenaar53076832015-12-31 19:53:21 +01001635#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001637 * Put braces around the command (for concatenated commands) when
1638 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001640 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001641 {
1642 if (is_fish_shell)
1643 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1644 else
1645 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1646 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001647 else
1648 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 if (itmp != NULL)
1650 {
1651 STRCAT(buf, " < ");
1652 STRCAT(buf, itmp);
1653 }
1654#else
1655 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001656 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 * the use of commands in a pipe.
1658 */
1659 STRCPY(buf, cmd);
1660 if (itmp != NULL)
1661 {
1662 char_u *p;
1663
1664 /*
1665 * If there is a pipe, we have to put the '<' in front of it.
1666 * Don't do this when 'shellquote' is not empty, otherwise the
1667 * redirection would be inside the quotes.
1668 */
1669 if (*p_shq == NUL)
1670 {
1671 p = vim_strchr(buf, '|');
1672 if (p != NULL)
1673 *p = NUL;
1674 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1676 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 if (*p_shq == NUL)
1678 {
1679 p = vim_strchr(cmd, '|');
1680 if (p != NULL)
1681 {
1682 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1683 STRCAT(buf, p);
1684 }
1685 }
1686 }
1687#endif
1688 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001689 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690
1691 return buf;
1692}
1693
1694/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001695 * Append output redirection for file "fname" to the end of string buffer
1696 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 * Works with the 'shellredir' and 'shellpipe' options.
1698 * The caller should make sure that there is enough room:
1699 * STRLEN(opt) + STRLEN(fname) + 3
1700 */
1701 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001702append_redir(
1703 char_u *buf,
1704 int buflen,
1705 char_u *opt,
1706 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707{
1708 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001709 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001711 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001712 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001714 {
1715 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001717 if (p[1] == '%') /* skip %% */
1718 ++p;
1719 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 if (p != NULL)
1721 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001722 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1723 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1724 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 }
1726 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001727 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 " %s %s",
1730#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732#endif
1733 (char *)opt, (char *)fname);
1734}
1735
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001736#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001738static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001739static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001740static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001741static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742static int viminfo_errcnt;
1743
1744 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001745no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746{
1747 /* "vim -i NONE" does not read or write a viminfo file */
1748 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1749}
1750
1751/*
1752 * Report an error for reading a viminfo file.
1753 * Count the number of errors. When there are more than 10, return TRUE.
1754 */
1755 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001756viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001758 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1759 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001760 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001761 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1762 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 emsg(IObuff);
1764 if (++viminfo_errcnt >= 10)
1765 {
1766 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1767 return TRUE;
1768 }
1769 return FALSE;
1770}
1771
1772/*
1773 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001774 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 */
1776 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001777read_viminfo(
1778 char_u *file, /* file name or NULL to use default name */
1779 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780{
1781 FILE *fp;
1782 char_u *fname;
1783
1784 if (no_viminfo())
1785 return FAIL;
1786
Bram Moolenaard812df62008-11-09 12:46:09 +00001787 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 if (fname == NULL)
1789 return FAIL;
1790 fp = mch_fopen((char *)fname, READBIN);
1791
1792 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001793 {
1794 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001795 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1796 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001797 (flags & VIF_WANT_INFO) ? _(" info") : "",
1798 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1799 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001800 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001801 verbose_leave();
1802 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803
1804 vim_free(fname);
1805 if (fp == NULL)
1806 return FAIL;
1807
1808 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001809 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810
1811 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 return OK;
1813}
1814
1815/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001816 * Write the viminfo file. The old one is read in first so that effectively a
1817 * merge of current info and old info is done. This allows multiple vims to
1818 * run simultaneously, without losing any marks etc.
1819 * If "forceit" is TRUE, then the old file is not read in, and only internal
1820 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 */
1822 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001823write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824{
1825 char_u *fname;
1826 FILE *fp_in = NULL; /* input viminfo file, if any */
1827 FILE *fp_out = NULL; /* output viminfo file */
1828 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001829 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 char_u *wp;
1831#if defined(UNIX) || defined(VMS)
1832 mode_t umask_save;
1833#endif
1834#ifdef UNIX
1835 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001836 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001838#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001839 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001840#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841
1842 if (no_viminfo())
1843 return;
1844
1845 fname = viminfo_filename(file); /* may set to default if NULL */
1846 if (fname == NULL)
1847 return;
1848
1849 fp_in = mch_fopen((char *)fname, READBIN);
1850 if (fp_in == NULL)
1851 {
1852 /* if it does exist, but we can't read it, don't try writing */
1853 if (mch_stat((char *)fname, &st_new) == 0)
1854 goto end;
1855#if defined(UNIX) || defined(VMS)
1856 /*
1857 * For Unix we create the .viminfo non-accessible for others,
1858 * because it may contain text from non-accessible documents.
1859 */
1860 umask_save = umask(077);
1861#endif
1862 fp_out = mch_fopen((char *)fname, WRITEBIN);
1863#if defined(UNIX) || defined(VMS)
1864 (void)umask(umask_save);
1865#endif
1866 }
1867 else
1868 {
1869 /*
1870 * There is an existing viminfo file. Create a temporary file to
1871 * write the new viminfo into, in the same directory as the
1872 * existing viminfo file, which will be renamed later.
1873 */
1874#ifdef UNIX
1875 /*
1876 * For Unix we check the owner of the file. It's not very nice to
1877 * overwrite a user's viminfo file after a "su root", with a
1878 * viminfo file that the user can't read.
1879 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001880 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001881 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001883 if (mch_stat((char *)fname, &st_old) == 0
1884 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001885 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 ? (st_old.st_mode & 0200)
1887 : (st_old.st_gid == getgid()
1888 ? (st_old.st_mode & 0020)
1889 : (st_old.st_mode & 0002))))
1890 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001891 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892
1893 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1895 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001896 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 goto end;
1898 }
1899#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001900#ifdef WIN3264
1901 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001902 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001903#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904
1905 /*
1906 * Make tempname.
1907 * May try twice: Once normal and once with shortname set, just in
1908 * case somebody puts his viminfo file in an 8.3 filesystem.
1909 */
1910 for (;;)
1911 {
1912 tempname = buf_modname(
1913#ifdef UNIX
1914 shortname,
1915#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917#endif
1918 fname,
1919#ifdef VMS
1920 (char_u *)"-tmp",
1921#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923#endif
1924 FALSE);
1925 if (tempname == NULL) /* out of memory */
1926 break;
1927
1928 /*
1929 * Check if tempfile already exists. Never overwrite an
1930 * existing file!
1931 */
1932 if (mch_stat((char *)tempname, &st_new) == 0)
1933 {
1934#ifdef UNIX
1935 /*
1936 * Check if tempfile is same as original file. May happen
1937 * when modname() gave the same file back. E.g. silly
1938 * link, or file name-length reached. Try again with
1939 * shortname set.
1940 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001941 if (!shortname && st_new.st_dev == st_old.st_dev
1942 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 {
1944 vim_free(tempname);
1945 tempname = NULL;
1946 shortname = TRUE;
1947 continue;
1948 }
1949#endif
1950 /*
1951 * Try another name. Change one character, just before
1952 * the extension. This should also work for an 8.3
1953 * file name, when after adding the extension it still is
1954 * the same file as the original.
1955 */
1956 wp = tempname + STRLEN(tempname) - 5;
1957 if (wp < gettail(tempname)) /* empty file name? */
1958 wp = gettail(tempname);
1959 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1960 --*wp)
1961 {
1962 /*
1963 * They all exist? Must be something wrong! Don't
1964 * write the viminfo file then.
1965 */
1966 if (*wp == 'a')
1967 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001968 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1969 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 vim_free(tempname);
1971 tempname = NULL;
1972 break;
1973 }
1974 }
1975 }
1976 break;
1977 }
1978
1979 if (tempname != NULL)
1980 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001981#ifdef VMS
1982 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001983 umask_save = umask(077);
1984 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1985 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001986#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001987 int fd;
1988
1989 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001990 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001991 * Unix: same as original file, but strip s-bit. Reset umask to
1992 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001993 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001994# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001995 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001996 fd = mch_open((char *)tempname,
1997 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001998 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001999 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002000# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002001 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002002 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002003# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002004 if (fd < 0)
2005 fp_out = NULL;
2006 else
2007 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002008#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009
2010 /*
2011 * If we can't create in the same directory, try creating a
2012 * "normal" temp file.
2013 */
2014 if (fp_out == NULL)
2015 {
2016 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002017 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2019 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002020
2021#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002023 * Make sure the owner can read/write it. This only works for
2024 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 */
2026 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002027 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028#endif
2029 }
2030 }
2031
2032 /*
2033 * Check if the new viminfo file can be written to.
2034 */
2035 if (fp_out == NULL)
2036 {
2037 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002038 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 if (fp_in != NULL)
2040 fclose(fp_in);
2041 goto end;
2042 }
2043
2044 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002045 {
2046 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002047 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002048 verbose_leave();
2049 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050
2051 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002052 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053
Bram Moolenaar927030a2016-03-15 18:23:55 +01002054 if (fclose(fp_out) == EOF)
2055 ++viminfo_errcnt;
2056
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 if (fp_in != NULL)
2058 {
2059 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002060
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002061 /* In case of an error keep the original viminfo file. Otherwise
2062 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002063 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002064 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002065 if (vim_rename(tempname, fname) == -1)
2066 {
2067 ++viminfo_errcnt;
2068 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2069 }
2070# ifdef WIN3264
2071 /* If the viminfo file was hidden then also hide the new file. */
2072 else if (hidden)
2073 mch_hide(fname);
2074# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002075 }
2076 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 mch_remove(tempname);
2078 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002079
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080end:
2081 vim_free(fname);
2082 vim_free(tempname);
2083}
2084
2085/*
2086 * Get the viminfo file name to use.
2087 * If "file" is given and not empty, use it (has already been expanded by
2088 * cmdline functions).
2089 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2090 * expand environment variables.
2091 * Returns an allocated string. NULL when out of memory.
2092 */
2093 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002094viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095{
2096 if (file == NULL || *file == NUL)
2097 {
2098 if (use_viminfo != NULL)
2099 file = use_viminfo;
2100 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2101 {
2102#ifdef VIMINFO_FILE2
2103 /* don't use $HOME when not defined (turned into "c:/"!). */
2104# ifdef VMS
2105 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2106# else
2107 if (mch_getenv((char_u *)"HOME") == NULL)
2108# endif
2109 {
2110 /* don't use $VIM when not available. */
2111 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2112 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2113 file = (char_u *)VIMINFO_FILE2;
2114 else
2115 file = (char_u *)VIMINFO_FILE;
2116 }
2117 else
2118#endif
2119 file = (char_u *)VIMINFO_FILE;
2120 }
2121 expand_env(file, NameBuff, MAXPATHL);
2122 file = NameBuff;
2123 }
2124 return vim_strsave(file);
2125}
2126
2127/*
2128 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2129 */
2130 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002131do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 int eof = FALSE;
2134 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002135 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002136 int do_copy_marks = FALSE;
2137 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138
2139 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2140 return;
2141 vir.vir_fd = fp_in;
2142#ifdef FEAT_MBYTE
2143 vir.vir_conv.vc_type = CONV_NONE;
2144#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002145 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002146 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147
2148 if (fp_in != NULL)
2149 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002150 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002151 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002152 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002153 {
2154 /* Registers and marks are read and kept separate from what
2155 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002156 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002157 prepare_viminfo_marks();
2158 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002159
Bram Moolenaard812df62008-11-09 12:46:09 +00002160 eof = read_viminfo_up_to_marks(&vir,
2161 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002162 merge = TRUE;
2163 }
2164 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 /* Skip info, find start of marks */
2166 while (!(eof = viminfo_readline(&vir))
2167 && vir.vir_line[0] != '>')
2168 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002169
2170 do_copy_marks = (flags &
2171 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002173
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 if (fp_out != NULL)
2175 {
2176 /* Write the info: */
2177 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2178 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002179 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002180 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002182 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2184#endif
2185 write_viminfo_search_pattern(fp_out);
2186 write_viminfo_sub_string(fp_out);
2187#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002188 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189#endif
2190 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002191 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192#ifdef FEAT_EVAL
2193 write_viminfo_varlist(fp_out);
2194#endif
2195 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002196 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002198 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002199
2200 if (do_copy_marks)
2201 ga_init2(&buflist, sizeof(buf_T *), 50);
2202 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002204
2205 if (do_copy_marks)
2206 {
2207 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2208 if (fp_out != NULL)
2209 ga_clear(&buflist);
2210 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211
2212 vim_free(vir.vir_line);
2213#ifdef FEAT_MBYTE
2214 if (vir.vir_conv.vc_type != CONV_NONE)
2215 convert_setup(&vir.vir_conv, NULL, NULL);
2216#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002217 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218}
2219
2220/*
2221 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2222 * first part of the viminfo file which contains everything but the marks that
2223 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2224 */
2225 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002226read_viminfo_up_to_marks(
2227 vir_T *virp,
2228 int forceit,
2229 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230{
2231 int eof;
2232 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002233 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234
2235#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002236 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002238
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 eof = viminfo_readline(virp);
2240 while (!eof && virp->vir_line[0] != '>')
2241 {
2242 switch (virp->vir_line[0])
2243 {
2244 /* Characters reserved for future expansion, ignored now */
2245 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 case '^': /* to be defined */
2247 case '<': /* long line - ignored */
2248 /* A comment or empty line. */
2249 case NUL:
2250 case '\r':
2251 case '\n':
2252 case '#':
2253 eof = viminfo_readline(virp);
2254 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002255 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002256 eof = read_viminfo_barline(virp, got_encoding,
2257 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002258 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002260 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 eof = viminfo_encoding(virp);
2262 break;
2263 case '!': /* global variable */
2264#ifdef FEAT_EVAL
2265 eof = read_viminfo_varlist(virp, writing);
2266#else
2267 eof = viminfo_readline(virp);
2268#endif
2269 break;
2270 case '%': /* entry for buffer list */
2271 eof = read_viminfo_bufferlist(virp, writing);
2272 break;
2273 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002274 /* When registers are in bar lines skip the old style register
2275 * lines. */
2276 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2277 eof = read_viminfo_register(virp, forceit);
2278 else
2279 do {
2280 eof = viminfo_readline(virp);
2281 } while (!eof && (virp->vir_line[0] == TAB
2282 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283 break;
2284 case '/': /* Search string */
2285 case '&': /* Substitute search string */
2286 case '~': /* Last search string, followed by '/' or '&' */
2287 eof = read_viminfo_search_pattern(virp, forceit);
2288 break;
2289 case '$':
2290 eof = read_viminfo_sub_string(virp, forceit);
2291 break;
2292 case ':':
2293 case '?':
2294 case '=':
2295 case '@':
2296#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002297 /* When history is in bar lines skip the old style history
2298 * lines. */
2299 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2300 eof = read_viminfo_history(virp, writing);
2301 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002303 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 break;
2305 case '-':
2306 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002307 /* When file marks are in bar lines skip the old style lines. */
2308 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2309 eof = read_viminfo_filemark(virp, forceit);
2310 else
2311 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 break;
2313 default:
2314 if (viminfo_error("E575: ", _("Illegal starting char"),
2315 virp->vir_line))
2316 eof = TRUE;
2317 else
2318 eof = viminfo_readline(virp);
2319 break;
2320 }
2321 }
2322
2323#ifdef FEAT_CMDHIST
2324 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002325 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002326 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327#endif
2328
2329 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002330 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 fmarks_check_names(buf);
2332
2333 return eof;
2334}
2335
2336/*
2337 * Compare the 'encoding' value in the viminfo file with the current value of
2338 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2339 * conversion of text with iconv() in viminfo_readstring().
2340 */
2341 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002342viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343{
2344#ifdef FEAT_MBYTE
2345 char_u *p;
2346 int i;
2347
2348 if (get_viminfo_parameter('c') != 0)
2349 {
2350 p = vim_strchr(virp->vir_line, '=');
2351 if (p != NULL)
2352 {
2353 /* remove trailing newline */
2354 ++p;
2355 for (i = 0; vim_isprintc(p[i]); ++i)
2356 ;
2357 p[i] = NUL;
2358
2359 convert_setup(&virp->vir_conv, p, p_enc);
2360 }
2361 }
2362#endif
2363 return viminfo_readline(virp);
2364}
2365
2366/*
2367 * Read a line from the viminfo file.
2368 * Returns TRUE for end-of-file;
2369 */
2370 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002371viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372{
2373 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2374}
2375
2376/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002377 * Check string read from viminfo file.
2378 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 * - replace CTRL-V CTRL-V with CTRL-V
2380 * - replace CTRL-V 'n' with '\n'
2381 *
2382 * Check for a long line as written by viminfo_writestring().
2383 *
2384 * Return the string in allocated memory (NULL when out of memory).
2385 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002387viminfo_readstring(
2388 vir_T *virp,
2389 int off, /* offset for virp->vir_line */
2390 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391{
2392 char_u *retval;
2393 char_u *s, *d;
2394 long len;
2395
2396 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2397 {
2398 len = atol((char *)virp->vir_line + off + 1);
2399 retval = lalloc(len, TRUE);
2400 if (retval == NULL)
2401 {
2402 /* Line too long? File messed up? Skip next line. */
2403 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2404 return NULL;
2405 }
2406 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2407 s = retval + 1; /* Skip the leading '<' */
2408 }
2409 else
2410 {
2411 retval = vim_strsave(virp->vir_line + off);
2412 if (retval == NULL)
2413 return NULL;
2414 s = retval;
2415 }
2416
2417 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2418 d = retval;
2419 while (*s != NUL && *s != '\n')
2420 {
2421 if (s[0] == Ctrl_V && s[1] != NUL)
2422 {
2423 if (s[1] == 'n')
2424 *d++ = '\n';
2425 else
2426 *d++ = Ctrl_V;
2427 s += 2;
2428 }
2429 else
2430 *d++ = *s++;
2431 }
2432 *d = NUL;
2433
2434#ifdef FEAT_MBYTE
2435 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2436 {
2437 d = string_convert(&virp->vir_conv, retval, NULL);
2438 if (d != NULL)
2439 {
2440 vim_free(retval);
2441 retval = d;
2442 }
2443 }
2444#endif
2445
2446 return retval;
2447}
2448
2449/*
2450 * write string to viminfo file
2451 * - replace CTRL-V with CTRL-V CTRL-V
2452 * - replace '\n' with CTRL-V 'n'
2453 * - add a '\n' at the end
2454 *
2455 * For a long line:
2456 * - write " CTRL-V <length> \n " in first line
2457 * - write " < <string> \n " in second line
2458 */
2459 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002460viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461{
2462 int c;
2463 char_u *s;
2464 int len = 0;
2465
2466 for (s = p; *s != NUL; ++s)
2467 {
2468 if (*s == Ctrl_V || *s == '\n')
2469 ++len;
2470 ++len;
2471 }
2472
2473 /* If the string will be too long, write its length and put it in the next
2474 * line. Take into account that some room is needed for what comes before
2475 * the string (e.g., variable name). Add something to the length for the
2476 * '<', NL and trailing NUL. */
2477 if (len > LSIZE / 2)
2478 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2479
2480 while ((c = *p++) != NUL)
2481 {
2482 if (c == Ctrl_V || c == '\n')
2483 {
2484 putc(Ctrl_V, fd);
2485 if (c == '\n')
2486 c = 'n';
2487 }
2488 putc(c, fd);
2489 }
2490 putc('\n', fd);
2491}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002492
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002493/*
2494 * Write a string in quotes that barline_parse() can read back.
2495 * Breaks the line in less than LSIZE pieces when needed.
2496 * Returns remaining characters in the line.
2497 */
2498 int
2499barline_writestring(FILE *fd, char_u *s, int remaining_start)
2500{
2501 char_u *p;
2502 int remaining = remaining_start;
2503 int len = 2;
2504
2505 /* Count the number of characters produced, including quotes. */
2506 for (p = s; *p != NUL; ++p)
2507 {
2508 if (*p == NL)
2509 len += 2;
2510 else if (*p == '"' || *p == '\\')
2511 len += 2;
2512 else
2513 ++len;
2514 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002515 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002516 {
2517 fprintf(fd, ">%d\n|<", len);
2518 remaining = LSIZE - 20;
2519 }
2520
2521 putc('"', fd);
2522 for (p = s; *p != NUL; ++p)
2523 {
2524 if (*p == NL)
2525 {
2526 putc('\\', fd);
2527 putc('n', fd);
2528 --remaining;
2529 }
2530 else if (*p == '"' || *p == '\\')
2531 {
2532 putc('\\', fd);
2533 putc(*p, fd);
2534 --remaining;
2535 }
2536 else
2537 putc(*p, fd);
2538 --remaining;
2539
2540 if (remaining < 3)
2541 {
2542 putc('\n', fd);
2543 putc('|', fd);
2544 putc('<', fd);
2545 /* Leave enough space for another continuation. */
2546 remaining = LSIZE - 20;
2547 }
2548 }
2549 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002550 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002551}
2552
2553/*
2554 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002555 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002556 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002557 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002558 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002559barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002560{
2561 char_u *p = text;
2562 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002563 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002564 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002565 int i;
2566 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002567 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002568#ifdef FEAT_MBYTE
2569 char_u *sconv;
2570 int converted;
2571#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002572
2573 while (*p == ',')
2574 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002575 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002576 if (ga_grow(values, 1) == FAIL)
2577 break;
2578 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002579
2580 if (*p == '>')
2581 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002582 /* Need to read a continuation line. Put strings in allocated
2583 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002584 if (!allocated)
2585 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002586 for (i = 0; i < values->ga_len; ++i)
2587 {
2588 bval_T *vp = (bval_T *)(values->ga_data) + i;
2589
2590 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002591 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002592 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2593 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002594 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002595 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002596 allocated = TRUE;
2597 }
2598
2599 if (vim_isdigit(p[1]))
2600 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002601 size_t len;
2602 size_t todo;
2603 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002604
2605 /* String value was split into lines that are each shorter
2606 * than LSIZE:
2607 * |{bartype},>{length of "{text}{text2}"}
2608 * |<"{text1}
2609 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002610 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002611 */
2612 ++p;
2613 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002614 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002615 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002616 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002617 p = buf;
2618 for (todo = len; todo > 0; todo -= n)
2619 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002620 eof = viminfo_readline(virp);
2621 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002622 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002623 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002624 /* File was truncated or garbled. Read another line if
2625 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002626 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002627 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002628 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002629 /* Get length of text, excluding |< and NL chars. */
2630 n = STRLEN(virp->vir_line);
2631 while (n > 0 && (virp->vir_line[n - 1] == NL
2632 || virp->vir_line[n - 1] == CAR))
2633 --n;
2634 n -= 2;
2635 if (n > todo)
2636 {
2637 /* more values follow after the string */
2638 nextp = virp->vir_line + 2 + todo;
2639 n = todo;
2640 }
2641 mch_memmove(p, virp->vir_line + 2, n);
2642 p += n;
2643 }
2644 *p = NUL;
2645 p = buf;
2646 }
2647 else
2648 {
2649 /* Line ending in ">" continues in the next line:
2650 * |{bartype},{lots of values},>
2651 * |<{value},{value}
2652 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002653 eof = viminfo_readline(virp);
2654 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002655 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002656 /* File was truncated or garbled. Read another line if
2657 * this one starts with '|'. */
2658 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002659 p = virp->vir_line + 2;
2660 }
2661 }
2662
2663 if (isdigit(*p))
2664 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002665 value->bv_type = BVAL_NR;
2666 value->bv_nr = getdigits(&p);
2667 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002668 }
2669 else if (*p == '"')
2670 {
2671 int len = 0;
2672 char_u *s = p;
2673
2674 /* Unescape special characters in-place. */
2675 ++p;
2676 while (*p != '"')
2677 {
2678 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002679 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002680 if (*p == '\\')
2681 {
2682 ++p;
2683 if (*p == 'n')
2684 s[len++] = '\n';
2685 else
2686 s[len++] = *p;
2687 ++p;
2688 }
2689 else
2690 s[len++] = *p++;
2691 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002692 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002693 s[len] = NUL;
2694
Bram Moolenaar01227092016-06-11 14:47:40 +02002695#ifdef FEAT_MBYTE
2696 converted = FALSE;
2697 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2698 {
2699 sconv = string_convert(&virp->vir_conv, s, NULL);
2700 if (sconv != NULL)
2701 {
2702 if (s == buf)
2703 vim_free(s);
2704 s = sconv;
2705 buf = s;
2706 converted = TRUE;
2707 }
2708 }
2709#endif
2710 /* Need to copy in allocated memory if the string wasn't allocated
2711 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002712 if (s != buf && allocated)
2713 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002714 value->bv_string = s;
2715 value->bv_type = BVAL_STRING;
2716 value->bv_len = len;
2717 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002718#ifdef FEAT_MBYTE
2719 || converted
2720#endif
2721 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002722 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002723 if (nextp != NULL)
2724 {
2725 /* values following a long string */
2726 p = nextp;
2727 nextp = NULL;
2728 }
2729 }
2730 else if (*p == ',')
2731 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002732 value->bv_type = BVAL_EMPTY;
2733 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002734 }
2735 else
2736 break;
2737 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002738 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002739}
2740
2741 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002742read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002743{
2744 char_u *p = virp->vir_line + 1;
2745 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002746 garray_T values;
2747 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002748 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002749 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002750
2751 /* The format is: |{bartype},{value},...
2752 * For a very long string:
2753 * |{bartype},>{length of "{text}{text2}"}
2754 * |<{text1}
2755 * |<{text2},{value}
2756 * For a long line not using a string
2757 * |{bartype},{lots of values},>
2758 * |<{value},{value}
2759 */
2760 if (*p == '<')
2761 {
2762 /* Continuation line of an unrecognized item. */
2763 if (writing)
2764 ga_add_string(&virp->vir_barlines, virp->vir_line);
2765 }
2766 else
2767 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002768 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002769 bartype = getdigits(&p);
2770 switch (bartype)
2771 {
2772 case BARTYPE_VERSION:
2773 /* Only use the version when it comes before the encoding.
2774 * If it comes later it was copied by a Vim version that
2775 * doesn't understand the version. */
2776 if (!got_encoding)
2777 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002778 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002779 vp = (bval_T *)values.ga_data;
2780 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2781 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002782 }
2783 break;
2784
2785 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002786 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002787 handle_viminfo_history(&values, writing);
2788 break;
2789
2790 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002791 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002792 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002793 break;
2794
Bram Moolenaar2d358992016-06-12 21:20:54 +02002795 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002796 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002797 handle_viminfo_mark(&values, force);
2798 break;
2799
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002800 default:
2801 /* copy unrecognized line (for future use) */
2802 if (writing)
2803 ga_add_string(&virp->vir_barlines, virp->vir_line);
2804 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002805 for (i = 0; i < values.ga_len; ++i)
2806 {
2807 vp = (bval_T *)values.ga_data + i;
2808 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2809 vim_free(vp->bv_string);
2810 }
2811 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002812 }
2813
Bram Moolenaarecefe712016-06-20 12:50:17 +02002814 if (read_next)
2815 return viminfo_readline(virp);
2816 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002817}
2818
2819 static void
2820write_viminfo_version(FILE *fp_out)
2821{
2822 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2823 BARTYPE_VERSION, VIMINFO_VERSION);
2824}
2825
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002826 static void
2827write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2828{
2829 int i;
2830 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002831 int seen_useful = FALSE;
2832 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002833
2834 if (gap->ga_len > 0)
2835 {
2836 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2837
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002838 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002839 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002840 {
2841 line = ((char **)(gap->ga_data))[i];
2842 if (seen_useful || line[1] != '<')
2843 {
2844 fputs(line, fp_out);
2845 seen_useful = TRUE;
2846 }
2847 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002848 }
2849}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850#endif /* FEAT_VIMINFO */
2851
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002852/*
2853 * Return the current time in seconds. Calls time(), unless test_settime()
2854 * was used.
2855 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002856 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002857vim_time(void)
2858{
2859# ifdef FEAT_EVAL
2860 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2861# else
2862 return time(NULL);
2863# endif
2864}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002865
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866/*
2867 * Implementation of ":fixdel", also used by get_stty().
2868 * <BS> resulting <Del>
2869 * ^? ^H
2870 * not ^? ^?
2871 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002873do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874{
2875 char_u *p;
2876
2877 p = find_termcode((char_u *)"kb");
2878 add_termcode((char_u *)"kD", p != NULL
2879 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2880}
2881
2882 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002883print_line_no_prefix(
2884 linenr_T lnum,
2885 int use_number,
2886 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002888 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889
2890 if (curwin->w_p_nu || use_number)
2891 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002892 vim_snprintf((char *)numbuf, sizeof(numbuf),
2893 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2895 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002896 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897}
2898
2899/*
2900 * Print a text line. Also in silent mode ("ex -s").
2901 */
2902 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002903print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904{
2905 int save_silent = silent_mode;
2906
Bram Moolenaard29459b2016-08-26 22:29:11 +02002907 /* apply :filter /pat/ */
2908 if (message_filtered(ml_get(lnum)))
2909 return;
2910
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002912 silent_mode = FALSE;
2913 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2914 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 if (save_silent)
2916 {
2917 msg_putchar('\n');
2918 cursor_on(); /* msg_start() switches it off */
2919 out_flush();
2920 silent_mode = save_silent;
2921 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002922 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923}
2924
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002925 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002926rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002927{
2928 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002929 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002930
Bram Moolenaar7e283842013-05-30 11:43:15 +02002931#ifdef FEAT_AUTOCMD
2932 buf = curbuf;
2933 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002934 /* buffer changed, don't change name now */
2935 if (buf != curbuf)
2936 return FAIL;
2937# ifdef FEAT_EVAL
2938 if (aborting()) /* autocmds may abort script processing */
2939 return FAIL;
2940# endif
2941#endif
2942 /*
2943 * The name of the current buffer will be changed.
2944 * A new (unlisted) buffer entry needs to be made to hold the old file
2945 * name, which will become the alternate file name.
2946 * But don't set the alternate file name if the buffer didn't have a
2947 * name.
2948 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002949 fname = curbuf->b_ffname;
2950 sfname = curbuf->b_sfname;
2951 xfname = curbuf->b_fname;
2952 curbuf->b_ffname = NULL;
2953 curbuf->b_sfname = NULL;
2954 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002955 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002956 curbuf->b_ffname = fname;
2957 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002958 return FAIL;
2959 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002960 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002961 if (xfname != NULL && *xfname != NUL)
2962 {
2963 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2964 if (buf != NULL && !cmdmod.keepalt)
2965 curwin->w_alt_fnum = buf->b_fnum;
2966 }
2967 vim_free(fname);
2968 vim_free(sfname);
2969#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002970 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002971#endif
2972 /* Change directories when the 'acd' option is set. */
2973 DO_AUTOCHDIR
2974 return OK;
2975}
2976
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977/*
2978 * ":file[!] [fname]".
2979 */
2980 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002981ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002983 /* ":0file" removes the file name. Check for illegal uses ":3file",
2984 * "0file name", etc. */
2985 if (eap->addr_count > 0
2986 && (*eap->arg != NUL
2987 || eap->line2 > 0
2988 || eap->addr_count > 1))
2989 {
2990 EMSG(_(e_invarg));
2991 return;
2992 }
2993
2994 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002996 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 }
2999 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01003000 if (!shortmess(SHM_FILEINFO))
3001 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002}
3003
3004/*
3005 * ":update".
3006 */
3007 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003008ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009{
3010 if (curbufIsChanged())
3011 (void)do_write(eap);
3012}
3013
3014/*
3015 * ":write" and ":saveas".
3016 */
3017 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003018ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019{
3020 if (eap->usefilter) /* input lines to shell command */
3021 do_bang(1, eap, FALSE, TRUE, FALSE);
3022 else
3023 (void)do_write(eap);
3024}
3025
3026/*
3027 * write current buffer to file 'eap->arg'
3028 * if 'eap->append' is TRUE, append to the file
3029 *
3030 * if *eap->arg == NUL write to current file
3031 *
3032 * return FAIL for failure, OK otherwise
3033 */
3034 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003035do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036{
3037 int other;
3038 char_u *fname = NULL; /* init to shut up gcc */
3039 char_u *ffname;
3040 int retval = FAIL;
3041 char_u *free_fname = NULL;
3042#ifdef FEAT_BROWSE
3043 char_u *browse_file = NULL;
3044#endif
3045 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003046 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047
3048 if (not_writing()) /* check 'write' option */
3049 return FAIL;
3050
3051 ffname = eap->arg;
3052#ifdef FEAT_BROWSE
3053 if (cmdmod.browse)
3054 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003055 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 NULL, NULL, NULL, curbuf);
3057 if (browse_file == NULL)
3058 goto theend;
3059 ffname = browse_file;
3060 }
3061#endif
3062 if (*ffname == NUL)
3063 {
3064 if (eap->cmdidx == CMD_saveas)
3065 {
3066 EMSG(_(e_argreq));
3067 goto theend;
3068 }
3069 other = FALSE;
3070 }
3071 else
3072 {
3073 fname = ffname;
3074 free_fname = fix_fname(ffname);
3075 /*
3076 * When out-of-memory, keep unexpanded file name, because we MUST be
3077 * able to write the file in this situation.
3078 */
3079 if (free_fname != NULL)
3080 ffname = free_fname;
3081 other = otherfile(ffname);
3082 }
3083
3084 /*
3085 * If we have a new file, put its name in the list of alternate file names.
3086 */
3087 if (other)
3088 {
3089 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3090 || eap->cmdidx == CMD_saveas)
3091 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3092 else
3093 alt_buf = buflist_findname(ffname);
3094 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3095 {
3096 /* Overwriting a file that is loaded in another buffer is not a
3097 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003098 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 goto theend;
3100 }
3101 }
3102
3103 /*
3104 * Writing to the current file is not allowed in readonly mode
3105 * and a file name is required.
3106 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3107 */
3108 if (!other && (
3109#ifdef FEAT_QUICKFIX
3110 bt_dontwrite_msg(curbuf) ||
3111#endif
3112 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3113 goto theend;
3114
3115 if (!other)
3116 {
3117 ffname = curbuf->b_ffname;
3118 fname = curbuf->b_fname;
3119 /*
3120 * Not writing the whole file is only allowed with '!'.
3121 */
3122 if ( (eap->line1 != 1
3123 || eap->line2 != curbuf->b_ml.ml_line_count)
3124 && !eap->forceit
3125 && !eap->append
3126 && !p_wa)
3127 {
3128#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3129 if (p_confirm || cmdmod.confirm)
3130 {
3131 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3132 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3133 goto theend;
3134 eap->forceit = TRUE;
3135 }
3136 else
3137#endif
3138 {
3139 EMSG(_("E140: Use ! to write partial buffer"));
3140 goto theend;
3141 }
3142 }
3143 }
3144
3145 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3146 {
3147 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3148 {
3149#ifdef FEAT_AUTOCMD
3150 buf_T *was_curbuf = curbuf;
3151
3152 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003153 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154# ifdef FEAT_EVAL
3155 if (curbuf != was_curbuf || aborting())
3156# else
3157 if (curbuf != was_curbuf)
3158# endif
3159 {
3160 /* buffer changed, don't change name now */
3161 retval = FAIL;
3162 goto theend;
3163 }
3164#endif
3165 /* Exchange the file names for the current and the alternate
3166 * buffer. This makes it look like we are now editing the buffer
3167 * under the new name. Must be done before buf_write(), because
3168 * if there is no file name and 'cpo' contains 'F', it will set
3169 * the file name. */
3170 fname = alt_buf->b_fname;
3171 alt_buf->b_fname = curbuf->b_fname;
3172 curbuf->b_fname = fname;
3173 fname = alt_buf->b_ffname;
3174 alt_buf->b_ffname = curbuf->b_ffname;
3175 curbuf->b_ffname = fname;
3176 fname = alt_buf->b_sfname;
3177 alt_buf->b_sfname = curbuf->b_sfname;
3178 curbuf->b_sfname = fname;
3179 buf_name_changed(curbuf);
3180#ifdef FEAT_AUTOCMD
3181 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003182 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 if (!alt_buf->b_p_bl)
3184 {
3185 alt_buf->b_p_bl = TRUE;
3186 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3187 }
3188# ifdef FEAT_EVAL
3189 if (curbuf != was_curbuf || aborting())
3190# else
3191 if (curbuf != was_curbuf)
3192# endif
3193 {
3194 /* buffer changed, don't write the file */
3195 retval = FAIL;
3196 goto theend;
3197 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003198
3199 /* If 'filetype' was empty try detecting it now. */
3200 if (*curbuf->b_p_ft == NUL)
3201 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003202 if (au_has_group((char_u *)"filetypedetect"))
3203 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003204 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003205 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003206 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003207
3208 /* Autocommands may have changed buffer names, esp. when
3209 * 'autochdir' is set. */
3210 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211#endif
3212 }
3213
Bram Moolenaar5c719942016-07-09 23:40:45 +02003214 name_was_missing = curbuf->b_ffname == NULL;
3215
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3217 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003218
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003219 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003220 if (eap->cmdidx == CMD_saveas)
3221 {
3222 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003223 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003224 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003225#ifdef FEAT_WINDOWS
3226 redraw_tabline = TRUE;
3227#endif
3228 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003229 }
3230
3231 /* Change directories when the 'acd' option is set and the file name
3232 * got changed or set. */
3233 if (eap->cmdidx == CMD_saveas || name_was_missing)
3234 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003235 DO_AUTOCHDIR
3236 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 }
3238
3239theend:
3240#ifdef FEAT_BROWSE
3241 vim_free(browse_file);
3242#endif
3243 vim_free(free_fname);
3244 return retval;
3245}
3246
3247/*
3248 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3249 * BF_NEW or BF_READERR, check for overwriting current file.
3250 * May set eap->forceit if a dialog says it's OK to overwrite.
3251 * Return OK if it's OK, FAIL if it is not.
3252 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003253 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003254check_overwrite(
3255 exarg_T *eap,
3256 buf_T *buf,
3257 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003259 char_u *ffname, /* full path version of fname */
3260 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261{
3262 /*
3263 * write to other file or b_flags set or not writing the whole file:
3264 * overwriting only allowed with '!'
3265 */
3266 if ( (other
3267 || (buf->b_flags & BF_NOTEDITED)
3268 || ((buf->b_flags & BF_NEW)
3269 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3270 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003272#ifdef FEAT_QUICKFIX
3273 && !bt_nofile(buf)
3274#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 && vim_fexists(ffname))
3276 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003277 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003279#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003280 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003281 if (mch_isdir(ffname))
3282 {
3283 EMSG2(_(e_isadir2), ffname);
3284 return FAIL;
3285 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286#endif
3287#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003288 if (p_confirm || cmdmod.confirm)
3289 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003290 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003292 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3293 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3294 return FAIL;
3295 eap->forceit = TRUE;
3296 }
3297 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003299 {
3300 EMSG(_(e_exists));
3301 return FAIL;
3302 }
3303 }
3304
3305 /* For ":w! filename" check that no swap file exists for "filename". */
3306 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003308 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003309 char_u *p;
3310 int r;
3311 char_u *swapname;
3312
3313 /* We only try the first entry in 'directory', without checking if
3314 * it's writable. If the "." directory is not writable the write
3315 * will probably fail anyway.
3316 * Use 'shortname' of the current buffer, since there is no buffer
3317 * for the written file. */
3318 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003319 {
3320 dir = alloc(5);
3321 if (dir == NULL)
3322 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003323 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003324 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003325 else
3326 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003327 dir = alloc(MAXPATHL);
3328 if (dir == NULL)
3329 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003330 p = p_dir;
3331 copy_option_part(&p, dir, MAXPATHL, ",");
3332 }
3333 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003334 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003335 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003336 if (r)
3337 {
3338#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3339 if (p_confirm || cmdmod.confirm)
3340 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003341 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003342
3343 dialog_msg(buff,
3344 _("Swap file \"%s\" exists, overwrite anyway?"),
3345 swapname);
3346 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3347 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003348 {
3349 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003350 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003351 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003352 eap->forceit = TRUE;
3353 }
3354 else
3355#endif
3356 {
3357 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3358 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003359 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003360 return FAIL;
3361 }
3362 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003363 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 }
3365 }
3366 return OK;
3367}
3368
3369/*
3370 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3371 */
3372 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003373ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374{
3375 int i;
3376
3377 if (eap->cmd[1] == 'n')
3378 i = curwin->w_arg_idx + (int)eap->line2;
3379 else
3380 i = curwin->w_arg_idx - (int)eap->line2;
3381 eap->line1 = 1;
3382 eap->line2 = curbuf->b_ml.ml_line_count;
3383 if (do_write(eap) != FAIL)
3384 do_argfile(eap, i);
3385}
3386
3387/*
3388 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3389 */
3390 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003391do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392{
3393 buf_T *buf;
3394 int error = 0;
3395 int save_forceit = eap->forceit;
3396
3397 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3398 exiting = TRUE;
3399
Bram Moolenaar29323592016-07-24 22:04:11 +02003400 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 {
3402 if (bufIsChanged(buf))
3403 {
3404 /*
3405 * Check if there is a reason the buffer cannot be written:
3406 * 1. if the 'write' option is set
3407 * 2. if there is no file name (even after browsing)
3408 * 3. if the 'readonly' is set (even after a dialog)
3409 * 4. if overwriting is allowed (even after a dialog)
3410 */
3411 if (not_writing())
3412 {
3413 ++error;
3414 break;
3415 }
3416#ifdef FEAT_BROWSE
3417 /* ":browse wall": ask for file name if there isn't one */
3418 if (buf->b_ffname == NULL && cmdmod.browse)
3419 browse_save_fname(buf);
3420#endif
3421 if (buf->b_ffname == NULL)
3422 {
3423 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3424 ++error;
3425 }
3426 else if (check_readonly(&eap->forceit, buf)
3427 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3428 FALSE) == FAIL)
3429 {
3430 ++error;
3431 }
3432 else
3433 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003434#ifdef FEAT_AUTOCMD
3435 bufref_T bufref;
3436
3437 set_bufref(&bufref, buf);
3438#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 if (buf_write_all(buf, eap->forceit) == FAIL)
3440 ++error;
3441#ifdef FEAT_AUTOCMD
3442 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003443 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 buf = firstbuf;
3445#endif
3446 }
3447 eap->forceit = save_forceit; /* check_overwrite() may set it */
3448 }
3449 }
3450 if (exiting)
3451 {
3452 if (!error)
3453 getout(0); /* exit Vim */
3454 not_exiting();
3455 }
3456}
3457
3458/*
3459 * Check the 'write' option.
3460 * Return TRUE and give a message when it's not st.
3461 */
3462 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003463not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464{
3465 if (p_write)
3466 return FALSE;
3467 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3468 return TRUE;
3469}
3470
3471/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003472 * Check if a buffer is read-only (either 'readonly' option is set or file is
3473 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3474 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 */
3476 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003477check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003479 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003480
3481 /* Handle a file being readonly when the 'readonly' option is set or when
3482 * the file exists and permissions are read-only.
3483 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3484 * important for device checks but not here. */
3485 if (!*forceit && (buf->b_p_ro
3486 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3487 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 {
3489#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3490 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3491 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003492 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493
Bram Moolenaar5386a122007-06-28 20:02:32 +00003494 if (buf->b_p_ro)
3495 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3496 buf->b_fname);
3497 else
3498 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 +00003499 buf->b_fname);
3500
3501 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3502 {
3503 /* Set forceit, to force the writing of a readonly file */
3504 *forceit = TRUE;
3505 return FALSE;
3506 }
3507 else
3508 return TRUE;
3509 }
3510 else
3511#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003512 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003514 else
3515 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3516 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 return TRUE;
3518 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003519
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 return FALSE;
3521}
3522
3523/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003524 * Try to abandon current file and edit a new or existing file.
3525 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003527 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003528 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3530 */
3531 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003532getfile(
3533 int fnum,
3534 char_u *ffname,
3535 char_u *sfname,
3536 int setpm,
3537 linenr_T lnum,
3538 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539{
3540 int other;
3541 int retval;
3542 char_u *free_me = NULL;
3543
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003544 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003546#ifdef FEAT_AUTOCMD
3547 if (curbuf_locked())
3548 return 1;
3549#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550
3551 if (fnum == 0)
3552 {
3553 /* make ffname full path, set sfname */
3554 fname_expand(curbuf, &ffname, &sfname);
3555 other = otherfile(ffname);
3556 free_me = ffname; /* has been allocated, free() later */
3557 }
3558 else
3559 other = (fnum != curbuf->b_fnum);
3560
3561 if (other)
3562 ++no_wait_return; /* don't wait for autowrite message */
3563 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3564 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3565 {
3566#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3567 if (p_confirm && p_write)
3568 dialog_changed(curbuf, FALSE);
3569 if (curbufIsChanged())
3570#endif
3571 {
3572 if (other)
3573 --no_wait_return;
3574 EMSG(_(e_nowrtmsg));
3575 retval = 2; /* file has been changed */
3576 goto theend;
3577 }
3578 }
3579 if (other)
3580 --no_wait_return;
3581 if (setpm)
3582 setpcmark();
3583 if (!other)
3584 {
3585 if (lnum != 0)
3586 curwin->w_cursor.lnum = lnum;
3587 check_cursor_lnum();
3588 beginline(BL_SOL | BL_FIX);
3589 retval = 0; /* it's in the same file */
3590 }
3591 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003592 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3593 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 retval = -1; /* opened another file */
3595 else
3596 retval = 1; /* error encountered */
3597
3598theend:
3599 vim_free(free_me);
3600 return retval;
3601}
3602
3603/*
3604 * start editing a new file
3605 *
3606 * fnum: file number; if zero use ffname/sfname
3607 * ffname: the file name
3608 * - full path if sfname used,
3609 * - any file name if sfname is NULL
3610 * - empty string to re-edit with the same file name (but may be
3611 * in a different directory)
3612 * - NULL to start an empty buffer
3613 * sfname: the short file name (or NULL)
3614 * eap: contains the command to be executed after loading the file and
3615 * forced 'ff' and 'fenc'
3616 * newlnum: if > 0: put cursor on this line number (if possible)
3617 * if ECMD_LASTL: use last position in loaded file
3618 * if ECMD_LAST: use last position in all files
3619 * if ECMD_ONE: use first line
3620 * flags:
3621 * ECMD_HIDE: if TRUE don't free the current buffer
3622 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3623 * ECMD_OLDBUF: use existing buffer if it exists
3624 * ECMD_FORCEIT: ! used for Ex command
3625 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003626 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003627 * window, NULL when splitting the window first. When not NULL info
3628 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 *
3630 * return FAIL for failure, OK otherwise
3631 */
3632 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003633do_ecmd(
3634 int fnum,
3635 char_u *ffname,
3636 char_u *sfname,
3637 exarg_T *eap, /* can be NULL! */
3638 linenr_T newlnum,
3639 int flags,
3640 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641{
3642 int other_file; /* TRUE if editing another file */
3643 int oldbuf; /* TRUE if using existing buffer */
3644#ifdef FEAT_AUTOCMD
3645 int auto_buf = FALSE; /* TRUE if autocommands brought us
3646 into the buffer unexpectedly */
3647 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003648 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649#endif
3650 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003651 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003653 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654#endif
3655 char_u *free_fname = NULL;
3656#ifdef FEAT_BROWSE
3657 char_u *browse_file = NULL;
3658#endif
3659 int retval = FAIL;
3660 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003661 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 linenr_T topline = 0;
3663 int newcol = -1;
3664 int solcol = -1;
3665 pos_T *pos;
3666#ifdef FEAT_SUN_WORKSHOP
3667 char_u *cp;
3668#endif
3669 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003670#ifdef FEAT_SPELL
3671 int did_get_winopts = FALSE;
3672#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003673 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003674 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675
3676 if (eap != NULL)
3677 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003678#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3679 set_bufref(&old_curbuf, curbuf);
3680#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681
3682 if (fnum != 0)
3683 {
3684 if (fnum == curbuf->b_fnum) /* file is already being edited */
3685 return OK; /* nothing to do */
3686 other_file = TRUE;
3687 }
3688 else
3689 {
3690#ifdef FEAT_BROWSE
3691 if (cmdmod.browse)
3692 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003693# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003694 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003695# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003696 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003697# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003698 au_has_group((char_u *)"FileExplorer"))
3699 {
3700 /* No browsing supported but we do have the file explorer:
3701 * Edit the directory. */
3702 if (ffname == NULL || !mch_isdir(ffname))
3703 ffname = (char_u *)".";
3704 }
3705 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003706# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003707 {
3708 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003710 if (browse_file == NULL)
3711 goto theend;
3712 ffname = browse_file;
3713 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 }
3715#endif
3716 /* if no short name given, use ffname for short name */
3717 if (sfname == NULL)
3718 sfname = ffname;
3719#ifdef USE_FNAME_CASE
3720# ifdef USE_LONG_FNAME
3721 if (USE_LONG_FNAME)
3722# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003723 if (sfname != NULL)
3724 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725#endif
3726
3727#ifdef FEAT_LISTCMDS
3728 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3729 goto theend;
3730#endif
3731
3732 if (ffname == NULL)
3733 other_file = TRUE;
3734 /* there is no file name */
3735 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3736 other_file = FALSE;
3737 else
3738 {
3739 if (*ffname == NUL) /* re-edit with same file name */
3740 {
3741 ffname = curbuf->b_ffname;
3742 sfname = curbuf->b_fname;
3743 }
3744 free_fname = fix_fname(ffname); /* may expand to full path name */
3745 if (free_fname != NULL)
3746 ffname = free_fname;
3747 other_file = otherfile(ffname);
3748#ifdef FEAT_SUN_WORKSHOP
3749 if (usingSunWorkShop && p_acd
3750 && (cp = vim_strrchr(sfname, '/')) != NULL)
3751 sfname = ++cp;
3752#endif
3753 }
3754 }
3755
3756 /*
3757 * if the file was changed we may not be allowed to abandon it
3758 * - if we are going to re-edit the same file
3759 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3760 */
3761 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3762 || (curbuf->b_nwindows == 1
3763 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003764 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3765 | (other_file ? 0 : CCGD_MULTWIN)
3766 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3767 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 {
3769 if (fnum == 0 && other_file && ffname != NULL)
3770 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3771 goto theend;
3772 }
3773
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 /*
3775 * End Visual mode before switching to another buffer, so the text can be
3776 * copied into the GUI selection buffer.
3777 */
3778 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003780#ifdef FEAT_AUTOCMD
3781 if ((command != NULL || newlnum > (linenr_T)0)
3782 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3783 {
3784 int len;
3785 char_u *p;
3786
3787 /* Set v:swapcommand for the SwapExists autocommands. */
3788 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003789 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003790 else
3791 len = 30;
3792 p = alloc((unsigned)len);
3793 if (p != NULL)
3794 {
3795 if (command != NULL)
3796 vim_snprintf((char *)p, len, ":%s\r", command);
3797 else
3798 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3799 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3800 did_set_swapcommand = TRUE;
3801 vim_free(p);
3802 }
3803 }
3804#endif
3805
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 /*
3807 * If we are starting to edit another file, open a (new) buffer.
3808 * Otherwise we re-use the current buffer.
3809 */
3810 if (other_file)
3811 {
3812#ifdef FEAT_LISTCMDS
3813 if (!(flags & ECMD_ADDBUF))
3814#endif
3815 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003816 if (!cmdmod.keepalt)
3817 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003818 if (oldwin != NULL)
3819 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 }
3821
3822 if (fnum)
3823 buf = buflist_findnr(fnum);
3824 else
3825 {
3826#ifdef FEAT_LISTCMDS
3827 if (flags & ECMD_ADDBUF)
3828 {
3829 linenr_T tlnum = 1L;
3830
3831 if (command != NULL)
3832 {
3833 tlnum = atol((char *)command);
3834 if (tlnum <= 0)
3835 tlnum = 1L;
3836 }
3837 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3838 goto theend;
3839 }
3840#endif
3841 buf = buflist_new(ffname, sfname, 0L,
3842 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003843#ifdef FEAT_AUTOCMD
3844 /* autocommands may change curwin and curbuf */
3845 if (oldwin != NULL)
3846 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003847 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003848#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 }
3850 if (buf == NULL)
3851 goto theend;
3852 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3853 {
3854 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 }
3856 else /* existing memfile */
3857 {
3858 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003859 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003861 /* Check if autocommands made the buffer invalid or changed the
3862 * current buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003863 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003865 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866#endif
3867 )
3868 goto theend;
3869#ifdef FEAT_EVAL
3870 if (aborting()) /* autocmds may abort script processing */
3871 goto theend;
3872#endif
3873 }
3874
3875 /* May jump to last used line number for a loaded buffer or when asked
3876 * for explicitly */
3877 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3878 {
3879 pos = buflist_findfpos(buf);
3880 newlnum = pos->lnum;
3881 solcol = pos->col;
3882 }
3883
3884 /*
3885 * Make the (new) buffer the one used by the current window.
3886 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3887 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003888 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 */
3890 if (buf != curbuf)
3891 {
3892#ifdef FEAT_AUTOCMD
3893 /*
3894 * Be careful: The autocommands may delete any buffer and change
3895 * the current buffer.
3896 * - If the buffer we are going to edit is deleted, give up.
3897 * - If the current buffer is deleted, prefer to load the new
3898 * buffer when loading a buffer is required. This avoids
3899 * loading another buffer which then must be closed again.
3900 * - If we ended up in the new buffer already, need to skip a few
3901 * things, set auto_buf.
3902 */
3903 if (buf->b_fname != NULL)
3904 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003905 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003907 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003909 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 delbuf_msg(new_name); /* frees new_name */
3911 goto theend;
3912 }
3913# ifdef FEAT_EVAL
3914 if (aborting()) /* autocmds may abort script processing */
3915 {
3916 vim_free(new_name);
3917 goto theend;
3918 }
3919# endif
3920 if (buf == curbuf) /* already in new buffer */
3921 auto_buf = TRUE;
3922 else
3923 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02003924 win_T *the_curwin = curwin;
3925
3926 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003927 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02003928 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003929 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02003930
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003931 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932#endif
3933 buf_copy_options(buf, BCO_ENTER);
3934
Bram Moolenaar5a497892016-09-03 16:29:04 +02003935 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02003936 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003937 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003938 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003939 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940
3941#ifdef FEAT_AUTOCMD
Bram Moolenaar5a497892016-09-03 16:29:04 +02003942 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003943 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01003944
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945# ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02003946 /* autocmds may abort script processing */
3947 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 {
3949 vim_free(new_name);
3950 goto theend;
3951 }
3952# endif
3953 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003954 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003956 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 delbuf_msg(new_name); /* frees new_name */
3958 goto theend;
3959 }
3960 if (buf == curbuf) /* already in new buffer */
3961 auto_buf = TRUE;
3962 else
3963#endif
3964 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003965#ifdef FEAT_SYN_HL
3966 /*
3967 * <VN> We could instead free the synblock
3968 * and re-attach to buffer, perhaps.
3969 */
3970 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003971 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003972#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 curwin->w_buffer = buf;
3974 curbuf = buf;
3975 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003976
3977 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3978 if (!oldbuf && eap != NULL)
3979 {
3980 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003981#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003982 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003983#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003984 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 }
3986
3987 /* May get the window options from the last time this buffer
3988 * was in this window (or another window). If not used
3989 * before, reset the local window options to the global
3990 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003991 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003992#ifdef FEAT_SPELL
3993 did_get_winopts = TRUE;
3994#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995
3996#ifdef FEAT_AUTOCMD
3997 }
3998 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003999 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004000 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001#endif
4002 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003
4004 curwin->w_pcmark.lnum = 1;
4005 curwin->w_pcmark.col = 0;
4006 }
4007 else /* !other_file */
4008 {
4009 if (
4010#ifdef FEAT_LISTCMDS
4011 (flags & ECMD_ADDBUF) ||
4012#endif
4013 check_fname() == FAIL)
4014 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004015
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 oldbuf = (flags & ECMD_OLDBUF);
4017 }
4018
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004019 /* Don't redraw until the cursor is in the right line, otherwise
4020 * autocommands may cause ml_get errors. */
4021 ++RedrawingDisabled;
4022 did_inc_redrawing_disabled = TRUE;
4023
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004024#ifdef FEAT_AUTOCMD
4025 buf = curbuf;
4026#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4028 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004029 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 }
4031 else
4032 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 /* Don't make a buffer listed if it's a help buffer. Useful when
4034 * using CTRL-O to go back to a help file. */
4035 if (!curbuf->b_help)
4036 set_buflisted(TRUE);
4037 }
4038
4039#ifdef FEAT_AUTOCMD
4040 /* If autocommands change buffers under our fingers, forget about
4041 * editing the file. */
4042 if (buf != curbuf)
4043 goto theend;
4044# ifdef FEAT_EVAL
4045 if (aborting()) /* autocmds may abort script processing */
4046 goto theend;
4047# endif
4048
4049 /* Since we are starting to edit a file, consider the filetype to be
4050 * unset. Helps for when an autocommand changes files and expects syntax
4051 * highlighting to work in the other file. */
4052 did_filetype = FALSE;
4053#endif
4054
4055/*
4056 * other_file oldbuf
4057 * FALSE FALSE re-edit same file, buffer is re-used
4058 * FALSE TRUE re-edit same file, nothing changes
4059 * TRUE FALSE start editing new file, new buffer
4060 * TRUE TRUE start editing in existing buffer (nothing to do)
4061 */
4062 if (!other_file && !oldbuf) /* re-use the buffer */
4063 {
4064 set_last_cursor(curwin); /* may set b_last_cursor */
4065 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4066 {
4067 newlnum = curwin->w_cursor.lnum;
4068 solcol = curwin->w_cursor.col;
4069 }
4070#ifdef FEAT_AUTOCMD
4071 buf = curbuf;
4072 if (buf->b_fname != NULL)
4073 new_name = vim_strsave(buf->b_fname);
4074 else
4075 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004076 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004078 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4079 {
4080 /* Save all the text, so that the reload can be undone.
4081 * Sync first so that this is a separate undo-able action. */
4082 u_sync(FALSE);
4083 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4084 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004085 {
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004086#ifdef FEAT_AUTOCMD
Bram Moolenaar1e225822016-07-30 21:48:59 +02004087 vim_free(new_name);
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004088#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004089 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004090 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004091 u_unchanged(curbuf);
4092 buf_freeall(curbuf, BFA_KEEP_UNDO);
4093
4094 /* tell readfile() not to clear or reload undo info */
4095 readfile_flags = READ_KEEP_UNDO;
4096 }
4097 else
4098 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099#ifdef FEAT_AUTOCMD
4100 /* If autocommands deleted the buffer we were going to re-edit, give
4101 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004102 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 {
4104 delbuf_msg(new_name); /* frees new_name */
4105 goto theend;
4106 }
4107 vim_free(new_name);
4108
4109 /* If autocommands change buffers under our fingers, forget about
4110 * re-editing the file. Should do the buf_clear_file(), but perhaps
4111 * the autocommands changed the buffer... */
4112 if (buf != curbuf)
4113 goto theend;
4114# ifdef FEAT_EVAL
4115 if (aborting()) /* autocmds may abort script processing */
4116 goto theend;
4117# endif
4118#endif
4119 buf_clear_file(curbuf);
4120 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4121 curbuf->b_op_end.lnum = 0;
4122 }
4123
4124/*
4125 * If we get here we are sure to start editing
4126 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 /* Assume success now */
4128 retval = OK;
4129
4130 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 * Check if we are editing the w_arg_idx file in the argument list.
4132 */
4133 check_arg_idx(curwin);
4134
4135#ifdef FEAT_AUTOCMD
4136 if (!auto_buf)
4137#endif
4138 {
4139 /*
4140 * Set cursor and init window before reading the file and executing
4141 * autocommands. This allows for the autocommands to position the
4142 * cursor.
4143 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004144 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145
4146#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004147 /* It's possible that all lines in the buffer changed. Need to update
4148 * automatic folding for all windows where it's used. */
4149# ifdef FEAT_WINDOWS
4150 {
4151 win_T *win;
4152 tabpage_T *tp;
4153
4154 FOR_ALL_TAB_WINDOWS(tp, win)
4155 if (win->w_buffer == curbuf)
4156 foldUpdateAll(win);
4157 }
4158# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004160# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161#endif
4162
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004163 /* Change directories when the 'acd' option is set. */
4164 DO_AUTOCHDIR
4165
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 /*
4167 * Careful: open_buffer() and apply_autocmds() may change the current
4168 * buffer and window.
4169 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004170 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 topline = curwin->w_topline;
4172 if (!oldbuf) /* need to read the file */
4173 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004174#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 swap_exists_action = SEA_DIALOG;
4176#endif
4177 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4178
4179 /*
4180 * Open the buffer and read the file.
4181 */
4182#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004183 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 retval = FAIL;
4185#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004186 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187#endif
4188
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004189#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 if (swap_exists_action == SEA_QUIT)
4191 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004192 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193#endif
4194 }
4195#ifdef FEAT_AUTOCMD
4196 else
4197 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004198 /* Read the modelines, but only to set window-local options. Any
4199 * buffer-local options have already been set and may have been
4200 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004201 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004202
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4204 &retval);
4205 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4206 &retval);
4207 }
4208 check_arg_idx(curwin);
4209#endif
4210
Bram Moolenaareab316b2015-03-24 11:46:30 +01004211 /* If autocommands change the cursor position or topline, we should
4212 * keep it. Also when it moves within a line. */
4213 if (!equalpos(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 {
4215 newlnum = curwin->w_cursor.lnum;
4216 newcol = curwin->w_cursor.col;
4217 }
4218 if (curwin->w_topline == topline)
4219 topline = 0;
4220
4221 /* Even when cursor didn't move we need to recompute topline. */
4222 changed_line_abv_curs();
4223
4224#ifdef FEAT_TITLE
4225 maketitle();
4226#endif
4227 }
4228
4229#ifdef FEAT_DIFF
4230 /* Tell the diff stuff that this buffer is new and/or needs updating.
4231 * Also needed when re-editing the same buffer, because unloading will
4232 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004233 if (curwin->w_p_diff)
4234 {
4235 diff_buf_add(curbuf);
4236 diff_invalidate(curbuf);
4237 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238#endif
4239
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004240#ifdef FEAT_SPELL
4241 /* If the window options were changed may need to set the spell language.
4242 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004243 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4244 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004245#endif
4246
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 if (command == NULL)
4248 {
4249 if (newcol >= 0) /* position set by autocommands */
4250 {
4251 curwin->w_cursor.lnum = newlnum;
4252 curwin->w_cursor.col = newcol;
4253 check_cursor();
4254 }
4255 else if (newlnum > 0) /* line number from caller or old position */
4256 {
4257 curwin->w_cursor.lnum = newlnum;
4258 check_cursor_lnum();
4259 if (solcol >= 0 && !p_sol)
4260 {
4261 /* 'sol' is off: Use last known column. */
4262 curwin->w_cursor.col = solcol;
4263 check_cursor_col();
4264#ifdef FEAT_VIRTUALEDIT
4265 curwin->w_cursor.coladd = 0;
4266#endif
4267 curwin->w_set_curswant = TRUE;
4268 }
4269 else
4270 beginline(BL_SOL | BL_FIX);
4271 }
4272 else /* no line number, go to last line in Ex mode */
4273 {
4274 if (exmode_active)
4275 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4276 beginline(BL_WHITE | BL_FIX);
4277 }
4278 }
4279
4280#ifdef FEAT_WINDOWS
4281 /* Check if cursors in other windows on the same buffer are still valid */
4282 check_lnums(FALSE);
4283#endif
4284
4285 /*
4286 * Did not read the file, need to show some info about the file.
4287 * Do this after setting the cursor.
4288 */
4289 if (oldbuf
4290#ifdef FEAT_AUTOCMD
4291 && !auto_buf
4292#endif
4293 )
4294 {
4295 int msg_scroll_save = msg_scroll;
4296
4297 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4298 * message. */
4299 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4300 msg_scroll = FALSE;
4301 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4302 check_for_delay(FALSE);
4303 msg_start();
4304 msg_scroll = msg_scroll_save;
4305 msg_scrolled_ign = TRUE;
4306
Bram Moolenaar426dd022016-03-15 15:09:29 +01004307 if (!shortmess(SHM_FILEINFO))
4308 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309
4310 msg_scrolled_ign = FALSE;
4311 }
4312
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004313#ifdef FEAT_VIMINFO
4314 curbuf->b_last_used = vim_time();
4315#endif
4316
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 if (command != NULL)
4318 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4319
4320#ifdef FEAT_KEYMAP
4321 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004322 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323#endif
4324
4325 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004326 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 if (!skip_redraw)
4328 {
4329 n = p_so;
4330 if (topline == 0 && command == NULL)
4331 p_so = 999; /* force cursor halfway the window */
4332 update_topline();
4333#ifdef FEAT_SCROLLBIND
4334 curwin->w_scbind_pos = curwin->w_topline;
4335#endif
4336 p_so = n;
4337 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4338 }
4339
4340 if (p_im)
4341 need_start_insertmode = TRUE;
4342
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004343 /* Change directories when the 'acd' option is set. */
4344 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004346#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004347 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 {
4349# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004350 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4352# endif
4353# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004354 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004355 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356# endif
4357 }
4358#endif
4359
4360theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004361 if (did_inc_redrawing_disabled)
4362 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004363#ifdef FEAT_AUTOCMD
4364 if (did_set_swapcommand)
4365 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4366#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367#ifdef FEAT_BROWSE
4368 vim_free(browse_file);
4369#endif
4370 vim_free(free_fname);
4371 return retval;
4372}
4373
4374#ifdef FEAT_AUTOCMD
4375 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004376delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377{
4378 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4379 name == NULL ? (char_u *)"" : name);
4380 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004381 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004382 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383}
4384#endif
4385
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004386static int append_indent = 0; /* autoindent for first line */
4387
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388/*
4389 * ":insert" and ":append", also used by ":change"
4390 */
4391 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004392ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393{
4394 char_u *theline;
4395 int did_undo = FALSE;
4396 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004397 int indent = 0;
4398 char_u *p;
4399 int vcol;
4400 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004402 /* the ! flag toggles autoindent */
4403 if (eap->forceit)
4404 curbuf->b_p_ai = !curbuf->b_p_ai;
4405
4406 /* First autoindent comes from the line we start on */
4407 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4408 append_indent = get_indent_lnum(lnum);
4409
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 if (eap->cmdidx != CMD_append)
4411 --lnum;
4412
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004413 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004414 if (empty && lnum == 1)
4415 lnum = 0;
4416
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 State = INSERT; /* behave like in Insert mode */
4418 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4419 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004420
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004421 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 {
4423 msg_scroll = TRUE;
4424 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004425 if (curbuf->b_p_ai)
4426 {
4427 if (append_indent >= 0)
4428 {
4429 indent = append_indent;
4430 append_indent = -1;
4431 }
4432 else if (lnum > 0)
4433 indent = get_indent_lnum(lnum);
4434 }
4435 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004437 {
4438 /* No getline() function, use the lines that follow. This ends
4439 * when there is no more. */
4440 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4441 break;
4442 p = vim_strchr(eap->nextcmd, NL);
4443 if (p == NULL)
4444 p = eap->nextcmd + STRLEN(eap->nextcmd);
4445 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4446 if (*p != NUL)
4447 ++p;
4448 eap->nextcmd = p;
4449 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004451 {
4452 int save_State = State;
4453
4454 /* Set State to avoid the cursor shape to be set to INSERT mode
4455 * when getline() returns. */
4456 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 theline = eap->getline(
4458#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004459 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004461 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004462 State = save_State;
4463 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004465 if (theline == NULL)
4466 break;
4467
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004468 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4469 if (ex_keep_indent)
4470 append_indent = indent;
4471
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004472 /* Look for the "." after automatic indent. */
4473 vcol = 0;
4474 for (p = theline; indent > vcol; ++p)
4475 {
4476 if (*p == ' ')
4477 ++vcol;
4478 else if (*p == TAB)
4479 vcol += 8 - vcol % 8;
4480 else
4481 break;
4482 }
4483 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004484 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4485 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 {
4487 vim_free(theline);
4488 break;
4489 }
4490
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004491 /* don't use autoindent if nothing was typed. */
4492 if (p[0] == NUL)
4493 theline[0] = NUL;
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 did_undo = TRUE;
4496 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004497 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 vim_free(theline);
4500 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004501
4502 if (empty)
4503 {
4504 ml_delete(2L, FALSE);
4505 empty = FALSE;
4506 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 }
4508 State = NORMAL;
4509
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004510 if (eap->forceit)
4511 curbuf->b_p_ai = !curbuf->b_p_ai;
4512
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004514 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 * "end" is set to lnum when something has been appended, otherwise
4516 * it is the same than "start" -- Acevedo */
4517 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4518 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4519 if (eap->cmdidx != CMD_append)
4520 --curbuf->b_op_start.lnum;
4521 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4522 ? lnum : curbuf->b_op_start.lnum;
4523 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4524 curwin->w_cursor.lnum = lnum;
4525 check_cursor_lnum();
4526 beginline(BL_SOL | BL_FIX);
4527
4528 need_wait_return = FALSE; /* don't use wait_return() now */
4529 ex_no_reprint = TRUE;
4530}
4531
4532/*
4533 * ":change"
4534 */
4535 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004536ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537{
4538 linenr_T lnum;
4539
4540 if (eap->line2 >= eap->line1
4541 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4542 return;
4543
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004544 /* the ! flag toggles autoindent */
4545 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4546 append_indent = get_indent_lnum(eap->line1);
4547
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4549 {
4550 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4551 break;
4552 ml_delete(eap->line1, FALSE);
4553 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004554
4555 /* make sure the cursor is not beyond the end of the file now */
4556 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4558
4559 /* ":append" on the line above the deleted lines. */
4560 eap->line2 = eap->line1;
4561 ex_append(eap);
4562}
4563
4564 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004565ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566{
4567 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004568 int bigness;
4569 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 int minus = 0;
4571 linenr_T start, end, curs, i;
4572 int j;
4573 linenr_T lnum = eap->line2;
4574
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004575 /* Vi compatible: ":z!" uses display height, without a count uses
4576 * 'scroll' */
4577 if (eap->forceit)
4578 bigness = curwin->w_height;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004579#ifdef FEAT_WINDOWS
Bram Moolenaar459ca562016-11-10 18:16:33 +01004580 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004581 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004582#endif
Bram Moolenaar631abc32014-02-22 22:27:47 +01004583 else
4584 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 if (bigness < 1)
4586 bigness = 1;
4587
4588 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004589 kind = x;
4590 if (*kind == '-' || *kind == '+' || *kind == '='
4591 || *kind == '^' || *kind == '.')
4592 ++x;
4593 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 ++x;
4595
4596 if (*x != 0)
4597 {
4598 if (!VIM_ISDIGIT(*x))
4599 {
4600 EMSG(_("E144: non-numeric argument to :z"));
4601 return;
4602 }
4603 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004604 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004606 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004607 if (*kind == '=')
4608 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004609 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 }
4611
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004612 /* the number of '-' and '+' multiplies the distance */
4613 if (*kind == '-' || *kind == '+')
4614 for (x = kind + 1; *x == *kind; ++x)
4615 ;
4616
4617 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 {
4619 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004620 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4621 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004622 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 break;
4624
4625 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004626 start = lnum - (bigness + 1) / 2 + 1;
4627 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 curs = lnum;
4629 minus = 1;
4630 break;
4631
4632 case '^':
4633 start = lnum - bigness * 2;
4634 end = lnum - bigness;
4635 curs = lnum - bigness;
4636 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 = end;
4642 break;
4643
4644 default: /* '+' */
4645 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004646 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004647 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004648 else if (eap->addr_count == 0)
4649 ++start;
4650 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 curs = end;
4652 break;
4653 }
4654
4655 if (start < 1)
4656 start = 1;
4657
4658 if (end > curbuf->b_ml.ml_line_count)
4659 end = curbuf->b_ml.ml_line_count;
4660
4661 if (curs > curbuf->b_ml.ml_line_count)
4662 curs = curbuf->b_ml.ml_line_count;
4663
4664 for (i = start; i <= end; i++)
4665 {
4666 if (minus && i == lnum)
4667 {
4668 msg_putchar('\n');
4669
4670 for (j = 1; j < Columns; j++)
4671 msg_putchar('-');
4672 }
4673
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004674 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675
4676 if (minus && i == lnum)
4677 {
4678 msg_putchar('\n');
4679
4680 for (j = 1; j < Columns; j++)
4681 msg_putchar('-');
4682 }
4683 }
4684
4685 curwin->w_cursor.lnum = curs;
4686 ex_no_reprint = TRUE;
4687}
4688
4689/*
4690 * Check if the restricted flag is set.
4691 * If so, give an error message and return TRUE.
4692 * Otherwise, return FALSE.
4693 */
4694 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004695check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696{
4697 if (restricted)
4698 {
4699 EMSG(_("E145: Shell commands not allowed in rvim"));
4700 return TRUE;
4701 }
4702 return FALSE;
4703}
4704
4705/*
4706 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4707 * If so, give an error message and return TRUE.
4708 * Otherwise, return FALSE.
4709 */
4710 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004711check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712{
4713 if (secure)
4714 {
4715 secure = 2;
4716 EMSG(_(e_curdir));
4717 return TRUE;
4718 }
4719#ifdef HAVE_SANDBOX
4720 /*
4721 * In the sandbox more things are not allowed, including the things
4722 * disallowed in secure mode.
4723 */
4724 if (sandbox != 0)
4725 {
4726 EMSG(_(e_sandbox));
4727 return TRUE;
4728 }
4729#endif
4730 return FALSE;
4731}
4732
4733static char_u *old_sub = NULL; /* previous substitute pattern */
4734static int global_need_beginline; /* call beginline() after ":g" */
4735
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004736/*
4737 * Flags that are kept between calls to :substitute.
4738 */
4739typedef struct {
4740 int do_all; /* do multiple substitutions per line */
4741 int do_ask; /* ask for confirmation */
4742 int do_count; /* count only */
4743 int do_error; /* if false, ignore errors */
4744 int do_print; /* print last line with subs. */
4745 int do_list; /* list last line with subs. */
4746 int do_number; /* list last line with line nr*/
4747 int do_ic; /* ignore case flag */
4748} subflags_T;
4749
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750/* do_sub()
4751 *
4752 * Perform a substitution from line eap->line1 to line eap->line2 using the
4753 * command pointed to by eap->arg which should be of the form:
4754 *
4755 * /pattern/substitution/{flags}
4756 *
4757 * The usual escapes are supported as described in the regexp docs.
4758 */
4759 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004760do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761{
4762 linenr_T lnum;
4763 long i = 0;
4764 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004765 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4766 FALSE, FALSE, 0};
4767#ifdef FEAT_EVAL
4768 subflags_T subflags_save;
4769#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004770 int save_do_all; /* remember user specified 'g' flag */
4771 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4773 int delimiter;
4774 int sublen;
4775 int got_quit = FALSE;
4776 int got_match = FALSE;
4777 int temp;
4778 int which_pat;
4779 char_u *cmd;
4780 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004781 linenr_T first_line = 0; /* first changed line */
4782 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 * change */
4784 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4785 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004786 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004787 char_u *sub_firstline; /* allocated copy of first sub line */
4788 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004789 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004790 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004791#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004792 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004793#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794
4795 cmd = eap->arg;
4796 if (!global_busy)
4797 {
4798 sub_nsubs = 0;
4799 sub_nlines = 0;
4800 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004801 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 if (eap->cmdidx == CMD_tilde)
4804 which_pat = RE_LAST; /* use last used regexp */
4805 else
4806 which_pat = RE_SUBST; /* use last substitute regexp */
4807
4808 /* new pattern and substitution */
4809 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4810 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4811 {
4812 /* don't accept alphanumeric for separator */
4813 if (isalpha(*cmd))
4814 {
4815 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4816 return;
4817 }
4818 /*
4819 * undocumented vi feature:
4820 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4821 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4822 */
4823 if (*cmd == '\\')
4824 {
4825 ++cmd;
4826 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4827 {
4828 EMSG(_(e_backslash));
4829 return;
4830 }
4831 if (*cmd != '&')
4832 which_pat = RE_SEARCH; /* use last '/' pattern */
4833 pat = (char_u *)""; /* empty search pattern */
4834 delimiter = *cmd++; /* remember delimiter character */
4835 }
4836 else /* find the end of the regexp */
4837 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004838#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4839 if (p_altkeymap && curwin->w_p_rl)
4840 lrF_sub(cmd);
4841#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 which_pat = RE_LAST; /* use last used regexp */
4843 delimiter = *cmd++; /* remember delimiter character */
4844 pat = cmd; /* remember start of search pat */
4845 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4846 if (cmd[0] == delimiter) /* end delimiter found */
4847 *cmd++ = NUL; /* replace it with a NUL */
4848 }
4849
4850 /*
4851 * Small incompatibility: vi sees '\n' as end of the command, but in
4852 * Vim we want to use '\n' to find/substitute a NUL.
4853 */
4854 sub = cmd; /* remember the start of the substitution */
4855
4856 while (cmd[0])
4857 {
4858 if (cmd[0] == delimiter) /* end delimiter found */
4859 {
4860 *cmd++ = NUL; /* replace it with a NUL */
4861 break;
4862 }
4863 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4864 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004865 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 }
4867
4868 if (!eap->skip)
4869 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004870 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4871 if (STRCMP(sub, "%") == 0
4872 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4873 {
4874 if (old_sub == NULL) /* there is no previous command */
4875 {
4876 EMSG(_(e_nopresub));
4877 return;
4878 }
4879 sub = old_sub;
4880 }
4881 else
4882 {
4883 vim_free(old_sub);
4884 old_sub = vim_strsave(sub);
4885 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 }
4887 }
4888 else if (!eap->skip) /* use previous pattern and substitution */
4889 {
4890 if (old_sub == NULL) /* there is no previous command */
4891 {
4892 EMSG(_(e_nopresub));
4893 return;
4894 }
4895 pat = NULL; /* search_regcomp() will use previous pattern */
4896 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004897
4898 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4899 * last column after using "$". */
4900 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 }
4902
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004903 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4904 * more efficient.
4905 * TODO: find a generic solution to make line-joining operations more
4906 * efficient, avoid allocating a string that grows in size.
4907 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004908 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004909 && *sub == NUL
4910 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4911 || *cmd == 'p' || *cmd == '#'))))
4912 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004913 linenr_T joined_lines_count;
4914
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004915 curwin->w_cursor.lnum = eap->line1;
4916 if (*cmd == 'l')
4917 eap->flags = EXFLAG_LIST;
4918 else if (*cmd == '#')
4919 eap->flags = EXFLAG_NR;
4920 else if (*cmd == 'p')
4921 eap->flags = EXFLAG_PRINT;
4922
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004923 /* The number of lines joined is the number of lines in the range plus
4924 * one. One less when the last line is included. */
4925 joined_lines_count = eap->line2 - eap->line1 + 1;
4926 if (eap->line2 < curbuf->b_ml.ml_line_count)
4927 ++joined_lines_count;
4928 if (joined_lines_count > 1)
4929 {
4930 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4931 sub_nsubs = joined_lines_count - 1;
4932 sub_nlines = 1;
4933 (void)do_sub_msg(FALSE);
4934 ex_may_print(eap);
4935 }
4936
4937 if (!cmdmod.keeppatterns)
4938 save_re_pat(RE_SUBST, pat, p_magic);
4939#ifdef FEAT_CMDHIST
4940 /* put pattern in history */
4941 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4942#endif
4943
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004944 return;
4945 }
4946
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 /*
4948 * Find trailing options. When '&' is used, keep old options.
4949 */
4950 if (*cmd == '&')
4951 ++cmd;
4952 else
4953 {
4954 if (!p_ed)
4955 {
4956 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004957 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004959 subflags.do_all = FALSE;
4960 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004962 subflags.do_error = TRUE;
4963 subflags.do_print = FALSE;
4964 subflags.do_count = FALSE;
4965 subflags.do_number = FALSE;
4966 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 }
4968 while (*cmd)
4969 {
4970 /*
4971 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4972 * 'r' is never inverted.
4973 */
4974 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004975 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004977 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004978 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004979 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004981 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 else if (*cmd == 'r') /* use last used regexp */
4983 which_pat = RE_LAST;
4984 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004985 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004986 else if (*cmd == '#')
4987 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004988 subflags.do_print = TRUE;
4989 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004990 }
4991 else if (*cmd == 'l')
4992 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004993 subflags.do_print = TRUE;
4994 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004995 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004997 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004999 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 else
5001 break;
5002 ++cmd;
5003 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005004 if (subflags.do_count)
5005 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005007 save_do_all = subflags.do_all;
5008 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005009
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 /*
5011 * check for a trailing count
5012 */
5013 cmd = skipwhite(cmd);
5014 if (VIM_ISDIGIT(*cmd))
5015 {
5016 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005017 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 {
5019 EMSG(_(e_zerocount));
5020 return;
5021 }
5022 eap->line1 = eap->line2;
5023 eap->line2 += i - 1;
5024 if (eap->line2 > curbuf->b_ml.ml_line_count)
5025 eap->line2 = curbuf->b_ml.ml_line_count;
5026 }
5027
5028 /*
5029 * check for trailing command or garbage
5030 */
5031 cmd = skipwhite(cmd);
5032 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5033 {
5034 eap->nextcmd = check_nextcmd(cmd);
5035 if (eap->nextcmd == NULL)
5036 {
5037 EMSG(_(e_trailing));
5038 return;
5039 }
5040 }
5041
5042 if (eap->skip) /* not executing commands, only parsing */
5043 return;
5044
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005045 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005046 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005047 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005048 EMSG(_(e_modifiable));
5049 return;
5050 }
5051
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5053 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005054 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 EMSG(_(e_invcmd));
5056 return;
5057 }
5058
5059 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005060 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005062 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 regmatch.rmm_ic = FALSE;
5064
5065 sub_firstline = NULL;
5066
5067 /*
5068 * ~ in the substitute pattern is replaced with the old pattern.
5069 * We do it here once to avoid it to be replaced over and over again.
5070 * But don't do it when it starts with "\=", then it's an expression.
5071 */
5072 if (!(sub[0] == '\\' && sub[1] == '='))
5073 sub = regtilde(sub, p_magic);
5074
5075 /*
5076 * Check for a match on each line.
5077 */
5078 line2 = eap->line2;
5079 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5080#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5081 || aborting()
5082#endif
5083 ); ++lnum)
5084 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005085 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5086 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 if (nmatch)
5088 {
5089 colnr_T copycol;
5090 colnr_T matchcol;
5091 colnr_T prev_matchcol = MAXCOL;
5092 char_u *new_end, *new_start = NULL;
5093 unsigned new_start_len = 0;
5094 char_u *p1;
5095 int did_sub = FALSE;
5096 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005097 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 long nmatch_tl = 0; /* nr of lines matched below lnum */
5099 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005100 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005101 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102
5103 /*
5104 * The new text is build up step by step, to avoid too much
5105 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005106 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 * copycol Column in the old text where we started
5108 * looking for a match; from here old text still
5109 * needs to be copied to the new text.
5110 * matchcol Column number of the old text where to look
5111 * for the next match. It's just after the
5112 * previous match or one further.
5113 * prev_matchcol Column just after the previous match (if any).
5114 * Mostly equal to matchcol, except for the first
5115 * match and after skipping an empty match.
5116 * regmatch.*pos Where the pattern matched in the old text.
5117 * new_start The new text, all that has been produced so
5118 * far.
5119 * new_end The new text, where to append new text.
5120 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005121 * lnum The line number where we found the start of
5122 * the match. Can be below the line we searched
5123 * when there is a \n before a \zs in the
5124 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 * sub_firstlnum The line number in the buffer where to look
5126 * for a match. Can be different from "lnum"
5127 * when the pattern or substitute string contains
5128 * line breaks.
5129 *
5130 * Special situations:
5131 * - When the substitute string contains a line break, the part up
5132 * to the line break is inserted in the text, but the copy of
5133 * the original line is kept. "sub_firstlnum" is adjusted for
5134 * the inserted lines.
5135 * - When the matched pattern contains a line break, the old line
5136 * is taken from the line at the end of the pattern. The lines
5137 * in the match are deleted later, "sub_firstlnum" is adjusted
5138 * accordingly.
5139 *
5140 * The new text is built up in new_start[]. It has some extra
5141 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005142 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 *
5144 * Make a copy of the old line, so it won't be taken away when
5145 * updating the screen or handling a multi-line match. The "old_"
5146 * pointers point into this copy.
5147 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005148 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 copycol = 0;
5150 matchcol = 0;
5151
5152 /* At first match, remember current cursor position. */
5153 if (!got_match)
5154 {
5155 setpcmark();
5156 got_match = TRUE;
5157 }
5158
5159 /*
5160 * Loop until nothing more to replace in this line.
5161 * 1. Handle match with empty string.
5162 * 2. If do_ask is set, ask for confirmation.
5163 * 3. substitute the string.
5164 * 4. if do_all is set, find next match
5165 * 5. break if there isn't another match in this line
5166 */
5167 for (;;)
5168 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005169 /* Advance "lnum" to the line where the match starts. The
5170 * match does not start in the first line when there is a line
5171 * break before \zs. */
5172 if (regmatch.startpos[0].lnum > 0)
5173 {
5174 lnum += regmatch.startpos[0].lnum;
5175 sub_firstlnum += regmatch.startpos[0].lnum;
5176 nmatch -= regmatch.startpos[0].lnum;
5177 vim_free(sub_firstline);
5178 sub_firstline = NULL;
5179 }
5180
5181 if (sub_firstline == NULL)
5182 {
5183 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5184 if (sub_firstline == NULL)
5185 {
5186 vim_free(new_start);
5187 goto outofmem;
5188 }
5189 }
5190
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 /* Save the line number of the last change for the final
5192 * cursor position (just like Vi). */
5193 curwin->w_cursor.lnum = lnum;
5194 do_again = FALSE;
5195
5196 /*
5197 * 1. Match empty string does not count, except for first
5198 * match. This reproduces the strange vi behaviour.
5199 * This also catches endless loops.
5200 */
5201 if (matchcol == prev_matchcol
5202 && regmatch.endpos[0].lnum == 0
5203 && matchcol == regmatch.endpos[0].col)
5204 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005205 if (sub_firstline[matchcol] == NUL)
5206 /* We already were at the end of the line. Don't look
5207 * for a match in this line again. */
5208 skip_match = TRUE;
5209 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005210 {
5211 /* search for a match at next column */
5212#ifdef FEAT_MBYTE
5213 if (has_mbyte)
5214 matchcol += mb_ptr2len(sub_firstline + matchcol);
5215 else
5216#endif
5217 ++matchcol;
5218 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 goto skip;
5220 }
5221
5222 /* Normally we continue searching for a match just after the
5223 * previous match. */
5224 matchcol = regmatch.endpos[0].col;
5225 prev_matchcol = matchcol;
5226
5227 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005228 * 2. If do_count is set only increase the counter.
5229 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005231 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005232 {
5233 /* For a multi-line match, put matchcol at the NUL at
5234 * the end of the line and set nmatch to one, so that
5235 * we continue looking for a match on the next line.
5236 * Avoids that ":s/\nB\@=//gc" get stuck. */
5237 if (nmatch > 1)
5238 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005239 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005240 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005241 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005242 }
5243 sub_nsubs++;
5244 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005245#ifdef FEAT_EVAL
5246 /* Skip the substitution, unless an expression is used,
5247 * then it is evaluated in the sandbox. */
5248 if (!(sub[0] == '\\' && sub[1] == '='))
5249#endif
5250 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005251 }
5252
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005253 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005255 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005256
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 /* change State to CONFIRM, so that the mouse works
5258 * properly */
5259 save_State = State;
5260 State = CONFIRM;
5261#ifdef FEAT_MOUSE
5262 setmouse(); /* disable mouse in xterm */
5263#endif
5264 curwin->w_cursor.col = regmatch.startpos[0].col;
5265
5266 /* When 'cpoptions' contains "u" don't sync undo when
5267 * asking for confirmation. */
5268 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5269 ++no_u_sync;
5270
5271 /*
5272 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5273 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005274 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005276 if (exmode_active)
5277 {
5278 char_u *resp;
5279 colnr_T sc, ec;
5280
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005281 print_line_no_prefix(lnum,
5282 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005283
5284 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5285 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
5286 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005287 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005288 {
5289 int numw = number_width(curwin) + 1;
5290 sc += numw;
5291 ec += numw;
5292 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005293 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005294 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005295 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005296 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005297 msg_putchar('^');
5298
5299 resp = getexmodeline('?', NULL, 0);
5300 if (resp != NULL)
5301 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005302 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005303 vim_free(resp);
5304 }
5305 }
5306 else
5307 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005308 char_u *orig_line = NULL;
5309 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005311 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005313 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005315 /* Invert the matched string.
5316 * Remove the inversion afterwards. */
5317 temp = RedrawingDisabled;
5318 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005320 if (new_start != NULL)
5321 {
5322 /* There already was a substitution, we would
5323 * like to show this to the user. We cannot
5324 * really update the line, it would change
5325 * what matches. Temporarily replace the line
5326 * and change it back afterwards. */
5327 orig_line = vim_strsave(ml_get(lnum));
5328 if (orig_line != NULL)
5329 {
5330 char_u *new_line = concat_str(new_start,
5331 sub_firstline + copycol);
5332
5333 if (new_line == NULL)
5334 {
5335 vim_free(orig_line);
5336 orig_line = NULL;
5337 }
5338 else
5339 {
5340 /* Position the cursor relative to the
5341 * end of the line, the previous
5342 * substitute may have inserted or
5343 * deleted characters before the
5344 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005345 len_change = (int)STRLEN(new_line)
5346 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005347 curwin->w_cursor.col += len_change;
5348 ml_replace(lnum, new_line, FALSE);
5349 }
5350 }
5351 }
5352
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005353 search_match_lines = regmatch.endpos[0].lnum
5354 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005355 search_match_endcol = regmatch.endpos[0].col
5356 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005357 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005359 update_topline();
5360 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005361 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005362 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005363 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364
5365#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005366 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005368 if (msg_row == Rows - 1)
5369 msg_didout = FALSE; /* avoid a scroll-up */
5370 msg_starthere();
5371 i = msg_scroll;
5372 msg_scroll = 0; /* truncate msg when
5373 needed */
5374 msg_no_more = TRUE;
5375 /* write message same highlighting as for
5376 * wait_return */
5377 smsg_attr(hl_attr(HLF_R),
5378 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5379 msg_no_more = FALSE;
5380 msg_scroll = i;
5381 showruler(TRUE);
5382 windgoto(msg_row, msg_col);
5383 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384
5385#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005386 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005388 ++no_mapping; /* don't map this key */
5389 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005390 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005391 --allow_keys;
5392 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005394 /* clear the question */
5395 msg_didout = FALSE; /* don't scroll up */
5396 msg_col = 0;
5397 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005398
5399 /* restore the line */
5400 if (orig_line != NULL)
5401 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005402 }
5403
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005405 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005407 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408#endif
5409 )
5410 {
5411 got_quit = TRUE;
5412 break;
5413 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005414 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005416 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005418 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 {
5420 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005421 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 line2 = lnum;
5423 break;
5424 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005425 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005427 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 break;
5429 }
5430#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005431 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005433 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 scrolldown_clamp();
5435#endif
5436 }
5437 State = save_State;
5438#ifdef FEAT_MOUSE
5439 setmouse();
5440#endif
5441 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5442 --no_u_sync;
5443
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005444 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 {
5446 /* For a multi-line match, put matchcol at the NUL at
5447 * the end of the line and set nmatch to one, so that
5448 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005449 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5450 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 if (nmatch > 1)
5452 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005453 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005454 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 }
5456 goto skip;
5457 }
5458 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005459 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 }
5461
5462 /* Move the cursor to the start of the match, so that we can
5463 * use "\=col("."). */
5464 curwin->w_cursor.col = regmatch.startpos[0].col;
5465
5466 /*
5467 * 3. substitute the string.
5468 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005469#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005470 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005471 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005472 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005473 save_ma = curbuf->b_p_ma;
5474 curbuf->b_p_ma = FALSE;
5475 sandbox++;
5476 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005477 /* Save flags for recursion. They can change for e.g.
5478 * :s/^/\=execute("s#^##gn") */
5479 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005480#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005482 sublen = vim_regsub_multi(&regmatch,
5483 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005485#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005486 /* Don't keep flags set by a recursive call. */
5487 subflags = subflags_save;
5488 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005489 {
5490 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005491 if (sandbox > 0)
5492 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005493 goto skip;
5494 }
5495#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496
Bram Moolenaar4463f292005-09-25 22:20:24 +00005497 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005498 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005499 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5500 {
5501 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5502 skip_match = TRUE;
5503 }
5504
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 /* Need room for:
5506 * - result so far in new_start (not for first sub in line)
5507 * - original text up to match
5508 * - length of substituted part
5509 * - original text after match
5510 */
5511 if (nmatch == 1)
5512 p1 = sub_firstline;
5513 else
5514 {
5515 p1 = ml_get(sub_firstlnum + nmatch - 1);
5516 nmatch_tl += nmatch - 1;
5517 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005518 copy_len = regmatch.startpos[0].col - copycol;
5519 needed_len = copy_len + ((unsigned)STRLEN(p1)
5520 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 if (new_start == NULL)
5522 {
5523 /*
5524 * Get some space for a temporary buffer to do the
5525 * substitution into (and some extra space to avoid
5526 * too many calls to alloc()/free()).
5527 */
5528 new_start_len = needed_len + 50;
5529 if ((new_start = alloc_check(new_start_len)) == NULL)
5530 goto outofmem;
5531 *new_start = NUL;
5532 new_end = new_start;
5533 }
5534 else
5535 {
5536 /*
5537 * Check if the temporary buffer is long enough to do the
5538 * substitution into. If not, make it larger (with a bit
5539 * extra to avoid too many calls to alloc()/free()).
5540 */
5541 len = (unsigned)STRLEN(new_start);
5542 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005543 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 {
5545 new_start_len = needed_len + 50;
5546 if ((p1 = alloc_check(new_start_len)) == NULL)
5547 {
5548 vim_free(new_start);
5549 goto outofmem;
5550 }
5551 mch_memmove(p1, new_start, (size_t)(len + 1));
5552 vim_free(new_start);
5553 new_start = p1;
5554 }
5555 new_end = new_start + len;
5556 }
5557
5558 /*
5559 * copy the text up to the part that matched
5560 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005561 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5562 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005564 (void)vim_regsub_multi(&regmatch,
5565 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 sub, new_end, TRUE, p_magic, TRUE);
5567 sub_nsubs++;
5568 did_sub = TRUE;
5569
5570 /* Move the cursor to the start of the line, to avoid that it
5571 * is beyond the end of the line after the substitution. */
5572 curwin->w_cursor.col = 0;
5573
5574 /* For a multi-line match, make a copy of the last matched
5575 * line and continue in that one. */
5576 if (nmatch > 1)
5577 {
5578 sub_firstlnum += nmatch - 1;
5579 vim_free(sub_firstline);
5580 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5581 /* When going beyond the last line, stop substituting. */
5582 if (sub_firstlnum <= line2)
5583 do_again = TRUE;
5584 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005585 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 }
5587
5588 /* Remember next character to be copied. */
5589 copycol = regmatch.endpos[0].col;
5590
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005591 if (skip_match)
5592 {
5593 /* Already hit end of the buffer, sub_firstlnum is one
5594 * less than what it ought to be. */
5595 vim_free(sub_firstline);
5596 sub_firstline = vim_strsave((char_u *)"");
5597 copycol = 0;
5598 }
5599
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 /*
5601 * Now the trick is to replace CTRL-M chars with a real line
5602 * break. This would make it impossible to insert a CTRL-M in
5603 * the text. The line break can be avoided by preceding the
5604 * CTRL-M with a backslash. To be able to insert a backslash,
5605 * they must be doubled in the string and are halved here.
5606 * That is Vi compatible.
5607 */
5608 for (p1 = new_end; *p1; ++p1)
5609 {
5610 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005611 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 else if (*p1 == CAR)
5613 {
5614 if (u_inssub(lnum) == OK) /* prepare for undo */
5615 {
5616 *p1 = NUL; /* truncate up to the CR */
5617 ml_append(lnum - 1, new_start,
5618 (colnr_T)(p1 - new_start + 1), FALSE);
5619 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005620 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 appended_lines(lnum - 1, 1L);
5622 else
5623 {
5624 if (first_line == 0)
5625 first_line = lnum;
5626 last_line = lnum + 1;
5627 }
5628 /* All line numbers increase. */
5629 ++sub_firstlnum;
5630 ++lnum;
5631 ++line2;
5632 /* move the cursor to the new line, like Vi */
5633 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005634 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005635 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 p1 = new_start - 1;
5637 }
5638 }
5639#ifdef FEAT_MBYTE
5640 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005641 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642#endif
5643 }
5644
5645 /*
5646 * 4. If do_all is set, find next match.
5647 * Prevent endless loop with patterns that match empty
5648 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5649 * But ":s/\n/#/" is OK.
5650 */
5651skip:
5652 /* We already know that we did the last subst when we are at
5653 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005654 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5655 * "line2" when there is a \zs in the pattern after a line
5656 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005657 lastone = (skip_match
5658 || got_int
5659 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005660 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005661 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005662 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5663 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 nmatch = -1;
5665
5666 /*
5667 * Replace the line in the buffer when needed. This is
5668 * skipped when there are more matches.
5669 * The check for nmatch_tl is needed for when multi-line
5670 * matching must replace the lines before trying to do another
5671 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005672 * When the match starts below where we start searching also
5673 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 */
5675 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 || nmatch_tl > 0
5677 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005678 curbuf, sub_firstlnum,
5679 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005680 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 {
5682 if (new_start != NULL)
5683 {
5684 /*
5685 * Copy the rest of the line, that didn't match.
5686 * "matchcol" has to be adjusted, we use the end of
5687 * the line as reference, because the substitute may
5688 * have changed the number of characters. Same for
5689 * "prev_matchcol".
5690 */
5691 STRCAT(new_start, sub_firstline + copycol);
5692 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5693 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5694 - prev_matchcol;
5695
5696 if (u_savesub(lnum) != OK)
5697 break;
5698 ml_replace(lnum, new_start, TRUE);
5699
5700 if (nmatch_tl > 0)
5701 {
5702 /*
5703 * Matched lines have now been substituted and are
5704 * useless, delete them. The part after the match
5705 * has been appended to new_start, we don't need
5706 * it in the buffer.
5707 */
5708 ++lnum;
5709 if (u_savedel(lnum, nmatch_tl) != OK)
5710 break;
5711 for (i = 0; i < nmatch_tl; ++i)
5712 ml_delete(lnum, (int)FALSE);
5713 mark_adjust(lnum, lnum + nmatch_tl - 1,
5714 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005715 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 deleted_lines(lnum, nmatch_tl);
5717 --lnum;
5718 line2 -= nmatch_tl; /* nr of lines decreases */
5719 nmatch_tl = 0;
5720 }
5721
5722 /* When asking, undo is saved each time, must also set
5723 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005724 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 changed_bytes(lnum, 0);
5726 else
5727 {
5728 if (first_line == 0)
5729 first_line = lnum;
5730 last_line = lnum + 1;
5731 }
5732
5733 sub_firstlnum = lnum;
5734 vim_free(sub_firstline); /* free the temp buffer */
5735 sub_firstline = new_start;
5736 new_start = NULL;
5737 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5738 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5739 - prev_matchcol;
5740 copycol = 0;
5741 }
5742 if (nmatch == -1 && !lastone)
5743 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005744 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745
5746 /*
5747 * 5. break if there isn't another match in this line
5748 */
5749 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005750 {
5751 /* If the match found didn't start where we were
5752 * searching, do the next search in the line where we
5753 * found the match. */
5754 if (nmatch == -1)
5755 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005757 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 }
5759
5760 line_breakcheck();
5761 }
5762
5763 if (did_sub)
5764 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005765 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 vim_free(sub_firstline); /* free the copy of the original line */
5767 sub_firstline = NULL;
5768 }
5769
5770 line_breakcheck();
5771 }
5772
5773 if (first_line != 0)
5774 {
5775 /* Need to subtract the number of added lines from "last_line" to get
5776 * the line number before the change (same as adding the number of
5777 * deleted lines). */
5778 i = curbuf->b_ml.ml_line_count - old_line_count;
5779 changed_lines(first_line, 0, last_line - i, i);
5780 }
5781
5782outofmem:
5783 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005784
5785 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005786 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005787 curwin->w_cursor = old_cursor;
5788
Bram Moolenaar46475522010-03-23 17:36:29 +01005789 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 {
5791 /* Set the '[ and '] marks. */
5792 curbuf->b_op_start.lnum = eap->line1;
5793 curbuf->b_op_end.lnum = line2;
5794 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5795
5796 if (!global_busy)
5797 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005798 /* when interactive leave cursor on the match */
5799 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005800 {
5801 if (endcolumn)
5802 coladvance((colnr_T)MAXCOL);
5803 else
5804 beginline(BL_WHITE | BL_FIX);
5805 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005806 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 MSG("");
5808 }
5809 else
5810 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005811 if (subflags.do_print)
5812 print_line(curwin->w_cursor.lnum,
5813 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 }
5815 else if (!global_busy)
5816 {
5817 if (got_int) /* interrupted */
5818 EMSG(_(e_interr));
5819 else if (got_match) /* did find something but nothing substituted */
5820 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005821 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 EMSG2(_(e_patnotf2), get_search_pat());
5823 }
5824
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005825#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005826 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005827 /* Cursor position may require updating */
5828 changed_window_setting();
5829#endif
5830
Bram Moolenaar473de612013-06-08 18:19:48 +02005831 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005832
5833 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005834 subflags.do_all = save_do_all;
5835 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836}
5837
5838/*
5839 * Give message for number of substitutions.
5840 * Can also be used after a ":global" command.
5841 * Return TRUE if a message was given.
5842 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005843 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005844do_sub_msg(
5845 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846{
5847 /*
5848 * Only report substitutions when:
5849 * - more than 'report' substitutions
5850 * - command was typed by user, or number of changed lines > 'report'
5851 * - giving messages is not disabled by 'lazyredraw'
5852 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005853 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5854 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 && messaging())
5856 {
5857 if (got_int)
5858 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005859 else
5860 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005862 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005863 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005865 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005866 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867 sub_nsubs);
5868 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005869 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005870 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005872 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005873 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005876 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 return TRUE;
5878 }
5879 if (got_int)
5880 {
5881 EMSG(_(e_interr));
5882 return TRUE;
5883 }
5884 return FALSE;
5885}
5886
5887/*
5888 * Execute a global command of the form:
5889 *
5890 * g/pattern/X : execute X on all lines where pattern matches
5891 * v/pattern/X : execute X on all lines where pattern does not match
5892 *
5893 * where 'X' is an EX command
5894 *
5895 * The command character (as well as the trailing slash) is optional, and
5896 * is assumed to be 'p' if missing.
5897 *
5898 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005899 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 * for each line that has a mark. This is required because after deleting
5901 * lines we do not know where to search for the next match.
5902 */
5903 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005904ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905{
5906 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005907 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 int type; /* first char of cmd: 'v' or 'g' */
5909 char_u *cmd; /* command argument */
5910
5911 char_u delim; /* delimiter, normally '/' */
5912 char_u *pat;
5913 regmmatch_T regmatch;
5914 int match;
5915 int which_pat;
5916
5917 if (global_busy)
5918 {
5919 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5920 return;
5921 }
5922
5923 if (eap->forceit) /* ":global!" is like ":vglobal" */
5924 type = 'v';
5925 else
5926 type = *eap->cmd;
5927 cmd = eap->arg;
5928 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929
5930 /*
5931 * undocumented vi feature:
5932 * "\/" and "\?": use previous search pattern.
5933 * "\&": use previous substitute pattern.
5934 */
5935 if (*cmd == '\\')
5936 {
5937 ++cmd;
5938 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5939 {
5940 EMSG(_(e_backslash));
5941 return;
5942 }
5943 if (*cmd == '&')
5944 which_pat = RE_SUBST; /* use previous substitute pattern */
5945 else
5946 which_pat = RE_SEARCH; /* use previous search pattern */
5947 ++cmd;
5948 pat = (char_u *)"";
5949 }
5950 else if (*cmd == NUL)
5951 {
5952 EMSG(_("E148: Regular expression missing from global"));
5953 return;
5954 }
5955 else
5956 {
5957 delim = *cmd; /* get the delimiter */
5958 if (delim)
5959 ++cmd; /* skip delimiter if there is one */
5960 pat = cmd; /* remember start of pattern */
5961 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5962 if (cmd[0] == delim) /* end delimiter found */
5963 *cmd++ = NUL; /* replace it with a NUL */
5964 }
5965
5966#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5967 if (p_altkeymap && curwin->w_p_rl)
5968 lrFswap(pat,0);
5969#endif
5970
5971 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5972 {
5973 EMSG(_(e_invcmd));
5974 return;
5975 }
5976
5977 /*
5978 * pass 1: set marks for each (not) matching line
5979 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5981 {
5982 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005983 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5984 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 if ((type == 'g' && match) || (type == 'v' && !match))
5986 {
5987 ml_setmarked(lnum);
5988 ndone++;
5989 }
5990 line_breakcheck();
5991 }
5992
5993 /*
5994 * pass 2: execute the command for each line that has been marked
5995 */
5996 if (got_int)
5997 MSG(_(e_interr));
5998 else if (ndone == 0)
5999 {
6000 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00006001 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01006003 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 }
6005 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006006 {
6007#ifdef FEAT_CLIPBOARD
6008 start_global_changes();
6009#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006011#ifdef FEAT_CLIPBOARD
6012 end_global_changes();
6013#endif
6014 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015
6016 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02006017 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018}
6019
6020/*
6021 * Execute "cmd" on lines marked with ml_setmarked().
6022 */
6023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006024global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006026 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6027 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6028 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029
6030 /*
6031 * Set current position only once for a global command.
6032 * If global_busy is set, setpcmark() will not do anything.
6033 * If there is an error, global_busy will be incremented.
6034 */
6035 setpcmark();
6036
6037 /* When the command writes a message, don't overwrite the command. */
6038 msg_didout = TRUE;
6039
Bram Moolenaard25bc232010-03-23 17:49:24 +01006040 sub_nsubs = 0;
6041 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 global_need_beginline = FALSE;
6043 global_busy = 1;
6044 old_lcount = curbuf->b_ml.ml_line_count;
6045 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6046 {
6047 curwin->w_cursor.lnum = lnum;
6048 curwin->w_cursor.col = 0;
6049 if (*cmd == NUL || *cmd == '\n')
6050 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6051 else
6052 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6053 ui_breakcheck();
6054 }
6055
6056 global_busy = 0;
6057 if (global_need_beginline)
6058 beginline(BL_WHITE | BL_FIX);
6059 else
6060 check_cursor(); /* cursor may be beyond the end of the line */
6061
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006062 /* the cursor may not have moved in the text but a change in a previous
6063 * line may move it on the screen */
6064 changed_line_abv_curs();
6065
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 /* If it looks like no message was written, allow overwriting the
6067 * command with the report for number of changes. */
6068 if (msg_col == 0 && msg_scrolled == 0)
6069 msg_didout = FALSE;
6070
Bram Moolenaar45667512007-05-10 19:24:43 +00006071 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006072 * number of extra or deleted lines.
6073 * Don't report extra or deleted lines in the edge case where the buffer
6074 * we are in after execution is different from the buffer we started in. */
6075 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6077}
6078
6079#ifdef FEAT_VIMINFO
6080 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006081read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006083 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 vim_free(old_sub);
6085 if (force || old_sub == NULL)
6086 old_sub = viminfo_readstring(virp, 1, TRUE);
6087 return viminfo_readline(virp);
6088}
6089
6090 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006091write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092{
6093 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6094 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006095 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 viminfo_writestring(fp, old_sub);
6097 }
6098}
6099#endif /* FEAT_VIMINFO */
6100
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006101#if defined(EXITFREE) || defined(PROTO)
6102 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006103free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006104{
6105 vim_free(old_sub);
6106}
6107#endif
6108
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
6110/*
6111 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006112 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006114 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006115prepare_tagpreview(
6116 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117{
6118 win_T *wp;
6119
6120# ifdef FEAT_GUI
6121 need_mouse_correct = TRUE;
6122# endif
6123
6124 /*
6125 * If there is already a preview window open, use that one.
6126 */
6127 if (!curwin->w_p_pvw)
6128 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006129 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 if (wp->w_p_pvw)
6131 break;
6132 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006133 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 else
6135 {
6136 /*
6137 * There is no preview window open yet. Create one.
6138 */
6139 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6140 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006141 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 curwin->w_p_pvw = TRUE;
6143 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006144 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6145 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146# ifdef FEAT_DIFF
6147 curwin->w_p_diff = FALSE; /* no 'diff' */
6148# endif
6149# ifdef FEAT_FOLDING
6150 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6151# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006152 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 }
6154 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006155 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156}
6157
6158#endif
6159
6160
6161/*
6162 * ":help": open a read-only window on a help file
6163 */
6164 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006165ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166{
6167 char_u *arg;
6168 char_u *tag;
6169 FILE *helpfd; /* file descriptor of help file */
6170 int n;
6171 int i;
6172#ifdef FEAT_WINDOWS
6173 win_T *wp;
6174#endif
6175 int num_matches;
6176 char_u **matches;
6177 char_u *p;
6178 int empty_fnum = 0;
6179 int alt_fnum = 0;
6180 buf_T *buf;
6181#ifdef FEAT_MULTI_LANG
6182 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006183 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006185#ifdef FEAT_FOLDING
6186 int old_KeyTyped = KeyTyped;
6187#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188
6189 if (eap != NULL)
6190 {
6191 /*
6192 * A ":help" command ends at the first LF, or at a '|' that is
6193 * followed by some text. Set nextcmd to the following command.
6194 */
6195 for (arg = eap->arg; *arg; ++arg)
6196 {
6197 if (*arg == '\n' || *arg == '\r'
6198 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6199 {
6200 *arg++ = NUL;
6201 eap->nextcmd = arg;
6202 break;
6203 }
6204 }
6205 arg = eap->arg;
6206
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006207 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 {
6209 EMSG(_("E478: Don't panic!"));
6210 return;
6211 }
6212
6213 if (eap->skip) /* not executing commands */
6214 return;
6215 }
6216 else
6217 arg = (char_u *)"";
6218
6219 /* remove trailing blanks */
6220 p = arg + STRLEN(arg) - 1;
6221 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
6222 *p-- = NUL;
6223
6224#ifdef FEAT_MULTI_LANG
6225 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006226 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227#endif
6228
6229 /* When no argument given go to the index. */
6230 if (*arg == NUL)
6231 arg = (char_u *)"help.txt";
6232
6233 /*
6234 * Check if there is a match for the argument.
6235 */
6236 n = find_help_tags(arg, &num_matches, &matches,
6237 eap != NULL && eap->forceit);
6238
6239 i = 0;
6240#ifdef FEAT_MULTI_LANG
6241 if (n != FAIL && lang != NULL)
6242 /* Find first item with the requested language. */
6243 for (i = 0; i < num_matches; ++i)
6244 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006245 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 if (len > 3 && matches[i][len - 3] == '@'
6247 && STRICMP(matches[i] + len - 2, lang) == 0)
6248 break;
6249 }
6250#endif
6251 if (i >= num_matches || n == FAIL)
6252 {
6253#ifdef FEAT_MULTI_LANG
6254 if (lang != NULL)
6255 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6256 else
6257#endif
6258 EMSG2(_("E149: Sorry, no help for %s"), arg);
6259 if (n != FAIL)
6260 FreeWild(num_matches, matches);
6261 return;
6262 }
6263
6264 /* The first match (in the requested language) is the best match. */
6265 tag = vim_strsave(matches[i]);
6266 FreeWild(num_matches, matches);
6267
6268#ifdef FEAT_GUI
6269 need_mouse_correct = TRUE;
6270#endif
6271
6272 /*
6273 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006274 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006276 if (!curwin->w_buffer->b_help
6277#ifdef FEAT_WINDOWS
6278 || cmdmod.tab != 0
6279#endif
6280 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 {
6282#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006283 if (cmdmod.tab != 0)
6284 wp = NULL;
6285 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006286 FOR_ALL_WINDOWS(wp)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006287 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
6288 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6290 win_enter(wp, TRUE);
6291 else
6292#endif
6293 {
6294 /*
6295 * There is no help window yet.
6296 * Try to open the file specified by the "helpfile" option.
6297 */
6298 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6299 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006300 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 goto erret;
6302 }
6303 fclose(helpfd);
6304
6305#ifdef FEAT_WINDOWS
6306 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006307 * specified, the current window is vertically split and
6308 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006311 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006314 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315#else
6316 /* use current window */
6317 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006319#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320
6321#ifdef FEAT_WINDOWS
6322 if (curwin->w_height < p_hh)
6323 win_setheight((int)p_hh);
6324#endif
6325
6326 /*
6327 * Open help file (do_ecmd() will set b_help flag, readfile() will
6328 * set b_p_ro flag).
6329 * Set the alternate file to the previously edited file.
6330 */
6331 alt_fnum = curbuf->b_fnum;
6332 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006333 ECMD_HIDE + ECMD_SET_HELP,
6334#ifdef FEAT_WINDOWS
6335 NULL /* buffer is still open, don't store info */
6336#else
6337 curwin
6338#endif
6339 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006340 if (!cmdmod.keepalt)
6341 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 empty_fnum = curbuf->b_fnum;
6343 }
6344 }
6345
6346 if (!p_im)
6347 restart_edit = 0; /* don't want insert mode in help file */
6348
Bram Moolenaar8f535582011-09-30 17:30:31 +02006349#ifdef FEAT_FOLDING
6350 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6351 * It is needed for do_tag top open folds under the cursor. */
6352 KeyTyped = old_KeyTyped;
6353#endif
6354
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 if (tag != NULL)
6356 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6357
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006358 /* Delete the empty buffer if we're not using it. Careful: autocommands
6359 * may have jumped to another window, check that the buffer is not in a
6360 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6362 {
6363 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006364 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 wipe_buffer(buf, TRUE);
6366 }
6367
6368 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006369 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 curwin->w_alt_fnum = alt_fnum;
6371
6372erret:
6373 vim_free(tag);
6374}
6375
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006376/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006377 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006378 */
6379 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006380ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006381{
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006382#if defined(FEAT_WINDOWS)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006383 win_T *win;
6384
6385 FOR_ALL_WINDOWS(win)
6386 {
6387 if (win->w_buffer->b_help)
6388 {
6389 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006390 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006391 }
6392 }
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006393#endif
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006394}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006396#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6397/*
6398 * In an argument search for a language specifiers in the form "@xx".
6399 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6400 * Returns NULL if not found.
6401 */
6402 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006403check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006404{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006405 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006406
6407 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6408 && ASCII_ISALPHA(arg[len - 1]))
6409 {
6410 arg[len - 3] = NUL; /* remove the '@' */
6411 return arg + len - 2;
6412 }
6413 return NULL;
6414}
6415#endif
6416
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417/*
6418 * Return a heuristic indicating how well the given string matches. The
6419 * smaller the number, the better the match. This is the order of priorities,
6420 * from best match to worst match:
6421 * - Match with least alpha-numeric characters is better.
6422 * - Match with least total characters is better.
6423 * - Match towards the start is better.
6424 * - Match starting with "+" is worse (feature instead of command)
6425 * Assumption is made that the matched_string passed has already been found to
6426 * match some string for which help is requested. webb.
6427 */
6428 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006429help_heuristic(
6430 char_u *matched_string,
6431 int offset, /* offset for match */
6432 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433{
6434 int num_letters;
6435 char_u *p;
6436
6437 num_letters = 0;
6438 for (p = matched_string; *p; p++)
6439 if (ASCII_ISALNUM(*p))
6440 num_letters++;
6441
6442 /*
6443 * Multiply the number of letters by 100 to give it a much bigger
6444 * weighting than the number of characters.
6445 * If there only is a match while ignoring case, add 5000.
6446 * If the match starts in the middle of a word, add 10000 to put it
6447 * somewhere in the last half.
6448 * If the match is more than 2 chars from the start, multiply by 200 to
6449 * put it after matches at the start.
6450 */
6451 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6452 && ASCII_ISALNUM(matched_string[offset - 1]))
6453 offset += 10000;
6454 else if (offset > 2)
6455 offset *= 200;
6456 if (wrong_case)
6457 offset += 5000;
6458 /* Features are less interesting than the subjects themselves, but "+"
6459 * alone is not a feature. */
6460 if (matched_string[0] == '+' && matched_string[1] != NUL)
6461 offset += 100;
6462 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6463}
6464
6465/*
6466 * Compare functions for qsort() below, that checks the help heuristics number
6467 * that has been put after the tagname by find_tags().
6468 */
6469 static int
6470#ifdef __BORLANDC__
6471_RTLENTRYF
6472#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006473help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474{
6475 char *p1;
6476 char *p2;
6477
6478 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6479 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6480 return strcmp(p1, p2);
6481}
6482
6483/*
6484 * Find all help tags matching "arg", sort them and return in matches[], with
6485 * the number of matches in num_matches.
6486 * The matches will be sorted with a "best" match algorithm.
6487 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6488 */
6489 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006490find_help_tags(
6491 char_u *arg,
6492 int *num_matches,
6493 char_u ***matches,
6494 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495{
6496 char_u *s, *d;
6497 int i;
6498 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006499 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006500 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006501 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006502 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 "[count]", "[quotex]", "[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006504 "[pattern]", "\\|", "\\%$",
6505 "s/\\~", "s/\\U", "s/\\L",
6506 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006508 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006509 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006510 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006511 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 "\\[count]", "\\[quotex]", "\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006513 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006514 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006515 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 int flags;
6517
6518 d = IObuff; /* assume IObuff is long enough! */
6519
6520 /*
6521 * Recognize a few exceptions to the rule. Some strings that contain '*'
6522 * with "star". Otherwise '*' is recognized as a wildcard.
6523 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006524 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 if (STRCMP(arg, mtable[i]) == 0)
6526 {
6527 STRCPY(d, rtable[i]);
6528 break;
6529 }
6530
6531 if (i < 0) /* no match in table */
6532 {
6533 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6534 * Also replace "\%^" and "\%(", they match every tag too.
6535 * Also "\zs", "\z1", etc.
6536 * Also "\@<", "\@=", "\@<=", etc.
6537 * And also "\_$" and "\_^". */
6538 if (arg[0] == '\\'
6539 && ((arg[1] != NUL && arg[2] == NUL)
6540 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6541 && arg[2] != NUL)))
6542 {
6543 STRCPY(d, "/\\\\");
6544 STRCPY(d + 3, arg + 1);
6545 /* Check for "/\\_$", should be "/\\_\$" */
6546 if (d[3] == '_' && d[4] == '$')
6547 STRCPY(d + 4, "\\$");
6548 }
6549 else
6550 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006551 /* Replace:
6552 * "[:...:]" with "\[:...:]"
6553 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006554 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006555 */
6556 if ((arg[0] == '[' && (arg[1] == ':'
6557 || (arg[1] == '+' && arg[2] == '+')))
6558 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 *d++ = '\\';
6560
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006561 /*
6562 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6563 */
6564 if (*arg == '(' && arg[1] == '\'')
6565 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 for (s = arg; *s; ++s)
6567 {
6568 /*
6569 * Replace "|" with "bar" and '"' with "quote" to match the name of
6570 * the tags for these commands.
6571 * Replace "*" with ".*" and "?" with "." to match command line
6572 * completion.
6573 * Insert a backslash before '~', '$' and '.' to avoid their
6574 * special meaning.
6575 */
6576 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6577 break;
6578 switch (*s)
6579 {
6580 case '|': STRCPY(d, "bar");
6581 d += 3;
6582 continue;
6583 case '"': STRCPY(d, "quote");
6584 d += 5;
6585 continue;
6586 case '*': *d++ = '.';
6587 break;
6588 case '?': *d++ = '.';
6589 continue;
6590 case '$':
6591 case '.':
6592 case '~': *d++ = '\\';
6593 break;
6594 }
6595
6596 /*
6597 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6598 * ":help i_^_CTRL-D" work.
6599 * Insert '-' before and after "CTRL-X" when applicable.
6600 */
6601 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6602 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6603 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006604 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6605 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 STRCPY(d, "CTRL-");
6607 d += 5;
6608 if (*s < ' ')
6609 {
6610#ifdef EBCDIC
6611 *d++ = CtrlChar(*s);
6612#else
6613 *d++ = *s + '@';
6614#endif
6615 if (d[-1] == '\\')
6616 *d++ = '\\'; /* double a backslash */
6617 }
6618 else
6619 *d++ = *++s;
6620 if (s[1] != NUL && s[1] != '_')
6621 *d++ = '_'; /* append a '_' */
6622 continue;
6623 }
6624 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6625 *d++ = '\\';
6626
6627 /*
6628 * Insert a backslash before a backslash after a slash, for search
6629 * pattern tags: "/\|" --> "/\\|".
6630 */
6631 else if (s[0] == '\\' && s[1] != '\\'
6632 && *arg == '/' && s == arg + 1)
6633 *d++ = '\\';
6634
6635 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6636 * "CTRL-\_CTRL-N" */
6637 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6638 {
6639 STRCPY(d, "CTRL-\\\\");
6640 d += 7;
6641 s += 6;
6642 }
6643
6644 *d++ = *s;
6645
6646 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006647 * If tag contains "({" or "([", tag terminates at the "(".
6648 * This is for help on functions, e.g.: abs({expr}).
6649 */
6650 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6651 break;
6652
6653 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 * If tag starts with ', toss everything after a second '. Fixes
6655 * CTRL-] on 'option'. (would include the trailing '.').
6656 */
6657 if (*s == '\'' && s > arg && *arg == '\'')
6658 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006659 /* Also '{' and '}'. */
6660 if (*s == '}' && s > arg && *arg == '{')
6661 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 }
6663 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006664
6665 if (*IObuff == '`')
6666 {
6667 if (d > IObuff + 2 && d[-1] == '`')
6668 {
6669 /* remove the backticks from `command` */
6670 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6671 d[-2] = NUL;
6672 }
6673 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6674 {
6675 /* remove the backticks and comma from `command`, */
6676 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6677 d[-3] = NUL;
6678 }
6679 else if (d > IObuff + 4 && d[-3] == '`'
6680 && d[-2] == '\\' && d[-1] == '.')
6681 {
6682 /* remove the backticks and dot from `command`\. */
6683 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6684 d[-4] = NUL;
6685 }
6686 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 }
6688 }
6689
6690 *matches = (char_u **)"";
6691 *num_matches = 0;
6692 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6693 if (keep_lang)
6694 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006695 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006697 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 /* Sort the matches found on the heuristic number that is after the
6699 * tag name. */
6700 qsort((void *)*matches, (size_t)*num_matches,
6701 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006702 /* Delete more than TAG_MANY to reduce the size of the listing. */
6703 while (*num_matches > TAG_MANY)
6704 vim_free((*matches)[--*num_matches]);
6705 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 return OK;
6707}
6708
6709/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006710 * Called when starting to edit a buffer for a help file.
6711 */
6712 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006713prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006714{
6715 char_u *p;
6716
6717 curbuf->b_help = TRUE;
6718#ifdef FEAT_QUICKFIX
6719 set_string_option_direct((char_u *)"buftype", -1,
6720 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6721#endif
6722
6723 /*
6724 * Always set these options after jumping to a help tag, because the
6725 * user may have an autocommand that gets in the way.
6726 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6727 * latin1 word characters (for translated help files).
6728 * Only set it when needed, buf_init_chartab() is some work.
6729 */
6730 p =
6731#ifdef EBCDIC
6732 (char_u *)"65-255,^*,^|,^\"";
6733#else
6734 (char_u *)"!-~,^*,^|,^\",192-255";
6735#endif
6736 if (STRCMP(curbuf->b_p_isk, p) != 0)
6737 {
6738 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6739 check_buf_options(curbuf);
6740 (void)buf_init_chartab(curbuf, FALSE);
6741 }
6742
Bram Moolenaar0b105412014-11-30 13:34:23 +01006743#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006744 /* Don't use the global foldmethod.*/
6745 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6746 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006747#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006748
6749 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6750 curwin->w_p_list = FALSE; /* no list mode */
6751
6752 curbuf->b_p_ma = FALSE; /* not modifiable */
6753 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6754 curwin->w_p_nu = 0; /* no line numbers */
6755 curwin->w_p_rnu = 0; /* no relative line numbers */
6756 RESET_BINDING(curwin); /* no scroll or cursor binding */
6757#ifdef FEAT_ARABIC
6758 curwin->w_p_arab = FALSE; /* no arabic mode */
6759#endif
6760#ifdef FEAT_RIGHTLEFT
6761 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6762#endif
6763#ifdef FEAT_FOLDING
6764 curwin->w_p_fen = FALSE; /* No folding in the help window */
6765#endif
6766#ifdef FEAT_DIFF
6767 curwin->w_p_diff = FALSE; /* No 'diff' */
6768#endif
6769#ifdef FEAT_SPELL
6770 curwin->w_p_spell = FALSE; /* No spell checking */
6771#endif
6772
6773 set_buflisted(FALSE);
6774}
6775
6776/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 * After reading a help file: May cleanup a help buffer when syntax
6778 * highlighting is not used.
6779 */
6780 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006781fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782{
6783 linenr_T lnum;
6784 char_u *line;
6785 int in_example = FALSE;
6786 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006787 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 char_u *p;
6789 char_u *rt;
6790 int mustfree;
6791
6792 /* set filetype to "help". */
6793 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6794
6795#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006796 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797#endif
6798 {
6799 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6800 {
6801 line = ml_get_buf(curbuf, lnum, FALSE);
6802 len = (int)STRLEN(line);
6803 if (in_example && len > 0 && !vim_iswhite(line[0]))
6804 {
6805 /* End of example: non-white or '<' in first column. */
6806 if (line[0] == '<')
6807 {
6808 /* blank-out a '<' in the first column */
6809 line = ml_get_buf(curbuf, lnum, TRUE);
6810 line[0] = ' ';
6811 }
6812 in_example = FALSE;
6813 }
6814 if (!in_example && len > 0)
6815 {
6816 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6817 {
6818 /* blank-out a '>' in the last column (start of example) */
6819 line = ml_get_buf(curbuf, lnum, TRUE);
6820 line[len - 1] = ' ';
6821 in_example = TRUE;
6822 }
6823 else if (line[len - 1] == '~')
6824 {
6825 /* blank-out a '~' at the end of line (header marker) */
6826 line = ml_get_buf(curbuf, lnum, TRUE);
6827 line[len - 1] = ' ';
6828 }
6829 }
6830 }
6831 }
6832
6833 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006834 * In the "help.txt" and "help.abx" file, add the locally added help
6835 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006837 fname = gettail(curbuf->b_fname);
6838 if (fnamecmp(fname, "help.txt") == 0
6839#ifdef FEAT_MULTI_LANG
6840 || (fnamencmp(fname, "help.", 5) == 0
6841 && ASCII_ISALPHA(fname[5])
6842 && ASCII_ISALPHA(fname[6])
6843 && TOLOWER_ASC(fname[7]) == 'x'
6844 && fname[8] == NUL)
6845#endif
6846 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 {
6848 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6849 {
6850 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006851 if (strstr((char *)line, "*local-additions*") == NULL)
6852 continue;
6853
6854 /* Go through all directories in 'runtimepath', skipping
6855 * $VIMRUNTIME. */
6856 p = p_rtp;
6857 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006859 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6860 mustfree = FALSE;
6861 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6862 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006864 int fcount;
6865 char_u **fnames;
6866 FILE *fd;
6867 char_u *s;
6868 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006870 vimconv_T vc;
6871 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872#endif
6873
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006874 /* Find all "doc/ *.txt" files in this directory. */
6875 add_pathsep(NameBuff);
6876#ifdef FEAT_MULTI_LANG
6877 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006879 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006881 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6882 &fnames, EW_FILE|EW_SILENT) == OK
6883 && fcount > 0)
6884 {
6885#ifdef FEAT_MULTI_LANG
6886 int i1;
6887 int i2;
6888 char_u *f1;
6889 char_u *f2;
6890 char_u *t1;
6891 char_u *e1;
6892 char_u *e2;
6893
6894 /* If foo.abx is found use it instead of foo.txt in
6895 * the same directory. */
6896 for (i1 = 0; i1 < fcount; ++i1)
6897 {
6898 for (i2 = 0; i2 < fcount; ++i2)
6899 {
6900 if (i1 == i2)
6901 continue;
6902 if (fnames[i1] == NULL || fnames[i2] == NULL)
6903 continue;
6904 f1 = fnames[i1];
6905 f2 = fnames[i2];
6906 t1 = gettail(f1);
6907 if (fnamencmp(f1, f2, t1 - f1) != 0)
6908 continue;
6909 e1 = vim_strrchr(t1, '.');
6910 e2 = vim_strrchr(gettail(f2), '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02006911 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006912 continue;
6913 if (fnamecmp(e1, ".txt") != 0
6914 && fnamecmp(e1, fname + 4) != 0)
6915 {
6916 /* Not .txt and not .abx, remove it. */
6917 vim_free(fnames[i1]);
6918 fnames[i1] = NULL;
6919 continue;
6920 }
6921 if (fnamencmp(f1, f2, e1 - f1) != 0)
6922 continue;
6923 if (fnamecmp(e1, ".txt") == 0
6924 && fnamecmp(e2, fname + 4) == 0)
6925 {
6926 /* use .abx instead of .txt */
6927 vim_free(fnames[i1]);
6928 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 }
6930 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006932#endif
6933 for (fi = 0; fi < fcount; ++fi)
6934 {
6935 if (fnames[fi] == NULL)
6936 continue;
6937 fd = mch_fopen((char *)fnames[fi], "r");
6938 if (fd != NULL)
6939 {
6940 vim_fgets(IObuff, IOSIZE, fd);
6941 if (IObuff[0] == '*'
6942 && (s = vim_strchr(IObuff + 1, '*'))
6943 != NULL)
6944 {
6945#ifdef FEAT_MBYTE
6946 int this_utf = MAYBE;
6947#endif
6948 /* Change tag definition to a
6949 * reference and remove <CR>/<NL>. */
6950 IObuff[0] = '|';
6951 *s = '|';
6952 while (*s != NUL)
6953 {
6954 if (*s == '\r' || *s == '\n')
6955 *s = NUL;
6956#ifdef FEAT_MBYTE
6957 /* The text is utf-8 when a byte
6958 * above 127 is found and no
6959 * illegal byte sequence is found.
6960 */
6961 if (*s >= 0x80 && this_utf != FALSE)
6962 {
6963 int l;
6964
6965 this_utf = TRUE;
6966 l = utf_ptr2len(s);
6967 if (l == 1)
6968 this_utf = FALSE;
6969 s += l - 1;
6970 }
6971#endif
6972 ++s;
6973 }
6974#ifdef FEAT_MBYTE
6975 /* The help file is latin1 or utf-8;
6976 * conversion to the current
6977 * 'encoding' may be required. */
6978 vc.vc_type = CONV_NONE;
6979 convert_setup(&vc, (char_u *)(
6980 this_utf == TRUE ? "utf-8"
6981 : "latin1"), p_enc);
6982 if (vc.vc_type == CONV_NONE)
6983 /* No conversion needed. */
6984 cp = IObuff;
6985 else
6986 {
6987 /* Do the conversion. If it fails
6988 * use the unconverted text. */
6989 cp = string_convert(&vc, IObuff,
6990 NULL);
6991 if (cp == NULL)
6992 cp = IObuff;
6993 }
6994 convert_setup(&vc, NULL, NULL);
6995
6996 ml_append(lnum, cp, (colnr_T)0, FALSE);
6997 if (cp != IObuff)
6998 vim_free(cp);
6999#else
7000 ml_append(lnum, IObuff, (colnr_T)0,
7001 FALSE);
7002#endif
7003 ++lnum;
7004 }
7005 fclose(fd);
7006 }
7007 }
7008 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007011 if (mustfree)
7012 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007014 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 }
7016 }
7017}
7018
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007019/*
7020 * ":exusage"
7021 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007022 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007023ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007024{
7025 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7026}
7027
7028/*
7029 * ":viusage"
7030 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007031 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007032ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007033{
7034 do_cmdline_cmd((char_u *)"help normal-index");
7035}
7036
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007038 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007041helptags_one(
7042 char_u *dir, /* doc directory */
7043 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7044 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7045 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046{
7047 FILE *fd_tags;
7048 FILE *fd;
7049 garray_T ga;
7050 int filecount;
7051 char_u **files;
7052 char_u *p1, *p2;
7053 int fi;
7054 char_u *s;
7055 int i;
7056 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007057 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058# ifdef FEAT_MBYTE
7059 int utf8 = MAYBE;
7060 int this_utf8;
7061 int firstline;
7062 int mix = FALSE; /* detected mixed encodings */
7063# endif
7064
7065 /*
7066 * Find all *.txt files.
7067 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007068 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007070 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 STRCAT(NameBuff, ext);
7072 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7073 EW_FILE|EW_SILENT) == FAIL
7074 || filecount == 0)
7075 {
7076 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007077 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 return;
7079 }
7080
7081 /*
7082 * Open the tags file for writing.
7083 * Do this before scanning through all the files.
7084 */
7085 STRCPY(NameBuff, dir);
7086 add_pathsep(NameBuff);
7087 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007088 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 if (fd_tags == NULL)
7090 {
7091 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7092 FreeWild(filecount, files);
7093 return;
7094 }
7095
7096 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007097 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7098 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 */
7100 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007101 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7102 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 {
7104 if (ga_grow(&ga, 1) == FAIL)
7105 got_int = TRUE;
7106 else
7107 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007108 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 if (s == NULL)
7110 got_int = TRUE;
7111 else
7112 {
7113 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7114 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7115 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 }
7117 }
7118 }
7119
7120 /*
7121 * Go over all the files and extract the tags.
7122 */
7123 for (fi = 0; fi < filecount && !got_int; ++fi)
7124 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007125 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 if (fd == NULL)
7127 {
7128 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7129 continue;
7130 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007131 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132
7133# ifdef FEAT_MBYTE
7134 firstline = TRUE;
7135# endif
7136 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7137 {
7138# ifdef FEAT_MBYTE
7139 if (firstline)
7140 {
7141 /* Detect utf-8 file by a non-ASCII char in the first line. */
7142 this_utf8 = MAYBE;
7143 for (s = IObuff; *s != NUL; ++s)
7144 if (*s >= 0x80)
7145 {
7146 int l;
7147
7148 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007149 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 if (l == 1)
7151 {
7152 /* Illegal UTF-8 byte sequence. */
7153 this_utf8 = FALSE;
7154 break;
7155 }
7156 s += l - 1;
7157 }
7158 if (this_utf8 == MAYBE) /* only ASCII characters found */
7159 this_utf8 = FALSE;
7160 if (utf8 == MAYBE) /* first file */
7161 utf8 = this_utf8;
7162 else if (utf8 != this_utf8)
7163 {
7164 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7165 mix = !got_int;
7166 got_int = TRUE;
7167 }
7168 firstline = FALSE;
7169 }
7170# endif
7171 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7172 while (p1 != NULL)
7173 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007174 /* Use vim_strbyte() instead of vim_strchr() so that when
7175 * 'encoding' is dbcs it still works, don't find '*' in the
7176 * second byte. */
7177 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7179 {
7180 for (s = p1 + 1; s < p2; ++s)
7181 if (*s == ' ' || *s == '\t' || *s == '|')
7182 break;
7183
7184 /*
7185 * Only accept a *tag* when it consists of valid
7186 * characters, there is white space before it and is
7187 * followed by a white character or end-of-line.
7188 */
7189 if (s == p2
7190 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7191 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7192 || s[1] == '\0'))
7193 {
7194 *p2 = '\0';
7195 ++p1;
7196 if (ga_grow(&ga, 1) == FAIL)
7197 {
7198 got_int = TRUE;
7199 break;
7200 }
7201 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7202 if (s == NULL)
7203 {
7204 got_int = TRUE;
7205 break;
7206 }
7207 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7208 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 sprintf((char *)s, "%s\t%s", p1, fname);
7210
7211 /* find next '*' */
7212 p2 = vim_strchr(p2 + 1, '*');
7213 }
7214 }
7215 p1 = p2;
7216 }
7217 line_breakcheck();
7218 }
7219
7220 fclose(fd);
7221 }
7222
7223 FreeWild(filecount, files);
7224
7225 if (!got_int)
7226 {
7227 /*
7228 * Sort the tags.
7229 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007230 if (ga.ga_data != NULL)
7231 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232
7233 /*
7234 * Check for duplicates.
7235 */
7236 for (i = 1; i < ga.ga_len; ++i)
7237 {
7238 p1 = ((char_u **)ga.ga_data)[i - 1];
7239 p2 = ((char_u **)ga.ga_data)[i];
7240 while (*p1 == *p2)
7241 {
7242 if (*p2 == '\t')
7243 {
7244 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007245 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7247 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7248 EMSG(NameBuff);
7249 *p2 = '\t';
7250 break;
7251 }
7252 ++p1;
7253 ++p2;
7254 }
7255 }
7256
7257# ifdef FEAT_MBYTE
7258 if (utf8 == TRUE)
7259 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7260# endif
7261
7262 /*
7263 * Write the tags into the file.
7264 */
7265 for (i = 0; i < ga.ga_len; ++i)
7266 {
7267 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007268 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007270 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 else
7272 {
7273 fprintf(fd_tags, "%s\t/*", s);
7274 for (p1 = s; *p1 != '\t'; ++p1)
7275 {
7276 /* insert backslash before '\\' and '/' */
7277 if (*p1 == '\\' || *p1 == '/')
7278 putc('\\', fd_tags);
7279 putc(*p1, fd_tags);
7280 }
7281 fprintf(fd_tags, "*\n");
7282 }
7283 }
7284 }
7285#ifdef FEAT_MBYTE
7286 if (mix)
7287 got_int = FALSE; /* continue with other languages */
7288#endif
7289
7290 for (i = 0; i < ga.ga_len; ++i)
7291 vim_free(((char_u **)ga.ga_data)[i]);
7292 ga_clear(&ga);
7293 fclose(fd_tags); /* there is no check for an error... */
7294}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007296/*
7297 * Generate tags in one help directory, taking care of translations.
7298 */
7299 static void
7300do_helptags(char_u *dirname, int add_help_tags)
7301{
7302#ifdef FEAT_MULTI_LANG
7303 int len;
7304 int i, j;
7305 garray_T ga;
7306 char_u lang[2];
7307 char_u ext[5];
7308 char_u fname[8];
7309 int filecount;
7310 char_u **files;
7311
7312 /* Get a list of all files in the help directory and in subdirectories. */
7313 STRCPY(NameBuff, dirname);
7314 add_pathsep(NameBuff);
7315 STRCAT(NameBuff, "**");
7316 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7317 EW_FILE|EW_SILENT) == FAIL
7318 || filecount == 0)
7319 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007320 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007321 return;
7322 }
7323
7324 /* Go over all files in the directory to find out what languages are
7325 * present. */
7326 ga_init2(&ga, 1, 10);
7327 for (i = 0; i < filecount; ++i)
7328 {
7329 len = (int)STRLEN(files[i]);
7330 if (len > 4)
7331 {
7332 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7333 {
7334 /* ".txt" -> language "en" */
7335 lang[0] = 'e';
7336 lang[1] = 'n';
7337 }
7338 else if (files[i][len - 4] == '.'
7339 && ASCII_ISALPHA(files[i][len - 3])
7340 && ASCII_ISALPHA(files[i][len - 2])
7341 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7342 {
7343 /* ".abx" -> language "ab" */
7344 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7345 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7346 }
7347 else
7348 continue;
7349
7350 /* Did we find this language already? */
7351 for (j = 0; j < ga.ga_len; j += 2)
7352 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7353 break;
7354 if (j == ga.ga_len)
7355 {
7356 /* New language, add it. */
7357 if (ga_grow(&ga, 2) == FAIL)
7358 break;
7359 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7360 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7361 }
7362 }
7363 }
7364
7365 /*
7366 * Loop over the found languages to generate a tags file for each one.
7367 */
7368 for (j = 0; j < ga.ga_len; j += 2)
7369 {
7370 STRCPY(fname, "tags-xx");
7371 fname[5] = ((char_u *)ga.ga_data)[j];
7372 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7373 if (fname[5] == 'e' && fname[6] == 'n')
7374 {
7375 /* English is an exception: use ".txt" and "tags". */
7376 fname[4] = NUL;
7377 STRCPY(ext, ".txt");
7378 }
7379 else
7380 {
7381 /* Language "ab" uses ".abx" and "tags-ab". */
7382 STRCPY(ext, ".xxx");
7383 ext[1] = fname[5];
7384 ext[2] = fname[6];
7385 }
7386 helptags_one(dirname, ext, fname, add_help_tags);
7387 }
7388
7389 ga_clear(&ga);
7390 FreeWild(filecount, files);
7391
7392#else
7393 /* No language support, just use "*.txt" and "tags". */
7394 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7395#endif
7396}
7397
7398 static void
7399helptags_cb(char_u *fname, void *cookie)
7400{
7401 do_helptags(fname, *(int *)cookie);
7402}
7403
7404/*
7405 * ":helptags"
7406 */
7407 void
7408ex_helptags(exarg_T *eap)
7409{
7410 expand_T xpc;
7411 char_u *dirname;
7412 int add_help_tags = FALSE;
7413
7414 /* Check for ":helptags ++t {dir}". */
7415 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
7416 {
7417 add_help_tags = TRUE;
7418 eap->arg = skipwhite(eap->arg + 3);
7419 }
7420
7421 if (STRCMP(eap->arg, "ALL") == 0)
7422 {
7423 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7424 helptags_cb, &add_help_tags);
7425 }
7426 else
7427 {
7428 ExpandInit(&xpc);
7429 xpc.xp_context = EXPAND_DIRECTORIES;
7430 dirname = ExpandOne(&xpc, eap->arg, NULL,
7431 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7432 if (dirname == NULL || !mch_isdir(dirname))
7433 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7434 else
7435 do_helptags(dirname, add_help_tags);
7436 vim_free(dirname);
7437 }
7438}
7439
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440#if defined(FEAT_SIGNS) || defined(PROTO)
7441
7442/*
7443 * Struct to hold the sign properties.
7444 */
7445typedef struct sign sign_T;
7446
7447struct sign
7448{
7449 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007450 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 char_u *sn_name; /* name of sign */
7452 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007453# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007455# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 char_u *sn_text; /* text used instead of pixmap */
7457 int sn_line_hl; /* highlight ID for line */
7458 int sn_text_hl; /* highlight ID for text */
7459};
7460
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007462static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007464static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7465static void sign_list_defined(sign_T *sp);
7466static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007468static char *cmds[] = {
7469 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007470# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007471 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007472# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007473 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007474# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007475 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007476# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007477 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007478# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007479 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007480# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007481 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007482# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007483};
7484
7485/*
7486 * Find index of a ":sign" subcmd from its name.
7487 * "*end_cmd" must be writable.
7488 */
7489 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007490sign_cmd_idx(
7491 char_u *begin_cmd, /* begin of sign subcmd */
7492 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007493{
7494 int idx;
7495 char save = *end_cmd;
7496
7497 *end_cmd = NUL;
7498 for (idx = 0; ; ++idx)
7499 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7500 break;
7501 *end_cmd = save;
7502 return idx;
7503}
7504
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505/*
7506 * ":sign" command
7507 */
7508 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007509ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510{
7511 char_u *arg = eap->arg;
7512 char_u *p;
7513 int idx;
7514 sign_T *sp;
7515 sign_T *sp_prev;
7516 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
7518 /* Parse the subcommand. */
7519 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007520 idx = sign_cmd_idx(arg, p);
7521 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007523 EMSG2(_("E160: Unknown sign command: %s"), arg);
7524 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 }
7526 arg = skipwhite(p);
7527
7528 if (idx <= SIGNCMD_LIST)
7529 {
7530 /*
7531 * Define, undefine or list signs.
7532 */
7533 if (idx == SIGNCMD_LIST && *arg == NUL)
7534 {
7535 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007536 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 sign_list_defined(sp);
7538 }
7539 else if (*arg == NUL)
7540 EMSG(_("E156: Missing sign name"));
7541 else
7542 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007543 /* Isolate the sign name. If it's a number skip leading zeroes,
7544 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 p = skiptowhite(arg);
7546 if (*p != NUL)
7547 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007548 while (arg[0] == '0' && arg[1] != NUL)
7549 ++arg;
7550
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 sp_prev = NULL;
7552 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7553 {
7554 if (STRCMP(sp->sn_name, arg) == 0)
7555 break;
7556 sp_prev = sp;
7557 }
7558 if (idx == SIGNCMD_DEFINE)
7559 {
7560 /* ":sign define {name} ...": define a sign */
7561 if (sp == NULL)
7562 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007563 sign_T *lp;
7564 int start = next_sign_typenr;
7565
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 /* Allocate a new sign. */
7567 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7568 if (sp == NULL)
7569 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007571 /* Check that next_sign_typenr is not already being used.
7572 * This only happens after wrapping around. Hopefully
7573 * another one got deleted and we can use its number. */
7574 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007576 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007578 ++next_sign_typenr;
7579 if (next_sign_typenr == MAX_TYPENR)
7580 next_sign_typenr = 1;
7581 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007583 vim_free(sp);
7584 EMSG(_("E612: Too many signs defined"));
7585 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007587 lp = first_sign; /* start all over */
7588 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007590 lp = lp->sn_next;
7591 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007593 sp->sn_typenr = next_sign_typenr;
7594 if (++next_sign_typenr == MAX_TYPENR)
7595 next_sign_typenr = 1; /* wrap around */
7596
7597 sp->sn_name = vim_strsave(arg);
7598 if (sp->sn_name == NULL) /* out of memory */
7599 {
7600 vim_free(sp);
7601 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007603
7604 /* add the new sign to the list of signs */
7605 if (sp_prev == NULL)
7606 first_sign = sp;
7607 else
7608 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 }
7610
7611 /* set values for a defined sign. */
7612 for (;;)
7613 {
7614 arg = skipwhite(p);
7615 if (*arg == NUL)
7616 break;
7617 p = skiptowhite_esc(arg);
7618 if (STRNCMP(arg, "icon=", 5) == 0)
7619 {
7620 arg += 5;
7621 vim_free(sp->sn_icon);
7622 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7623 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007624# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 if (gui.in_use)
7626 {
7627 out_flush();
7628 if (sp->sn_image != NULL)
7629 gui_mch_destroy_sign(sp->sn_image);
7630 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7631 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007632# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 }
7634 else if (STRNCMP(arg, "text=", 5) == 0)
7635 {
7636 char_u *s;
7637 int cells;
7638 int len;
7639
7640 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007641# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 /* Count cells and check for non-printable chars */
7643 if (has_mbyte)
7644 {
7645 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007646 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 {
7648 if (!vim_isprintc((*mb_ptr2char)(s)))
7649 break;
7650 cells += (*mb_ptr2cells)(s);
7651 }
7652 }
7653 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007654# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 {
7656 for (s = arg; s < p; ++s)
7657 if (!vim_isprintc(*s))
7658 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007659 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 }
7661 /* Currently must be one or two display cells */
7662 if (s != p || cells < 1 || cells > 2)
7663 {
7664 *p = NUL;
7665 EMSG2(_("E239: Invalid sign text: %s"), arg);
7666 return;
7667 }
7668
7669 vim_free(sp->sn_text);
7670 /* Allocate one byte more if we need to pad up
7671 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007672 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673 sp->sn_text = vim_strnsave(arg, len);
7674
7675 if (sp->sn_text != NULL && cells == 1)
7676 STRCPY(sp->sn_text + len - 1, " ");
7677 }
7678 else if (STRNCMP(arg, "linehl=", 7) == 0)
7679 {
7680 arg += 7;
7681 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7682 }
7683 else if (STRNCMP(arg, "texthl=", 7) == 0)
7684 {
7685 arg += 7;
7686 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7687 }
7688 else
7689 {
7690 EMSG2(_(e_invarg2), arg);
7691 return;
7692 }
7693 }
7694 }
7695 else if (sp == NULL)
7696 EMSG2(_("E155: Unknown sign: %s"), arg);
7697 else if (idx == SIGNCMD_LIST)
7698 /* ":sign list {name}" */
7699 sign_list_defined(sp);
7700 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007702 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 }
7704 }
7705 else
7706 {
7707 int id = -1;
7708 linenr_T lnum = -1;
7709 char_u *sign_name = NULL;
7710 char_u *arg1;
7711
7712 if (*arg == NUL)
7713 {
7714 if (idx == SIGNCMD_PLACE)
7715 {
7716 /* ":sign place": list placed signs in all buffers */
7717 sign_list_placed(NULL);
7718 }
7719 else if (idx == SIGNCMD_UNPLACE)
7720 {
7721 /* ":sign unplace": remove placed sign at cursor */
7722 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7723 if (id > 0)
7724 {
7725 buf_delsign(curwin->w_buffer, id);
7726 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7727 }
7728 else
7729 EMSG(_("E159: Missing sign number"));
7730 }
7731 else
7732 EMSG(_(e_argreq));
7733 return;
7734 }
7735
7736 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7737 {
7738 /* ":sign unplace *": remove all placed signs */
7739 buf_delete_all_signs();
7740 return;
7741 }
7742
7743 /* first arg could be placed sign id */
7744 arg1 = arg;
7745 if (VIM_ISDIGIT(*arg))
7746 {
7747 id = getdigits(&arg);
7748 if (!vim_iswhite(*arg) && *arg != NUL)
7749 {
7750 id = -1;
7751 arg = arg1;
7752 }
7753 else
7754 {
7755 arg = skipwhite(arg);
7756 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7757 {
7758 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007759 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 if ((lnum = buf_delsign(buf, id)) != 0)
7761 update_debug_sign(buf, lnum);
7762 return;
7763 }
7764 }
7765 }
7766
7767 /*
7768 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7769 * Leave "arg" pointing to {fname}.
7770 */
7771 for (;;)
7772 {
7773 if (STRNCMP(arg, "line=", 5) == 0)
7774 {
7775 arg += 5;
7776 lnum = atoi((char *)arg);
7777 arg = skiptowhite(arg);
7778 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007779 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7780 {
7781 if (id != -1)
7782 {
7783 EMSG(_(e_invarg));
7784 return;
7785 }
7786 id = -2;
7787 arg = skiptowhite(arg + 1);
7788 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 else if (STRNCMP(arg, "name=", 5) == 0)
7790 {
7791 arg += 5;
7792 sign_name = arg;
7793 arg = skiptowhite(arg);
7794 if (*arg != NUL)
7795 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007796 while (sign_name[0] == '0' && sign_name[1] != NUL)
7797 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007798 }
7799 else if (STRNCMP(arg, "file=", 5) == 0)
7800 {
7801 arg += 5;
7802 buf = buflist_findname(arg);
7803 break;
7804 }
7805 else if (STRNCMP(arg, "buffer=", 7) == 0)
7806 {
7807 arg += 7;
7808 buf = buflist_findnr((int)getdigits(&arg));
7809 if (*skipwhite(arg) != NUL)
7810 EMSG(_(e_trailing));
7811 break;
7812 }
7813 else
7814 {
7815 EMSG(_(e_invarg));
7816 return;
7817 }
7818 arg = skipwhite(arg);
7819 }
7820
7821 if (buf == NULL)
7822 {
7823 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7824 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007825 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 {
7827 if (lnum >= 0 || sign_name != NULL)
7828 EMSG(_(e_invarg));
7829 else
7830 /* ":sign place file={fname}": list placed signs in one file */
7831 sign_list_placed(buf);
7832 }
7833 else if (idx == SIGNCMD_JUMP)
7834 {
7835 /* ":sign jump {id} file={fname}" */
7836 if (lnum >= 0 || sign_name != NULL)
7837 EMSG(_(e_invarg));
7838 else if ((lnum = buf_findsign(buf, id)) > 0)
7839 { /* goto a sign ... */
7840 if (buf_jump_open_win(buf) != NULL)
7841 { /* ... in a current window */
7842 curwin->w_cursor.lnum = lnum;
7843 check_cursor_lnum();
7844 beginline(BL_WHITE);
7845 }
7846 else
7847 { /* ... not currently in a window */
7848 char_u *cmd;
7849
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007850 if (buf->b_fname == NULL)
7851 {
7852 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7853 return;
7854 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7856 if (cmd == NULL)
7857 return;
7858 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7859 do_cmdline_cmd(cmd);
7860 vim_free(cmd);
7861 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007862# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007864# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 }
7866 else
7867 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7868 }
7869 else if (idx == SIGNCMD_UNPLACE)
7870 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 if (lnum >= 0 || sign_name != NULL)
7872 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007873 else if (id == -2)
7874 {
7875 /* ":sign unplace * file={fname}" */
7876 redraw_buf_later(buf, NOT_VALID);
7877 buf_delete_signs(buf);
7878 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 else
7880 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007881 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 lnum = buf_delsign(buf, id);
7883 update_debug_sign(buf, lnum);
7884 }
7885 }
7886 /* idx == SIGNCMD_PLACE */
7887 else if (sign_name != NULL)
7888 {
7889 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7890 if (STRCMP(sp->sn_name, sign_name) == 0)
7891 break;
7892 if (sp == NULL)
7893 {
7894 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7895 return;
7896 }
7897 if (lnum > 0)
7898 /* ":sign place {id} line={lnum} name={name} file={fname}":
7899 * place a sign */
7900 buf_addsign(buf, id, lnum, sp->sn_typenr);
7901 else
7902 /* ":sign place {id} file={fname}": change sign type */
7903 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007904 if (lnum > 0)
7905 update_debug_sign(buf, lnum);
7906 else
7907 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 }
7909 else
7910 EMSG(_(e_invarg));
7911 }
7912}
7913
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007914# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915/*
7916 * Allocate the icons. Called when the GUI has started. Allows defining
7917 * signs before it starts.
7918 */
7919 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007920sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921{
7922 sign_T *sp;
7923
7924 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7925 if (sp->sn_icon != NULL)
7926 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7927}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007928# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929
7930/*
7931 * List one sign.
7932 */
7933 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007934sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935{
7936 char_u *p;
7937
Bram Moolenaar555b2802005-05-19 21:08:39 +00007938 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 if (sp->sn_icon != NULL)
7940 {
7941 MSG_PUTS(" icon=");
7942 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007943# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 if (sp->sn_image == NULL)
7945 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007946# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007948# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 }
7950 if (sp->sn_text != NULL)
7951 {
7952 MSG_PUTS(" text=");
7953 msg_outtrans(sp->sn_text);
7954 }
7955 if (sp->sn_line_hl > 0)
7956 {
7957 MSG_PUTS(" linehl=");
7958 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7959 if (p == NULL)
7960 MSG_PUTS("NONE");
7961 else
7962 msg_puts(p);
7963 }
7964 if (sp->sn_text_hl > 0)
7965 {
7966 MSG_PUTS(" texthl=");
7967 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7968 if (p == NULL)
7969 MSG_PUTS("NONE");
7970 else
7971 msg_puts(p);
7972 }
7973}
7974
7975/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007976 * Undefine a sign and free its memory.
7977 */
7978 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007979sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007980{
7981 vim_free(sp->sn_name);
7982 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007983# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007984 if (sp->sn_image != NULL)
7985 {
7986 out_flush();
7987 gui_mch_destroy_sign(sp->sn_image);
7988 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007989# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007990 vim_free(sp->sn_text);
7991 if (sp_prev == NULL)
7992 first_sign = sp->sn_next;
7993 else
7994 sp_prev->sn_next = sp->sn_next;
7995 vim_free(sp);
7996}
7997
7998/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 * Get highlighting attribute for sign "typenr".
8000 * If "line" is TRUE: line highl, if FALSE: text highl.
8001 */
8002 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008003sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004{
8005 sign_T *sp;
8006
8007 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8008 if (sp->sn_typenr == typenr)
8009 {
8010 if (line)
8011 {
8012 if (sp->sn_line_hl > 0)
8013 return syn_id2attr(sp->sn_line_hl);
8014 }
8015 else
8016 {
8017 if (sp->sn_text_hl > 0)
8018 return syn_id2attr(sp->sn_text_hl);
8019 }
8020 break;
8021 }
8022 return 0;
8023}
8024
8025/*
8026 * Get text mark for sign "typenr".
8027 * Returns NULL if there isn't one.
8028 */
8029 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008030sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031{
8032 sign_T *sp;
8033
8034 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8035 if (sp->sn_typenr == typenr)
8036 return sp->sn_text;
8037 return NULL;
8038}
8039
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008040# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008042sign_get_image(
8043 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044{
8045 sign_T *sp;
8046
8047 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8048 if (sp->sn_typenr == typenr)
8049 return sp->sn_image;
8050 return NULL;
8051}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008052# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053
8054/*
8055 * Get the name of a sign by its typenr.
8056 */
8057 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008058sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059{
8060 sign_T *sp;
8061
8062 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8063 if (sp->sn_typenr == typenr)
8064 return sp->sn_name;
8065 return (char_u *)_("[Deleted]");
8066}
8067
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008068# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008069/*
8070 * Undefine/free all signs.
8071 */
8072 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008073free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008074{
8075 while (first_sign != NULL)
8076 sign_undefine(first_sign, NULL);
8077}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008078# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008079
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008080# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008081static enum
8082{
8083 EXP_SUBCMD, /* expand :sign sub-commands */
8084 EXP_DEFINE, /* expand :sign define {name} args */
8085 EXP_PLACE, /* expand :sign place {id} args */
8086 EXP_UNPLACE, /* expand :sign unplace" */
8087 EXP_SIGN_NAMES /* expand with name of placed signs */
8088} expand_what;
8089
8090/*
8091 * Function given to ExpandGeneric() to obtain the sign command
8092 * expansion.
8093 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008094 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008095get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008096{
8097 sign_T *sp;
8098 int current_idx;
8099
8100 switch (expand_what)
8101 {
8102 case EXP_SUBCMD:
8103 return (char_u *)cmds[idx];
8104 case EXP_DEFINE:
8105 {
8106 char *define_arg[] =
8107 {
8108 "icon=", "linehl=", "text=", "texthl=", NULL
8109 };
8110 return (char_u *)define_arg[idx];
8111 }
8112 case EXP_PLACE:
8113 {
8114 char *place_arg[] =
8115 {
8116 "line=", "name=", "file=", "buffer=", NULL
8117 };
8118 return (char_u *)place_arg[idx];
8119 }
8120 case EXP_UNPLACE:
8121 {
8122 char *unplace_arg[] = { "file=", "buffer=", NULL };
8123 return (char_u *)unplace_arg[idx];
8124 }
8125 case EXP_SIGN_NAMES:
8126 /* Complete with name of signs already defined */
8127 current_idx = 0;
8128 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8129 if (current_idx++ == idx)
8130 return sp->sn_name;
8131 return NULL;
8132 default:
8133 return NULL;
8134 }
8135}
8136
8137/*
8138 * Handle command line completion for :sign command.
8139 */
8140 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008141set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008142{
8143 char_u *p;
8144 char_u *end_subcmd;
8145 char_u *last;
8146 int cmd_idx;
8147 char_u *begin_subcmd_args;
8148
8149 /* Default: expand subcommands. */
8150 xp->xp_context = EXPAND_SIGN;
8151 expand_what = EXP_SUBCMD;
8152 xp->xp_pattern = arg;
8153
8154 end_subcmd = skiptowhite(arg);
8155 if (*end_subcmd == NUL)
8156 /* expand subcmd name
8157 * :sign {subcmd}<CTRL-D>*/
8158 return;
8159
8160 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8161
8162 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008163 * |
8164 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008165 begin_subcmd_args = skipwhite(end_subcmd);
8166 p = skiptowhite(begin_subcmd_args);
8167 if (*p == NUL)
8168 {
8169 /*
8170 * Expand first argument of subcmd when possible.
8171 * For ":jump {id}" and ":unplace {id}", we could
8172 * possibly expand the ids of all signs already placed.
8173 */
8174 xp->xp_pattern = begin_subcmd_args;
8175 switch (cmd_idx)
8176 {
8177 case SIGNCMD_LIST:
8178 case SIGNCMD_UNDEFINE:
8179 /* :sign list <CTRL-D>
8180 * :sign undefine <CTRL-D> */
8181 expand_what = EXP_SIGN_NAMES;
8182 break;
8183 default:
8184 xp->xp_context = EXPAND_NOTHING;
8185 }
8186 return;
8187 }
8188
8189 /* expand last argument of subcmd */
8190
8191 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008192 * |
8193 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008194
8195 /* Loop until reaching last argument. */
8196 do
8197 {
8198 p = skipwhite(p);
8199 last = p;
8200 p = skiptowhite(p);
8201 } while (*p != NUL);
8202
8203 p = vim_strchr(last, '=');
8204
8205 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008206 * | |
8207 * last p */
Bram Moolenaar7756e742016-10-21 20:35:37 +02008208 if (p == NULL)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008209 {
8210 /* Expand last argument name (before equal sign). */
8211 xp->xp_pattern = last;
8212 switch (cmd_idx)
8213 {
8214 case SIGNCMD_DEFINE:
8215 expand_what = EXP_DEFINE;
8216 break;
8217 case SIGNCMD_PLACE:
8218 expand_what = EXP_PLACE;
8219 break;
8220 case SIGNCMD_JUMP:
8221 case SIGNCMD_UNPLACE:
8222 expand_what = EXP_UNPLACE;
8223 break;
8224 default:
8225 xp->xp_context = EXPAND_NOTHING;
8226 }
8227 }
8228 else
8229 {
8230 /* Expand last argument value (after equal sign). */
8231 xp->xp_pattern = p + 1;
8232 switch (cmd_idx)
8233 {
8234 case SIGNCMD_DEFINE:
8235 if (STRNCMP(last, "texthl", p - last) == 0 ||
8236 STRNCMP(last, "linehl", p - last) == 0)
8237 xp->xp_context = EXPAND_HIGHLIGHT;
8238 else if (STRNCMP(last, "icon", p - last) == 0)
8239 xp->xp_context = EXPAND_FILES;
8240 else
8241 xp->xp_context = EXPAND_NOTHING;
8242 break;
8243 case SIGNCMD_PLACE:
8244 if (STRNCMP(last, "name", p - last) == 0)
8245 expand_what = EXP_SIGN_NAMES;
8246 else
8247 xp->xp_context = EXPAND_NOTHING;
8248 break;
8249 default:
8250 xp->xp_context = EXPAND_NOTHING;
8251 }
8252 }
8253}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008254# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008255#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008256
8257/*
8258 * Make the user happy.
8259 */
8260 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008261ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008262{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008263 static char *code[] = {
8264 "\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$",
8265 "\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"
8266 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008267 char *p;
8268 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008269 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008270
8271 msg_start();
8272 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008273 for (i = 0; i < 2; ++i)
8274 for (p = code[i]; *p != NUL; ++p)
8275 if (*p == 'x')
8276 msg_putchar('\n');
8277 else
8278 for (n = *p++; n > 0; --n)
8279 if (*p == 'o' || *p == '$')
8280 msg_putchar_attr(*p, hl_attr(HLF_L));
8281 else
8282 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008283 msg_clr_eos();
8284}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285
8286#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8287/*
8288 * ":drop"
8289 * Opens the first argument in a window. When there are two or more arguments
8290 * the argument list is redefined.
8291 */
8292 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008293ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294{
8295 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 win_T *wp;
8297 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008298# ifdef FEAT_WINDOWS
8299 tabpage_T *tp;
8300# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301
8302 /*
8303 * Check if the first argument is already being edited in a window. If
8304 * so, jump to that window.
8305 * We would actually need to check all arguments, but that's complicated
8306 * and mostly only one file is dropped.
8307 * This also ignores wildcards, since it is very unlikely the user is
8308 * editing a file name with a wildcard character.
8309 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008310 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008312 /*
8313 * Expanding wildcards may result in an empty argument list. E.g. when
8314 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8315 * already did an error message for this.
8316 */
8317 if (ARGCOUNT == 0)
8318 return;
8319
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008320# ifdef FEAT_WINDOWS
8321 if (cmdmod.tab)
8322 {
8323 /* ":tab drop file ...": open a tab for each argument that isn't
8324 * edited in a window yet. It's like ":tab all" but without closing
8325 * windows or tabs. */
8326 ex_all(eap);
8327 }
8328 else
8329# endif
8330 {
8331 /* ":drop file ...": Edit the first argument. Jump to an existing
8332 * window if possible, edit in current window if the current buffer
8333 * can be abandoned, otherwise open a new window. */
8334 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8335
8336 FOR_ALL_TAB_WINDOWS(tp, wp)
8337 {
8338 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008340# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008341 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008342# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 return;
8345 }
8346 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008348 /*
8349 * Check whether the current buffer is changed. If so, we will need
8350 * to split the current window or data could be lost.
8351 * Skip the check if the 'hidden' option is set, as in this case the
8352 * buffer won't be lost.
8353 */
8354 if (!P_HID(curbuf))
8355 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008357 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358# endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008359 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008361 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008363 if (split)
8364 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008365# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008366 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008368 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8369 if (split)
8370 {
8371 eap->cmdidx = CMD_sfirst;
8372 eap->cmd[0] = 's';
8373 }
8374 else
8375 eap->cmdidx = CMD_first;
8376 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378}
8379#endif
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008380
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008381/*
8382 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8383 * Put the start of the pattern in "*s", unless "s" is NULL.
8384 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8385 * If "s" is not NULL terminate the pattern with a NUL.
8386 * Return a pointer to the char just past the pattern plus flags.
8387 */
8388 char_u *
8389skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8390{
8391 int c;
8392
8393 if (vim_isIDc(*p))
8394 {
8395 /* ":vimgrep pattern fname" */
8396 if (s != NULL)
8397 *s = p;
8398 p = skiptowhite(p);
8399 if (s != NULL && *p != NUL)
8400 *p++ = NUL;
8401 }
8402 else
8403 {
8404 /* ":vimgrep /pattern/[g][j] fname" */
8405 if (s != NULL)
8406 *s = p + 1;
8407 c = *p;
8408 p = skip_regexp(p + 1, c, TRUE, NULL);
8409 if (*p != c)
8410 return NULL;
8411
8412 /* Truncate the pattern. */
8413 if (s != NULL)
8414 *p = NUL;
8415 ++p;
8416
8417 /* Find the flags */
8418 while (*p == 'g' || *p == 'j')
8419 {
8420 if (flags != NULL)
8421 {
8422 if (*p == 'g')
8423 *flags |= VGR_GLOBAL;
8424 else
8425 *flags |= VGR_NOJUMP;
8426 }
8427 ++p;
8428 }
8429 }
8430 return p;
8431}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008432
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008433#if defined(FEAT_EVAL) || defined(PROTO)
8434/*
8435 * List v:oldfiles in a nice way.
8436 */
8437 void
8438ex_oldfiles(exarg_T *eap UNUSED)
8439{
8440 list_T *l = get_vim_var_list(VV_OLDFILES);
8441 listitem_T *li;
8442 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008443 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008444
8445 if (l == NULL)
8446 msg((char_u *)_("No old files"));
8447 else
8448 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008449 msg_start();
8450 msg_scroll = TRUE;
8451 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8452 {
8453 ++nr;
8454 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008455 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008456 {
8457 msg_outnum((long)nr);
8458 MSG_PUTS(": ");
8459 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02008460 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008461 msg_putchar('\n');
8462 out_flush(); /* output one line at a time */
8463 ui_breakcheck();
8464 }
8465 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008466
8467 /* Assume "got_int" was set to truncate the listing. */
8468 got_int = FALSE;
8469
8470# ifdef FEAT_BROWSE_CMD
8471 if (cmdmod.browse)
8472 {
8473 quit_more = FALSE;
8474 nr = prompt_for_number(FALSE);
8475 msg_starthere();
8476 if (nr > 0)
8477 {
8478 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8479 (long)nr);
8480
8481 if (p != NULL)
8482 {
8483 p = expand_env_save(p);
8484 eap->arg = p;
8485 eap->cmdidx = CMD_edit;
8486 cmdmod.browse = FALSE;
8487 do_exedit(eap, NULL);
8488 vim_free(p);
8489 }
8490 }
8491 }
8492# endif
8493 }
8494}
8495#endif
8496