blob: 2afa5e733a58438dfb1640f1f5456c4c1f5e60ba [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
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
1178#ifdef WIN3264
1179 /*
1180 * Check if external commands are allowed now.
1181 */
1182 if (can_end_termcap_mode(TRUE) == FALSE)
1183 return;
1184#endif
1185
1186 cursor_save = curwin->w_cursor;
1187 linecount = line2 - line1 + 1;
1188 curwin->w_cursor.lnum = line1;
1189 curwin->w_cursor.col = 0;
1190 changed_line_abv_curs();
1191 invalidate_botline();
1192
1193 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001194 * When using temp files:
1195 * 1. * Form temp file names
1196 * 2. * Write the lines to a temp file
1197 * 3. Run the filter command on the temp file
1198 * 4. * Read the output of the command into the buffer
1199 * 5. * Delete the original lines to be filtered
1200 * 6. * Remove the temp files
1201 *
1202 * When writing the input with a pipe or when catching the output with a
1203 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 */
1205
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001206 if (do_out)
1207 shell_flags |= SHELL_DOOUT;
1208
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001209#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001210 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001212 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1213 shell_flags |= SHELL_READ;
1214 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001216 else if (do_in && !do_out && !p_stmp)
1217 {
1218 /* Use a pipe to write stdin of the command, do not use a temp file. */
1219 shell_flags |= SHELL_WRITE;
1220 curbuf->b_op_start.lnum = line1;
1221 curbuf->b_op_end.lnum = line2;
1222 }
1223 else if (do_in && do_out && !p_stmp)
1224 {
1225 /* Use a pipe to write stdin and fetch stdout of the command, do not
1226 * use a temp file. */
1227 shell_flags |= SHELL_READ|SHELL_WRITE;
1228 curbuf->b_op_start.lnum = line1;
1229 curbuf->b_op_end.lnum = line2;
1230 curwin->w_cursor.lnum = line2;
1231 }
1232 else
1233#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001234 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1235 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 {
1237 EMSG(_(e_notmp));
1238 goto filterend;
1239 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
1241/*
1242 * The writing and reading of temp files will not be shown.
1243 * Vi also doesn't do this and the messages are not very informative.
1244 */
1245 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001246 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 FALSE, FALSE, FALSE, TRUE) == FAIL)
1248 {
1249 msg_putchar('\n'); /* keep message from buf_write() */
1250 --no_wait_return;
1251#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1252 if (!aborting())
1253#endif
1254 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1255 goto filterend;
1256 }
1257#ifdef FEAT_AUTOCMD
1258 if (curbuf != old_curbuf)
1259 goto filterend;
1260#endif
1261
1262 if (!do_out)
1263 msg_putchar('\n');
1264
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001265 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1267 if (cmd_buf == NULL)
1268 goto filterend;
1269
1270 windgoto((int)Rows - 1, 0);
1271 cursor_on();
1272
1273 /*
1274 * When not redirecting the output the command can write anything to the
1275 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1276 * stderr output of external command. Clear the screen later.
1277 * If do_in is FALSE, this could be something like ":r !cat", which may
1278 * also mess up the screen, clear it later.
1279 */
1280 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1281 redraw_later_clear();
1282
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001283 if (do_out)
1284 {
1285 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001286 {
1287 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001288 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001289 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001290 redraw_curbuf_later(VALID);
1291 }
1292 read_linecount = curbuf->b_ml.ml_line_count;
1293
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 /*
1295 * When call_shell() fails wait_return() is called to give the user a
1296 * chance to read the error messages. Otherwise errors are ignored, so you
1297 * can see the error messages from the command that appear on stdout; use
1298 * 'u' to fix the text
1299 * Switch to cooked mode when not redirecting stdin, avoids that something
1300 * like ":r !cat" hangs.
1301 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1302 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001303 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 {
1305 redraw_later_clear();
1306 wait_return(FALSE);
1307 }
1308 vim_free(cmd_buf);
1309
1310 did_check_timestamps = FALSE;
1311 need_check_timestamps = TRUE;
1312
1313 /* When interrupting the shell command, it may still have produced some
1314 * useful output. Reset got_int here, so that readfile() won't cancel
1315 * reading. */
1316 ui_breakcheck();
1317 got_int = FALSE;
1318
1319 if (do_out)
1320 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001321 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001323 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1324 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001326#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1327 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001329 {
1330 msg_putchar('\n');
1331 EMSG2(_(e_notread), otmp);
1332 }
1333 goto error;
1334 }
1335#ifdef FEAT_AUTOCMD
1336 if (curbuf != old_curbuf)
1337 goto filterend;
1338#endif
1339 }
1340
1341 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1342
1343 if (shell_flags & SHELL_READ)
1344 {
1345 curbuf->b_op_start.lnum = line2 + 1;
1346 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1347 appended_lines_mark(line2, read_linecount);
1348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349
1350 if (do_in)
1351 {
1352 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1353 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 if (read_linecount >= linecount)
1355 /* move all marks from old lines to new lines */
1356 mark_adjust(line1, line2, linecount, 0L);
1357 else
1358 {
1359 /* move marks from old lines to new lines, delete marks
1360 * that are in deleted lines */
1361 mark_adjust(line1, line1 + read_linecount - 1,
1362 linecount, 0L);
1363 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1364 }
1365 }
1366
1367 /*
1368 * Put cursor on first filtered line for ":range!cmd".
1369 * Adjust '[ and '] (set by buf_write()).
1370 */
1371 curwin->w_cursor.lnum = line1;
1372 del_lines(linecount, TRUE);
1373 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1374 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1375 write_lnum_adjust(-linecount); /* adjust last line
1376 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001377#ifdef FEAT_FOLDING
1378 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1379#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 }
1381 else
1382 {
1383 /*
1384 * Put cursor on last new line for ":r !cmd".
1385 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001387 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001389
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1391 --no_wait_return;
1392
1393 if (linecount > p_report)
1394 {
1395 if (do_in)
1396 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001397 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1398 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001401 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402 }
1403 else
1404 msgmore((long)linecount);
1405 }
1406 }
1407 else
1408 {
1409error:
1410 /* put cursor back in same position for ":w !cmd" */
1411 curwin->w_cursor = cursor_save;
1412 --no_wait_return;
1413 wait_return(FALSE);
1414 }
1415
1416filterend:
1417
1418#ifdef FEAT_AUTOCMD
1419 if (curbuf != old_curbuf)
1420 {
1421 --no_wait_return;
1422 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1423 }
1424#endif
1425 if (itmp != NULL)
1426 mch_remove(itmp);
1427 if (otmp != NULL)
1428 mch_remove(otmp);
1429 vim_free(itmp);
1430 vim_free(otmp);
1431}
1432
1433/*
1434 * Call a shell to execute a command.
1435 * When "cmd" is NULL start an interactive shell.
1436 */
1437 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001438do_shell(
1439 char_u *cmd,
1440 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441{
1442 buf_T *buf;
1443#ifndef FEAT_GUI_MSWIN
1444 int save_nwr;
1445#endif
1446#ifdef MSWIN
1447 int winstart = FALSE;
1448#endif
1449
1450 /*
1451 * Disallow shell commands for "rvim".
1452 * Disallow shell commands from .exrc and .vimrc in current directory for
1453 * security reasons.
1454 */
1455 if (check_restricted() || check_secure())
1456 {
1457 msg_end();
1458 return;
1459 }
1460
1461#ifdef MSWIN
1462 /*
1463 * Check if external commands are allowed now.
1464 */
1465 if (can_end_termcap_mode(TRUE) == FALSE)
1466 return;
1467
1468 /*
1469 * Check if ":!start" is used.
1470 */
1471 if (cmd != NULL)
1472 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1473#endif
1474
1475 /*
1476 * For autocommands we want to get the output on the current screen, to
1477 * avoid having to type return below.
1478 */
1479 msg_putchar('\r'); /* put cursor at start of line */
1480#ifdef FEAT_AUTOCMD
1481 if (!autocmd_busy)
1482#endif
1483 {
1484#ifdef MSWIN
1485 if (!winstart)
1486#endif
1487 stoptermcap();
1488 }
1489#ifdef MSWIN
1490 if (!winstart)
1491#endif
1492 msg_putchar('\n'); /* may shift screen one line up */
1493
1494 /* warning message before calling the shell */
1495 if (p_warn
1496#ifdef FEAT_AUTOCMD
1497 && !autocmd_busy
1498#endif
1499 && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001500 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 if (bufIsChanged(buf))
1502 {
1503#ifdef FEAT_GUI_MSWIN
1504 if (!winstart)
1505 starttermcap(); /* don't want a message box here */
1506#endif
1507 MSG_PUTS(_("[No write since last change]\n"));
1508#ifdef FEAT_GUI_MSWIN
1509 if (!winstart)
1510 stoptermcap();
1511#endif
1512 break;
1513 }
1514
1515 /* This windgoto is required for when the '\n' resulted in a "delete line
1516 * 1" command to the terminal. */
1517 if (!swapping_screen())
1518 windgoto(msg_row, msg_col);
1519 cursor_on();
1520 (void)call_shell(cmd, SHELL_COOKED | flags);
1521 did_check_timestamps = FALSE;
1522 need_check_timestamps = TRUE;
1523
1524 /*
1525 * put the message cursor at the end of the screen, avoids wait_return()
1526 * to overwrite the text that the external command showed
1527 */
1528 if (!swapping_screen())
1529 {
1530 msg_row = Rows - 1;
1531 msg_col = 0;
1532 }
1533
1534#ifdef FEAT_AUTOCMD
1535 if (autocmd_busy)
1536 {
1537 if (msg_silent == 0)
1538 redraw_later_clear();
1539 }
1540 else
1541#endif
1542 {
1543 /*
1544 * For ":sh" there is no need to call wait_return(), just redraw.
1545 * Also for the Win32 GUI (the output is in a console window).
1546 * Otherwise there is probably text on the screen that the user wants
1547 * to read before redrawing, so call wait_return().
1548 */
1549#ifndef FEAT_GUI_MSWIN
1550 if (cmd == NULL
1551# ifdef WIN3264
1552 || (winstart && !need_wait_return)
1553# endif
1554 )
1555 {
1556 if (msg_silent == 0)
1557 redraw_later_clear();
1558 need_wait_return = FALSE;
1559 }
1560 else
1561 {
1562 /*
1563 * If we switch screens when starttermcap() is called, we really
1564 * want to wait for "hit return to continue".
1565 */
1566 save_nwr = no_wait_return;
1567 if (swapping_screen())
1568 no_wait_return = FALSE;
1569# ifdef AMIGA
1570 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1571# else
1572 wait_return(msg_silent == 0);
1573# endif
1574 no_wait_return = save_nwr;
1575 }
1576#endif /* FEAT_GUI_W32 */
1577
1578#ifdef MSWIN
1579 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1580#endif
1581 starttermcap(); /* start termcap if not done by wait_return() */
1582
1583 /*
1584 * In an Amiga window redrawing is caused by asking the window size.
1585 * If we got an interrupt this will not work. The chance that the
1586 * window size is wrong is very small, but we need to redraw the
1587 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1588 * but it saves an extra redraw.
1589 */
1590#ifdef AMIGA
1591 if (skip_redraw) /* ':' hit in wait_return() */
1592 {
1593 if (msg_silent == 0)
1594 redraw_later_clear();
1595 }
1596 else if (term_console)
1597 {
1598 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1599 if (got_int && msg_silent == 0)
1600 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1601 else
1602 must_redraw = 0; /* no extra redraw needed */
1603 }
1604#endif
1605 }
1606
1607 /* display any error messages now */
1608 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001609
1610#ifdef FEAT_AUTOCMD
1611 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1612#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613}
1614
1615/*
1616 * Create a shell command from a command string, input redirection file and
1617 * output redirection file.
1618 * Returns an allocated string with the shell command, or NULL for failure.
1619 */
1620 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001621make_filter_cmd(
1622 char_u *cmd, /* command */
1623 char_u *itmp, /* NULL or name of input file */
1624 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625{
1626 char_u *buf;
1627 long_u len;
1628
Bram Moolenaar53076832015-12-31 19:53:21 +01001629#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001630 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001631 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001632
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001633 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001634 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1635 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001636 if (is_fish_shell)
1637 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1638 else
1639#endif
1640 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 if (itmp != NULL)
1642 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1643 if (otmp != NULL)
1644 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1645 buf = lalloc(len, TRUE);
1646 if (buf == NULL)
1647 return NULL;
1648
Bram Moolenaar53076832015-12-31 19:53:21 +01001649#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001651 * Put braces around the command (for concatenated commands) when
1652 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001654 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001655 {
1656 if (is_fish_shell)
1657 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1658 else
1659 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1660 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001661 else
1662 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 if (itmp != NULL)
1664 {
1665 STRCAT(buf, " < ");
1666 STRCAT(buf, itmp);
1667 }
1668#else
1669 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001670 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 * the use of commands in a pipe.
1672 */
1673 STRCPY(buf, cmd);
1674 if (itmp != NULL)
1675 {
1676 char_u *p;
1677
1678 /*
1679 * If there is a pipe, we have to put the '<' in front of it.
1680 * Don't do this when 'shellquote' is not empty, otherwise the
1681 * redirection would be inside the quotes.
1682 */
1683 if (*p_shq == NUL)
1684 {
1685 p = vim_strchr(buf, '|');
1686 if (p != NULL)
1687 *p = NUL;
1688 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1690 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 if (*p_shq == NUL)
1692 {
1693 p = vim_strchr(cmd, '|');
1694 if (p != NULL)
1695 {
1696 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1697 STRCAT(buf, p);
1698 }
1699 }
1700 }
1701#endif
1702 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001703 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704
1705 return buf;
1706}
1707
1708/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001709 * Append output redirection for file "fname" to the end of string buffer
1710 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 * Works with the 'shellredir' and 'shellpipe' options.
1712 * The caller should make sure that there is enough room:
1713 * STRLEN(opt) + STRLEN(fname) + 3
1714 */
1715 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001716append_redir(
1717 char_u *buf,
1718 int buflen,
1719 char_u *opt,
1720 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721{
1722 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001723 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001725 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001726 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001728 {
1729 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001731 if (p[1] == '%') /* skip %% */
1732 ++p;
1733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 if (p != NULL)
1735 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001736 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1737 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1738 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 }
1740 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001741 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 " %s %s",
1744#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746#endif
1747 (char *)opt, (char *)fname);
1748}
1749
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001750#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001752static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001753static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001754static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001755static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756static int viminfo_errcnt;
1757
1758 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001759no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760{
1761 /* "vim -i NONE" does not read or write a viminfo file */
1762 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1763}
1764
1765/*
1766 * Report an error for reading a viminfo file.
1767 * Count the number of errors. When there are more than 10, return TRUE.
1768 */
1769 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001770viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001772 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1773 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001774 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001775 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1776 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 emsg(IObuff);
1778 if (++viminfo_errcnt >= 10)
1779 {
1780 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1781 return TRUE;
1782 }
1783 return FALSE;
1784}
1785
1786/*
1787 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001788 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 */
1790 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001791read_viminfo(
1792 char_u *file, /* file name or NULL to use default name */
1793 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794{
1795 FILE *fp;
1796 char_u *fname;
1797
1798 if (no_viminfo())
1799 return FAIL;
1800
Bram Moolenaard812df62008-11-09 12:46:09 +00001801 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 if (fname == NULL)
1803 return FAIL;
1804 fp = mch_fopen((char *)fname, READBIN);
1805
1806 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001807 {
1808 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001809 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1810 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001811 (flags & VIF_WANT_INFO) ? _(" info") : "",
1812 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1813 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001814 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001815 verbose_leave();
1816 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 vim_free(fname);
1819 if (fp == NULL)
1820 return FAIL;
1821
1822 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001823 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824
1825 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 return OK;
1827}
1828
1829/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001830 * Write the viminfo file. The old one is read in first so that effectively a
1831 * merge of current info and old info is done. This allows multiple vims to
1832 * run simultaneously, without losing any marks etc.
1833 * If "forceit" is TRUE, then the old file is not read in, and only internal
1834 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 */
1836 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001837write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838{
1839 char_u *fname;
1840 FILE *fp_in = NULL; /* input viminfo file, if any */
1841 FILE *fp_out = NULL; /* output viminfo file */
1842 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001843 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 char_u *wp;
1845#if defined(UNIX) || defined(VMS)
1846 mode_t umask_save;
1847#endif
1848#ifdef UNIX
1849 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001850 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001852#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001853 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001854#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855
1856 if (no_viminfo())
1857 return;
1858
1859 fname = viminfo_filename(file); /* may set to default if NULL */
1860 if (fname == NULL)
1861 return;
1862
1863 fp_in = mch_fopen((char *)fname, READBIN);
1864 if (fp_in == NULL)
1865 {
1866 /* if it does exist, but we can't read it, don't try writing */
1867 if (mch_stat((char *)fname, &st_new) == 0)
1868 goto end;
1869#if defined(UNIX) || defined(VMS)
1870 /*
1871 * For Unix we create the .viminfo non-accessible for others,
1872 * because it may contain text from non-accessible documents.
1873 */
1874 umask_save = umask(077);
1875#endif
1876 fp_out = mch_fopen((char *)fname, WRITEBIN);
1877#if defined(UNIX) || defined(VMS)
1878 (void)umask(umask_save);
1879#endif
1880 }
1881 else
1882 {
1883 /*
1884 * There is an existing viminfo file. Create a temporary file to
1885 * write the new viminfo into, in the same directory as the
1886 * existing viminfo file, which will be renamed later.
1887 */
1888#ifdef UNIX
1889 /*
1890 * For Unix we check the owner of the file. It's not very nice to
1891 * overwrite a user's viminfo file after a "su root", with a
1892 * viminfo file that the user can't read.
1893 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001894 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001895 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001897 if (mch_stat((char *)fname, &st_old) == 0
1898 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001899 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 ? (st_old.st_mode & 0200)
1901 : (st_old.st_gid == getgid()
1902 ? (st_old.st_mode & 0020)
1903 : (st_old.st_mode & 0002))))
1904 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001905 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906
1907 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1909 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001910 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 goto end;
1912 }
1913#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001914#ifdef WIN3264
1915 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001916 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001917#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918
1919 /*
1920 * Make tempname.
1921 * May try twice: Once normal and once with shortname set, just in
1922 * case somebody puts his viminfo file in an 8.3 filesystem.
1923 */
1924 for (;;)
1925 {
1926 tempname = buf_modname(
1927#ifdef UNIX
1928 shortname,
1929#else
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001930# ifdef FEAT_GUI_W32
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 gui_is_win32s(),
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001932# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934# endif
1935#endif
1936 fname,
1937#ifdef VMS
1938 (char_u *)"-tmp",
1939#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941#endif
1942 FALSE);
1943 if (tempname == NULL) /* out of memory */
1944 break;
1945
1946 /*
1947 * Check if tempfile already exists. Never overwrite an
1948 * existing file!
1949 */
1950 if (mch_stat((char *)tempname, &st_new) == 0)
1951 {
1952#ifdef UNIX
1953 /*
1954 * Check if tempfile is same as original file. May happen
1955 * when modname() gave the same file back. E.g. silly
1956 * link, or file name-length reached. Try again with
1957 * shortname set.
1958 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001959 if (!shortname && st_new.st_dev == st_old.st_dev
1960 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 {
1962 vim_free(tempname);
1963 tempname = NULL;
1964 shortname = TRUE;
1965 continue;
1966 }
1967#endif
1968 /*
1969 * Try another name. Change one character, just before
1970 * the extension. This should also work for an 8.3
1971 * file name, when after adding the extension it still is
1972 * the same file as the original.
1973 */
1974 wp = tempname + STRLEN(tempname) - 5;
1975 if (wp < gettail(tempname)) /* empty file name? */
1976 wp = gettail(tempname);
1977 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1978 --*wp)
1979 {
1980 /*
1981 * They all exist? Must be something wrong! Don't
1982 * write the viminfo file then.
1983 */
1984 if (*wp == 'a')
1985 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001986 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1987 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 vim_free(tempname);
1989 tempname = NULL;
1990 break;
1991 }
1992 }
1993 }
1994 break;
1995 }
1996
1997 if (tempname != NULL)
1998 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001999#ifdef VMS
2000 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00002001 umask_save = umask(077);
2002 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2003 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002004#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00002005 int fd;
2006
2007 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002008 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002009 * Unix: same as original file, but strip s-bit. Reset umask to
2010 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002011 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00002012# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002013 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00002014 fd = mch_open((char *)tempname,
2015 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002016 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002017 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002018# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002019 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002020 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002021# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002022 if (fd < 0)
2023 fp_out = NULL;
2024 else
2025 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002026#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027
2028 /*
2029 * If we can't create in the same directory, try creating a
2030 * "normal" temp file.
2031 */
2032 if (fp_out == NULL)
2033 {
2034 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002035 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2037 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002038
2039#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002041 * Make sure the owner can read/write it. This only works for
2042 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 */
2044 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002045 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046#endif
2047 }
2048 }
2049
2050 /*
2051 * Check if the new viminfo file can be written to.
2052 */
2053 if (fp_out == NULL)
2054 {
2055 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002056 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 if (fp_in != NULL)
2058 fclose(fp_in);
2059 goto end;
2060 }
2061
2062 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002063 {
2064 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002065 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002066 verbose_leave();
2067 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068
2069 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002070 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071
Bram Moolenaar927030a2016-03-15 18:23:55 +01002072 if (fclose(fp_out) == EOF)
2073 ++viminfo_errcnt;
2074
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 if (fp_in != NULL)
2076 {
2077 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002078
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002079 /* In case of an error keep the original viminfo file. Otherwise
2080 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002081 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002082 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002083 if (vim_rename(tempname, fname) == -1)
2084 {
2085 ++viminfo_errcnt;
2086 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2087 }
2088# ifdef WIN3264
2089 /* If the viminfo file was hidden then also hide the new file. */
2090 else if (hidden)
2091 mch_hide(fname);
2092# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002093 }
2094 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 mch_remove(tempname);
2096 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002097
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098end:
2099 vim_free(fname);
2100 vim_free(tempname);
2101}
2102
2103/*
2104 * Get the viminfo file name to use.
2105 * If "file" is given and not empty, use it (has already been expanded by
2106 * cmdline functions).
2107 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2108 * expand environment variables.
2109 * Returns an allocated string. NULL when out of memory.
2110 */
2111 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002112viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113{
2114 if (file == NULL || *file == NUL)
2115 {
2116 if (use_viminfo != NULL)
2117 file = use_viminfo;
2118 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2119 {
2120#ifdef VIMINFO_FILE2
2121 /* don't use $HOME when not defined (turned into "c:/"!). */
2122# ifdef VMS
2123 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2124# else
2125 if (mch_getenv((char_u *)"HOME") == NULL)
2126# endif
2127 {
2128 /* don't use $VIM when not available. */
2129 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2130 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2131 file = (char_u *)VIMINFO_FILE2;
2132 else
2133 file = (char_u *)VIMINFO_FILE;
2134 }
2135 else
2136#endif
2137 file = (char_u *)VIMINFO_FILE;
2138 }
2139 expand_env(file, NameBuff, MAXPATHL);
2140 file = NameBuff;
2141 }
2142 return vim_strsave(file);
2143}
2144
2145/*
2146 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2147 */
2148 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002149do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 int eof = FALSE;
2152 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002153 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002154 int do_copy_marks = FALSE;
2155 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156
2157 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2158 return;
2159 vir.vir_fd = fp_in;
2160#ifdef FEAT_MBYTE
2161 vir.vir_conv.vc_type = CONV_NONE;
2162#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002163 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002164 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165
2166 if (fp_in != NULL)
2167 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002168 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002169 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002170 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002171 {
2172 /* Registers and marks are read and kept separate from what
2173 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002174 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002175 prepare_viminfo_marks();
2176 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002177
Bram Moolenaard812df62008-11-09 12:46:09 +00002178 eof = read_viminfo_up_to_marks(&vir,
2179 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002180 merge = TRUE;
2181 }
2182 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 /* Skip info, find start of marks */
2184 while (!(eof = viminfo_readline(&vir))
2185 && vir.vir_line[0] != '>')
2186 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002187
2188 do_copy_marks = (flags &
2189 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002191
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 if (fp_out != NULL)
2193 {
2194 /* Write the info: */
2195 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2196 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002197 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002198 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002200 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2202#endif
2203 write_viminfo_search_pattern(fp_out);
2204 write_viminfo_sub_string(fp_out);
2205#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002206 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207#endif
2208 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002209 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210#ifdef FEAT_EVAL
2211 write_viminfo_varlist(fp_out);
2212#endif
2213 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002214 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002216 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002217
2218 if (do_copy_marks)
2219 ga_init2(&buflist, sizeof(buf_T *), 50);
2220 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002222
2223 if (do_copy_marks)
2224 {
2225 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2226 if (fp_out != NULL)
2227 ga_clear(&buflist);
2228 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229
2230 vim_free(vir.vir_line);
2231#ifdef FEAT_MBYTE
2232 if (vir.vir_conv.vc_type != CONV_NONE)
2233 convert_setup(&vir.vir_conv, NULL, NULL);
2234#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002235 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236}
2237
2238/*
2239 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2240 * first part of the viminfo file which contains everything but the marks that
2241 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2242 */
2243 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002244read_viminfo_up_to_marks(
2245 vir_T *virp,
2246 int forceit,
2247 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248{
2249 int eof;
2250 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002251 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252
2253#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002254 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002256
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 eof = viminfo_readline(virp);
2258 while (!eof && virp->vir_line[0] != '>')
2259 {
2260 switch (virp->vir_line[0])
2261 {
2262 /* Characters reserved for future expansion, ignored now */
2263 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 case '^': /* to be defined */
2265 case '<': /* long line - ignored */
2266 /* A comment or empty line. */
2267 case NUL:
2268 case '\r':
2269 case '\n':
2270 case '#':
2271 eof = viminfo_readline(virp);
2272 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002273 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002274 eof = read_viminfo_barline(virp, got_encoding,
2275 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002276 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002278 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 eof = viminfo_encoding(virp);
2280 break;
2281 case '!': /* global variable */
2282#ifdef FEAT_EVAL
2283 eof = read_viminfo_varlist(virp, writing);
2284#else
2285 eof = viminfo_readline(virp);
2286#endif
2287 break;
2288 case '%': /* entry for buffer list */
2289 eof = read_viminfo_bufferlist(virp, writing);
2290 break;
2291 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002292 /* When registers are in bar lines skip the old style register
2293 * lines. */
2294 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2295 eof = read_viminfo_register(virp, forceit);
2296 else
2297 do {
2298 eof = viminfo_readline(virp);
2299 } while (!eof && (virp->vir_line[0] == TAB
2300 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 break;
2302 case '/': /* Search string */
2303 case '&': /* Substitute search string */
2304 case '~': /* Last search string, followed by '/' or '&' */
2305 eof = read_viminfo_search_pattern(virp, forceit);
2306 break;
2307 case '$':
2308 eof = read_viminfo_sub_string(virp, forceit);
2309 break;
2310 case ':':
2311 case '?':
2312 case '=':
2313 case '@':
2314#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002315 /* When history is in bar lines skip the old style history
2316 * lines. */
2317 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2318 eof = read_viminfo_history(virp, writing);
2319 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002321 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 break;
2323 case '-':
2324 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002325 /* When file marks are in bar lines skip the old style lines. */
2326 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2327 eof = read_viminfo_filemark(virp, forceit);
2328 else
2329 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 break;
2331 default:
2332 if (viminfo_error("E575: ", _("Illegal starting char"),
2333 virp->vir_line))
2334 eof = TRUE;
2335 else
2336 eof = viminfo_readline(virp);
2337 break;
2338 }
2339 }
2340
2341#ifdef FEAT_CMDHIST
2342 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002343 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002344 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345#endif
2346
2347 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002348 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 fmarks_check_names(buf);
2350
2351 return eof;
2352}
2353
2354/*
2355 * Compare the 'encoding' value in the viminfo file with the current value of
2356 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2357 * conversion of text with iconv() in viminfo_readstring().
2358 */
2359 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002360viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361{
2362#ifdef FEAT_MBYTE
2363 char_u *p;
2364 int i;
2365
2366 if (get_viminfo_parameter('c') != 0)
2367 {
2368 p = vim_strchr(virp->vir_line, '=');
2369 if (p != NULL)
2370 {
2371 /* remove trailing newline */
2372 ++p;
2373 for (i = 0; vim_isprintc(p[i]); ++i)
2374 ;
2375 p[i] = NUL;
2376
2377 convert_setup(&virp->vir_conv, p, p_enc);
2378 }
2379 }
2380#endif
2381 return viminfo_readline(virp);
2382}
2383
2384/*
2385 * Read a line from the viminfo file.
2386 * Returns TRUE for end-of-file;
2387 */
2388 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002389viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390{
2391 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2392}
2393
2394/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002395 * Check string read from viminfo file.
2396 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 * - replace CTRL-V CTRL-V with CTRL-V
2398 * - replace CTRL-V 'n' with '\n'
2399 *
2400 * Check for a long line as written by viminfo_writestring().
2401 *
2402 * Return the string in allocated memory (NULL when out of memory).
2403 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002405viminfo_readstring(
2406 vir_T *virp,
2407 int off, /* offset for virp->vir_line */
2408 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409{
2410 char_u *retval;
2411 char_u *s, *d;
2412 long len;
2413
2414 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2415 {
2416 len = atol((char *)virp->vir_line + off + 1);
2417 retval = lalloc(len, TRUE);
2418 if (retval == NULL)
2419 {
2420 /* Line too long? File messed up? Skip next line. */
2421 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2422 return NULL;
2423 }
2424 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2425 s = retval + 1; /* Skip the leading '<' */
2426 }
2427 else
2428 {
2429 retval = vim_strsave(virp->vir_line + off);
2430 if (retval == NULL)
2431 return NULL;
2432 s = retval;
2433 }
2434
2435 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2436 d = retval;
2437 while (*s != NUL && *s != '\n')
2438 {
2439 if (s[0] == Ctrl_V && s[1] != NUL)
2440 {
2441 if (s[1] == 'n')
2442 *d++ = '\n';
2443 else
2444 *d++ = Ctrl_V;
2445 s += 2;
2446 }
2447 else
2448 *d++ = *s++;
2449 }
2450 *d = NUL;
2451
2452#ifdef FEAT_MBYTE
2453 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2454 {
2455 d = string_convert(&virp->vir_conv, retval, NULL);
2456 if (d != NULL)
2457 {
2458 vim_free(retval);
2459 retval = d;
2460 }
2461 }
2462#endif
2463
2464 return retval;
2465}
2466
2467/*
2468 * write string to viminfo file
2469 * - replace CTRL-V with CTRL-V CTRL-V
2470 * - replace '\n' with CTRL-V 'n'
2471 * - add a '\n' at the end
2472 *
2473 * For a long line:
2474 * - write " CTRL-V <length> \n " in first line
2475 * - write " < <string> \n " in second line
2476 */
2477 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002478viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479{
2480 int c;
2481 char_u *s;
2482 int len = 0;
2483
2484 for (s = p; *s != NUL; ++s)
2485 {
2486 if (*s == Ctrl_V || *s == '\n')
2487 ++len;
2488 ++len;
2489 }
2490
2491 /* If the string will be too long, write its length and put it in the next
2492 * line. Take into account that some room is needed for what comes before
2493 * the string (e.g., variable name). Add something to the length for the
2494 * '<', NL and trailing NUL. */
2495 if (len > LSIZE / 2)
2496 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2497
2498 while ((c = *p++) != NUL)
2499 {
2500 if (c == Ctrl_V || c == '\n')
2501 {
2502 putc(Ctrl_V, fd);
2503 if (c == '\n')
2504 c = 'n';
2505 }
2506 putc(c, fd);
2507 }
2508 putc('\n', fd);
2509}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002510
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002511/*
2512 * Write a string in quotes that barline_parse() can read back.
2513 * Breaks the line in less than LSIZE pieces when needed.
2514 * Returns remaining characters in the line.
2515 */
2516 int
2517barline_writestring(FILE *fd, char_u *s, int remaining_start)
2518{
2519 char_u *p;
2520 int remaining = remaining_start;
2521 int len = 2;
2522
2523 /* Count the number of characters produced, including quotes. */
2524 for (p = s; *p != NUL; ++p)
2525 {
2526 if (*p == NL)
2527 len += 2;
2528 else if (*p == '"' || *p == '\\')
2529 len += 2;
2530 else
2531 ++len;
2532 }
2533 if (len > remaining)
2534 {
2535 fprintf(fd, ">%d\n|<", len);
2536 remaining = LSIZE - 20;
2537 }
2538
2539 putc('"', fd);
2540 for (p = s; *p != NUL; ++p)
2541 {
2542 if (*p == NL)
2543 {
2544 putc('\\', fd);
2545 putc('n', fd);
2546 --remaining;
2547 }
2548 else if (*p == '"' || *p == '\\')
2549 {
2550 putc('\\', fd);
2551 putc(*p, fd);
2552 --remaining;
2553 }
2554 else
2555 putc(*p, fd);
2556 --remaining;
2557
2558 if (remaining < 3)
2559 {
2560 putc('\n', fd);
2561 putc('|', fd);
2562 putc('<', fd);
2563 /* Leave enough space for another continuation. */
2564 remaining = LSIZE - 20;
2565 }
2566 }
2567 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002568 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002569}
2570
2571/*
2572 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002573 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002574 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002575 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002576 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002577barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002578{
2579 char_u *p = text;
2580 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002581 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002582 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002583 int i;
2584 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002585 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002586#ifdef FEAT_MBYTE
2587 char_u *sconv;
2588 int converted;
2589#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002590
2591 while (*p == ',')
2592 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002593 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002594 if (ga_grow(values, 1) == FAIL)
2595 break;
2596 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002597
2598 if (*p == '>')
2599 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002600 /* Need to read a continuation line. Put strings in allocated
2601 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002602 if (!allocated)
2603 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002604 for (i = 0; i < values->ga_len; ++i)
2605 {
2606 bval_T *vp = (bval_T *)(values->ga_data) + i;
2607
2608 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002609 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002610 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2611 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002612 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002613 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002614 allocated = TRUE;
2615 }
2616
2617 if (vim_isdigit(p[1]))
2618 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002619 size_t len;
2620 size_t todo;
2621 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002622
2623 /* String value was split into lines that are each shorter
2624 * than LSIZE:
2625 * |{bartype},>{length of "{text}{text2}"}
2626 * |<"{text1}
2627 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002628 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002629 */
2630 ++p;
2631 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002632 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002633 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002634 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002635 p = buf;
2636 for (todo = len; todo > 0; todo -= n)
2637 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002638 eof = viminfo_readline(virp);
2639 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002640 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002641 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002642 /* File was truncated or garbled. Read another line if
2643 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002644 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002645 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002646 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002647 /* Get length of text, excluding |< and NL chars. */
2648 n = STRLEN(virp->vir_line);
2649 while (n > 0 && (virp->vir_line[n - 1] == NL
2650 || virp->vir_line[n - 1] == CAR))
2651 --n;
2652 n -= 2;
2653 if (n > todo)
2654 {
2655 /* more values follow after the string */
2656 nextp = virp->vir_line + 2 + todo;
2657 n = todo;
2658 }
2659 mch_memmove(p, virp->vir_line + 2, n);
2660 p += n;
2661 }
2662 *p = NUL;
2663 p = buf;
2664 }
2665 else
2666 {
2667 /* Line ending in ">" continues in the next line:
2668 * |{bartype},{lots of values},>
2669 * |<{value},{value}
2670 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002671 eof = viminfo_readline(virp);
2672 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002673 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002674 /* File was truncated or garbled. Read another line if
2675 * this one starts with '|'. */
2676 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002677 p = virp->vir_line + 2;
2678 }
2679 }
2680
2681 if (isdigit(*p))
2682 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002683 value->bv_type = BVAL_NR;
2684 value->bv_nr = getdigits(&p);
2685 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002686 }
2687 else if (*p == '"')
2688 {
2689 int len = 0;
2690 char_u *s = p;
2691
2692 /* Unescape special characters in-place. */
2693 ++p;
2694 while (*p != '"')
2695 {
2696 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002697 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002698 if (*p == '\\')
2699 {
2700 ++p;
2701 if (*p == 'n')
2702 s[len++] = '\n';
2703 else
2704 s[len++] = *p;
2705 ++p;
2706 }
2707 else
2708 s[len++] = *p++;
2709 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002710 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002711 s[len] = NUL;
2712
Bram Moolenaar01227092016-06-11 14:47:40 +02002713#ifdef FEAT_MBYTE
2714 converted = FALSE;
2715 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2716 {
2717 sconv = string_convert(&virp->vir_conv, s, NULL);
2718 if (sconv != NULL)
2719 {
2720 if (s == buf)
2721 vim_free(s);
2722 s = sconv;
2723 buf = s;
2724 converted = TRUE;
2725 }
2726 }
2727#endif
2728 /* Need to copy in allocated memory if the string wasn't allocated
2729 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002730 if (s != buf && allocated)
2731 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002732 value->bv_string = s;
2733 value->bv_type = BVAL_STRING;
2734 value->bv_len = len;
2735 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002736#ifdef FEAT_MBYTE
2737 || converted
2738#endif
2739 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002740 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002741 if (nextp != NULL)
2742 {
2743 /* values following a long string */
2744 p = nextp;
2745 nextp = NULL;
2746 }
2747 }
2748 else if (*p == ',')
2749 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002750 value->bv_type = BVAL_EMPTY;
2751 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002752 }
2753 else
2754 break;
2755 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002756 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002757}
2758
2759 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002760read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002761{
2762 char_u *p = virp->vir_line + 1;
2763 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002764 garray_T values;
2765 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002766 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002767 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002768
2769 /* The format is: |{bartype},{value},...
2770 * For a very long string:
2771 * |{bartype},>{length of "{text}{text2}"}
2772 * |<{text1}
2773 * |<{text2},{value}
2774 * For a long line not using a string
2775 * |{bartype},{lots of values},>
2776 * |<{value},{value}
2777 */
2778 if (*p == '<')
2779 {
2780 /* Continuation line of an unrecognized item. */
2781 if (writing)
2782 ga_add_string(&virp->vir_barlines, virp->vir_line);
2783 }
2784 else
2785 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002786 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002787 bartype = getdigits(&p);
2788 switch (bartype)
2789 {
2790 case BARTYPE_VERSION:
2791 /* Only use the version when it comes before the encoding.
2792 * If it comes later it was copied by a Vim version that
2793 * doesn't understand the version. */
2794 if (!got_encoding)
2795 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002796 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002797 vp = (bval_T *)values.ga_data;
2798 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2799 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002800 }
2801 break;
2802
2803 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002804 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002805 handle_viminfo_history(&values, writing);
2806 break;
2807
2808 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002809 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002810 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002811 break;
2812
Bram Moolenaar2d358992016-06-12 21:20:54 +02002813 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002814 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002815 handle_viminfo_mark(&values, force);
2816 break;
2817
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002818 default:
2819 /* copy unrecognized line (for future use) */
2820 if (writing)
2821 ga_add_string(&virp->vir_barlines, virp->vir_line);
2822 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002823 for (i = 0; i < values.ga_len; ++i)
2824 {
2825 vp = (bval_T *)values.ga_data + i;
2826 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2827 vim_free(vp->bv_string);
2828 }
2829 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002830 }
2831
Bram Moolenaarecefe712016-06-20 12:50:17 +02002832 if (read_next)
2833 return viminfo_readline(virp);
2834 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002835}
2836
2837 static void
2838write_viminfo_version(FILE *fp_out)
2839{
2840 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2841 BARTYPE_VERSION, VIMINFO_VERSION);
2842}
2843
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002844 static void
2845write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2846{
2847 int i;
2848 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002849 int seen_useful = FALSE;
2850 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002851
2852 if (gap->ga_len > 0)
2853 {
2854 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2855
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002856 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002857 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002858 {
2859 line = ((char **)(gap->ga_data))[i];
2860 if (seen_useful || line[1] != '<')
2861 {
2862 fputs(line, fp_out);
2863 seen_useful = TRUE;
2864 }
2865 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002866 }
2867}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868#endif /* FEAT_VIMINFO */
2869
Bram Moolenaar724f2ed2016-06-11 22:21:17 +02002870#if defined(FEAT_CMDHIST) || defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002871/*
2872 * Return the current time in seconds. Calls time(), unless test_settime()
2873 * was used.
2874 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002875 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002876vim_time(void)
2877{
2878# ifdef FEAT_EVAL
2879 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2880# else
2881 return time(NULL);
2882# endif
2883}
2884#endif
2885
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886/*
2887 * Implementation of ":fixdel", also used by get_stty().
2888 * <BS> resulting <Del>
2889 * ^? ^H
2890 * not ^? ^?
2891 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002893do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894{
2895 char_u *p;
2896
2897 p = find_termcode((char_u *)"kb");
2898 add_termcode((char_u *)"kD", p != NULL
2899 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2900}
2901
2902 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002903print_line_no_prefix(
2904 linenr_T lnum,
2905 int use_number,
2906 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002908 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909
2910 if (curwin->w_p_nu || use_number)
2911 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002912 vim_snprintf((char *)numbuf, sizeof(numbuf),
2913 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2915 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002916 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917}
2918
2919/*
2920 * Print a text line. Also in silent mode ("ex -s").
2921 */
2922 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002923print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924{
2925 int save_silent = silent_mode;
2926
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002928 silent_mode = FALSE;
2929 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2930 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 if (save_silent)
2932 {
2933 msg_putchar('\n');
2934 cursor_on(); /* msg_start() switches it off */
2935 out_flush();
2936 silent_mode = save_silent;
2937 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002938 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939}
2940
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002941 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002942rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002943{
2944 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002945 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002946
Bram Moolenaar7e283842013-05-30 11:43:15 +02002947#ifdef FEAT_AUTOCMD
2948 buf = curbuf;
2949 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002950 /* buffer changed, don't change name now */
2951 if (buf != curbuf)
2952 return FAIL;
2953# ifdef FEAT_EVAL
2954 if (aborting()) /* autocmds may abort script processing */
2955 return FAIL;
2956# endif
2957#endif
2958 /*
2959 * The name of the current buffer will be changed.
2960 * A new (unlisted) buffer entry needs to be made to hold the old file
2961 * name, which will become the alternate file name.
2962 * But don't set the alternate file name if the buffer didn't have a
2963 * name.
2964 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002965 fname = curbuf->b_ffname;
2966 sfname = curbuf->b_sfname;
2967 xfname = curbuf->b_fname;
2968 curbuf->b_ffname = NULL;
2969 curbuf->b_sfname = NULL;
2970 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002971 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002972 curbuf->b_ffname = fname;
2973 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002974 return FAIL;
2975 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002976 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002977 if (xfname != NULL && *xfname != NUL)
2978 {
2979 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2980 if (buf != NULL && !cmdmod.keepalt)
2981 curwin->w_alt_fnum = buf->b_fnum;
2982 }
2983 vim_free(fname);
2984 vim_free(sfname);
2985#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002986 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002987#endif
2988 /* Change directories when the 'acd' option is set. */
2989 DO_AUTOCHDIR
2990 return OK;
2991}
2992
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993/*
2994 * ":file[!] [fname]".
2995 */
2996 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002997ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002999 /* ":0file" removes the file name. Check for illegal uses ":3file",
3000 * "0file name", etc. */
3001 if (eap->addr_count > 0
3002 && (*eap->arg != NUL
3003 || eap->line2 > 0
3004 || eap->addr_count > 1))
3005 {
3006 EMSG(_(e_invarg));
3007 return;
3008 }
3009
3010 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02003012 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 }
3015 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01003016 if (!shortmess(SHM_FILEINFO))
3017 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018}
3019
3020/*
3021 * ":update".
3022 */
3023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003024ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025{
3026 if (curbufIsChanged())
3027 (void)do_write(eap);
3028}
3029
3030/*
3031 * ":write" and ":saveas".
3032 */
3033 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003034ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035{
3036 if (eap->usefilter) /* input lines to shell command */
3037 do_bang(1, eap, FALSE, TRUE, FALSE);
3038 else
3039 (void)do_write(eap);
3040}
3041
3042/*
3043 * write current buffer to file 'eap->arg'
3044 * if 'eap->append' is TRUE, append to the file
3045 *
3046 * if *eap->arg == NUL write to current file
3047 *
3048 * return FAIL for failure, OK otherwise
3049 */
3050 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003051do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052{
3053 int other;
3054 char_u *fname = NULL; /* init to shut up gcc */
3055 char_u *ffname;
3056 int retval = FAIL;
3057 char_u *free_fname = NULL;
3058#ifdef FEAT_BROWSE
3059 char_u *browse_file = NULL;
3060#endif
3061 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003062 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063
3064 if (not_writing()) /* check 'write' option */
3065 return FAIL;
3066
3067 ffname = eap->arg;
3068#ifdef FEAT_BROWSE
3069 if (cmdmod.browse)
3070 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003071 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 NULL, NULL, NULL, curbuf);
3073 if (browse_file == NULL)
3074 goto theend;
3075 ffname = browse_file;
3076 }
3077#endif
3078 if (*ffname == NUL)
3079 {
3080 if (eap->cmdidx == CMD_saveas)
3081 {
3082 EMSG(_(e_argreq));
3083 goto theend;
3084 }
3085 other = FALSE;
3086 }
3087 else
3088 {
3089 fname = ffname;
3090 free_fname = fix_fname(ffname);
3091 /*
3092 * When out-of-memory, keep unexpanded file name, because we MUST be
3093 * able to write the file in this situation.
3094 */
3095 if (free_fname != NULL)
3096 ffname = free_fname;
3097 other = otherfile(ffname);
3098 }
3099
3100 /*
3101 * If we have a new file, put its name in the list of alternate file names.
3102 */
3103 if (other)
3104 {
3105 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3106 || eap->cmdidx == CMD_saveas)
3107 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3108 else
3109 alt_buf = buflist_findname(ffname);
3110 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3111 {
3112 /* Overwriting a file that is loaded in another buffer is not a
3113 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003114 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 goto theend;
3116 }
3117 }
3118
3119 /*
3120 * Writing to the current file is not allowed in readonly mode
3121 * and a file name is required.
3122 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3123 */
3124 if (!other && (
3125#ifdef FEAT_QUICKFIX
3126 bt_dontwrite_msg(curbuf) ||
3127#endif
3128 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3129 goto theend;
3130
3131 if (!other)
3132 {
3133 ffname = curbuf->b_ffname;
3134 fname = curbuf->b_fname;
3135 /*
3136 * Not writing the whole file is only allowed with '!'.
3137 */
3138 if ( (eap->line1 != 1
3139 || eap->line2 != curbuf->b_ml.ml_line_count)
3140 && !eap->forceit
3141 && !eap->append
3142 && !p_wa)
3143 {
3144#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3145 if (p_confirm || cmdmod.confirm)
3146 {
3147 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3148 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3149 goto theend;
3150 eap->forceit = TRUE;
3151 }
3152 else
3153#endif
3154 {
3155 EMSG(_("E140: Use ! to write partial buffer"));
3156 goto theend;
3157 }
3158 }
3159 }
3160
3161 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3162 {
3163 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3164 {
3165#ifdef FEAT_AUTOCMD
3166 buf_T *was_curbuf = curbuf;
3167
3168 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003169 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170# ifdef FEAT_EVAL
3171 if (curbuf != was_curbuf || aborting())
3172# else
3173 if (curbuf != was_curbuf)
3174# endif
3175 {
3176 /* buffer changed, don't change name now */
3177 retval = FAIL;
3178 goto theend;
3179 }
3180#endif
3181 /* Exchange the file names for the current and the alternate
3182 * buffer. This makes it look like we are now editing the buffer
3183 * under the new name. Must be done before buf_write(), because
3184 * if there is no file name and 'cpo' contains 'F', it will set
3185 * the file name. */
3186 fname = alt_buf->b_fname;
3187 alt_buf->b_fname = curbuf->b_fname;
3188 curbuf->b_fname = fname;
3189 fname = alt_buf->b_ffname;
3190 alt_buf->b_ffname = curbuf->b_ffname;
3191 curbuf->b_ffname = fname;
3192 fname = alt_buf->b_sfname;
3193 alt_buf->b_sfname = curbuf->b_sfname;
3194 curbuf->b_sfname = fname;
3195 buf_name_changed(curbuf);
3196#ifdef FEAT_AUTOCMD
3197 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003198 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 if (!alt_buf->b_p_bl)
3200 {
3201 alt_buf->b_p_bl = TRUE;
3202 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3203 }
3204# ifdef FEAT_EVAL
3205 if (curbuf != was_curbuf || aborting())
3206# else
3207 if (curbuf != was_curbuf)
3208# endif
3209 {
3210 /* buffer changed, don't write the file */
3211 retval = FAIL;
3212 goto theend;
3213 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003214
3215 /* If 'filetype' was empty try detecting it now. */
3216 if (*curbuf->b_p_ft == NUL)
3217 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003218 if (au_has_group((char_u *)"filetypedetect"))
3219 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003220 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003221 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003222 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003223
3224 /* Autocommands may have changed buffer names, esp. when
3225 * 'autochdir' is set. */
3226 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227#endif
3228 }
3229
Bram Moolenaar5c719942016-07-09 23:40:45 +02003230 name_was_missing = curbuf->b_ffname == NULL;
3231
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3233 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003234
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003235 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003236 if (eap->cmdidx == CMD_saveas)
3237 {
3238 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003239 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003240 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003241#ifdef FEAT_WINDOWS
3242 redraw_tabline = TRUE;
3243#endif
3244 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003245 }
3246
3247 /* Change directories when the 'acd' option is set and the file name
3248 * got changed or set. */
3249 if (eap->cmdidx == CMD_saveas || name_was_missing)
3250 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003251 DO_AUTOCHDIR
3252 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 }
3254
3255theend:
3256#ifdef FEAT_BROWSE
3257 vim_free(browse_file);
3258#endif
3259 vim_free(free_fname);
3260 return retval;
3261}
3262
3263/*
3264 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3265 * BF_NEW or BF_READERR, check for overwriting current file.
3266 * May set eap->forceit if a dialog says it's OK to overwrite.
3267 * Return OK if it's OK, FAIL if it is not.
3268 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003269 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003270check_overwrite(
3271 exarg_T *eap,
3272 buf_T *buf,
3273 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003275 char_u *ffname, /* full path version of fname */
3276 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277{
3278 /*
3279 * write to other file or b_flags set or not writing the whole file:
3280 * overwriting only allowed with '!'
3281 */
3282 if ( (other
3283 || (buf->b_flags & BF_NOTEDITED)
3284 || ((buf->b_flags & BF_NEW)
3285 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3286 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003288#ifdef FEAT_QUICKFIX
3289 && !bt_nofile(buf)
3290#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 && vim_fexists(ffname))
3292 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003293 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003295#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003296 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003297 if (mch_isdir(ffname))
3298 {
3299 EMSG2(_(e_isadir2), ffname);
3300 return FAIL;
3301 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302#endif
3303#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003304 if (p_confirm || cmdmod.confirm)
3305 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003306 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003308 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3309 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3310 return FAIL;
3311 eap->forceit = TRUE;
3312 }
3313 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003315 {
3316 EMSG(_(e_exists));
3317 return FAIL;
3318 }
3319 }
3320
3321 /* For ":w! filename" check that no swap file exists for "filename". */
3322 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003324 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003325 char_u *p;
3326 int r;
3327 char_u *swapname;
3328
3329 /* We only try the first entry in 'directory', without checking if
3330 * it's writable. If the "." directory is not writable the write
3331 * will probably fail anyway.
3332 * Use 'shortname' of the current buffer, since there is no buffer
3333 * for the written file. */
3334 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003335 {
3336 dir = alloc(5);
3337 if (dir == NULL)
3338 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003339 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003340 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003341 else
3342 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003343 dir = alloc(MAXPATHL);
3344 if (dir == NULL)
3345 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003346 p = p_dir;
3347 copy_option_part(&p, dir, MAXPATHL, ",");
3348 }
3349 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003350 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003351 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003352 if (r)
3353 {
3354#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3355 if (p_confirm || cmdmod.confirm)
3356 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003357 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003358
3359 dialog_msg(buff,
3360 _("Swap file \"%s\" exists, overwrite anyway?"),
3361 swapname);
3362 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3363 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003364 {
3365 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003366 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003367 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003368 eap->forceit = TRUE;
3369 }
3370 else
3371#endif
3372 {
3373 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3374 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003375 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003376 return FAIL;
3377 }
3378 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003379 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 }
3381 }
3382 return OK;
3383}
3384
3385/*
3386 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3387 */
3388 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003389ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390{
3391 int i;
3392
3393 if (eap->cmd[1] == 'n')
3394 i = curwin->w_arg_idx + (int)eap->line2;
3395 else
3396 i = curwin->w_arg_idx - (int)eap->line2;
3397 eap->line1 = 1;
3398 eap->line2 = curbuf->b_ml.ml_line_count;
3399 if (do_write(eap) != FAIL)
3400 do_argfile(eap, i);
3401}
3402
3403/*
3404 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3405 */
3406 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003407do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408{
3409 buf_T *buf;
3410 int error = 0;
3411 int save_forceit = eap->forceit;
3412
3413 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3414 exiting = TRUE;
3415
Bram Moolenaar29323592016-07-24 22:04:11 +02003416 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 {
3418 if (bufIsChanged(buf))
3419 {
3420 /*
3421 * Check if there is a reason the buffer cannot be written:
3422 * 1. if the 'write' option is set
3423 * 2. if there is no file name (even after browsing)
3424 * 3. if the 'readonly' is set (even after a dialog)
3425 * 4. if overwriting is allowed (even after a dialog)
3426 */
3427 if (not_writing())
3428 {
3429 ++error;
3430 break;
3431 }
3432#ifdef FEAT_BROWSE
3433 /* ":browse wall": ask for file name if there isn't one */
3434 if (buf->b_ffname == NULL && cmdmod.browse)
3435 browse_save_fname(buf);
3436#endif
3437 if (buf->b_ffname == NULL)
3438 {
3439 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3440 ++error;
3441 }
3442 else if (check_readonly(&eap->forceit, buf)
3443 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3444 FALSE) == FAIL)
3445 {
3446 ++error;
3447 }
3448 else
3449 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003450#ifdef FEAT_AUTOCMD
3451 bufref_T bufref;
3452
3453 set_bufref(&bufref, buf);
3454#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 if (buf_write_all(buf, eap->forceit) == FAIL)
3456 ++error;
3457#ifdef FEAT_AUTOCMD
3458 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003459 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 buf = firstbuf;
3461#endif
3462 }
3463 eap->forceit = save_forceit; /* check_overwrite() may set it */
3464 }
3465 }
3466 if (exiting)
3467 {
3468 if (!error)
3469 getout(0); /* exit Vim */
3470 not_exiting();
3471 }
3472}
3473
3474/*
3475 * Check the 'write' option.
3476 * Return TRUE and give a message when it's not st.
3477 */
3478 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003479not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480{
3481 if (p_write)
3482 return FALSE;
3483 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3484 return TRUE;
3485}
3486
3487/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003488 * Check if a buffer is read-only (either 'readonly' option is set or file is
3489 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3490 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 */
3492 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003493check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003495 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003496
3497 /* Handle a file being readonly when the 'readonly' option is set or when
3498 * the file exists and permissions are read-only.
3499 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3500 * important for device checks but not here. */
3501 if (!*forceit && (buf->b_p_ro
3502 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3503 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 {
3505#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3506 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3507 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003508 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509
Bram Moolenaar5386a122007-06-28 20:02:32 +00003510 if (buf->b_p_ro)
3511 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3512 buf->b_fname);
3513 else
3514 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 +00003515 buf->b_fname);
3516
3517 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3518 {
3519 /* Set forceit, to force the writing of a readonly file */
3520 *forceit = TRUE;
3521 return FALSE;
3522 }
3523 else
3524 return TRUE;
3525 }
3526 else
3527#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003528 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003530 else
3531 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3532 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 return TRUE;
3534 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 return FALSE;
3537}
3538
3539/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003540 * Try to abandon current file and edit a new or existing file.
3541 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003543 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003544 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3546 */
3547 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003548getfile(
3549 int fnum,
3550 char_u *ffname,
3551 char_u *sfname,
3552 int setpm,
3553 linenr_T lnum,
3554 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555{
3556 int other;
3557 int retval;
3558 char_u *free_me = NULL;
3559
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003560 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003562#ifdef FEAT_AUTOCMD
3563 if (curbuf_locked())
3564 return 1;
3565#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566
3567 if (fnum == 0)
3568 {
3569 /* make ffname full path, set sfname */
3570 fname_expand(curbuf, &ffname, &sfname);
3571 other = otherfile(ffname);
3572 free_me = ffname; /* has been allocated, free() later */
3573 }
3574 else
3575 other = (fnum != curbuf->b_fnum);
3576
3577 if (other)
3578 ++no_wait_return; /* don't wait for autowrite message */
3579 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3580 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3581 {
3582#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3583 if (p_confirm && p_write)
3584 dialog_changed(curbuf, FALSE);
3585 if (curbufIsChanged())
3586#endif
3587 {
3588 if (other)
3589 --no_wait_return;
3590 EMSG(_(e_nowrtmsg));
3591 retval = 2; /* file has been changed */
3592 goto theend;
3593 }
3594 }
3595 if (other)
3596 --no_wait_return;
3597 if (setpm)
3598 setpcmark();
3599 if (!other)
3600 {
3601 if (lnum != 0)
3602 curwin->w_cursor.lnum = lnum;
3603 check_cursor_lnum();
3604 beginline(BL_SOL | BL_FIX);
3605 retval = 0; /* it's in the same file */
3606 }
3607 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003608 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3609 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 retval = -1; /* opened another file */
3611 else
3612 retval = 1; /* error encountered */
3613
3614theend:
3615 vim_free(free_me);
3616 return retval;
3617}
3618
3619/*
3620 * start editing a new file
3621 *
3622 * fnum: file number; if zero use ffname/sfname
3623 * ffname: the file name
3624 * - full path if sfname used,
3625 * - any file name if sfname is NULL
3626 * - empty string to re-edit with the same file name (but may be
3627 * in a different directory)
3628 * - NULL to start an empty buffer
3629 * sfname: the short file name (or NULL)
3630 * eap: contains the command to be executed after loading the file and
3631 * forced 'ff' and 'fenc'
3632 * newlnum: if > 0: put cursor on this line number (if possible)
3633 * if ECMD_LASTL: use last position in loaded file
3634 * if ECMD_LAST: use last position in all files
3635 * if ECMD_ONE: use first line
3636 * flags:
3637 * ECMD_HIDE: if TRUE don't free the current buffer
3638 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3639 * ECMD_OLDBUF: use existing buffer if it exists
3640 * ECMD_FORCEIT: ! used for Ex command
3641 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003642 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003643 * window, NULL when splitting the window first. When not NULL info
3644 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 *
3646 * return FAIL for failure, OK otherwise
3647 */
3648 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003649do_ecmd(
3650 int fnum,
3651 char_u *ffname,
3652 char_u *sfname,
3653 exarg_T *eap, /* can be NULL! */
3654 linenr_T newlnum,
3655 int flags,
3656 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657{
3658 int other_file; /* TRUE if editing another file */
3659 int oldbuf; /* TRUE if using existing buffer */
3660#ifdef FEAT_AUTOCMD
3661 int auto_buf = FALSE; /* TRUE if autocommands brought us
3662 into the buffer unexpectedly */
3663 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003664 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665#endif
3666 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003667 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003669 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670#endif
3671 char_u *free_fname = NULL;
3672#ifdef FEAT_BROWSE
3673 char_u *browse_file = NULL;
3674#endif
3675 int retval = FAIL;
3676 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003677 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 linenr_T topline = 0;
3679 int newcol = -1;
3680 int solcol = -1;
3681 pos_T *pos;
3682#ifdef FEAT_SUN_WORKSHOP
3683 char_u *cp;
3684#endif
3685 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003686#ifdef FEAT_SPELL
3687 int did_get_winopts = FALSE;
3688#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003689 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003690 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691
3692 if (eap != NULL)
3693 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003694#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3695 set_bufref(&old_curbuf, curbuf);
3696#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697
3698 if (fnum != 0)
3699 {
3700 if (fnum == curbuf->b_fnum) /* file is already being edited */
3701 return OK; /* nothing to do */
3702 other_file = TRUE;
3703 }
3704 else
3705 {
3706#ifdef FEAT_BROWSE
3707 if (cmdmod.browse)
3708 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003709# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003710 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003711# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003712 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003713# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003714 au_has_group((char_u *)"FileExplorer"))
3715 {
3716 /* No browsing supported but we do have the file explorer:
3717 * Edit the directory. */
3718 if (ffname == NULL || !mch_isdir(ffname))
3719 ffname = (char_u *)".";
3720 }
3721 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003722# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003723 {
3724 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003726 if (browse_file == NULL)
3727 goto theend;
3728 ffname = browse_file;
3729 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 }
3731#endif
3732 /* if no short name given, use ffname for short name */
3733 if (sfname == NULL)
3734 sfname = ffname;
3735#ifdef USE_FNAME_CASE
3736# ifdef USE_LONG_FNAME
3737 if (USE_LONG_FNAME)
3738# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003739 if (sfname != NULL)
3740 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741#endif
3742
3743#ifdef FEAT_LISTCMDS
3744 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3745 goto theend;
3746#endif
3747
3748 if (ffname == NULL)
3749 other_file = TRUE;
3750 /* there is no file name */
3751 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3752 other_file = FALSE;
3753 else
3754 {
3755 if (*ffname == NUL) /* re-edit with same file name */
3756 {
3757 ffname = curbuf->b_ffname;
3758 sfname = curbuf->b_fname;
3759 }
3760 free_fname = fix_fname(ffname); /* may expand to full path name */
3761 if (free_fname != NULL)
3762 ffname = free_fname;
3763 other_file = otherfile(ffname);
3764#ifdef FEAT_SUN_WORKSHOP
3765 if (usingSunWorkShop && p_acd
3766 && (cp = vim_strrchr(sfname, '/')) != NULL)
3767 sfname = ++cp;
3768#endif
3769 }
3770 }
3771
3772 /*
3773 * if the file was changed we may not be allowed to abandon it
3774 * - if we are going to re-edit the same file
3775 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3776 */
3777 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3778 || (curbuf->b_nwindows == 1
3779 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003780 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3781 | (other_file ? 0 : CCGD_MULTWIN)
3782 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3783 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 {
3785 if (fnum == 0 && other_file && ffname != NULL)
3786 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3787 goto theend;
3788 }
3789
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 /*
3791 * End Visual mode before switching to another buffer, so the text can be
3792 * copied into the GUI selection buffer.
3793 */
3794 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003796#ifdef FEAT_AUTOCMD
3797 if ((command != NULL || newlnum > (linenr_T)0)
3798 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3799 {
3800 int len;
3801 char_u *p;
3802
3803 /* Set v:swapcommand for the SwapExists autocommands. */
3804 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003805 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003806 else
3807 len = 30;
3808 p = alloc((unsigned)len);
3809 if (p != NULL)
3810 {
3811 if (command != NULL)
3812 vim_snprintf((char *)p, len, ":%s\r", command);
3813 else
3814 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3815 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3816 did_set_swapcommand = TRUE;
3817 vim_free(p);
3818 }
3819 }
3820#endif
3821
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 /*
3823 * If we are starting to edit another file, open a (new) buffer.
3824 * Otherwise we re-use the current buffer.
3825 */
3826 if (other_file)
3827 {
3828#ifdef FEAT_LISTCMDS
3829 if (!(flags & ECMD_ADDBUF))
3830#endif
3831 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003832 if (!cmdmod.keepalt)
3833 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003834 if (oldwin != NULL)
3835 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 }
3837
3838 if (fnum)
3839 buf = buflist_findnr(fnum);
3840 else
3841 {
3842#ifdef FEAT_LISTCMDS
3843 if (flags & ECMD_ADDBUF)
3844 {
3845 linenr_T tlnum = 1L;
3846
3847 if (command != NULL)
3848 {
3849 tlnum = atol((char *)command);
3850 if (tlnum <= 0)
3851 tlnum = 1L;
3852 }
3853 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3854 goto theend;
3855 }
3856#endif
3857 buf = buflist_new(ffname, sfname, 0L,
3858 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003859#ifdef FEAT_AUTOCMD
3860 /* autocommands may change curwin and curbuf */
3861 if (oldwin != NULL)
3862 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003863 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003864#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 }
3866 if (buf == NULL)
3867 goto theend;
3868 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3869 {
3870 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 }
3872 else /* existing memfile */
3873 {
3874 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003875 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 (void)buf_check_timestamp(buf, FALSE);
3877 /* Check if autocommands made buffer invalid or changed the current
3878 * buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003879 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003881 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882#endif
3883 )
3884 goto theend;
3885#ifdef FEAT_EVAL
3886 if (aborting()) /* autocmds may abort script processing */
3887 goto theend;
3888#endif
3889 }
3890
3891 /* May jump to last used line number for a loaded buffer or when asked
3892 * for explicitly */
3893 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3894 {
3895 pos = buflist_findfpos(buf);
3896 newlnum = pos->lnum;
3897 solcol = pos->col;
3898 }
3899
3900 /*
3901 * Make the (new) buffer the one used by the current window.
3902 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3903 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003904 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 */
3906 if (buf != curbuf)
3907 {
3908#ifdef FEAT_AUTOCMD
3909 /*
3910 * Be careful: The autocommands may delete any buffer and change
3911 * the current buffer.
3912 * - If the buffer we are going to edit is deleted, give up.
3913 * - If the current buffer is deleted, prefer to load the new
3914 * buffer when loading a buffer is required. This avoids
3915 * loading another buffer which then must be closed again.
3916 * - If we ended up in the new buffer already, need to skip a few
3917 * things, set auto_buf.
3918 */
3919 if (buf->b_fname != NULL)
3920 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003921 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003923 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003925 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 delbuf_msg(new_name); /* frees new_name */
3927 goto theend;
3928 }
3929# ifdef FEAT_EVAL
3930 if (aborting()) /* autocmds may abort script processing */
3931 {
3932 vim_free(new_name);
3933 goto theend;
3934 }
3935# endif
3936 if (buf == curbuf) /* already in new buffer */
3937 auto_buf = TRUE;
3938 else
3939 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003940 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941#endif
3942 buf_copy_options(buf, BCO_ENTER);
3943
3944 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003945 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003946 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003947 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948
3949#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003950 /* Autocommands may open a new window and leave oldwin open
3951 * which leads to crashes since the above call sets
3952 * oldwin->w_buffer to NULL. */
3953 if (curwin != oldwin && oldwin != aucmd_win
3954 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3955 win_close(oldwin, FALSE);
3956
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957# ifdef FEAT_EVAL
3958 if (aborting()) /* autocmds may abort script processing */
3959 {
3960 vim_free(new_name);
3961 goto theend;
3962 }
3963# endif
3964 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003965 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003967 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 delbuf_msg(new_name); /* frees new_name */
3969 goto theend;
3970 }
3971 if (buf == curbuf) /* already in new buffer */
3972 auto_buf = TRUE;
3973 else
3974#endif
3975 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003976#ifdef FEAT_SYN_HL
3977 /*
3978 * <VN> We could instead free the synblock
3979 * and re-attach to buffer, perhaps.
3980 */
3981 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003982 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003983#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 curwin->w_buffer = buf;
3985 curbuf = buf;
3986 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003987
3988 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3989 if (!oldbuf && eap != NULL)
3990 {
3991 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003992#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003993 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003994#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003995 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 }
3997
3998 /* May get the window options from the last time this buffer
3999 * was in this window (or another window). If not used
4000 * before, reset the local window options to the global
4001 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00004002 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004003#ifdef FEAT_SPELL
4004 did_get_winopts = TRUE;
4005#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006
4007#ifdef FEAT_AUTOCMD
4008 }
4009 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004010 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004011 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012#endif
4013 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014
4015 curwin->w_pcmark.lnum = 1;
4016 curwin->w_pcmark.col = 0;
4017 }
4018 else /* !other_file */
4019 {
4020 if (
4021#ifdef FEAT_LISTCMDS
4022 (flags & ECMD_ADDBUF) ||
4023#endif
4024 check_fname() == FAIL)
4025 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004026
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 oldbuf = (flags & ECMD_OLDBUF);
4028 }
4029
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004030 /* Don't redraw until the cursor is in the right line, otherwise
4031 * autocommands may cause ml_get errors. */
4032 ++RedrawingDisabled;
4033 did_inc_redrawing_disabled = TRUE;
4034
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004035#ifdef FEAT_AUTOCMD
4036 buf = curbuf;
4037#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4039 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004040 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 }
4042 else
4043 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 /* Don't make a buffer listed if it's a help buffer. Useful when
4045 * using CTRL-O to go back to a help file. */
4046 if (!curbuf->b_help)
4047 set_buflisted(TRUE);
4048 }
4049
4050#ifdef FEAT_AUTOCMD
4051 /* If autocommands change buffers under our fingers, forget about
4052 * editing the file. */
4053 if (buf != curbuf)
4054 goto theend;
4055# ifdef FEAT_EVAL
4056 if (aborting()) /* autocmds may abort script processing */
4057 goto theend;
4058# endif
4059
4060 /* Since we are starting to edit a file, consider the filetype to be
4061 * unset. Helps for when an autocommand changes files and expects syntax
4062 * highlighting to work in the other file. */
4063 did_filetype = FALSE;
4064#endif
4065
4066/*
4067 * other_file oldbuf
4068 * FALSE FALSE re-edit same file, buffer is re-used
4069 * FALSE TRUE re-edit same file, nothing changes
4070 * TRUE FALSE start editing new file, new buffer
4071 * TRUE TRUE start editing in existing buffer (nothing to do)
4072 */
4073 if (!other_file && !oldbuf) /* re-use the buffer */
4074 {
4075 set_last_cursor(curwin); /* may set b_last_cursor */
4076 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4077 {
4078 newlnum = curwin->w_cursor.lnum;
4079 solcol = curwin->w_cursor.col;
4080 }
4081#ifdef FEAT_AUTOCMD
4082 buf = curbuf;
4083 if (buf->b_fname != NULL)
4084 new_name = vim_strsave(buf->b_fname);
4085 else
4086 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004087 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004089 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4090 {
4091 /* Save all the text, so that the reload can be undone.
4092 * Sync first so that this is a separate undo-able action. */
4093 u_sync(FALSE);
4094 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4095 == FAIL)
4096 goto theend;
4097 u_unchanged(curbuf);
4098 buf_freeall(curbuf, BFA_KEEP_UNDO);
4099
4100 /* tell readfile() not to clear or reload undo info */
4101 readfile_flags = READ_KEEP_UNDO;
4102 }
4103 else
4104 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105#ifdef FEAT_AUTOCMD
4106 /* If autocommands deleted the buffer we were going to re-edit, give
4107 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004108 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 {
4110 delbuf_msg(new_name); /* frees new_name */
4111 goto theend;
4112 }
4113 vim_free(new_name);
4114
4115 /* If autocommands change buffers under our fingers, forget about
4116 * re-editing the file. Should do the buf_clear_file(), but perhaps
4117 * the autocommands changed the buffer... */
4118 if (buf != curbuf)
4119 goto theend;
4120# ifdef FEAT_EVAL
4121 if (aborting()) /* autocmds may abort script processing */
4122 goto theend;
4123# endif
4124#endif
4125 buf_clear_file(curbuf);
4126 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4127 curbuf->b_op_end.lnum = 0;
4128 }
4129
4130/*
4131 * If we get here we are sure to start editing
4132 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 /* Assume success now */
4134 retval = OK;
4135
4136 /*
4137 * Reset cursor position, could be used by autocommands.
4138 */
4139 check_cursor();
4140
4141 /*
4142 * Check if we are editing the w_arg_idx file in the argument list.
4143 */
4144 check_arg_idx(curwin);
4145
4146#ifdef FEAT_AUTOCMD
4147 if (!auto_buf)
4148#endif
4149 {
4150 /*
4151 * Set cursor and init window before reading the file and executing
4152 * autocommands. This allows for the autocommands to position the
4153 * cursor.
4154 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004155 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156
4157#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004158 /* It's possible that all lines in the buffer changed. Need to update
4159 * automatic folding for all windows where it's used. */
4160# ifdef FEAT_WINDOWS
4161 {
4162 win_T *win;
4163 tabpage_T *tp;
4164
4165 FOR_ALL_TAB_WINDOWS(tp, win)
4166 if (win->w_buffer == curbuf)
4167 foldUpdateAll(win);
4168 }
4169# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004171# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172#endif
4173
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004174 /* Change directories when the 'acd' option is set. */
4175 DO_AUTOCHDIR
4176
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 /*
4178 * Careful: open_buffer() and apply_autocmds() may change the current
4179 * buffer and window.
4180 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004181 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 topline = curwin->w_topline;
4183 if (!oldbuf) /* need to read the file */
4184 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004185#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 swap_exists_action = SEA_DIALOG;
4187#endif
4188 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4189
4190 /*
4191 * Open the buffer and read the file.
4192 */
4193#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004194 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 retval = FAIL;
4196#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004197 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198#endif
4199
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004200#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 if (swap_exists_action == SEA_QUIT)
4202 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004203 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204#endif
4205 }
4206#ifdef FEAT_AUTOCMD
4207 else
4208 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004209 /* Read the modelines, but only to set window-local options. Any
4210 * buffer-local options have already been set and may have been
4211 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004212 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004213
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4215 &retval);
4216 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4217 &retval);
4218 }
4219 check_arg_idx(curwin);
4220#endif
4221
Bram Moolenaareab316b2015-03-24 11:46:30 +01004222 /* If autocommands change the cursor position or topline, we should
4223 * keep it. Also when it moves within a line. */
4224 if (!equalpos(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 {
4226 newlnum = curwin->w_cursor.lnum;
4227 newcol = curwin->w_cursor.col;
4228 }
4229 if (curwin->w_topline == topline)
4230 topline = 0;
4231
4232 /* Even when cursor didn't move we need to recompute topline. */
4233 changed_line_abv_curs();
4234
4235#ifdef FEAT_TITLE
4236 maketitle();
4237#endif
4238 }
4239
4240#ifdef FEAT_DIFF
4241 /* Tell the diff stuff that this buffer is new and/or needs updating.
4242 * Also needed when re-editing the same buffer, because unloading will
4243 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004244 if (curwin->w_p_diff)
4245 {
4246 diff_buf_add(curbuf);
4247 diff_invalidate(curbuf);
4248 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249#endif
4250
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004251#ifdef FEAT_SPELL
4252 /* If the window options were changed may need to set the spell language.
4253 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004254 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4255 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004256#endif
4257
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 if (command == NULL)
4259 {
4260 if (newcol >= 0) /* position set by autocommands */
4261 {
4262 curwin->w_cursor.lnum = newlnum;
4263 curwin->w_cursor.col = newcol;
4264 check_cursor();
4265 }
4266 else if (newlnum > 0) /* line number from caller or old position */
4267 {
4268 curwin->w_cursor.lnum = newlnum;
4269 check_cursor_lnum();
4270 if (solcol >= 0 && !p_sol)
4271 {
4272 /* 'sol' is off: Use last known column. */
4273 curwin->w_cursor.col = solcol;
4274 check_cursor_col();
4275#ifdef FEAT_VIRTUALEDIT
4276 curwin->w_cursor.coladd = 0;
4277#endif
4278 curwin->w_set_curswant = TRUE;
4279 }
4280 else
4281 beginline(BL_SOL | BL_FIX);
4282 }
4283 else /* no line number, go to last line in Ex mode */
4284 {
4285 if (exmode_active)
4286 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4287 beginline(BL_WHITE | BL_FIX);
4288 }
4289 }
4290
4291#ifdef FEAT_WINDOWS
4292 /* Check if cursors in other windows on the same buffer are still valid */
4293 check_lnums(FALSE);
4294#endif
4295
4296 /*
4297 * Did not read the file, need to show some info about the file.
4298 * Do this after setting the cursor.
4299 */
4300 if (oldbuf
4301#ifdef FEAT_AUTOCMD
4302 && !auto_buf
4303#endif
4304 )
4305 {
4306 int msg_scroll_save = msg_scroll;
4307
4308 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4309 * message. */
4310 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4311 msg_scroll = FALSE;
4312 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4313 check_for_delay(FALSE);
4314 msg_start();
4315 msg_scroll = msg_scroll_save;
4316 msg_scrolled_ign = TRUE;
4317
Bram Moolenaar426dd022016-03-15 15:09:29 +01004318 if (!shortmess(SHM_FILEINFO))
4319 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320
4321 msg_scrolled_ign = FALSE;
4322 }
4323
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004324#ifdef FEAT_VIMINFO
4325 curbuf->b_last_used = vim_time();
4326#endif
4327
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 if (command != NULL)
4329 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4330
4331#ifdef FEAT_KEYMAP
4332 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004333 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334#endif
4335
4336 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004337 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 if (!skip_redraw)
4339 {
4340 n = p_so;
4341 if (topline == 0 && command == NULL)
4342 p_so = 999; /* force cursor halfway the window */
4343 update_topline();
4344#ifdef FEAT_SCROLLBIND
4345 curwin->w_scbind_pos = curwin->w_topline;
4346#endif
4347 p_so = n;
4348 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4349 }
4350
4351 if (p_im)
4352 need_start_insertmode = TRUE;
4353
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004354 /* Change directories when the 'acd' option is set. */
4355 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004357#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004358 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 {
4360# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004361 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4363# endif
4364# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004365 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004366 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367# endif
4368 }
4369#endif
4370
4371theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004372 if (did_inc_redrawing_disabled)
4373 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004374#ifdef FEAT_AUTOCMD
4375 if (did_set_swapcommand)
4376 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4377#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378#ifdef FEAT_BROWSE
4379 vim_free(browse_file);
4380#endif
4381 vim_free(free_fname);
4382 return retval;
4383}
4384
4385#ifdef FEAT_AUTOCMD
4386 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004387delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388{
4389 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4390 name == NULL ? (char_u *)"" : name);
4391 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004392 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004393 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394}
4395#endif
4396
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004397static int append_indent = 0; /* autoindent for first line */
4398
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399/*
4400 * ":insert" and ":append", also used by ":change"
4401 */
4402 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004403ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404{
4405 char_u *theline;
4406 int did_undo = FALSE;
4407 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004408 int indent = 0;
4409 char_u *p;
4410 int vcol;
4411 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004413 /* the ! flag toggles autoindent */
4414 if (eap->forceit)
4415 curbuf->b_p_ai = !curbuf->b_p_ai;
4416
4417 /* First autoindent comes from the line we start on */
4418 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4419 append_indent = get_indent_lnum(lnum);
4420
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 if (eap->cmdidx != CMD_append)
4422 --lnum;
4423
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004424 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004425 if (empty && lnum == 1)
4426 lnum = 0;
4427
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 State = INSERT; /* behave like in Insert mode */
4429 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4430 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004431
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004432 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 {
4434 msg_scroll = TRUE;
4435 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004436 if (curbuf->b_p_ai)
4437 {
4438 if (append_indent >= 0)
4439 {
4440 indent = append_indent;
4441 append_indent = -1;
4442 }
4443 else if (lnum > 0)
4444 indent = get_indent_lnum(lnum);
4445 }
4446 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004448 {
4449 /* No getline() function, use the lines that follow. This ends
4450 * when there is no more. */
4451 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4452 break;
4453 p = vim_strchr(eap->nextcmd, NL);
4454 if (p == NULL)
4455 p = eap->nextcmd + STRLEN(eap->nextcmd);
4456 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4457 if (*p != NUL)
4458 ++p;
4459 eap->nextcmd = p;
4460 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004462 {
4463 int save_State = State;
4464
4465 /* Set State to avoid the cursor shape to be set to INSERT mode
4466 * when getline() returns. */
4467 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 theline = eap->getline(
4469#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004470 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004472 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004473 State = save_State;
4474 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004476 if (theline == NULL)
4477 break;
4478
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004479 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4480 if (ex_keep_indent)
4481 append_indent = indent;
4482
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004483 /* Look for the "." after automatic indent. */
4484 vcol = 0;
4485 for (p = theline; indent > vcol; ++p)
4486 {
4487 if (*p == ' ')
4488 ++vcol;
4489 else if (*p == TAB)
4490 vcol += 8 - vcol % 8;
4491 else
4492 break;
4493 }
4494 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004495 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4496 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 {
4498 vim_free(theline);
4499 break;
4500 }
4501
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004502 /* don't use autoindent if nothing was typed. */
4503 if (p[0] == NUL)
4504 theline[0] = NUL;
4505
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 did_undo = TRUE;
4507 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004508 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509
4510 vim_free(theline);
4511 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004512
4513 if (empty)
4514 {
4515 ml_delete(2L, FALSE);
4516 empty = FALSE;
4517 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 }
4519 State = NORMAL;
4520
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004521 if (eap->forceit)
4522 curbuf->b_p_ai = !curbuf->b_p_ai;
4523
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004525 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 * "end" is set to lnum when something has been appended, otherwise
4527 * it is the same than "start" -- Acevedo */
4528 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4529 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4530 if (eap->cmdidx != CMD_append)
4531 --curbuf->b_op_start.lnum;
4532 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4533 ? lnum : curbuf->b_op_start.lnum;
4534 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4535 curwin->w_cursor.lnum = lnum;
4536 check_cursor_lnum();
4537 beginline(BL_SOL | BL_FIX);
4538
4539 need_wait_return = FALSE; /* don't use wait_return() now */
4540 ex_no_reprint = TRUE;
4541}
4542
4543/*
4544 * ":change"
4545 */
4546 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004547ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548{
4549 linenr_T lnum;
4550
4551 if (eap->line2 >= eap->line1
4552 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4553 return;
4554
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004555 /* the ! flag toggles autoindent */
4556 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4557 append_indent = get_indent_lnum(eap->line1);
4558
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4560 {
4561 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4562 break;
4563 ml_delete(eap->line1, FALSE);
4564 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004565
4566 /* make sure the cursor is not beyond the end of the file now */
4567 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4569
4570 /* ":append" on the line above the deleted lines. */
4571 eap->line2 = eap->line1;
4572 ex_append(eap);
4573}
4574
4575 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004576ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577{
4578 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004579 int bigness;
4580 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 int minus = 0;
4582 linenr_T start, end, curs, i;
4583 int j;
4584 linenr_T lnum = eap->line2;
4585
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004586 /* Vi compatible: ":z!" uses display height, without a count uses
4587 * 'scroll' */
4588 if (eap->forceit)
4589 bigness = curwin->w_height;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004590#ifdef FEAT_WINDOWS
Bram Moolenaar631abc32014-02-22 22:27:47 +01004591 else if (firstwin != lastwin)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004592 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004593#endif
Bram Moolenaar631abc32014-02-22 22:27:47 +01004594 else
4595 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 if (bigness < 1)
4597 bigness = 1;
4598
4599 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004600 kind = x;
4601 if (*kind == '-' || *kind == '+' || *kind == '='
4602 || *kind == '^' || *kind == '.')
4603 ++x;
4604 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 ++x;
4606
4607 if (*x != 0)
4608 {
4609 if (!VIM_ISDIGIT(*x))
4610 {
4611 EMSG(_("E144: non-numeric argument to :z"));
4612 return;
4613 }
4614 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004615 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004617 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004618 if (*kind == '=')
4619 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004620 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 }
4622
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004623 /* the number of '-' and '+' multiplies the distance */
4624 if (*kind == '-' || *kind == '+')
4625 for (x = kind + 1; *x == *kind; ++x)
4626 ;
4627
4628 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 {
4630 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004631 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4632 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004633 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 break;
4635
4636 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004637 start = lnum - (bigness + 1) / 2 + 1;
4638 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 curs = lnum;
4640 minus = 1;
4641 break;
4642
4643 case '^':
4644 start = lnum - bigness * 2;
4645 end = lnum - bigness;
4646 curs = lnum - bigness;
4647 break;
4648
4649 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004650 start = lnum - (bigness + 1) / 2 + 1;
4651 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 curs = end;
4653 break;
4654
4655 default: /* '+' */
4656 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004657 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004658 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004659 else if (eap->addr_count == 0)
4660 ++start;
4661 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 curs = end;
4663 break;
4664 }
4665
4666 if (start < 1)
4667 start = 1;
4668
4669 if (end > curbuf->b_ml.ml_line_count)
4670 end = curbuf->b_ml.ml_line_count;
4671
4672 if (curs > curbuf->b_ml.ml_line_count)
4673 curs = curbuf->b_ml.ml_line_count;
4674
4675 for (i = start; i <= end; i++)
4676 {
4677 if (minus && i == lnum)
4678 {
4679 msg_putchar('\n');
4680
4681 for (j = 1; j < Columns; j++)
4682 msg_putchar('-');
4683 }
4684
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004685 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686
4687 if (minus && i == lnum)
4688 {
4689 msg_putchar('\n');
4690
4691 for (j = 1; j < Columns; j++)
4692 msg_putchar('-');
4693 }
4694 }
4695
4696 curwin->w_cursor.lnum = curs;
4697 ex_no_reprint = TRUE;
4698}
4699
4700/*
4701 * Check if the restricted flag is set.
4702 * If so, give an error message and return TRUE.
4703 * Otherwise, return FALSE.
4704 */
4705 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004706check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707{
4708 if (restricted)
4709 {
4710 EMSG(_("E145: Shell commands not allowed in rvim"));
4711 return TRUE;
4712 }
4713 return FALSE;
4714}
4715
4716/*
4717 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4718 * If so, give an error message and return TRUE.
4719 * Otherwise, return FALSE.
4720 */
4721 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004722check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723{
4724 if (secure)
4725 {
4726 secure = 2;
4727 EMSG(_(e_curdir));
4728 return TRUE;
4729 }
4730#ifdef HAVE_SANDBOX
4731 /*
4732 * In the sandbox more things are not allowed, including the things
4733 * disallowed in secure mode.
4734 */
4735 if (sandbox != 0)
4736 {
4737 EMSG(_(e_sandbox));
4738 return TRUE;
4739 }
4740#endif
4741 return FALSE;
4742}
4743
4744static char_u *old_sub = NULL; /* previous substitute pattern */
4745static int global_need_beginline; /* call beginline() after ":g" */
4746
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747/* do_sub()
4748 *
4749 * Perform a substitution from line eap->line1 to line eap->line2 using the
4750 * command pointed to by eap->arg which should be of the form:
4751 *
4752 * /pattern/substitution/{flags}
4753 *
4754 * The usual escapes are supported as described in the regexp docs.
4755 */
4756 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004757do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758{
4759 linenr_T lnum;
4760 long i = 0;
4761 regmmatch_T regmatch;
4762 static int do_all = FALSE; /* do multiple substitutions per line */
4763 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004764 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 static int do_error = TRUE; /* if false, ignore errors */
4766 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004767 static int do_list = FALSE; /* list last line with subs. */
4768 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 static int do_ic = 0; /* ignore case flag */
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 */
4957 do_all = TRUE;
4958 else
4959 do_all = FALSE;
4960 do_ask = FALSE;
4961 }
4962 do_error = TRUE;
4963 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004964 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004965 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 do_ic = 0;
4967 }
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')
4975 do_all = !do_all;
4976 else if (*cmd == 'c')
4977 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004978 else if (*cmd == 'n')
4979 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 else if (*cmd == 'e')
4981 do_error = !do_error;
4982 else if (*cmd == 'r') /* use last used regexp */
4983 which_pat = RE_LAST;
4984 else if (*cmd == 'p')
4985 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004986 else if (*cmd == '#')
4987 {
4988 do_print = TRUE;
4989 do_number = TRUE;
4990 }
4991 else if (*cmd == 'l')
4992 {
4993 do_print = TRUE;
4994 do_list = TRUE;
4995 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 else if (*cmd == 'i') /* ignore case */
4997 do_ic = 'i';
4998 else if (*cmd == 'I') /* don't ignore case */
4999 do_ic = 'I';
5000 else
5001 break;
5002 ++cmd;
5003 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005004 if (do_count)
5005 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005007 save_do_all = do_all;
5008 save_do_ask = do_ask;
5009
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);
5017 if (i <= 0 && !eap->skip && do_error)
5018 {
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 Moolenaar61660ea2006-04-07 21:40:07 +00005045 if (!do_count && !curbuf->b_p_ma)
5046 {
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 {
5054 if (do_error)
5055 EMSG(_(e_invcmd));
5056 return;
5057 }
5058
5059 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
5060 if (do_ic == 'i')
5061 regmatch.rmm_ic = TRUE;
5062 else if (do_ic == 'I')
5063 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 Moolenaar05159a02005-02-26 23:04:13 +00005231 if (do_count)
5232 {
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 Moolenaar071d4272004-06-13 20:20:40 +00005253 if (do_ask)
5254 {
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 */
5274 while (do_ask)
5275 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005276 if (exmode_active)
5277 {
5278 char_u *resp;
5279 colnr_T sc, ec;
5280
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005281 print_line_no_prefix(lnum, do_number, do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005282
5283 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5284 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
5285 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005286 if (do_number || curwin->w_p_nu)
5287 {
5288 int numw = number_width(curwin) + 1;
5289 sc += numw;
5290 ec += numw;
5291 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005292 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005293 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005294 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005295 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005296 msg_putchar('^');
5297
5298 resp = getexmodeline('?', NULL, 0);
5299 if (resp != NULL)
5300 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005301 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005302 vim_free(resp);
5303 }
5304 }
5305 else
5306 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005307 char_u *orig_line = NULL;
5308 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005310 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005312 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005314 /* Invert the matched string.
5315 * Remove the inversion afterwards. */
5316 temp = RedrawingDisabled;
5317 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005319 if (new_start != NULL)
5320 {
5321 /* There already was a substitution, we would
5322 * like to show this to the user. We cannot
5323 * really update the line, it would change
5324 * what matches. Temporarily replace the line
5325 * and change it back afterwards. */
5326 orig_line = vim_strsave(ml_get(lnum));
5327 if (orig_line != NULL)
5328 {
5329 char_u *new_line = concat_str(new_start,
5330 sub_firstline + copycol);
5331
5332 if (new_line == NULL)
5333 {
5334 vim_free(orig_line);
5335 orig_line = NULL;
5336 }
5337 else
5338 {
5339 /* Position the cursor relative to the
5340 * end of the line, the previous
5341 * substitute may have inserted or
5342 * deleted characters before the
5343 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005344 len_change = (int)STRLEN(new_line)
5345 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005346 curwin->w_cursor.col += len_change;
5347 ml_replace(lnum, new_line, FALSE);
5348 }
5349 }
5350 }
5351
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005352 search_match_lines = regmatch.endpos[0].lnum
5353 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005354 search_match_endcol = regmatch.endpos[0].col
5355 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005356 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005358 update_topline();
5359 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005360 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005361 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005362 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363
5364#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005365 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005367 if (msg_row == Rows - 1)
5368 msg_didout = FALSE; /* avoid a scroll-up */
5369 msg_starthere();
5370 i = msg_scroll;
5371 msg_scroll = 0; /* truncate msg when
5372 needed */
5373 msg_no_more = TRUE;
5374 /* write message same highlighting as for
5375 * wait_return */
5376 smsg_attr(hl_attr(HLF_R),
5377 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5378 msg_no_more = FALSE;
5379 msg_scroll = i;
5380 showruler(TRUE);
5381 windgoto(msg_row, msg_col);
5382 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383
5384#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005385 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005387 ++no_mapping; /* don't map this key */
5388 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005389 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005390 --allow_keys;
5391 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005393 /* clear the question */
5394 msg_didout = FALSE; /* don't scroll up */
5395 msg_col = 0;
5396 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005397
5398 /* restore the line */
5399 if (orig_line != NULL)
5400 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005401 }
5402
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005404 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005406 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407#endif
5408 )
5409 {
5410 got_quit = TRUE;
5411 break;
5412 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005413 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005415 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005417 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 {
5419 /* last: replace and then stop */
5420 do_all = FALSE;
5421 line2 = lnum;
5422 break;
5423 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005424 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 {
5426 do_ask = FALSE;
5427 break;
5428 }
5429#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005430 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005432 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 scrolldown_clamp();
5434#endif
5435 }
5436 State = save_State;
5437#ifdef FEAT_MOUSE
5438 setmouse();
5439#endif
5440 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5441 --no_u_sync;
5442
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005443 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 {
5445 /* For a multi-line match, put matchcol at the NUL at
5446 * the end of the line and set nmatch to one, so that
5447 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005448 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5449 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 if (nmatch > 1)
5451 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005452 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005453 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 }
5455 goto skip;
5456 }
5457 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005458 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 }
5460
5461 /* Move the cursor to the start of the match, so that we can
5462 * use "\=col("."). */
5463 curwin->w_cursor.col = regmatch.startpos[0].col;
5464
5465 /*
5466 * 3. substitute the string.
5467 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005468#ifdef FEAT_EVAL
5469 if (do_count)
5470 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005471 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005472 save_ma = curbuf->b_p_ma;
5473 curbuf->b_p_ma = FALSE;
5474 sandbox++;
5475 }
5476#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005478 sublen = vim_regsub_multi(&regmatch,
5479 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005481#ifdef FEAT_EVAL
5482 if (do_count)
5483 {
5484 curbuf->b_p_ma = save_ma;
5485 sandbox--;
5486 goto skip;
5487 }
5488#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489
Bram Moolenaar4463f292005-09-25 22:20:24 +00005490 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005491 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005492 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5493 {
5494 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5495 skip_match = TRUE;
5496 }
5497
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 /* Need room for:
5499 * - result so far in new_start (not for first sub in line)
5500 * - original text up to match
5501 * - length of substituted part
5502 * - original text after match
5503 */
5504 if (nmatch == 1)
5505 p1 = sub_firstline;
5506 else
5507 {
5508 p1 = ml_get(sub_firstlnum + nmatch - 1);
5509 nmatch_tl += nmatch - 1;
5510 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005511 copy_len = regmatch.startpos[0].col - copycol;
5512 needed_len = copy_len + ((unsigned)STRLEN(p1)
5513 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 if (new_start == NULL)
5515 {
5516 /*
5517 * Get some space for a temporary buffer to do the
5518 * substitution into (and some extra space to avoid
5519 * too many calls to alloc()/free()).
5520 */
5521 new_start_len = needed_len + 50;
5522 if ((new_start = alloc_check(new_start_len)) == NULL)
5523 goto outofmem;
5524 *new_start = NUL;
5525 new_end = new_start;
5526 }
5527 else
5528 {
5529 /*
5530 * Check if the temporary buffer is long enough to do the
5531 * substitution into. If not, make it larger (with a bit
5532 * extra to avoid too many calls to alloc()/free()).
5533 */
5534 len = (unsigned)STRLEN(new_start);
5535 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005536 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 {
5538 new_start_len = needed_len + 50;
5539 if ((p1 = alloc_check(new_start_len)) == NULL)
5540 {
5541 vim_free(new_start);
5542 goto outofmem;
5543 }
5544 mch_memmove(p1, new_start, (size_t)(len + 1));
5545 vim_free(new_start);
5546 new_start = p1;
5547 }
5548 new_end = new_start + len;
5549 }
5550
5551 /*
5552 * copy the text up to the part that matched
5553 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005554 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5555 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005557 (void)vim_regsub_multi(&regmatch,
5558 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 sub, new_end, TRUE, p_magic, TRUE);
5560 sub_nsubs++;
5561 did_sub = TRUE;
5562
5563 /* Move the cursor to the start of the line, to avoid that it
5564 * is beyond the end of the line after the substitution. */
5565 curwin->w_cursor.col = 0;
5566
5567 /* For a multi-line match, make a copy of the last matched
5568 * line and continue in that one. */
5569 if (nmatch > 1)
5570 {
5571 sub_firstlnum += nmatch - 1;
5572 vim_free(sub_firstline);
5573 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5574 /* When going beyond the last line, stop substituting. */
5575 if (sub_firstlnum <= line2)
5576 do_again = TRUE;
5577 else
5578 do_all = FALSE;
5579 }
5580
5581 /* Remember next character to be copied. */
5582 copycol = regmatch.endpos[0].col;
5583
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005584 if (skip_match)
5585 {
5586 /* Already hit end of the buffer, sub_firstlnum is one
5587 * less than what it ought to be. */
5588 vim_free(sub_firstline);
5589 sub_firstline = vim_strsave((char_u *)"");
5590 copycol = 0;
5591 }
5592
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 /*
5594 * Now the trick is to replace CTRL-M chars with a real line
5595 * break. This would make it impossible to insert a CTRL-M in
5596 * the text. The line break can be avoided by preceding the
5597 * CTRL-M with a backslash. To be able to insert a backslash,
5598 * they must be doubled in the string and are halved here.
5599 * That is Vi compatible.
5600 */
5601 for (p1 = new_end; *p1; ++p1)
5602 {
5603 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005604 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 else if (*p1 == CAR)
5606 {
5607 if (u_inssub(lnum) == OK) /* prepare for undo */
5608 {
5609 *p1 = NUL; /* truncate up to the CR */
5610 ml_append(lnum - 1, new_start,
5611 (colnr_T)(p1 - new_start + 1), FALSE);
5612 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
5613 if (do_ask)
5614 appended_lines(lnum - 1, 1L);
5615 else
5616 {
5617 if (first_line == 0)
5618 first_line = lnum;
5619 last_line = lnum + 1;
5620 }
5621 /* All line numbers increase. */
5622 ++sub_firstlnum;
5623 ++lnum;
5624 ++line2;
5625 /* move the cursor to the new line, like Vi */
5626 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005627 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005628 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 p1 = new_start - 1;
5630 }
5631 }
5632#ifdef FEAT_MBYTE
5633 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005634 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635#endif
5636 }
5637
5638 /*
5639 * 4. If do_all is set, find next match.
5640 * Prevent endless loop with patterns that match empty
5641 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5642 * But ":s/\n/#/" is OK.
5643 */
5644skip:
5645 /* We already know that we did the last subst when we are at
5646 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005647 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5648 * "line2" when there is a \zs in the pattern after a line
5649 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005650 lastone = (skip_match
5651 || got_int
5652 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005653 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005654 || !(do_all || do_again)
5655 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5656 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 nmatch = -1;
5658
5659 /*
5660 * Replace the line in the buffer when needed. This is
5661 * skipped when there are more matches.
5662 * The check for nmatch_tl is needed for when multi-line
5663 * matching must replace the lines before trying to do another
5664 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005665 * When the match starts below where we start searching also
5666 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 */
5668 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 || nmatch_tl > 0
5670 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005671 curbuf, sub_firstlnum,
5672 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005673 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 {
5675 if (new_start != NULL)
5676 {
5677 /*
5678 * Copy the rest of the line, that didn't match.
5679 * "matchcol" has to be adjusted, we use the end of
5680 * the line as reference, because the substitute may
5681 * have changed the number of characters. Same for
5682 * "prev_matchcol".
5683 */
5684 STRCAT(new_start, sub_firstline + copycol);
5685 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5686 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5687 - prev_matchcol;
5688
5689 if (u_savesub(lnum) != OK)
5690 break;
5691 ml_replace(lnum, new_start, TRUE);
5692
5693 if (nmatch_tl > 0)
5694 {
5695 /*
5696 * Matched lines have now been substituted and are
5697 * useless, delete them. The part after the match
5698 * has been appended to new_start, we don't need
5699 * it in the buffer.
5700 */
5701 ++lnum;
5702 if (u_savedel(lnum, nmatch_tl) != OK)
5703 break;
5704 for (i = 0; i < nmatch_tl; ++i)
5705 ml_delete(lnum, (int)FALSE);
5706 mark_adjust(lnum, lnum + nmatch_tl - 1,
5707 (long)MAXLNUM, -nmatch_tl);
5708 if (do_ask)
5709 deleted_lines(lnum, nmatch_tl);
5710 --lnum;
5711 line2 -= nmatch_tl; /* nr of lines decreases */
5712 nmatch_tl = 0;
5713 }
5714
5715 /* When asking, undo is saved each time, must also set
5716 * changed flag each time. */
5717 if (do_ask)
5718 changed_bytes(lnum, 0);
5719 else
5720 {
5721 if (first_line == 0)
5722 first_line = lnum;
5723 last_line = lnum + 1;
5724 }
5725
5726 sub_firstlnum = lnum;
5727 vim_free(sub_firstline); /* free the temp buffer */
5728 sub_firstline = new_start;
5729 new_start = NULL;
5730 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5731 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5732 - prev_matchcol;
5733 copycol = 0;
5734 }
5735 if (nmatch == -1 && !lastone)
5736 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005737 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738
5739 /*
5740 * 5. break if there isn't another match in this line
5741 */
5742 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005743 {
5744 /* If the match found didn't start where we were
5745 * searching, do the next search in the line where we
5746 * found the match. */
5747 if (nmatch == -1)
5748 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005750 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 }
5752
5753 line_breakcheck();
5754 }
5755
5756 if (did_sub)
5757 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005758 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 vim_free(sub_firstline); /* free the copy of the original line */
5760 sub_firstline = NULL;
5761 }
5762
5763 line_breakcheck();
5764 }
5765
5766 if (first_line != 0)
5767 {
5768 /* Need to subtract the number of added lines from "last_line" to get
5769 * the line number before the change (same as adding the number of
5770 * deleted lines). */
5771 i = curbuf->b_ml.ml_line_count - old_line_count;
5772 changed_lines(first_line, 0, last_line - i, i);
5773 }
5774
5775outofmem:
5776 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005777
5778 /* ":s/pat//n" doesn't move the cursor */
5779 if (do_count)
5780 curwin->w_cursor = old_cursor;
5781
Bram Moolenaar46475522010-03-23 17:36:29 +01005782 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {
5784 /* Set the '[ and '] marks. */
5785 curbuf->b_op_start.lnum = eap->line1;
5786 curbuf->b_op_end.lnum = line2;
5787 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5788
5789 if (!global_busy)
5790 {
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005791 if (!do_ask) /* when interactive leave cursor on the match */
5792 {
5793 if (endcolumn)
5794 coladvance((colnr_T)MAXCOL);
5795 else
5796 beginline(BL_WHITE | BL_FIX);
5797 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005798 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 MSG("");
5800 }
5801 else
5802 global_need_beginline = TRUE;
5803 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005804 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 }
5806 else if (!global_busy)
5807 {
5808 if (got_int) /* interrupted */
5809 EMSG(_(e_interr));
5810 else if (got_match) /* did find something but nothing substituted */
5811 MSG("");
5812 else if (do_error) /* nothing found */
5813 EMSG2(_(e_patnotf2), get_search_pat());
5814 }
5815
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005816#ifdef FEAT_FOLDING
5817 if (do_ask && hasAnyFolding(curwin))
5818 /* Cursor position may require updating */
5819 changed_window_setting();
5820#endif
5821
Bram Moolenaar473de612013-06-08 18:19:48 +02005822 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005823
5824 /* Restore the flag values, they can be used for ":&&". */
5825 do_all = save_do_all;
5826 do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827}
5828
5829/*
5830 * Give message for number of substitutions.
5831 * Can also be used after a ":global" command.
5832 * Return TRUE if a message was given.
5833 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005834 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005835do_sub_msg(
5836 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837{
5838 /*
5839 * Only report substitutions when:
5840 * - more than 'report' substitutions
5841 * - command was typed by user, or number of changed lines > 'report'
5842 * - giving messages is not disabled by 'lazyredraw'
5843 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005844 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5845 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 && messaging())
5847 {
5848 if (got_int)
5849 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005850 else
5851 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005853 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005854 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005856 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005857 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005858 sub_nsubs);
5859 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005860 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005861 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005863 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005864 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005867 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 return TRUE;
5869 }
5870 if (got_int)
5871 {
5872 EMSG(_(e_interr));
5873 return TRUE;
5874 }
5875 return FALSE;
5876}
5877
5878/*
5879 * Execute a global command of the form:
5880 *
5881 * g/pattern/X : execute X on all lines where pattern matches
5882 * v/pattern/X : execute X on all lines where pattern does not match
5883 *
5884 * where 'X' is an EX command
5885 *
5886 * The command character (as well as the trailing slash) is optional, and
5887 * is assumed to be 'p' if missing.
5888 *
5889 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005890 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 * for each line that has a mark. This is required because after deleting
5892 * lines we do not know where to search for the next match.
5893 */
5894 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005895ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896{
5897 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005898 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 int type; /* first char of cmd: 'v' or 'g' */
5900 char_u *cmd; /* command argument */
5901
5902 char_u delim; /* delimiter, normally '/' */
5903 char_u *pat;
5904 regmmatch_T regmatch;
5905 int match;
5906 int which_pat;
5907
5908 if (global_busy)
5909 {
5910 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5911 return;
5912 }
5913
5914 if (eap->forceit) /* ":global!" is like ":vglobal" */
5915 type = 'v';
5916 else
5917 type = *eap->cmd;
5918 cmd = eap->arg;
5919 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920
5921 /*
5922 * undocumented vi feature:
5923 * "\/" and "\?": use previous search pattern.
5924 * "\&": use previous substitute pattern.
5925 */
5926 if (*cmd == '\\')
5927 {
5928 ++cmd;
5929 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5930 {
5931 EMSG(_(e_backslash));
5932 return;
5933 }
5934 if (*cmd == '&')
5935 which_pat = RE_SUBST; /* use previous substitute pattern */
5936 else
5937 which_pat = RE_SEARCH; /* use previous search pattern */
5938 ++cmd;
5939 pat = (char_u *)"";
5940 }
5941 else if (*cmd == NUL)
5942 {
5943 EMSG(_("E148: Regular expression missing from global"));
5944 return;
5945 }
5946 else
5947 {
5948 delim = *cmd; /* get the delimiter */
5949 if (delim)
5950 ++cmd; /* skip delimiter if there is one */
5951 pat = cmd; /* remember start of pattern */
5952 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5953 if (cmd[0] == delim) /* end delimiter found */
5954 *cmd++ = NUL; /* replace it with a NUL */
5955 }
5956
5957#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5958 if (p_altkeymap && curwin->w_p_rl)
5959 lrFswap(pat,0);
5960#endif
5961
5962 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5963 {
5964 EMSG(_(e_invcmd));
5965 return;
5966 }
5967
5968 /*
5969 * pass 1: set marks for each (not) matching line
5970 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5972 {
5973 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005974 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5975 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 if ((type == 'g' && match) || (type == 'v' && !match))
5977 {
5978 ml_setmarked(lnum);
5979 ndone++;
5980 }
5981 line_breakcheck();
5982 }
5983
5984 /*
5985 * pass 2: execute the command for each line that has been marked
5986 */
5987 if (got_int)
5988 MSG(_(e_interr));
5989 else if (ndone == 0)
5990 {
5991 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005992 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01005994 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 }
5996 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005997 {
5998#ifdef FEAT_CLIPBOARD
5999 start_global_changes();
6000#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006002#ifdef FEAT_CLIPBOARD
6003 end_global_changes();
6004#endif
6005 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006
6007 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02006008 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009}
6010
6011/*
6012 * Execute "cmd" on lines marked with ml_setmarked().
6013 */
6014 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006015global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006017 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6018 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6019 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020
6021 /*
6022 * Set current position only once for a global command.
6023 * If global_busy is set, setpcmark() will not do anything.
6024 * If there is an error, global_busy will be incremented.
6025 */
6026 setpcmark();
6027
6028 /* When the command writes a message, don't overwrite the command. */
6029 msg_didout = TRUE;
6030
Bram Moolenaard25bc232010-03-23 17:49:24 +01006031 sub_nsubs = 0;
6032 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 global_need_beginline = FALSE;
6034 global_busy = 1;
6035 old_lcount = curbuf->b_ml.ml_line_count;
6036 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6037 {
6038 curwin->w_cursor.lnum = lnum;
6039 curwin->w_cursor.col = 0;
6040 if (*cmd == NUL || *cmd == '\n')
6041 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
6042 else
6043 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
6044 ui_breakcheck();
6045 }
6046
6047 global_busy = 0;
6048 if (global_need_beginline)
6049 beginline(BL_WHITE | BL_FIX);
6050 else
6051 check_cursor(); /* cursor may be beyond the end of the line */
6052
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006053 /* the cursor may not have moved in the text but a change in a previous
6054 * line may move it on the screen */
6055 changed_line_abv_curs();
6056
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 /* If it looks like no message was written, allow overwriting the
6058 * command with the report for number of changes. */
6059 if (msg_col == 0 && msg_scrolled == 0)
6060 msg_didout = FALSE;
6061
Bram Moolenaar45667512007-05-10 19:24:43 +00006062 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006063 * number of extra or deleted lines.
6064 * Don't report extra or deleted lines in the edge case where the buffer
6065 * we are in after execution is different from the buffer we started in. */
6066 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6068}
6069
6070#ifdef FEAT_VIMINFO
6071 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006072read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006074 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 vim_free(old_sub);
6076 if (force || old_sub == NULL)
6077 old_sub = viminfo_readstring(virp, 1, TRUE);
6078 return viminfo_readline(virp);
6079}
6080
6081 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006082write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083{
6084 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6085 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006086 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 viminfo_writestring(fp, old_sub);
6088 }
6089}
6090#endif /* FEAT_VIMINFO */
6091
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006092#if defined(EXITFREE) || defined(PROTO)
6093 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006094free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006095{
6096 vim_free(old_sub);
6097}
6098#endif
6099
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
6101/*
6102 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006103 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006105 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006106prepare_tagpreview(
6107 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108{
6109 win_T *wp;
6110
6111# ifdef FEAT_GUI
6112 need_mouse_correct = TRUE;
6113# endif
6114
6115 /*
6116 * If there is already a preview window open, use that one.
6117 */
6118 if (!curwin->w_p_pvw)
6119 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006120 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 if (wp->w_p_pvw)
6122 break;
6123 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006124 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 else
6126 {
6127 /*
6128 * There is no preview window open yet. Create one.
6129 */
6130 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6131 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006132 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 curwin->w_p_pvw = TRUE;
6134 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006135 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6136 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137# ifdef FEAT_DIFF
6138 curwin->w_p_diff = FALSE; /* no 'diff' */
6139# endif
6140# ifdef FEAT_FOLDING
6141 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6142# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006143 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 }
6145 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006146 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147}
6148
6149#endif
6150
6151
6152/*
6153 * ":help": open a read-only window on a help file
6154 */
6155 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006156ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157{
6158 char_u *arg;
6159 char_u *tag;
6160 FILE *helpfd; /* file descriptor of help file */
6161 int n;
6162 int i;
6163#ifdef FEAT_WINDOWS
6164 win_T *wp;
6165#endif
6166 int num_matches;
6167 char_u **matches;
6168 char_u *p;
6169 int empty_fnum = 0;
6170 int alt_fnum = 0;
6171 buf_T *buf;
6172#ifdef FEAT_MULTI_LANG
6173 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006174 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006176#ifdef FEAT_FOLDING
6177 int old_KeyTyped = KeyTyped;
6178#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179
6180 if (eap != NULL)
6181 {
6182 /*
6183 * A ":help" command ends at the first LF, or at a '|' that is
6184 * followed by some text. Set nextcmd to the following command.
6185 */
6186 for (arg = eap->arg; *arg; ++arg)
6187 {
6188 if (*arg == '\n' || *arg == '\r'
6189 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6190 {
6191 *arg++ = NUL;
6192 eap->nextcmd = arg;
6193 break;
6194 }
6195 }
6196 arg = eap->arg;
6197
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006198 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 {
6200 EMSG(_("E478: Don't panic!"));
6201 return;
6202 }
6203
6204 if (eap->skip) /* not executing commands */
6205 return;
6206 }
6207 else
6208 arg = (char_u *)"";
6209
6210 /* remove trailing blanks */
6211 p = arg + STRLEN(arg) - 1;
6212 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
6213 *p-- = NUL;
6214
6215#ifdef FEAT_MULTI_LANG
6216 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006217 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218#endif
6219
6220 /* When no argument given go to the index. */
6221 if (*arg == NUL)
6222 arg = (char_u *)"help.txt";
6223
6224 /*
6225 * Check if there is a match for the argument.
6226 */
6227 n = find_help_tags(arg, &num_matches, &matches,
6228 eap != NULL && eap->forceit);
6229
6230 i = 0;
6231#ifdef FEAT_MULTI_LANG
6232 if (n != FAIL && lang != NULL)
6233 /* Find first item with the requested language. */
6234 for (i = 0; i < num_matches; ++i)
6235 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006236 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 if (len > 3 && matches[i][len - 3] == '@'
6238 && STRICMP(matches[i] + len - 2, lang) == 0)
6239 break;
6240 }
6241#endif
6242 if (i >= num_matches || n == FAIL)
6243 {
6244#ifdef FEAT_MULTI_LANG
6245 if (lang != NULL)
6246 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6247 else
6248#endif
6249 EMSG2(_("E149: Sorry, no help for %s"), arg);
6250 if (n != FAIL)
6251 FreeWild(num_matches, matches);
6252 return;
6253 }
6254
6255 /* The first match (in the requested language) is the best match. */
6256 tag = vim_strsave(matches[i]);
6257 FreeWild(num_matches, matches);
6258
6259#ifdef FEAT_GUI
6260 need_mouse_correct = TRUE;
6261#endif
6262
6263 /*
6264 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006265 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006267 if (!curwin->w_buffer->b_help
6268#ifdef FEAT_WINDOWS
6269 || cmdmod.tab != 0
6270#endif
6271 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 {
6273#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006274 if (cmdmod.tab != 0)
6275 wp = NULL;
6276 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006277 FOR_ALL_WINDOWS(wp)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006278 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
6279 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6281 win_enter(wp, TRUE);
6282 else
6283#endif
6284 {
6285 /*
6286 * There is no help window yet.
6287 * Try to open the file specified by the "helpfile" option.
6288 */
6289 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6290 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006291 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 goto erret;
6293 }
6294 fclose(helpfd);
6295
6296#ifdef FEAT_WINDOWS
6297 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006298 * specified, the current window is vertically split and
6299 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006302 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006305 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306#else
6307 /* use current window */
6308 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006310#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311
6312#ifdef FEAT_WINDOWS
6313 if (curwin->w_height < p_hh)
6314 win_setheight((int)p_hh);
6315#endif
6316
6317 /*
6318 * Open help file (do_ecmd() will set b_help flag, readfile() will
6319 * set b_p_ro flag).
6320 * Set the alternate file to the previously edited file.
6321 */
6322 alt_fnum = curbuf->b_fnum;
6323 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006324 ECMD_HIDE + ECMD_SET_HELP,
6325#ifdef FEAT_WINDOWS
6326 NULL /* buffer is still open, don't store info */
6327#else
6328 curwin
6329#endif
6330 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006331 if (!cmdmod.keepalt)
6332 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 empty_fnum = curbuf->b_fnum;
6334 }
6335 }
6336
6337 if (!p_im)
6338 restart_edit = 0; /* don't want insert mode in help file */
6339
Bram Moolenaar8f535582011-09-30 17:30:31 +02006340#ifdef FEAT_FOLDING
6341 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6342 * It is needed for do_tag top open folds under the cursor. */
6343 KeyTyped = old_KeyTyped;
6344#endif
6345
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 if (tag != NULL)
6347 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6348
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006349 /* Delete the empty buffer if we're not using it. Careful: autocommands
6350 * may have jumped to another window, check that the buffer is not in a
6351 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6353 {
6354 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006355 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 wipe_buffer(buf, TRUE);
6357 }
6358
6359 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006360 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 curwin->w_alt_fnum = alt_fnum;
6362
6363erret:
6364 vim_free(tag);
6365}
6366
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006367/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006368 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006369 */
6370 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006371ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006372{
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006373#if defined(FEAT_WINDOWS)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006374 win_T *win;
6375
6376 FOR_ALL_WINDOWS(win)
6377 {
6378 if (win->w_buffer->b_help)
6379 {
6380 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006381 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006382 }
6383 }
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006384#endif
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006385}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006387#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6388/*
6389 * In an argument search for a language specifiers in the form "@xx".
6390 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6391 * Returns NULL if not found.
6392 */
6393 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006394check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006395{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006396 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006397
6398 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6399 && ASCII_ISALPHA(arg[len - 1]))
6400 {
6401 arg[len - 3] = NUL; /* remove the '@' */
6402 return arg + len - 2;
6403 }
6404 return NULL;
6405}
6406#endif
6407
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408/*
6409 * Return a heuristic indicating how well the given string matches. The
6410 * smaller the number, the better the match. This is the order of priorities,
6411 * from best match to worst match:
6412 * - Match with least alpha-numeric characters is better.
6413 * - Match with least total characters is better.
6414 * - Match towards the start is better.
6415 * - Match starting with "+" is worse (feature instead of command)
6416 * Assumption is made that the matched_string passed has already been found to
6417 * match some string for which help is requested. webb.
6418 */
6419 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006420help_heuristic(
6421 char_u *matched_string,
6422 int offset, /* offset for match */
6423 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424{
6425 int num_letters;
6426 char_u *p;
6427
6428 num_letters = 0;
6429 for (p = matched_string; *p; p++)
6430 if (ASCII_ISALNUM(*p))
6431 num_letters++;
6432
6433 /*
6434 * Multiply the number of letters by 100 to give it a much bigger
6435 * weighting than the number of characters.
6436 * If there only is a match while ignoring case, add 5000.
6437 * If the match starts in the middle of a word, add 10000 to put it
6438 * somewhere in the last half.
6439 * If the match is more than 2 chars from the start, multiply by 200 to
6440 * put it after matches at the start.
6441 */
6442 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6443 && ASCII_ISALNUM(matched_string[offset - 1]))
6444 offset += 10000;
6445 else if (offset > 2)
6446 offset *= 200;
6447 if (wrong_case)
6448 offset += 5000;
6449 /* Features are less interesting than the subjects themselves, but "+"
6450 * alone is not a feature. */
6451 if (matched_string[0] == '+' && matched_string[1] != NUL)
6452 offset += 100;
6453 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6454}
6455
6456/*
6457 * Compare functions for qsort() below, that checks the help heuristics number
6458 * that has been put after the tagname by find_tags().
6459 */
6460 static int
6461#ifdef __BORLANDC__
6462_RTLENTRYF
6463#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006464help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465{
6466 char *p1;
6467 char *p2;
6468
6469 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6470 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6471 return strcmp(p1, p2);
6472}
6473
6474/*
6475 * Find all help tags matching "arg", sort them and return in matches[], with
6476 * the number of matches in num_matches.
6477 * The matches will be sorted with a "best" match algorithm.
6478 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6479 */
6480 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006481find_help_tags(
6482 char_u *arg,
6483 int *num_matches,
6484 char_u ***matches,
6485 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486{
6487 char_u *s, *d;
6488 int i;
6489 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006490 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006491 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006492 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006493 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 "[count]", "[quotex]", "[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006495 "[pattern]", "\\|", "\\%$",
6496 "s/\\~", "s/\\U", "s/\\L",
6497 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006499 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006500 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
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]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006505 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006506 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507 int flags;
6508
6509 d = IObuff; /* assume IObuff is long enough! */
6510
6511 /*
6512 * Recognize a few exceptions to the rule. Some strings that contain '*'
6513 * with "star". Otherwise '*' is recognized as a wildcard.
6514 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006515 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 if (STRCMP(arg, mtable[i]) == 0)
6517 {
6518 STRCPY(d, rtable[i]);
6519 break;
6520 }
6521
6522 if (i < 0) /* no match in table */
6523 {
6524 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6525 * Also replace "\%^" and "\%(", they match every tag too.
6526 * Also "\zs", "\z1", etc.
6527 * Also "\@<", "\@=", "\@<=", etc.
6528 * And also "\_$" and "\_^". */
6529 if (arg[0] == '\\'
6530 && ((arg[1] != NUL && arg[2] == NUL)
6531 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6532 && arg[2] != NUL)))
6533 {
6534 STRCPY(d, "/\\\\");
6535 STRCPY(d + 3, arg + 1);
6536 /* Check for "/\\_$", should be "/\\_\$" */
6537 if (d[3] == '_' && d[4] == '$')
6538 STRCPY(d + 4, "\\$");
6539 }
6540 else
6541 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006542 /* Replace:
6543 * "[:...:]" with "\[:...:]"
6544 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006545 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006546 */
6547 if ((arg[0] == '[' && (arg[1] == ':'
6548 || (arg[1] == '+' && arg[2] == '+')))
6549 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 *d++ = '\\';
6551
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006552 /*
6553 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6554 */
6555 if (*arg == '(' && arg[1] == '\'')
6556 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 for (s = arg; *s; ++s)
6558 {
6559 /*
6560 * Replace "|" with "bar" and '"' with "quote" to match the name of
6561 * the tags for these commands.
6562 * Replace "*" with ".*" and "?" with "." to match command line
6563 * completion.
6564 * Insert a backslash before '~', '$' and '.' to avoid their
6565 * special meaning.
6566 */
6567 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6568 break;
6569 switch (*s)
6570 {
6571 case '|': STRCPY(d, "bar");
6572 d += 3;
6573 continue;
6574 case '"': STRCPY(d, "quote");
6575 d += 5;
6576 continue;
6577 case '*': *d++ = '.';
6578 break;
6579 case '?': *d++ = '.';
6580 continue;
6581 case '$':
6582 case '.':
6583 case '~': *d++ = '\\';
6584 break;
6585 }
6586
6587 /*
6588 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6589 * ":help i_^_CTRL-D" work.
6590 * Insert '-' before and after "CTRL-X" when applicable.
6591 */
6592 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6593 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6594 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006595 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6596 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 STRCPY(d, "CTRL-");
6598 d += 5;
6599 if (*s < ' ')
6600 {
6601#ifdef EBCDIC
6602 *d++ = CtrlChar(*s);
6603#else
6604 *d++ = *s + '@';
6605#endif
6606 if (d[-1] == '\\')
6607 *d++ = '\\'; /* double a backslash */
6608 }
6609 else
6610 *d++ = *++s;
6611 if (s[1] != NUL && s[1] != '_')
6612 *d++ = '_'; /* append a '_' */
6613 continue;
6614 }
6615 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6616 *d++ = '\\';
6617
6618 /*
6619 * Insert a backslash before a backslash after a slash, for search
6620 * pattern tags: "/\|" --> "/\\|".
6621 */
6622 else if (s[0] == '\\' && s[1] != '\\'
6623 && *arg == '/' && s == arg + 1)
6624 *d++ = '\\';
6625
6626 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6627 * "CTRL-\_CTRL-N" */
6628 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6629 {
6630 STRCPY(d, "CTRL-\\\\");
6631 d += 7;
6632 s += 6;
6633 }
6634
6635 *d++ = *s;
6636
6637 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006638 * If tag contains "({" or "([", tag terminates at the "(".
6639 * This is for help on functions, e.g.: abs({expr}).
6640 */
6641 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6642 break;
6643
6644 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 * If tag starts with ', toss everything after a second '. Fixes
6646 * CTRL-] on 'option'. (would include the trailing '.').
6647 */
6648 if (*s == '\'' && s > arg && *arg == '\'')
6649 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006650 /* Also '{' and '}'. */
6651 if (*s == '}' && s > arg && *arg == '{')
6652 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 }
6654 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006655
6656 if (*IObuff == '`')
6657 {
6658 if (d > IObuff + 2 && d[-1] == '`')
6659 {
6660 /* remove the backticks from `command` */
6661 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6662 d[-2] = NUL;
6663 }
6664 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6665 {
6666 /* remove the backticks and comma from `command`, */
6667 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6668 d[-3] = NUL;
6669 }
6670 else if (d > IObuff + 4 && d[-3] == '`'
6671 && d[-2] == '\\' && d[-1] == '.')
6672 {
6673 /* remove the backticks and dot from `command`\. */
6674 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6675 d[-4] = NUL;
6676 }
6677 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 }
6679 }
6680
6681 *matches = (char_u **)"";
6682 *num_matches = 0;
6683 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6684 if (keep_lang)
6685 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006686 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006688 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 /* Sort the matches found on the heuristic number that is after the
6690 * tag name. */
6691 qsort((void *)*matches, (size_t)*num_matches,
6692 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006693 /* Delete more than TAG_MANY to reduce the size of the listing. */
6694 while (*num_matches > TAG_MANY)
6695 vim_free((*matches)[--*num_matches]);
6696 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 return OK;
6698}
6699
6700/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006701 * Called when starting to edit a buffer for a help file.
6702 */
6703 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006704prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006705{
6706 char_u *p;
6707
6708 curbuf->b_help = TRUE;
6709#ifdef FEAT_QUICKFIX
6710 set_string_option_direct((char_u *)"buftype", -1,
6711 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6712#endif
6713
6714 /*
6715 * Always set these options after jumping to a help tag, because the
6716 * user may have an autocommand that gets in the way.
6717 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6718 * latin1 word characters (for translated help files).
6719 * Only set it when needed, buf_init_chartab() is some work.
6720 */
6721 p =
6722#ifdef EBCDIC
6723 (char_u *)"65-255,^*,^|,^\"";
6724#else
6725 (char_u *)"!-~,^*,^|,^\",192-255";
6726#endif
6727 if (STRCMP(curbuf->b_p_isk, p) != 0)
6728 {
6729 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6730 check_buf_options(curbuf);
6731 (void)buf_init_chartab(curbuf, FALSE);
6732 }
6733
Bram Moolenaar0b105412014-11-30 13:34:23 +01006734#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006735 /* Don't use the global foldmethod.*/
6736 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6737 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006738#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006739
6740 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6741 curwin->w_p_list = FALSE; /* no list mode */
6742
6743 curbuf->b_p_ma = FALSE; /* not modifiable */
6744 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6745 curwin->w_p_nu = 0; /* no line numbers */
6746 curwin->w_p_rnu = 0; /* no relative line numbers */
6747 RESET_BINDING(curwin); /* no scroll or cursor binding */
6748#ifdef FEAT_ARABIC
6749 curwin->w_p_arab = FALSE; /* no arabic mode */
6750#endif
6751#ifdef FEAT_RIGHTLEFT
6752 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6753#endif
6754#ifdef FEAT_FOLDING
6755 curwin->w_p_fen = FALSE; /* No folding in the help window */
6756#endif
6757#ifdef FEAT_DIFF
6758 curwin->w_p_diff = FALSE; /* No 'diff' */
6759#endif
6760#ifdef FEAT_SPELL
6761 curwin->w_p_spell = FALSE; /* No spell checking */
6762#endif
6763
6764 set_buflisted(FALSE);
6765}
6766
6767/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 * After reading a help file: May cleanup a help buffer when syntax
6769 * highlighting is not used.
6770 */
6771 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006772fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773{
6774 linenr_T lnum;
6775 char_u *line;
6776 int in_example = FALSE;
6777 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006778 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 char_u *p;
6780 char_u *rt;
6781 int mustfree;
6782
6783 /* set filetype to "help". */
6784 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6785
6786#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006787 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788#endif
6789 {
6790 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6791 {
6792 line = ml_get_buf(curbuf, lnum, FALSE);
6793 len = (int)STRLEN(line);
6794 if (in_example && len > 0 && !vim_iswhite(line[0]))
6795 {
6796 /* End of example: non-white or '<' in first column. */
6797 if (line[0] == '<')
6798 {
6799 /* blank-out a '<' in the first column */
6800 line = ml_get_buf(curbuf, lnum, TRUE);
6801 line[0] = ' ';
6802 }
6803 in_example = FALSE;
6804 }
6805 if (!in_example && len > 0)
6806 {
6807 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6808 {
6809 /* blank-out a '>' in the last column (start of example) */
6810 line = ml_get_buf(curbuf, lnum, TRUE);
6811 line[len - 1] = ' ';
6812 in_example = TRUE;
6813 }
6814 else if (line[len - 1] == '~')
6815 {
6816 /* blank-out a '~' at the end of line (header marker) */
6817 line = ml_get_buf(curbuf, lnum, TRUE);
6818 line[len - 1] = ' ';
6819 }
6820 }
6821 }
6822 }
6823
6824 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006825 * In the "help.txt" and "help.abx" file, add the locally added help
6826 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006828 fname = gettail(curbuf->b_fname);
6829 if (fnamecmp(fname, "help.txt") == 0
6830#ifdef FEAT_MULTI_LANG
6831 || (fnamencmp(fname, "help.", 5) == 0
6832 && ASCII_ISALPHA(fname[5])
6833 && ASCII_ISALPHA(fname[6])
6834 && TOLOWER_ASC(fname[7]) == 'x'
6835 && fname[8] == NUL)
6836#endif
6837 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 {
6839 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6840 {
6841 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006842 if (strstr((char *)line, "*local-additions*") == NULL)
6843 continue;
6844
6845 /* Go through all directories in 'runtimepath', skipping
6846 * $VIMRUNTIME. */
6847 p = p_rtp;
6848 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006850 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6851 mustfree = FALSE;
6852 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6853 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006855 int fcount;
6856 char_u **fnames;
6857 FILE *fd;
6858 char_u *s;
6859 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006861 vimconv_T vc;
6862 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863#endif
6864
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006865 /* Find all "doc/ *.txt" files in this directory. */
6866 add_pathsep(NameBuff);
6867#ifdef FEAT_MULTI_LANG
6868 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006870 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006872 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6873 &fnames, EW_FILE|EW_SILENT) == OK
6874 && fcount > 0)
6875 {
6876#ifdef FEAT_MULTI_LANG
6877 int i1;
6878 int i2;
6879 char_u *f1;
6880 char_u *f2;
6881 char_u *t1;
6882 char_u *e1;
6883 char_u *e2;
6884
6885 /* If foo.abx is found use it instead of foo.txt in
6886 * the same directory. */
6887 for (i1 = 0; i1 < fcount; ++i1)
6888 {
6889 for (i2 = 0; i2 < fcount; ++i2)
6890 {
6891 if (i1 == i2)
6892 continue;
6893 if (fnames[i1] == NULL || fnames[i2] == NULL)
6894 continue;
6895 f1 = fnames[i1];
6896 f2 = fnames[i2];
6897 t1 = gettail(f1);
6898 if (fnamencmp(f1, f2, t1 - f1) != 0)
6899 continue;
6900 e1 = vim_strrchr(t1, '.');
6901 e2 = vim_strrchr(gettail(f2), '.');
6902 if (e1 == NUL || e2 == NUL)
6903 continue;
6904 if (fnamecmp(e1, ".txt") != 0
6905 && fnamecmp(e1, fname + 4) != 0)
6906 {
6907 /* Not .txt and not .abx, remove it. */
6908 vim_free(fnames[i1]);
6909 fnames[i1] = NULL;
6910 continue;
6911 }
6912 if (fnamencmp(f1, f2, e1 - f1) != 0)
6913 continue;
6914 if (fnamecmp(e1, ".txt") == 0
6915 && fnamecmp(e2, fname + 4) == 0)
6916 {
6917 /* use .abx instead of .txt */
6918 vim_free(fnames[i1]);
6919 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 }
6921 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006923#endif
6924 for (fi = 0; fi < fcount; ++fi)
6925 {
6926 if (fnames[fi] == NULL)
6927 continue;
6928 fd = mch_fopen((char *)fnames[fi], "r");
6929 if (fd != NULL)
6930 {
6931 vim_fgets(IObuff, IOSIZE, fd);
6932 if (IObuff[0] == '*'
6933 && (s = vim_strchr(IObuff + 1, '*'))
6934 != NULL)
6935 {
6936#ifdef FEAT_MBYTE
6937 int this_utf = MAYBE;
6938#endif
6939 /* Change tag definition to a
6940 * reference and remove <CR>/<NL>. */
6941 IObuff[0] = '|';
6942 *s = '|';
6943 while (*s != NUL)
6944 {
6945 if (*s == '\r' || *s == '\n')
6946 *s = NUL;
6947#ifdef FEAT_MBYTE
6948 /* The text is utf-8 when a byte
6949 * above 127 is found and no
6950 * illegal byte sequence is found.
6951 */
6952 if (*s >= 0x80 && this_utf != FALSE)
6953 {
6954 int l;
6955
6956 this_utf = TRUE;
6957 l = utf_ptr2len(s);
6958 if (l == 1)
6959 this_utf = FALSE;
6960 s += l - 1;
6961 }
6962#endif
6963 ++s;
6964 }
6965#ifdef FEAT_MBYTE
6966 /* The help file is latin1 or utf-8;
6967 * conversion to the current
6968 * 'encoding' may be required. */
6969 vc.vc_type = CONV_NONE;
6970 convert_setup(&vc, (char_u *)(
6971 this_utf == TRUE ? "utf-8"
6972 : "latin1"), p_enc);
6973 if (vc.vc_type == CONV_NONE)
6974 /* No conversion needed. */
6975 cp = IObuff;
6976 else
6977 {
6978 /* Do the conversion. If it fails
6979 * use the unconverted text. */
6980 cp = string_convert(&vc, IObuff,
6981 NULL);
6982 if (cp == NULL)
6983 cp = IObuff;
6984 }
6985 convert_setup(&vc, NULL, NULL);
6986
6987 ml_append(lnum, cp, (colnr_T)0, FALSE);
6988 if (cp != IObuff)
6989 vim_free(cp);
6990#else
6991 ml_append(lnum, IObuff, (colnr_T)0,
6992 FALSE);
6993#endif
6994 ++lnum;
6995 }
6996 fclose(fd);
6997 }
6998 }
6999 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007002 if (mustfree)
7003 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007005 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 }
7007 }
7008}
7009
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007010/*
7011 * ":exusage"
7012 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007013 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007014ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007015{
7016 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7017}
7018
7019/*
7020 * ":viusage"
7021 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007022 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007023ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007024{
7025 do_cmdline_cmd((char_u *)"help normal-index");
7026}
7027
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007029 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007032helptags_one(
7033 char_u *dir, /* doc directory */
7034 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7035 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7036 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037{
7038 FILE *fd_tags;
7039 FILE *fd;
7040 garray_T ga;
7041 int filecount;
7042 char_u **files;
7043 char_u *p1, *p2;
7044 int fi;
7045 char_u *s;
7046 int i;
7047 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007048 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049# ifdef FEAT_MBYTE
7050 int utf8 = MAYBE;
7051 int this_utf8;
7052 int firstline;
7053 int mix = FALSE; /* detected mixed encodings */
7054# endif
7055
7056 /*
7057 * Find all *.txt files.
7058 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007059 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007061 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 STRCAT(NameBuff, ext);
7063 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7064 EW_FILE|EW_SILENT) == FAIL
7065 || filecount == 0)
7066 {
7067 if (!got_int)
7068 EMSG2("E151: No match: %s", NameBuff);
7069 return;
7070 }
7071
7072 /*
7073 * Open the tags file for writing.
7074 * Do this before scanning through all the files.
7075 */
7076 STRCPY(NameBuff, dir);
7077 add_pathsep(NameBuff);
7078 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007079 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 if (fd_tags == NULL)
7081 {
7082 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7083 FreeWild(filecount, files);
7084 return;
7085 }
7086
7087 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007088 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7089 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 */
7091 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007092 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7093 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 {
7095 if (ga_grow(&ga, 1) == FAIL)
7096 got_int = TRUE;
7097 else
7098 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007099 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 if (s == NULL)
7101 got_int = TRUE;
7102 else
7103 {
7104 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7105 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7106 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 }
7108 }
7109 }
7110
7111 /*
7112 * Go over all the files and extract the tags.
7113 */
7114 for (fi = 0; fi < filecount && !got_int; ++fi)
7115 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007116 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 if (fd == NULL)
7118 {
7119 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7120 continue;
7121 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007122 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123
7124# ifdef FEAT_MBYTE
7125 firstline = TRUE;
7126# endif
7127 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7128 {
7129# ifdef FEAT_MBYTE
7130 if (firstline)
7131 {
7132 /* Detect utf-8 file by a non-ASCII char in the first line. */
7133 this_utf8 = MAYBE;
7134 for (s = IObuff; *s != NUL; ++s)
7135 if (*s >= 0x80)
7136 {
7137 int l;
7138
7139 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007140 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 if (l == 1)
7142 {
7143 /* Illegal UTF-8 byte sequence. */
7144 this_utf8 = FALSE;
7145 break;
7146 }
7147 s += l - 1;
7148 }
7149 if (this_utf8 == MAYBE) /* only ASCII characters found */
7150 this_utf8 = FALSE;
7151 if (utf8 == MAYBE) /* first file */
7152 utf8 = this_utf8;
7153 else if (utf8 != this_utf8)
7154 {
7155 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7156 mix = !got_int;
7157 got_int = TRUE;
7158 }
7159 firstline = FALSE;
7160 }
7161# endif
7162 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7163 while (p1 != NULL)
7164 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007165 /* Use vim_strbyte() instead of vim_strchr() so that when
7166 * 'encoding' is dbcs it still works, don't find '*' in the
7167 * second byte. */
7168 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7170 {
7171 for (s = p1 + 1; s < p2; ++s)
7172 if (*s == ' ' || *s == '\t' || *s == '|')
7173 break;
7174
7175 /*
7176 * Only accept a *tag* when it consists of valid
7177 * characters, there is white space before it and is
7178 * followed by a white character or end-of-line.
7179 */
7180 if (s == p2
7181 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7182 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7183 || s[1] == '\0'))
7184 {
7185 *p2 = '\0';
7186 ++p1;
7187 if (ga_grow(&ga, 1) == FAIL)
7188 {
7189 got_int = TRUE;
7190 break;
7191 }
7192 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7193 if (s == NULL)
7194 {
7195 got_int = TRUE;
7196 break;
7197 }
7198 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7199 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 sprintf((char *)s, "%s\t%s", p1, fname);
7201
7202 /* find next '*' */
7203 p2 = vim_strchr(p2 + 1, '*');
7204 }
7205 }
7206 p1 = p2;
7207 }
7208 line_breakcheck();
7209 }
7210
7211 fclose(fd);
7212 }
7213
7214 FreeWild(filecount, files);
7215
7216 if (!got_int)
7217 {
7218 /*
7219 * Sort the tags.
7220 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007221 if (ga.ga_data != NULL)
7222 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223
7224 /*
7225 * Check for duplicates.
7226 */
7227 for (i = 1; i < ga.ga_len; ++i)
7228 {
7229 p1 = ((char_u **)ga.ga_data)[i - 1];
7230 p2 = ((char_u **)ga.ga_data)[i];
7231 while (*p1 == *p2)
7232 {
7233 if (*p2 == '\t')
7234 {
7235 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007236 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7238 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7239 EMSG(NameBuff);
7240 *p2 = '\t';
7241 break;
7242 }
7243 ++p1;
7244 ++p2;
7245 }
7246 }
7247
7248# ifdef FEAT_MBYTE
7249 if (utf8 == TRUE)
7250 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7251# endif
7252
7253 /*
7254 * Write the tags into the file.
7255 */
7256 for (i = 0; i < ga.ga_len; ++i)
7257 {
7258 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007259 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007261 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 else
7263 {
7264 fprintf(fd_tags, "%s\t/*", s);
7265 for (p1 = s; *p1 != '\t'; ++p1)
7266 {
7267 /* insert backslash before '\\' and '/' */
7268 if (*p1 == '\\' || *p1 == '/')
7269 putc('\\', fd_tags);
7270 putc(*p1, fd_tags);
7271 }
7272 fprintf(fd_tags, "*\n");
7273 }
7274 }
7275 }
7276#ifdef FEAT_MBYTE
7277 if (mix)
7278 got_int = FALSE; /* continue with other languages */
7279#endif
7280
7281 for (i = 0; i < ga.ga_len; ++i)
7282 vim_free(((char_u **)ga.ga_data)[i]);
7283 ga_clear(&ga);
7284 fclose(fd_tags); /* there is no check for an error... */
7285}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007287/*
7288 * Generate tags in one help directory, taking care of translations.
7289 */
7290 static void
7291do_helptags(char_u *dirname, int add_help_tags)
7292{
7293#ifdef FEAT_MULTI_LANG
7294 int len;
7295 int i, j;
7296 garray_T ga;
7297 char_u lang[2];
7298 char_u ext[5];
7299 char_u fname[8];
7300 int filecount;
7301 char_u **files;
7302
7303 /* Get a list of all files in the help directory and in subdirectories. */
7304 STRCPY(NameBuff, dirname);
7305 add_pathsep(NameBuff);
7306 STRCAT(NameBuff, "**");
7307 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7308 EW_FILE|EW_SILENT) == FAIL
7309 || filecount == 0)
7310 {
7311 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007312 return;
7313 }
7314
7315 /* Go over all files in the directory to find out what languages are
7316 * present. */
7317 ga_init2(&ga, 1, 10);
7318 for (i = 0; i < filecount; ++i)
7319 {
7320 len = (int)STRLEN(files[i]);
7321 if (len > 4)
7322 {
7323 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7324 {
7325 /* ".txt" -> language "en" */
7326 lang[0] = 'e';
7327 lang[1] = 'n';
7328 }
7329 else if (files[i][len - 4] == '.'
7330 && ASCII_ISALPHA(files[i][len - 3])
7331 && ASCII_ISALPHA(files[i][len - 2])
7332 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7333 {
7334 /* ".abx" -> language "ab" */
7335 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7336 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7337 }
7338 else
7339 continue;
7340
7341 /* Did we find this language already? */
7342 for (j = 0; j < ga.ga_len; j += 2)
7343 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7344 break;
7345 if (j == ga.ga_len)
7346 {
7347 /* New language, add it. */
7348 if (ga_grow(&ga, 2) == FAIL)
7349 break;
7350 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7351 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7352 }
7353 }
7354 }
7355
7356 /*
7357 * Loop over the found languages to generate a tags file for each one.
7358 */
7359 for (j = 0; j < ga.ga_len; j += 2)
7360 {
7361 STRCPY(fname, "tags-xx");
7362 fname[5] = ((char_u *)ga.ga_data)[j];
7363 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7364 if (fname[5] == 'e' && fname[6] == 'n')
7365 {
7366 /* English is an exception: use ".txt" and "tags". */
7367 fname[4] = NUL;
7368 STRCPY(ext, ".txt");
7369 }
7370 else
7371 {
7372 /* Language "ab" uses ".abx" and "tags-ab". */
7373 STRCPY(ext, ".xxx");
7374 ext[1] = fname[5];
7375 ext[2] = fname[6];
7376 }
7377 helptags_one(dirname, ext, fname, add_help_tags);
7378 }
7379
7380 ga_clear(&ga);
7381 FreeWild(filecount, files);
7382
7383#else
7384 /* No language support, just use "*.txt" and "tags". */
7385 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7386#endif
7387}
7388
7389 static void
7390helptags_cb(char_u *fname, void *cookie)
7391{
7392 do_helptags(fname, *(int *)cookie);
7393}
7394
7395/*
7396 * ":helptags"
7397 */
7398 void
7399ex_helptags(exarg_T *eap)
7400{
7401 expand_T xpc;
7402 char_u *dirname;
7403 int add_help_tags = FALSE;
7404
7405 /* Check for ":helptags ++t {dir}". */
7406 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
7407 {
7408 add_help_tags = TRUE;
7409 eap->arg = skipwhite(eap->arg + 3);
7410 }
7411
7412 if (STRCMP(eap->arg, "ALL") == 0)
7413 {
7414 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7415 helptags_cb, &add_help_tags);
7416 }
7417 else
7418 {
7419 ExpandInit(&xpc);
7420 xpc.xp_context = EXPAND_DIRECTORIES;
7421 dirname = ExpandOne(&xpc, eap->arg, NULL,
7422 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7423 if (dirname == NULL || !mch_isdir(dirname))
7424 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7425 else
7426 do_helptags(dirname, add_help_tags);
7427 vim_free(dirname);
7428 }
7429}
7430
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431#if defined(FEAT_SIGNS) || defined(PROTO)
7432
7433/*
7434 * Struct to hold the sign properties.
7435 */
7436typedef struct sign sign_T;
7437
7438struct sign
7439{
7440 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007441 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 char_u *sn_name; /* name of sign */
7443 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007444# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007446# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 char_u *sn_text; /* text used instead of pixmap */
7448 int sn_line_hl; /* highlight ID for line */
7449 int sn_text_hl; /* highlight ID for text */
7450};
7451
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007453static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007455static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7456static void sign_list_defined(sign_T *sp);
7457static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007459static char *cmds[] = {
7460 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007461# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007462 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007463# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007464 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007465# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007466 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007467# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007468 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007469# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007470 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007471# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007472 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007473# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007474};
7475
7476/*
7477 * Find index of a ":sign" subcmd from its name.
7478 * "*end_cmd" must be writable.
7479 */
7480 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007481sign_cmd_idx(
7482 char_u *begin_cmd, /* begin of sign subcmd */
7483 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007484{
7485 int idx;
7486 char save = *end_cmd;
7487
7488 *end_cmd = NUL;
7489 for (idx = 0; ; ++idx)
7490 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7491 break;
7492 *end_cmd = save;
7493 return idx;
7494}
7495
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496/*
7497 * ":sign" command
7498 */
7499 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007500ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501{
7502 char_u *arg = eap->arg;
7503 char_u *p;
7504 int idx;
7505 sign_T *sp;
7506 sign_T *sp_prev;
7507 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508
7509 /* Parse the subcommand. */
7510 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007511 idx = sign_cmd_idx(arg, p);
7512 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007514 EMSG2(_("E160: Unknown sign command: %s"), arg);
7515 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 }
7517 arg = skipwhite(p);
7518
7519 if (idx <= SIGNCMD_LIST)
7520 {
7521 /*
7522 * Define, undefine or list signs.
7523 */
7524 if (idx == SIGNCMD_LIST && *arg == NUL)
7525 {
7526 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007527 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 sign_list_defined(sp);
7529 }
7530 else if (*arg == NUL)
7531 EMSG(_("E156: Missing sign name"));
7532 else
7533 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007534 /* Isolate the sign name. If it's a number skip leading zeroes,
7535 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 p = skiptowhite(arg);
7537 if (*p != NUL)
7538 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007539 while (arg[0] == '0' && arg[1] != NUL)
7540 ++arg;
7541
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 sp_prev = NULL;
7543 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7544 {
7545 if (STRCMP(sp->sn_name, arg) == 0)
7546 break;
7547 sp_prev = sp;
7548 }
7549 if (idx == SIGNCMD_DEFINE)
7550 {
7551 /* ":sign define {name} ...": define a sign */
7552 if (sp == NULL)
7553 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007554 sign_T *lp;
7555 int start = next_sign_typenr;
7556
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 /* Allocate a new sign. */
7558 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7559 if (sp == NULL)
7560 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007562 /* Check that next_sign_typenr is not already being used.
7563 * This only happens after wrapping around. Hopefully
7564 * another one got deleted and we can use its number. */
7565 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007567 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007569 ++next_sign_typenr;
7570 if (next_sign_typenr == MAX_TYPENR)
7571 next_sign_typenr = 1;
7572 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007574 vim_free(sp);
7575 EMSG(_("E612: Too many signs defined"));
7576 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007578 lp = first_sign; /* start all over */
7579 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007581 lp = lp->sn_next;
7582 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007584 sp->sn_typenr = next_sign_typenr;
7585 if (++next_sign_typenr == MAX_TYPENR)
7586 next_sign_typenr = 1; /* wrap around */
7587
7588 sp->sn_name = vim_strsave(arg);
7589 if (sp->sn_name == NULL) /* out of memory */
7590 {
7591 vim_free(sp);
7592 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007594
7595 /* add the new sign to the list of signs */
7596 if (sp_prev == NULL)
7597 first_sign = sp;
7598 else
7599 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 }
7601
7602 /* set values for a defined sign. */
7603 for (;;)
7604 {
7605 arg = skipwhite(p);
7606 if (*arg == NUL)
7607 break;
7608 p = skiptowhite_esc(arg);
7609 if (STRNCMP(arg, "icon=", 5) == 0)
7610 {
7611 arg += 5;
7612 vim_free(sp->sn_icon);
7613 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7614 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007615# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 if (gui.in_use)
7617 {
7618 out_flush();
7619 if (sp->sn_image != NULL)
7620 gui_mch_destroy_sign(sp->sn_image);
7621 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7622 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007623# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 }
7625 else if (STRNCMP(arg, "text=", 5) == 0)
7626 {
7627 char_u *s;
7628 int cells;
7629 int len;
7630
7631 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007632# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 /* Count cells and check for non-printable chars */
7634 if (has_mbyte)
7635 {
7636 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007637 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 {
7639 if (!vim_isprintc((*mb_ptr2char)(s)))
7640 break;
7641 cells += (*mb_ptr2cells)(s);
7642 }
7643 }
7644 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007645# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 {
7647 for (s = arg; s < p; ++s)
7648 if (!vim_isprintc(*s))
7649 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007650 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 }
7652 /* Currently must be one or two display cells */
7653 if (s != p || cells < 1 || cells > 2)
7654 {
7655 *p = NUL;
7656 EMSG2(_("E239: Invalid sign text: %s"), arg);
7657 return;
7658 }
7659
7660 vim_free(sp->sn_text);
7661 /* Allocate one byte more if we need to pad up
7662 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007663 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 sp->sn_text = vim_strnsave(arg, len);
7665
7666 if (sp->sn_text != NULL && cells == 1)
7667 STRCPY(sp->sn_text + len - 1, " ");
7668 }
7669 else if (STRNCMP(arg, "linehl=", 7) == 0)
7670 {
7671 arg += 7;
7672 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7673 }
7674 else if (STRNCMP(arg, "texthl=", 7) == 0)
7675 {
7676 arg += 7;
7677 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7678 }
7679 else
7680 {
7681 EMSG2(_(e_invarg2), arg);
7682 return;
7683 }
7684 }
7685 }
7686 else if (sp == NULL)
7687 EMSG2(_("E155: Unknown sign: %s"), arg);
7688 else if (idx == SIGNCMD_LIST)
7689 /* ":sign list {name}" */
7690 sign_list_defined(sp);
7691 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007693 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 }
7695 }
7696 else
7697 {
7698 int id = -1;
7699 linenr_T lnum = -1;
7700 char_u *sign_name = NULL;
7701 char_u *arg1;
7702
7703 if (*arg == NUL)
7704 {
7705 if (idx == SIGNCMD_PLACE)
7706 {
7707 /* ":sign place": list placed signs in all buffers */
7708 sign_list_placed(NULL);
7709 }
7710 else if (idx == SIGNCMD_UNPLACE)
7711 {
7712 /* ":sign unplace": remove placed sign at cursor */
7713 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7714 if (id > 0)
7715 {
7716 buf_delsign(curwin->w_buffer, id);
7717 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7718 }
7719 else
7720 EMSG(_("E159: Missing sign number"));
7721 }
7722 else
7723 EMSG(_(e_argreq));
7724 return;
7725 }
7726
7727 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7728 {
7729 /* ":sign unplace *": remove all placed signs */
7730 buf_delete_all_signs();
7731 return;
7732 }
7733
7734 /* first arg could be placed sign id */
7735 arg1 = arg;
7736 if (VIM_ISDIGIT(*arg))
7737 {
7738 id = getdigits(&arg);
7739 if (!vim_iswhite(*arg) && *arg != NUL)
7740 {
7741 id = -1;
7742 arg = arg1;
7743 }
7744 else
7745 {
7746 arg = skipwhite(arg);
7747 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7748 {
7749 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007750 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 if ((lnum = buf_delsign(buf, id)) != 0)
7752 update_debug_sign(buf, lnum);
7753 return;
7754 }
7755 }
7756 }
7757
7758 /*
7759 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7760 * Leave "arg" pointing to {fname}.
7761 */
7762 for (;;)
7763 {
7764 if (STRNCMP(arg, "line=", 5) == 0)
7765 {
7766 arg += 5;
7767 lnum = atoi((char *)arg);
7768 arg = skiptowhite(arg);
7769 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007770 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7771 {
7772 if (id != -1)
7773 {
7774 EMSG(_(e_invarg));
7775 return;
7776 }
7777 id = -2;
7778 arg = skiptowhite(arg + 1);
7779 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 else if (STRNCMP(arg, "name=", 5) == 0)
7781 {
7782 arg += 5;
7783 sign_name = arg;
7784 arg = skiptowhite(arg);
7785 if (*arg != NUL)
7786 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007787 while (sign_name[0] == '0' && sign_name[1] != NUL)
7788 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 }
7790 else if (STRNCMP(arg, "file=", 5) == 0)
7791 {
7792 arg += 5;
7793 buf = buflist_findname(arg);
7794 break;
7795 }
7796 else if (STRNCMP(arg, "buffer=", 7) == 0)
7797 {
7798 arg += 7;
7799 buf = buflist_findnr((int)getdigits(&arg));
7800 if (*skipwhite(arg) != NUL)
7801 EMSG(_(e_trailing));
7802 break;
7803 }
7804 else
7805 {
7806 EMSG(_(e_invarg));
7807 return;
7808 }
7809 arg = skipwhite(arg);
7810 }
7811
7812 if (buf == NULL)
7813 {
7814 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7815 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007816 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 {
7818 if (lnum >= 0 || sign_name != NULL)
7819 EMSG(_(e_invarg));
7820 else
7821 /* ":sign place file={fname}": list placed signs in one file */
7822 sign_list_placed(buf);
7823 }
7824 else if (idx == SIGNCMD_JUMP)
7825 {
7826 /* ":sign jump {id} file={fname}" */
7827 if (lnum >= 0 || sign_name != NULL)
7828 EMSG(_(e_invarg));
7829 else if ((lnum = buf_findsign(buf, id)) > 0)
7830 { /* goto a sign ... */
7831 if (buf_jump_open_win(buf) != NULL)
7832 { /* ... in a current window */
7833 curwin->w_cursor.lnum = lnum;
7834 check_cursor_lnum();
7835 beginline(BL_WHITE);
7836 }
7837 else
7838 { /* ... not currently in a window */
7839 char_u *cmd;
7840
7841 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7842 if (cmd == NULL)
7843 return;
7844 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7845 do_cmdline_cmd(cmd);
7846 vim_free(cmd);
7847 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007848# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007850# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 }
7852 else
7853 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7854 }
7855 else if (idx == SIGNCMD_UNPLACE)
7856 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 if (lnum >= 0 || sign_name != NULL)
7858 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007859 else if (id == -2)
7860 {
7861 /* ":sign unplace * file={fname}" */
7862 redraw_buf_later(buf, NOT_VALID);
7863 buf_delete_signs(buf);
7864 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 else
7866 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007867 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 lnum = buf_delsign(buf, id);
7869 update_debug_sign(buf, lnum);
7870 }
7871 }
7872 /* idx == SIGNCMD_PLACE */
7873 else if (sign_name != NULL)
7874 {
7875 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7876 if (STRCMP(sp->sn_name, sign_name) == 0)
7877 break;
7878 if (sp == NULL)
7879 {
7880 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7881 return;
7882 }
7883 if (lnum > 0)
7884 /* ":sign place {id} line={lnum} name={name} file={fname}":
7885 * place a sign */
7886 buf_addsign(buf, id, lnum, sp->sn_typenr);
7887 else
7888 /* ":sign place {id} file={fname}": change sign type */
7889 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007890 if (lnum > 0)
7891 update_debug_sign(buf, lnum);
7892 else
7893 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 }
7895 else
7896 EMSG(_(e_invarg));
7897 }
7898}
7899
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007900# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901/*
7902 * Allocate the icons. Called when the GUI has started. Allows defining
7903 * signs before it starts.
7904 */
7905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007906sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907{
7908 sign_T *sp;
7909
7910 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7911 if (sp->sn_icon != NULL)
7912 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7913}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007914# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915
7916/*
7917 * List one sign.
7918 */
7919 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007920sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921{
7922 char_u *p;
7923
Bram Moolenaar555b2802005-05-19 21:08:39 +00007924 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 if (sp->sn_icon != NULL)
7926 {
7927 MSG_PUTS(" icon=");
7928 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007929# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 if (sp->sn_image == NULL)
7931 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007932# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007934# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 }
7936 if (sp->sn_text != NULL)
7937 {
7938 MSG_PUTS(" text=");
7939 msg_outtrans(sp->sn_text);
7940 }
7941 if (sp->sn_line_hl > 0)
7942 {
7943 MSG_PUTS(" linehl=");
7944 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7945 if (p == NULL)
7946 MSG_PUTS("NONE");
7947 else
7948 msg_puts(p);
7949 }
7950 if (sp->sn_text_hl > 0)
7951 {
7952 MSG_PUTS(" texthl=");
7953 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7954 if (p == NULL)
7955 MSG_PUTS("NONE");
7956 else
7957 msg_puts(p);
7958 }
7959}
7960
7961/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007962 * Undefine a sign and free its memory.
7963 */
7964 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007965sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007966{
7967 vim_free(sp->sn_name);
7968 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007969# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007970 if (sp->sn_image != NULL)
7971 {
7972 out_flush();
7973 gui_mch_destroy_sign(sp->sn_image);
7974 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007975# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007976 vim_free(sp->sn_text);
7977 if (sp_prev == NULL)
7978 first_sign = sp->sn_next;
7979 else
7980 sp_prev->sn_next = sp->sn_next;
7981 vim_free(sp);
7982}
7983
7984/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 * Get highlighting attribute for sign "typenr".
7986 * If "line" is TRUE: line highl, if FALSE: text highl.
7987 */
7988 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007989sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990{
7991 sign_T *sp;
7992
7993 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7994 if (sp->sn_typenr == typenr)
7995 {
7996 if (line)
7997 {
7998 if (sp->sn_line_hl > 0)
7999 return syn_id2attr(sp->sn_line_hl);
8000 }
8001 else
8002 {
8003 if (sp->sn_text_hl > 0)
8004 return syn_id2attr(sp->sn_text_hl);
8005 }
8006 break;
8007 }
8008 return 0;
8009}
8010
8011/*
8012 * Get text mark for sign "typenr".
8013 * Returns NULL if there isn't one.
8014 */
8015 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008016sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017{
8018 sign_T *sp;
8019
8020 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8021 if (sp->sn_typenr == typenr)
8022 return sp->sn_text;
8023 return NULL;
8024}
8025
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008026# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008028sign_get_image(
8029 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030{
8031 sign_T *sp;
8032
8033 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8034 if (sp->sn_typenr == typenr)
8035 return sp->sn_image;
8036 return NULL;
8037}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008038# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039
8040/*
8041 * Get the name of a sign by its typenr.
8042 */
8043 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008044sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045{
8046 sign_T *sp;
8047
8048 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8049 if (sp->sn_typenr == typenr)
8050 return sp->sn_name;
8051 return (char_u *)_("[Deleted]");
8052}
8053
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008054# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008055/*
8056 * Undefine/free all signs.
8057 */
8058 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008059free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008060{
8061 while (first_sign != NULL)
8062 sign_undefine(first_sign, NULL);
8063}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008064# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008065
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008066# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008067static enum
8068{
8069 EXP_SUBCMD, /* expand :sign sub-commands */
8070 EXP_DEFINE, /* expand :sign define {name} args */
8071 EXP_PLACE, /* expand :sign place {id} args */
8072 EXP_UNPLACE, /* expand :sign unplace" */
8073 EXP_SIGN_NAMES /* expand with name of placed signs */
8074} expand_what;
8075
8076/*
8077 * Function given to ExpandGeneric() to obtain the sign command
8078 * expansion.
8079 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008080 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008081get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008082{
8083 sign_T *sp;
8084 int current_idx;
8085
8086 switch (expand_what)
8087 {
8088 case EXP_SUBCMD:
8089 return (char_u *)cmds[idx];
8090 case EXP_DEFINE:
8091 {
8092 char *define_arg[] =
8093 {
8094 "icon=", "linehl=", "text=", "texthl=", NULL
8095 };
8096 return (char_u *)define_arg[idx];
8097 }
8098 case EXP_PLACE:
8099 {
8100 char *place_arg[] =
8101 {
8102 "line=", "name=", "file=", "buffer=", NULL
8103 };
8104 return (char_u *)place_arg[idx];
8105 }
8106 case EXP_UNPLACE:
8107 {
8108 char *unplace_arg[] = { "file=", "buffer=", NULL };
8109 return (char_u *)unplace_arg[idx];
8110 }
8111 case EXP_SIGN_NAMES:
8112 /* Complete with name of signs already defined */
8113 current_idx = 0;
8114 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8115 if (current_idx++ == idx)
8116 return sp->sn_name;
8117 return NULL;
8118 default:
8119 return NULL;
8120 }
8121}
8122
8123/*
8124 * Handle command line completion for :sign command.
8125 */
8126 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008127set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008128{
8129 char_u *p;
8130 char_u *end_subcmd;
8131 char_u *last;
8132 int cmd_idx;
8133 char_u *begin_subcmd_args;
8134
8135 /* Default: expand subcommands. */
8136 xp->xp_context = EXPAND_SIGN;
8137 expand_what = EXP_SUBCMD;
8138 xp->xp_pattern = arg;
8139
8140 end_subcmd = skiptowhite(arg);
8141 if (*end_subcmd == NUL)
8142 /* expand subcmd name
8143 * :sign {subcmd}<CTRL-D>*/
8144 return;
8145
8146 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8147
8148 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008149 * |
8150 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008151 begin_subcmd_args = skipwhite(end_subcmd);
8152 p = skiptowhite(begin_subcmd_args);
8153 if (*p == NUL)
8154 {
8155 /*
8156 * Expand first argument of subcmd when possible.
8157 * For ":jump {id}" and ":unplace {id}", we could
8158 * possibly expand the ids of all signs already placed.
8159 */
8160 xp->xp_pattern = begin_subcmd_args;
8161 switch (cmd_idx)
8162 {
8163 case SIGNCMD_LIST:
8164 case SIGNCMD_UNDEFINE:
8165 /* :sign list <CTRL-D>
8166 * :sign undefine <CTRL-D> */
8167 expand_what = EXP_SIGN_NAMES;
8168 break;
8169 default:
8170 xp->xp_context = EXPAND_NOTHING;
8171 }
8172 return;
8173 }
8174
8175 /* expand last argument of subcmd */
8176
8177 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008178 * |
8179 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008180
8181 /* Loop until reaching last argument. */
8182 do
8183 {
8184 p = skipwhite(p);
8185 last = p;
8186 p = skiptowhite(p);
8187 } while (*p != NUL);
8188
8189 p = vim_strchr(last, '=');
8190
8191 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008192 * | |
8193 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008194 if (p == NUL)
8195 {
8196 /* Expand last argument name (before equal sign). */
8197 xp->xp_pattern = last;
8198 switch (cmd_idx)
8199 {
8200 case SIGNCMD_DEFINE:
8201 expand_what = EXP_DEFINE;
8202 break;
8203 case SIGNCMD_PLACE:
8204 expand_what = EXP_PLACE;
8205 break;
8206 case SIGNCMD_JUMP:
8207 case SIGNCMD_UNPLACE:
8208 expand_what = EXP_UNPLACE;
8209 break;
8210 default:
8211 xp->xp_context = EXPAND_NOTHING;
8212 }
8213 }
8214 else
8215 {
8216 /* Expand last argument value (after equal sign). */
8217 xp->xp_pattern = p + 1;
8218 switch (cmd_idx)
8219 {
8220 case SIGNCMD_DEFINE:
8221 if (STRNCMP(last, "texthl", p - last) == 0 ||
8222 STRNCMP(last, "linehl", p - last) == 0)
8223 xp->xp_context = EXPAND_HIGHLIGHT;
8224 else if (STRNCMP(last, "icon", p - last) == 0)
8225 xp->xp_context = EXPAND_FILES;
8226 else
8227 xp->xp_context = EXPAND_NOTHING;
8228 break;
8229 case SIGNCMD_PLACE:
8230 if (STRNCMP(last, "name", p - last) == 0)
8231 expand_what = EXP_SIGN_NAMES;
8232 else
8233 xp->xp_context = EXPAND_NOTHING;
8234 break;
8235 default:
8236 xp->xp_context = EXPAND_NOTHING;
8237 }
8238 }
8239}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008240# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008241#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008242
8243/*
8244 * Make the user happy.
8245 */
8246 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008247ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008248{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008249 static char *code[] = {
8250 "\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$",
8251 "\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"
8252 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008253 char *p;
8254 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008255 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008256
8257 msg_start();
8258 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008259 for (i = 0; i < 2; ++i)
8260 for (p = code[i]; *p != NUL; ++p)
8261 if (*p == 'x')
8262 msg_putchar('\n');
8263 else
8264 for (n = *p++; n > 0; --n)
8265 if (*p == 'o' || *p == '$')
8266 msg_putchar_attr(*p, hl_attr(HLF_L));
8267 else
8268 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008269 msg_clr_eos();
8270}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271
8272#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8273/*
8274 * ":drop"
8275 * Opens the first argument in a window. When there are two or more arguments
8276 * the argument list is redefined.
8277 */
8278 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008279ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280{
8281 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 win_T *wp;
8283 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008284# ifdef FEAT_WINDOWS
8285 tabpage_T *tp;
8286# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008287
8288 /*
8289 * Check if the first argument is already being edited in a window. If
8290 * so, jump to that window.
8291 * We would actually need to check all arguments, but that's complicated
8292 * and mostly only one file is dropped.
8293 * This also ignores wildcards, since it is very unlikely the user is
8294 * editing a file name with a wildcard character.
8295 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008296 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008298 /*
8299 * Expanding wildcards may result in an empty argument list. E.g. when
8300 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8301 * already did an error message for this.
8302 */
8303 if (ARGCOUNT == 0)
8304 return;
8305
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008306# ifdef FEAT_WINDOWS
8307 if (cmdmod.tab)
8308 {
8309 /* ":tab drop file ...": open a tab for each argument that isn't
8310 * edited in a window yet. It's like ":tab all" but without closing
8311 * windows or tabs. */
8312 ex_all(eap);
8313 }
8314 else
8315# endif
8316 {
8317 /* ":drop file ...": Edit the first argument. Jump to an existing
8318 * window if possible, edit in current window if the current buffer
8319 * can be abandoned, otherwise open a new window. */
8320 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8321
8322 FOR_ALL_TAB_WINDOWS(tp, wp)
8323 {
8324 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008326# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008327 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008328# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008330 return;
8331 }
8332 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008334 /*
8335 * Check whether the current buffer is changed. If so, we will need
8336 * to split the current window or data could be lost.
8337 * Skip the check if the 'hidden' option is set, as in this case the
8338 * buffer won't be lost.
8339 */
8340 if (!P_HID(curbuf))
8341 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008343 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344# endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008345 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008347 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008349 if (split)
8350 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008352 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008353
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008354 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8355 if (split)
8356 {
8357 eap->cmdidx = CMD_sfirst;
8358 eap->cmd[0] = 's';
8359 }
8360 else
8361 eap->cmdidx = CMD_first;
8362 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364}
8365#endif