blob: b4351b23dc35ca855979d5b96f526fccd592fb89 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds.c: some functions for command line commands
12 */
13
Bram Moolenaar8c8de832008-06-24 22:58:06 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaar17576a12016-01-20 20:05:44 +010017#ifdef FEAT_FLOAT
18# include <float.h>
19#endif
20
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010021static int linelen(int *has_tab);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010022static void do_filter(linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#ifdef FEAT_VIMINFO
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static char_u *viminfo_filename(char_u *);
25static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags);
26static int viminfo_encoding(vir_T *virp);
27static int read_viminfo_up_to_marks(vir_T *virp, int forceit, int writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028#endif
29
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010030static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +000031#ifdef FEAT_AUTOCMD
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010032static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000033#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000034static int
35#ifdef __BORLANDC__
36 _RTLENTRYF
37#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010038 help_compare(const void *s1, const void *s2);
39static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040
41/*
42 * ":ascii" and "ga".
43 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010045do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000046{
47 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000048 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000049 char buf1[20];
50 char buf2[20];
51 char_u buf3[7];
52#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000053 int cc[MAX_MCO];
54 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 int len;
56
57 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000058 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 else
60#endif
61 c = gchar_cursor();
62 if (c == NUL)
63 {
64 MSG("NUL");
65 return;
66 }
67
68#ifdef FEAT_MBYTE
69 IObuff[0] = NUL;
70 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
71#endif
72 {
73 if (c == NL) /* NUL is stored as NL */
74 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000075 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
76 cval = NL; /* NL is stored as CR */
77 else
78 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 if (vim_isprintc_strict(c) && (c < ' '
80#ifndef EBCDIC
81 || c > '~'
82#endif
83 ))
84 {
85 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000086 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 }
88 else
89 buf1[0] = NUL;
90#ifndef EBCDIC
91 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000092 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
93 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 else
95#endif
96 buf2[0] = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +000097 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000099 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000101 if (enc_utf8)
102 c = cc[ci++];
103 else
104 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105#endif
106 }
107
108#ifdef FEAT_MBYTE
109 /* Repeat for combining characters. */
110 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
111 {
112 len = (int)STRLEN(IObuff);
113 /* This assumes every multi-byte char is printable... */
114 if (len > 0)
115 IObuff[len++] = ' ';
116 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000117 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000118# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 )
122 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000123 len += (*mb_char2bytes)(c, IObuff + len);
124 vim_snprintf((char *)IObuff + len, IOSIZE - len,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
126 : _("> %d, Hex %08x, Octal %o"), c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000127 if (ci == MAX_MCO)
128 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000129 if (enc_utf8)
130 c = cc[ci++];
131 else
132 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 }
134#endif
135
136 msg(IObuff);
137}
138
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139/*
140 * ":left", ":center" and ":right": align text.
141 */
142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100143ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144{
145 pos_T save_curpos;
146 int len;
147 int indent = 0;
148 int new_indent;
149 int has_tab;
150 int width;
151
152#ifdef FEAT_RIGHTLEFT
153 if (curwin->w_p_rl)
154 {
155 /* switch left and right aligning */
156 if (eap->cmdidx == CMD_right)
157 eap->cmdidx = CMD_left;
158 else if (eap->cmdidx == CMD_left)
159 eap->cmdidx = CMD_right;
160 }
161#endif
162
163 width = atoi((char *)eap->arg);
164 save_curpos = curwin->w_cursor;
165 if (eap->cmdidx == CMD_left) /* width is used for new indent */
166 {
167 if (width >= 0)
168 indent = width;
169 }
170 else
171 {
172 /*
173 * if 'textwidth' set, use it
174 * else if 'wrapmargin' set, use it
175 * if invalid value, use 80
176 */
177 if (width <= 0)
178 width = curbuf->b_p_tw;
179 if (width == 0 && curbuf->b_p_wm > 0)
Bram Moolenaar02631462017-09-22 15:20:32 +0200180 width = curwin->w_width - curbuf->b_p_wm;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 if (width <= 0)
182 width = 80;
183 }
184
185 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
186 return;
187
188 for (curwin->w_cursor.lnum = eap->line1;
189 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
190 {
191 if (eap->cmdidx == CMD_left) /* left align */
192 new_indent = indent;
193 else
194 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000195 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 len = linelen(eap->cmdidx == CMD_right ? &has_tab
197 : NULL) - get_indent();
198
199 if (len <= 0) /* skip blank lines */
200 continue;
201
202 if (eap->cmdidx == CMD_center)
203 new_indent = (width - len) / 2;
204 else
205 {
206 new_indent = width - len; /* right align */
207
208 /*
209 * Make sure that embedded TABs don't make the text go too far
210 * to the right.
211 */
212 if (has_tab)
213 while (new_indent > 0)
214 {
215 (void)set_indent(new_indent, 0);
216 if (linelen(NULL) <= width)
217 {
218 /*
219 * Now try to move the line as much as possible to
220 * the right. Stop when it moves too far.
221 */
222 do
223 (void)set_indent(++new_indent, 0);
224 while (linelen(NULL) <= width);
225 --new_indent;
226 break;
227 }
228 --new_indent;
229 }
230 }
231 }
232 if (new_indent < 0)
233 new_indent = 0;
234 (void)set_indent(new_indent, 0); /* set indent */
235 }
236 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
237 curwin->w_cursor = save_curpos;
238 beginline(BL_WHITE | BL_FIX);
239}
240
241/*
242 * Get the length of the current line, excluding trailing white space.
243 */
244 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100245linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246{
247 char_u *line;
248 char_u *first;
249 char_u *last;
250 int save;
251 int len;
252
253 /* find the first non-blank character */
254 line = ml_get_curline();
255 first = skipwhite(line);
256
257 /* find the character after the last non-blank character */
258 for (last = first + STRLEN(first);
Bram Moolenaar1c465442017-03-12 20:10:05 +0100259 last > first && VIM_ISWHITE(last[-1]); --last)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 ;
261 save = *last;
262 *last = NUL;
263 len = linetabsize(line); /* get line length */
264 if (has_tab != NULL) /* check for embedded TAB */
265 *has_tab = (vim_strrchr(first, TAB) != NULL);
266 *last = save;
267
268 return len;
269}
270
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000271/* Buffer for two lines used during sorting. They are allocated to
272 * contain the longest line being sorted. */
273static char_u *sortbuf1;
274static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000275
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100276static int sort_ic; /* ignore case */
277static int sort_nr; /* sort on number */
278static int sort_rx; /* sort on regex instead of skipping it */
279#ifdef FEAT_FLOAT
280static int sort_flt; /* sort on floating number */
281#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100283static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000284
285/* Struct to store info to be sorted. */
286typedef struct
287{
288 linenr_T lnum; /* line number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100289 union {
290 struct
291 {
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200292 varnumber_T start_col_nr; /* starting column number */
293 varnumber_T end_col_nr; /* ending column number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100294 } line;
Bram Moolenaar22fcfad2016-07-01 18:17:26 +0200295 varnumber_T value; /* value if sorting by integer */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100296#ifdef FEAT_FLOAT
297 float_T value_flt; /* value if sorting by float */
298#endif
299 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000300} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000301
302static int
303#ifdef __BORLANDC__
304_RTLENTRYF
305#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100306sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000307
308 static int
309#ifdef __BORLANDC__
310_RTLENTRYF
311#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100312sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000313{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000314 sorti_T l1 = *(sorti_T *)s1;
315 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000316 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000317
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000318 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000319 * if we return 0 every time, qsort will assume it's done sorting and
320 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000321 if (sort_abort)
322 return 0;
323 fast_breakcheck();
324 if (got_int)
325 sort_abort = TRUE;
326
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000327 /* When sorting numbers "start_col_nr" is the number, not the column
328 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 if (sort_nr)
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100330 result = l1.st_u.value == l2.st_u.value ? 0
331 : l1.st_u.value > l2.st_u.value ? 1 : -1;
332#ifdef FEAT_FLOAT
333 else if (sort_flt)
334 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
335 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
336#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 else
338 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000339 /* We need to copy one line into "sortbuf1", because there is no
340 * guarantee that the first pointer becomes invalid when obtaining the
341 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100342 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
343 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
344 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
345 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
346 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
347 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000348
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000349 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
350 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000351 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000352
353 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000354 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000355 return (int)(l1.lnum - l2.lnum);
356 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000357}
358
359/*
360 * ":sort".
361 */
362 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100363ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000364{
365 regmatch_T regmatch;
366 int len;
367 linenr_T lnum;
368 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000369 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000370 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000371 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000372 char_u *p;
373 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000374 char_u *s2;
375 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000376 int unique = FALSE;
377 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000378 colnr_T start_col;
379 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100380 int sort_what = 0;
381 int format_found = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382
Bram Moolenaar48c99162008-02-18 18:42:52 +0000383 /* Sorting one line is really quick! */
384 if (count <= 1)
385 return;
386
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000387 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
388 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000389 sortbuf1 = NULL;
390 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000391 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000392 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000393 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000394 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000395
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100396 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100397#ifdef FEAT_FLOAT
398 sort_flt = 0;
399#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000400
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401 for (p = eap->arg; *p != NUL; ++p)
402 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100403 if (VIM_ISWHITE(*p))
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000404 ;
405 else if (*p == 'i')
406 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000407 else if (*p == 'r')
408 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000409 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100410 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100411 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100412 ++format_found;
413 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100414#ifdef FEAT_FLOAT
415 else if (*p == 'f')
416 {
417 sort_flt = 1;
418 ++format_found;
419 }
420#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100421 else if (*p == 'b')
422 {
423 sort_what = STR2NR_BIN + STR2NR_FORCE;
424 ++format_found;
425 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000426 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100427 {
428 sort_what = STR2NR_OCT + STR2NR_FORCE;
429 ++format_found;
430 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000431 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100432 {
433 sort_what = STR2NR_HEX + STR2NR_FORCE;
434 ++format_found;
435 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000436 else if (*p == 'u')
437 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000438 else if (*p == '"') /* comment start */
439 break;
440 else if (check_nextcmd(p) != NULL)
441 {
442 eap->nextcmd = check_nextcmd(p);
443 break;
444 }
445 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000446 {
447 s = skip_regexp(p + 1, *p, TRUE, NULL);
448 if (*s != *p)
449 {
450 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000451 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000452 }
453 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000454 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100455 if (s == p + 1)
456 {
457 if (last_search_pat() == NULL)
458 {
459 EMSG(_(e_noprevre));
460 goto sortend;
461 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000462 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100463 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000464 else
465 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000466 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000467 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000468 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000469 regmatch.rm_ic = p_ic;
470 }
471 else
472 {
473 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000475 }
476 }
477
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100478 /* Can only have one of 'n', 'b', 'o' and 'x'. */
479 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000480 {
481 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000482 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000483 }
484
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100485 /* From here on "sort_nr" is used as a flag for any integer number
486 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100487 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000488
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000489 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000491 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000492 * When sorting on strings "start_col_nr" is the offset in the line, for
493 * numbers sorting it's the number to sort on. This means the pattern
494 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000496 */
497 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
498 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000499 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000500 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000501 if (maxlen < len)
502 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000503
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000504 start_col = 0;
505 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000506 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000507 {
508 if (sort_rx)
509 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000510 start_col = (colnr_T)(regmatch.startp[0] - s);
511 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000512 }
513 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000514 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000515 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000516 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000517 if (regmatch.regprog != NULL)
518 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000519
Bram Moolenaar937204a2016-01-30 23:37:38 +0100520 if (sort_nr
521#ifdef FEAT_FLOAT
522 || sort_flt
523#endif
524 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 /* Make sure vim_str2nr doesn't read any digits past the end
527 * of the match, by temporarily terminating the string there */
528 s2 = s + end_col;
529 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200530 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000531 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000532 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100533 if (sort_nr)
534 {
535 if (sort_what & STR2NR_HEX)
536 s = skiptohex(p);
537 else if (sort_what & STR2NR_BIN)
538 s = skiptobin(p);
539 else
540 s = skiptodigit(p);
541 if (s > p && s[-1] == '-')
542 --s; /* include preceding negative sign */
543 if (*s == NUL)
544 /* empty line should sort before any number */
545 nrs[lnum - eap->line1].st_u.value = -MAXLNUM;
546 else
547 vim_str2nr(s, NULL, NULL, sort_what,
548 &nrs[lnum - eap->line1].st_u.value, NULL, 0);
549 }
550#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000551 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 {
553 s = skipwhite(p);
554 if (*s == '+')
555 s = skipwhite(s + 1);
556
557 if (*s == NUL)
558 /* empty line should sort before any number */
559 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
560 else
561 nrs[lnum - eap->line1].st_u.value_flt =
562 strtod((char *)s, NULL);
563 }
564#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200565 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000566 }
567 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000568 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000569 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100570 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
571 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000572 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000573
574 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000575
576 if (regmatch.regprog != NULL)
577 fast_breakcheck();
578 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000579 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000580 }
581
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000582 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000583 sortbuf1 = alloc((unsigned)maxlen + 1);
584 if (sortbuf1 == NULL)
585 goto sortend;
586 sortbuf2 = alloc((unsigned)maxlen + 1);
587 if (sortbuf2 == NULL)
588 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000589
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000590 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000592
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 if (sort_abort)
594 goto sortend;
595
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000596 /* Insert the lines in the sorted order below the last one. */
597 lnum = eap->line2;
598 for (i = 0; i < count; ++i)
599 {
600 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
601 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000602 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603 {
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100604 /* Copy the line into a buffer, it may become invalid in
605 * ml_append(). And it's needed for "unique". */
606 STRCPY(sortbuf1, s);
607 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000609 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000610 fast_breakcheck();
611 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000612 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000613 }
614
615 /* delete the original lines if appending worked */
616 if (i == count)
617 for (i = 0; i < count; ++i)
618 ml_delete(eap->line1, FALSE);
619 else
620 count = 0;
621
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000622 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000623 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 if (deleted > 0)
625 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
626 else if (deleted < 0)
627 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
628 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000629
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000630 curwin->w_cursor.lnum = eap->line1;
631 beginline(BL_WHITE | BL_FIX);
632
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000633sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000635 vim_free(sortbuf1);
636 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200637 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000638 if (got_int)
639 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640}
641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642/*
643 * ":retab".
644 */
645 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100646ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647{
648 linenr_T lnum;
649 int got_tab = FALSE;
650 long num_spaces = 0;
651 long num_tabs;
652 long len;
653 long col;
654 long vcol;
655 long start_col = 0; /* For start of white-space string */
656 long start_vcol = 0; /* For start of white-space string */
657 int temp;
658 long old_len;
659 char_u *ptr;
660 char_u *new_line = (char_u *)1; /* init to non-NULL */
661 int did_undo; /* called u_save for current line */
662 int new_ts;
663 int save_list;
664 linenr_T first_line = 0; /* first changed line */
665 linenr_T last_line = 0; /* last changed line */
666
667 save_list = curwin->w_p_list;
668 curwin->w_p_list = 0; /* don't want list mode here */
669
670 new_ts = getdigits(&(eap->arg));
671 if (new_ts < 0)
672 {
673 EMSG(_(e_positive));
674 return;
675 }
676 if (new_ts == 0)
677 new_ts = curbuf->b_p_ts;
678 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
679 {
680 ptr = ml_get(lnum);
681 col = 0;
682 vcol = 0;
683 did_undo = FALSE;
684 for (;;)
685 {
Bram Moolenaar1c465442017-03-12 20:10:05 +0100686 if (VIM_ISWHITE(ptr[col]))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 {
688 if (!got_tab && num_spaces == 0)
689 {
690 /* First consecutive white-space */
691 start_vcol = vcol;
692 start_col = col;
693 }
694 if (ptr[col] == ' ')
695 num_spaces++;
696 else
697 got_tab = TRUE;
698 }
699 else
700 {
701 if (got_tab || (eap->forceit && num_spaces > 1))
702 {
703 /* Retabulate this string of white-space */
704
705 /* len is virtual length of white string */
706 len = num_spaces = vcol - start_vcol;
707 num_tabs = 0;
708 if (!curbuf->b_p_et)
709 {
710 temp = new_ts - (start_vcol % new_ts);
711 if (num_spaces >= temp)
712 {
713 num_spaces -= temp;
714 num_tabs++;
715 }
716 num_tabs += num_spaces / new_ts;
717 num_spaces -= (num_spaces / new_ts) * new_ts;
718 }
719 if (curbuf->b_p_et || got_tab ||
720 (num_spaces + num_tabs < len))
721 {
722 if (did_undo == FALSE)
723 {
724 did_undo = TRUE;
725 if (u_save((linenr_T)(lnum - 1),
726 (linenr_T)(lnum + 1)) == FAIL)
727 {
728 new_line = NULL; /* flag out-of-memory */
729 break;
730 }
731 }
732
733 /* len is actual number of white characters used */
734 len = num_spaces + num_tabs;
735 old_len = (long)STRLEN(ptr);
736 new_line = lalloc(old_len - col + start_col + len + 1,
737 TRUE);
738 if (new_line == NULL)
739 break;
740 if (start_col > 0)
741 mch_memmove(new_line, ptr, (size_t)start_col);
742 mch_memmove(new_line + start_col + len,
743 ptr + col, (size_t)(old_len - col + 1));
744 ptr = new_line + start_col;
745 for (col = 0; col < len; col++)
746 ptr[col] = (col < num_tabs) ? '\t' : ' ';
747 ml_replace(lnum, new_line, FALSE);
748 if (first_line == 0)
749 first_line = lnum;
750 last_line = lnum;
751 ptr = new_line;
752 col = start_col + len;
753 }
754 }
755 got_tab = FALSE;
756 num_spaces = 0;
757 }
758 if (ptr[col] == NUL)
759 break;
760 vcol += chartabsize(ptr + col, (colnr_T)vcol);
761#ifdef FEAT_MBYTE
762 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000763 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 else
765#endif
766 ++col;
767 }
768 if (new_line == NULL) /* out of memory */
769 break;
770 line_breakcheck();
771 }
772 if (got_int)
773 EMSG(_(e_interr));
774
775 if (curbuf->b_p_ts != new_ts)
776 redraw_curbuf_later(NOT_VALID);
777 if (first_line != 0)
778 changed_lines(first_line, 0, last_line + 1, 0L);
779
780 curwin->w_p_list = save_list; /* restore 'list' */
781
782 curbuf->b_p_ts = new_ts;
783 coladvance(curwin->w_curswant);
784
785 u_clearline();
786}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788/*
789 * :move command - move lines line1-line2 to line dest
790 *
791 * return FAIL for failure, OK otherwise
792 */
793 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100794do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795{
796 char_u *str;
797 linenr_T l;
798 linenr_T extra; /* Num lines added before line1 */
799 linenr_T num_lines; /* Num lines moved */
800 linenr_T last_line; /* Last line in file after adding new text */
Bram Moolenaard5f69332015-04-15 12:43:50 +0200801#ifdef FEAT_FOLDING
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100802 win_T *win;
803 tabpage_T *tp;
Bram Moolenaard5f69332015-04-15 12:43:50 +0200804#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
806 if (dest >= line1 && dest < line2)
807 {
808 EMSG(_("E134: Move lines into themselves"));
809 return FAIL;
810 }
811
812 num_lines = line2 - line1 + 1;
813
814 /*
815 * First we copy the old text to its new location -- webb
816 * Also copy the flag that ":global" command uses.
817 */
818 if (u_save(dest, dest + 1) == FAIL)
819 return FAIL;
820 for (extra = 0, l = line1; l <= line2; l++)
821 {
822 str = vim_strsave(ml_get(l + extra));
823 if (str != NULL)
824 {
825 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
826 vim_free(str);
827 if (dest < line1)
828 extra++;
829 }
830 }
831
832 /*
833 * Now we must be careful adjusting our marks so that we don't overlap our
834 * mark_adjust() calls.
835 *
836 * We adjust the marks within the old text so that they refer to the
837 * last lines of the file (temporarily), because we know no other marks
838 * will be set there since these line numbers did not exist until we added
839 * our new lines.
840 *
841 * Then we adjust the marks on lines between the old and new text positions
842 * (either forwards or backwards).
843 *
844 * And Finally we adjust the marks we put at the end of the file back to
845 * their final destination at the new text position -- webb
846 */
847 last_line = curbuf->b_ml.ml_line_count;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100848 mark_adjust_nofold(line1, line2, last_line - line2, 0L);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 if (dest >= line2)
850 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100851 mark_adjust_nofold(line2 + 1, dest, -num_lines, 0L);
852#ifdef FEAT_FOLDING
853 FOR_ALL_TAB_WINDOWS(tp, win) {
854 if (win->w_buffer == curbuf)
855 foldMoveRange(&win->w_folds, line1, line2, dest);
856 }
857#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 curbuf->b_op_start.lnum = dest - num_lines + 1;
859 curbuf->b_op_end.lnum = dest;
860 }
861 else
862 {
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100863 mark_adjust_nofold(dest + 1, line1 - 1, num_lines, 0L);
864#ifdef FEAT_FOLDING
865 FOR_ALL_TAB_WINDOWS(tp, win) {
866 if (win->w_buffer == curbuf)
867 foldMoveRange(&win->w_folds, dest + 1, line1 - 1, line2);
868 }
869#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 curbuf->b_op_start.lnum = dest + 1;
871 curbuf->b_op_end.lnum = dest + num_lines;
872 }
873 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
Bram Moolenaar88d298a2017-03-14 21:53:58 +0100874 mark_adjust_nofold(last_line - num_lines + 1, last_line,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 -(last_line - dest - extra), 0L);
876
877 /*
878 * Now we delete the original text -- webb
879 */
880 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
881 return FAIL;
882
883 for (l = line1; l <= line2; l++)
884 ml_delete(line1 + extra, TRUE);
885
886 if (!global_busy && num_lines > p_report)
887 {
888 if (num_lines == 1)
889 MSG(_("1 line moved"));
890 else
891 smsg((char_u *)_("%ld lines moved"), num_lines);
892 }
893
894 /*
895 * Leave the cursor on the last of the moved lines.
896 */
897 if (dest >= line1)
898 curwin->w_cursor.lnum = dest;
899 else
900 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
901
902 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100903 {
904 dest += num_lines + 1;
905 last_line = curbuf->b_ml.ml_line_count;
906 if (dest > last_line + 1)
907 dest = last_line + 1;
908 changed_lines(line1, 0, dest, 0L);
909 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 else
911 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
912
913 return OK;
914}
915
916/*
917 * ":copy"
918 */
919 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100920ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921{
922 linenr_T count;
923 char_u *p;
924
925 count = line2 - line1 + 1;
926 curbuf->b_op_start.lnum = n + 1;
927 curbuf->b_op_end.lnum = n + count;
928 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
929
930 /*
931 * there are three situations:
932 * 1. destination is above line1
933 * 2. destination is between line1 and line2
934 * 3. destination is below line2
935 *
936 * n = destination (when starting)
937 * curwin->w_cursor.lnum = destination (while copying)
938 * line1 = start of source (while copying)
939 * line2 = end of source (while copying)
940 */
941 if (u_save(n, n + 1) == FAIL)
942 return;
943
944 curwin->w_cursor.lnum = n;
945 while (line1 <= line2)
946 {
947 /* need to use vim_strsave() because the line will be unlocked within
948 * ml_append() */
949 p = vim_strsave(ml_get(line1));
950 if (p != NULL)
951 {
952 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
953 vim_free(p);
954 }
955 /* situation 2: skip already copied lines */
956 if (line1 == n)
957 line1 = curwin->w_cursor.lnum;
958 ++line1;
959 if (curwin->w_cursor.lnum < line1)
960 ++line1;
961 if (curwin->w_cursor.lnum < line2)
962 ++line2;
963 ++curwin->w_cursor.lnum;
964 }
965
966 appended_lines_mark(n, count);
967
968 msgmore((long)count);
969}
970
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000971static char_u *prevcmd = NULL; /* the previous command */
972
973#if defined(EXITFREE) || defined(PROTO)
974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100975free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000976{
977 vim_free(prevcmd);
978}
979#endif
980
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981/*
982 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
983 * Bangs in the argument are replaced with the previously entered command.
984 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 */
986 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100987do_bang(
988 int addr_count,
989 exarg_T *eap,
990 int forceit,
991 int do_in,
992 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993{
994 char_u *arg = eap->arg; /* command */
995 linenr_T line1 = eap->line1; /* start of range */
996 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 char_u *newcmd = NULL; /* the new command */
998 int free_newcmd = FALSE; /* need to free() newcmd */
999 int ins_prevcmd;
1000 char_u *t;
1001 char_u *p;
1002 char_u *trailarg;
1003 int len;
1004 int scroll_save = msg_scroll;
1005
1006 /*
1007 * Disallow shell commands for "rvim".
1008 * Disallow shell commands from .exrc and .vimrc in current directory for
1009 * security reasons.
1010 */
1011 if (check_restricted() || check_secure())
1012 return;
1013
1014 if (addr_count == 0) /* :! */
1015 {
1016 msg_scroll = FALSE; /* don't scroll here */
1017 autowrite_all();
1018 msg_scroll = scroll_save;
1019 }
1020
1021 /*
1022 * Try to find an embedded bang, like in :!<cmd> ! [args]
1023 * (:!! is indicated by the 'forceit' variable)
1024 */
1025 ins_prevcmd = forceit;
1026 trailarg = arg;
1027 do
1028 {
1029 len = (int)STRLEN(trailarg) + 1;
1030 if (newcmd != NULL)
1031 len += (int)STRLEN(newcmd);
1032 if (ins_prevcmd)
1033 {
1034 if (prevcmd == NULL)
1035 {
1036 EMSG(_(e_noprev));
1037 vim_free(newcmd);
1038 return;
1039 }
1040 len += (int)STRLEN(prevcmd);
1041 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001042 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 {
1044 vim_free(newcmd);
1045 return;
1046 }
1047 *t = NUL;
1048 if (newcmd != NULL)
1049 STRCAT(t, newcmd);
1050 if (ins_prevcmd)
1051 STRCAT(t, prevcmd);
1052 p = t + STRLEN(t);
1053 STRCAT(t, trailarg);
1054 vim_free(newcmd);
1055 newcmd = t;
1056
1057 /*
1058 * Scan the rest of the argument for '!', which is replaced by the
1059 * previous command. "\!" is replaced by "!" (this is vi compatible).
1060 */
1061 trailarg = NULL;
1062 while (*p)
1063 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001064 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065 {
1066 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001067 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 else
1069 {
1070 trailarg = p;
1071 *trailarg++ = NUL;
1072 ins_prevcmd = TRUE;
1073 break;
1074 }
1075 }
1076 ++p;
1077 }
1078 } while (trailarg != NULL);
1079
1080 vim_free(prevcmd);
1081 prevcmd = newcmd;
1082
1083 if (bangredo) /* put cmd in redo buffer for ! command */
1084 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001085 /* If % or # appears in the command, it must have been escaped.
1086 * Reescape them, so that redoing them does not substitute them by the
1087 * buffername. */
1088 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1089
1090 if (cmd != NULL)
1091 {
1092 AppendToRedobuffLit(cmd, -1);
1093 vim_free(cmd);
1094 }
1095 else
1096 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 AppendToRedobuff((char_u *)"\n");
1098 bangredo = FALSE;
1099 }
1100 /*
1101 * Add quotes around the command, for shells that need them.
1102 */
1103 if (*p_shq != NUL)
1104 {
1105 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1106 if (newcmd == NULL)
1107 return;
1108 STRCPY(newcmd, p_shq);
1109 STRCAT(newcmd, prevcmd);
1110 STRCAT(newcmd, p_shq);
1111 free_newcmd = TRUE;
1112 }
1113 if (addr_count == 0) /* :! */
1114 {
1115 /* echo the command */
1116 msg_start();
1117 msg_putchar(':');
1118 msg_putchar('!');
1119 msg_outtrans(newcmd);
1120 msg_clr_eos();
1121 windgoto(msg_row, msg_col);
1122
1123 do_shell(newcmd, 0);
1124 }
1125 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001126 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 /* Careful: This may recursively call do_bang() again! (because of
1128 * autocommands) */
1129 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001130#ifdef FEAT_AUTOCMD
1131 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1132#endif
1133 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134 if (free_newcmd)
1135 vim_free(newcmd);
1136}
1137
1138/*
1139 * do_filter: filter lines through a command given by the user
1140 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001141 * We mostly use temp files and the call_shell() routine here. This would
1142 * normally be done using pipes on a UNIX machine, but this is more portable
1143 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 * to deal with redirection somehow, and should handle things like looking
1145 * at the PATH env. variable, and adding reasonable extensions to the
1146 * command name given by the user. All reasonable versions of call_shell()
1147 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001148 * Alternatively, if on Unix and redirecting input or output, but not both,
1149 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 * We use input redirection if do_in is TRUE.
1151 * We use output redirection if do_out is TRUE.
1152 */
1153 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001154do_filter(
1155 linenr_T line1,
1156 linenr_T line2,
1157 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1158 char_u *cmd,
1159 int do_in,
1160 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161{
1162 char_u *itmp = NULL;
1163 char_u *otmp = NULL;
1164 linenr_T linecount;
1165 linenr_T read_linecount;
1166 pos_T cursor_save;
1167 char_u *cmd_buf;
1168#ifdef FEAT_AUTOCMD
1169 buf_T *old_curbuf = curbuf;
1170#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001171 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172
1173 if (*cmd == NUL) /* no filter command */
1174 return;
1175
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 cursor_save = curwin->w_cursor;
1177 linecount = line2 - line1 + 1;
1178 curwin->w_cursor.lnum = line1;
1179 curwin->w_cursor.col = 0;
1180 changed_line_abv_curs();
1181 invalidate_botline();
1182
1183 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001184 * When using temp files:
1185 * 1. * Form temp file names
1186 * 2. * Write the lines to a temp file
1187 * 3. Run the filter command on the temp file
1188 * 4. * Read the output of the command into the buffer
1189 * 5. * Delete the original lines to be filtered
1190 * 6. * Remove the temp files
1191 *
1192 * When writing the input with a pipe or when catching the output with a
1193 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 */
1195
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001196 if (do_out)
1197 shell_flags |= SHELL_DOOUT;
1198
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001199#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001200 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001202 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1203 shell_flags |= SHELL_READ;
1204 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001206 else if (do_in && !do_out && !p_stmp)
1207 {
1208 /* Use a pipe to write stdin of the command, do not use a temp file. */
1209 shell_flags |= SHELL_WRITE;
1210 curbuf->b_op_start.lnum = line1;
1211 curbuf->b_op_end.lnum = line2;
1212 }
1213 else if (do_in && do_out && !p_stmp)
1214 {
1215 /* Use a pipe to write stdin and fetch stdout of the command, do not
1216 * use a temp file. */
1217 shell_flags |= SHELL_READ|SHELL_WRITE;
1218 curbuf->b_op_start.lnum = line1;
1219 curbuf->b_op_end.lnum = line2;
1220 curwin->w_cursor.lnum = line2;
1221 }
1222 else
1223#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001224 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1225 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001226 {
1227 EMSG(_(e_notmp));
1228 goto filterend;
1229 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230
1231/*
1232 * The writing and reading of temp files will not be shown.
1233 * Vi also doesn't do this and the messages are not very informative.
1234 */
1235 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 FALSE, FALSE, FALSE, TRUE) == FAIL)
1238 {
1239 msg_putchar('\n'); /* keep message from buf_write() */
1240 --no_wait_return;
1241#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1242 if (!aborting())
1243#endif
1244 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1245 goto filterend;
1246 }
1247#ifdef FEAT_AUTOCMD
1248 if (curbuf != old_curbuf)
1249 goto filterend;
1250#endif
1251
1252 if (!do_out)
1253 msg_putchar('\n');
1254
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001255 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1257 if (cmd_buf == NULL)
1258 goto filterend;
1259
1260 windgoto((int)Rows - 1, 0);
1261 cursor_on();
1262
1263 /*
1264 * When not redirecting the output the command can write anything to the
1265 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1266 * stderr output of external command. Clear the screen later.
1267 * If do_in is FALSE, this could be something like ":r !cat", which may
1268 * also mess up the screen, clear it later.
1269 */
1270 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1271 redraw_later_clear();
1272
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001273 if (do_out)
1274 {
1275 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001276 {
1277 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001278 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001279 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001280 redraw_curbuf_later(VALID);
1281 }
1282 read_linecount = curbuf->b_ml.ml_line_count;
1283
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 /*
1285 * When call_shell() fails wait_return() is called to give the user a
1286 * chance to read the error messages. Otherwise errors are ignored, so you
1287 * can see the error messages from the command that appear on stdout; use
1288 * 'u' to fix the text
1289 * Switch to cooked mode when not redirecting stdin, avoids that something
1290 * like ":r !cat" hangs.
1291 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1292 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001293 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 {
1295 redraw_later_clear();
1296 wait_return(FALSE);
1297 }
1298 vim_free(cmd_buf);
1299
1300 did_check_timestamps = FALSE;
1301 need_check_timestamps = TRUE;
1302
1303 /* When interrupting the shell command, it may still have produced some
1304 * useful output. Reset got_int here, so that readfile() won't cancel
1305 * reading. */
1306 ui_breakcheck();
1307 got_int = FALSE;
1308
1309 if (do_out)
1310 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001311 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001313 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
Bram Moolenaare13b9af2017-01-13 22:01:02 +01001314 eap, READ_FILTER) != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001316#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1317 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001319 {
1320 msg_putchar('\n');
1321 EMSG2(_(e_notread), otmp);
1322 }
1323 goto error;
1324 }
1325#ifdef FEAT_AUTOCMD
1326 if (curbuf != old_curbuf)
1327 goto filterend;
1328#endif
1329 }
1330
1331 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1332
1333 if (shell_flags & SHELL_READ)
1334 {
1335 curbuf->b_op_start.lnum = line2 + 1;
1336 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1337 appended_lines_mark(line2, read_linecount);
1338 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339
1340 if (do_in)
1341 {
1342 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1343 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 if (read_linecount >= linecount)
1345 /* move all marks from old lines to new lines */
1346 mark_adjust(line1, line2, linecount, 0L);
1347 else
1348 {
1349 /* move marks from old lines to new lines, delete marks
1350 * that are in deleted lines */
1351 mark_adjust(line1, line1 + read_linecount - 1,
1352 linecount, 0L);
1353 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1354 }
1355 }
1356
1357 /*
1358 * Put cursor on first filtered line for ":range!cmd".
1359 * Adjust '[ and '] (set by buf_write()).
1360 */
1361 curwin->w_cursor.lnum = line1;
1362 del_lines(linecount, TRUE);
1363 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1364 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1365 write_lnum_adjust(-linecount); /* adjust last line
1366 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001367#ifdef FEAT_FOLDING
1368 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1369#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 }
1371 else
1372 {
1373 /*
1374 * Put cursor on last new line for ":r !cmd".
1375 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001377 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001379
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1381 --no_wait_return;
1382
1383 if (linecount > p_report)
1384 {
1385 if (do_in)
1386 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001387 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1388 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001391 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 }
1393 else
1394 msgmore((long)linecount);
1395 }
1396 }
1397 else
1398 {
1399error:
1400 /* put cursor back in same position for ":w !cmd" */
1401 curwin->w_cursor = cursor_save;
1402 --no_wait_return;
1403 wait_return(FALSE);
1404 }
1405
1406filterend:
1407
1408#ifdef FEAT_AUTOCMD
1409 if (curbuf != old_curbuf)
1410 {
1411 --no_wait_return;
1412 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1413 }
1414#endif
1415 if (itmp != NULL)
1416 mch_remove(itmp);
1417 if (otmp != NULL)
1418 mch_remove(otmp);
1419 vim_free(itmp);
1420 vim_free(otmp);
1421}
1422
1423/*
1424 * Call a shell to execute a command.
1425 * When "cmd" is NULL start an interactive shell.
1426 */
1427 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001428do_shell(
1429 char_u *cmd,
1430 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431{
1432 buf_T *buf;
1433#ifndef FEAT_GUI_MSWIN
1434 int save_nwr;
1435#endif
1436#ifdef MSWIN
1437 int winstart = FALSE;
1438#endif
1439
1440 /*
1441 * Disallow shell commands for "rvim".
1442 * Disallow shell commands from .exrc and .vimrc in current directory for
1443 * security reasons.
1444 */
1445 if (check_restricted() || check_secure())
1446 {
1447 msg_end();
1448 return;
1449 }
1450
1451#ifdef MSWIN
1452 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 * Check if ":!start" is used.
1454 */
1455 if (cmd != NULL)
1456 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1457#endif
1458
1459 /*
1460 * For autocommands we want to get the output on the current screen, to
1461 * avoid having to type return below.
1462 */
1463 msg_putchar('\r'); /* put cursor at start of line */
1464#ifdef FEAT_AUTOCMD
1465 if (!autocmd_busy)
1466#endif
1467 {
1468#ifdef MSWIN
1469 if (!winstart)
1470#endif
1471 stoptermcap();
1472 }
1473#ifdef MSWIN
1474 if (!winstart)
1475#endif
1476 msg_putchar('\n'); /* may shift screen one line up */
1477
1478 /* warning message before calling the shell */
1479 if (p_warn
1480#ifdef FEAT_AUTOCMD
1481 && !autocmd_busy
1482#endif
1483 && msg_silent == 0)
Bram Moolenaar29323592016-07-24 22:04:11 +02001484 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 if (bufIsChanged(buf))
1486 {
1487#ifdef FEAT_GUI_MSWIN
1488 if (!winstart)
1489 starttermcap(); /* don't want a message box here */
1490#endif
1491 MSG_PUTS(_("[No write since last change]\n"));
1492#ifdef FEAT_GUI_MSWIN
1493 if (!winstart)
1494 stoptermcap();
1495#endif
1496 break;
1497 }
1498
1499 /* This windgoto is required for when the '\n' resulted in a "delete line
1500 * 1" command to the terminal. */
1501 if (!swapping_screen())
1502 windgoto(msg_row, msg_col);
1503 cursor_on();
1504 (void)call_shell(cmd, SHELL_COOKED | flags);
1505 did_check_timestamps = FALSE;
1506 need_check_timestamps = TRUE;
1507
1508 /*
1509 * put the message cursor at the end of the screen, avoids wait_return()
1510 * to overwrite the text that the external command showed
1511 */
1512 if (!swapping_screen())
1513 {
1514 msg_row = Rows - 1;
1515 msg_col = 0;
1516 }
1517
1518#ifdef FEAT_AUTOCMD
1519 if (autocmd_busy)
1520 {
1521 if (msg_silent == 0)
1522 redraw_later_clear();
1523 }
1524 else
1525#endif
1526 {
1527 /*
1528 * For ":sh" there is no need to call wait_return(), just redraw.
1529 * Also for the Win32 GUI (the output is in a console window).
1530 * Otherwise there is probably text on the screen that the user wants
1531 * to read before redrawing, so call wait_return().
1532 */
1533#ifndef FEAT_GUI_MSWIN
1534 if (cmd == NULL
1535# ifdef WIN3264
1536 || (winstart && !need_wait_return)
1537# endif
1538 )
1539 {
1540 if (msg_silent == 0)
1541 redraw_later_clear();
1542 need_wait_return = FALSE;
1543 }
1544 else
1545 {
1546 /*
1547 * If we switch screens when starttermcap() is called, we really
1548 * want to wait for "hit return to continue".
1549 */
1550 save_nwr = no_wait_return;
1551 if (swapping_screen())
1552 no_wait_return = FALSE;
1553# ifdef AMIGA
1554 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1555# else
1556 wait_return(msg_silent == 0);
1557# endif
1558 no_wait_return = save_nwr;
1559 }
1560#endif /* FEAT_GUI_W32 */
1561
1562#ifdef MSWIN
1563 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1564#endif
1565 starttermcap(); /* start termcap if not done by wait_return() */
1566
1567 /*
1568 * In an Amiga window redrawing is caused by asking the window size.
1569 * If we got an interrupt this will not work. The chance that the
1570 * window size is wrong is very small, but we need to redraw the
1571 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1572 * but it saves an extra redraw.
1573 */
1574#ifdef AMIGA
1575 if (skip_redraw) /* ':' hit in wait_return() */
1576 {
1577 if (msg_silent == 0)
1578 redraw_later_clear();
1579 }
1580 else if (term_console)
1581 {
1582 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1583 if (got_int && msg_silent == 0)
1584 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1585 else
1586 must_redraw = 0; /* no extra redraw needed */
1587 }
1588#endif
1589 }
1590
1591 /* display any error messages now */
1592 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001593
1594#ifdef FEAT_AUTOCMD
1595 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1596#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597}
1598
1599/*
1600 * Create a shell command from a command string, input redirection file and
1601 * output redirection file.
1602 * Returns an allocated string with the shell command, or NULL for failure.
1603 */
1604 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001605make_filter_cmd(
1606 char_u *cmd, /* command */
1607 char_u *itmp, /* NULL or name of input file */
1608 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609{
1610 char_u *buf;
1611 long_u len;
1612
Bram Moolenaar53076832015-12-31 19:53:21 +01001613#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001614 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001615 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001616
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001617 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001618 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1619 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001620 if (is_fish_shell)
1621 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1622 else
1623#endif
1624 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 if (itmp != NULL)
1626 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1627 if (otmp != NULL)
1628 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1629 buf = lalloc(len, TRUE);
1630 if (buf == NULL)
1631 return NULL;
1632
Bram Moolenaar53076832015-12-31 19:53:21 +01001633#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001635 * Put braces around the command (for concatenated commands) when
1636 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001638 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001639 {
1640 if (is_fish_shell)
1641 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1642 else
1643 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1644 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001645 else
1646 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 if (itmp != NULL)
1648 {
1649 STRCAT(buf, " < ");
1650 STRCAT(buf, itmp);
1651 }
1652#else
1653 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001654 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 * the use of commands in a pipe.
1656 */
1657 STRCPY(buf, cmd);
1658 if (itmp != NULL)
1659 {
1660 char_u *p;
1661
1662 /*
1663 * If there is a pipe, we have to put the '<' in front of it.
1664 * Don't do this when 'shellquote' is not empty, otherwise the
1665 * redirection would be inside the quotes.
1666 */
1667 if (*p_shq == NUL)
1668 {
1669 p = vim_strchr(buf, '|');
1670 if (p != NULL)
1671 *p = NUL;
1672 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1674 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 if (*p_shq == NUL)
1676 {
1677 p = vim_strchr(cmd, '|');
1678 if (p != NULL)
1679 {
1680 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1681 STRCAT(buf, p);
1682 }
1683 }
1684 }
1685#endif
1686 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001687 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688
1689 return buf;
1690}
1691
1692/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001693 * Append output redirection for file "fname" to the end of string buffer
1694 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 * Works with the 'shellredir' and 'shellpipe' options.
1696 * The caller should make sure that there is enough room:
1697 * STRLEN(opt) + STRLEN(fname) + 3
1698 */
1699 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001700append_redir(
1701 char_u *buf,
1702 int buflen,
1703 char_u *opt,
1704 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705{
1706 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001707 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001709 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001710 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001712 {
1713 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001715 if (p[1] == '%') /* skip %% */
1716 ++p;
1717 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 if (p != NULL)
1719 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001720 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1721 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1722 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 }
1724 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001725 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 " %s %s",
1728#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730#endif
1731 (char *)opt, (char *)fname);
1732}
1733
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001734#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001736static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001737static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001738static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001739static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740static int viminfo_errcnt;
1741
1742 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001743no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744{
1745 /* "vim -i NONE" does not read or write a viminfo file */
Bram Moolenaarc4da1132017-07-15 19:39:43 +02001746 return STRCMP(p_viminfofile, "NONE") == 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747}
1748
1749/*
1750 * Report an error for reading a viminfo file.
1751 * Count the number of errors. When there are more than 10, return TRUE.
1752 */
1753 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001754viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001756 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1757 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001758 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001759 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1760 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 emsg(IObuff);
1762 if (++viminfo_errcnt >= 10)
1763 {
1764 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1765 return TRUE;
1766 }
1767 return FALSE;
1768}
1769
1770/*
1771 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001772 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 */
1774 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001775read_viminfo(
1776 char_u *file, /* file name or NULL to use default name */
1777 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778{
1779 FILE *fp;
1780 char_u *fname;
1781
1782 if (no_viminfo())
1783 return FAIL;
1784
Bram Moolenaard812df62008-11-09 12:46:09 +00001785 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 if (fname == NULL)
1787 return FAIL;
1788 fp = mch_fopen((char *)fname, READBIN);
1789
1790 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001791 {
1792 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001793 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1794 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001795 (flags & VIF_WANT_INFO) ? _(" info") : "",
1796 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1797 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001798 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001799 verbose_leave();
1800 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801
1802 vim_free(fname);
1803 if (fp == NULL)
1804 return FAIL;
1805
1806 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001807 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
1809 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 return OK;
1811}
1812
1813/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001814 * Write the viminfo file. The old one is read in first so that effectively a
1815 * merge of current info and old info is done. This allows multiple vims to
1816 * run simultaneously, without losing any marks etc.
1817 * If "forceit" is TRUE, then the old file is not read in, and only internal
1818 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 */
1820 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001821write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822{
1823 char_u *fname;
1824 FILE *fp_in = NULL; /* input viminfo file, if any */
1825 FILE *fp_out = NULL; /* output viminfo file */
1826 char_u *tempname = NULL; /* name of temp viminfo file */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001827 stat_T st_new; /* mch_stat() of potential new file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 char_u *wp;
1829#if defined(UNIX) || defined(VMS)
1830 mode_t umask_save;
1831#endif
1832#ifdef UNIX
1833 int shortname = FALSE; /* use 8.3 file name */
Bram Moolenaar8767f522016-07-01 17:17:39 +02001834 stat_T st_old; /* mch_stat() of existing viminfo file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001836#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001837 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001838#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 if (no_viminfo())
1841 return;
1842
1843 fname = viminfo_filename(file); /* may set to default if NULL */
1844 if (fname == NULL)
1845 return;
1846
1847 fp_in = mch_fopen((char *)fname, READBIN);
1848 if (fp_in == NULL)
1849 {
1850 /* if it does exist, but we can't read it, don't try writing */
1851 if (mch_stat((char *)fname, &st_new) == 0)
1852 goto end;
1853#if defined(UNIX) || defined(VMS)
1854 /*
1855 * For Unix we create the .viminfo non-accessible for others,
1856 * because it may contain text from non-accessible documents.
1857 */
1858 umask_save = umask(077);
1859#endif
1860 fp_out = mch_fopen((char *)fname, WRITEBIN);
1861#if defined(UNIX) || defined(VMS)
1862 (void)umask(umask_save);
1863#endif
1864 }
1865 else
1866 {
1867 /*
1868 * There is an existing viminfo file. Create a temporary file to
1869 * write the new viminfo into, in the same directory as the
1870 * existing viminfo file, which will be renamed later.
1871 */
1872#ifdef UNIX
1873 /*
1874 * For Unix we check the owner of the file. It's not very nice to
1875 * overwrite a user's viminfo file after a "su root", with a
1876 * viminfo file that the user can't read.
1877 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001878 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001879 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001881 if (mch_stat((char *)fname, &st_old) == 0
1882 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001883 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 ? (st_old.st_mode & 0200)
1885 : (st_old.st_gid == getgid()
1886 ? (st_old.st_mode & 0020)
1887 : (st_old.st_mode & 0002))))
1888 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001889 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
1891 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1893 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001894 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 goto end;
1896 }
1897#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001898#ifdef WIN3264
1899 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001900 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001901#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902
1903 /*
1904 * Make tempname.
1905 * May try twice: Once normal and once with shortname set, just in
1906 * case somebody puts his viminfo file in an 8.3 filesystem.
1907 */
1908 for (;;)
1909 {
1910 tempname = buf_modname(
1911#ifdef UNIX
1912 shortname,
1913#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915#endif
1916 fname,
1917#ifdef VMS
1918 (char_u *)"-tmp",
1919#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921#endif
1922 FALSE);
1923 if (tempname == NULL) /* out of memory */
1924 break;
1925
1926 /*
1927 * Check if tempfile already exists. Never overwrite an
1928 * existing file!
1929 */
1930 if (mch_stat((char *)tempname, &st_new) == 0)
1931 {
1932#ifdef UNIX
1933 /*
1934 * Check if tempfile is same as original file. May happen
1935 * when modname() gave the same file back. E.g. silly
1936 * link, or file name-length reached. Try again with
1937 * shortname set.
1938 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001939 if (!shortname && st_new.st_dev == st_old.st_dev
1940 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 {
1942 vim_free(tempname);
1943 tempname = NULL;
1944 shortname = TRUE;
1945 continue;
1946 }
1947#endif
1948 /*
1949 * Try another name. Change one character, just before
1950 * the extension. This should also work for an 8.3
1951 * file name, when after adding the extension it still is
1952 * the same file as the original.
1953 */
1954 wp = tempname + STRLEN(tempname) - 5;
1955 if (wp < gettail(tempname)) /* empty file name? */
1956 wp = gettail(tempname);
1957 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1958 --*wp)
1959 {
1960 /*
1961 * They all exist? Must be something wrong! Don't
1962 * write the viminfo file then.
1963 */
1964 if (*wp == 'a')
1965 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001966 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1967 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 vim_free(tempname);
1969 tempname = NULL;
1970 break;
1971 }
1972 }
1973 }
1974 break;
1975 }
1976
1977 if (tempname != NULL)
1978 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001979#ifdef VMS
1980 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001981 umask_save = umask(077);
1982 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1983 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001984#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001985 int fd;
1986
1987 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001988 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001989 * Unix: same as original file, but strip s-bit. Reset umask to
1990 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001991 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001992# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001993 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001994 fd = mch_open((char *)tempname,
1995 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001996 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001997 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001998# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001999 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002000 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002001# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002002 if (fd < 0)
2003 fp_out = NULL;
2004 else
2005 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002006#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007
2008 /*
2009 * If we can't create in the same directory, try creating a
2010 * "normal" temp file.
2011 */
2012 if (fp_out == NULL)
2013 {
2014 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002015 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2017 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002018
2019#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002021 * Make sure the owner can read/write it. This only works for
2022 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 */
2024 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002025 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026#endif
2027 }
2028 }
2029
2030 /*
2031 * Check if the new viminfo file can be written to.
2032 */
2033 if (fp_out == NULL)
2034 {
2035 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002036 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 if (fp_in != NULL)
2038 fclose(fp_in);
2039 goto end;
2040 }
2041
2042 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002043 {
2044 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002045 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002046 verbose_leave();
2047 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048
2049 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002050 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
Bram Moolenaar927030a2016-03-15 18:23:55 +01002052 if (fclose(fp_out) == EOF)
2053 ++viminfo_errcnt;
2054
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 if (fp_in != NULL)
2056 {
2057 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002058
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002059 /* In case of an error keep the original viminfo file. Otherwise
2060 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002061 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002062 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002063 if (vim_rename(tempname, fname) == -1)
2064 {
2065 ++viminfo_errcnt;
2066 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2067 }
2068# ifdef WIN3264
2069 /* If the viminfo file was hidden then also hide the new file. */
2070 else if (hidden)
2071 mch_hide(fname);
2072# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002073 }
2074 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 mch_remove(tempname);
2076 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002077
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078end:
2079 vim_free(fname);
2080 vim_free(tempname);
2081}
2082
2083/*
2084 * Get the viminfo file name to use.
2085 * If "file" is given and not empty, use it (has already been expanded by
2086 * cmdline functions).
2087 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2088 * expand environment variables.
2089 * Returns an allocated string. NULL when out of memory.
2090 */
2091 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002092viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093{
2094 if (file == NULL || *file == NUL)
2095 {
Bram Moolenaarc4da1132017-07-15 19:39:43 +02002096 if (*p_viminfofile != NUL)
2097 file = p_viminfofile;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2099 {
2100#ifdef VIMINFO_FILE2
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101# ifdef VMS
2102 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2103# else
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002104# ifdef MSWIN
2105 /* Use $VIM only if $HOME is the default "C:/". */
2106 if (STRCMP(vim_getenv((char_u *)"HOME", NULL), "C:/") == 0
2107 && mch_getenv((char_u *)"HOME") == NULL)
2108# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 if (mch_getenv((char_u *)"HOME") == NULL)
Bram Moolenaar3d593c22017-08-31 20:42:18 +02002110# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111# endif
2112 {
2113 /* don't use $VIM when not available. */
2114 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2115 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2116 file = (char_u *)VIMINFO_FILE2;
2117 else
2118 file = (char_u *)VIMINFO_FILE;
2119 }
2120 else
2121#endif
2122 file = (char_u *)VIMINFO_FILE;
2123 }
2124 expand_env(file, NameBuff, MAXPATHL);
2125 file = NameBuff;
2126 }
2127 return vim_strsave(file);
2128}
2129
2130/*
2131 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2132 */
2133 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002134do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 int eof = FALSE;
2137 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002138 int merge = FALSE;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002139 int do_copy_marks = FALSE;
2140 garray_T buflist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141
2142 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2143 return;
2144 vir.vir_fd = fp_in;
2145#ifdef FEAT_MBYTE
2146 vir.vir_conv.vc_type = CONV_NONE;
2147#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002148 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002149 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150
2151 if (fp_in != NULL)
2152 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002153 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002154 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002155 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002156 {
2157 /* Registers and marks are read and kept separate from what
2158 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002159 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002160 prepare_viminfo_marks();
2161 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002162
Bram Moolenaard812df62008-11-09 12:46:09 +00002163 eof = read_viminfo_up_to_marks(&vir,
2164 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002165 merge = TRUE;
2166 }
2167 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 /* Skip info, find start of marks */
2169 while (!(eof = viminfo_readline(&vir))
2170 && vir.vir_line[0] != '>')
2171 ;
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002172
2173 do_copy_marks = (flags &
2174 (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002176
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 if (fp_out != NULL)
2178 {
2179 /* Write the info: */
2180 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2181 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002182 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002183 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002185 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2187#endif
2188 write_viminfo_search_pattern(fp_out);
2189 write_viminfo_sub_string(fp_out);
2190#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002191 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192#endif
2193 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002194 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195#ifdef FEAT_EVAL
2196 write_viminfo_varlist(fp_out);
2197#endif
2198 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002199 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002201 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002202
2203 if (do_copy_marks)
2204 ga_init2(&buflist, sizeof(buf_T *), 50);
2205 write_viminfo_marks(fp_out, do_copy_marks ? &buflist : NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 }
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02002207
2208 if (do_copy_marks)
2209 {
2210 copy_viminfo_marks(&vir, fp_out, &buflist, eof, flags);
2211 if (fp_out != NULL)
2212 ga_clear(&buflist);
2213 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214
2215 vim_free(vir.vir_line);
2216#ifdef FEAT_MBYTE
2217 if (vir.vir_conv.vc_type != CONV_NONE)
2218 convert_setup(&vir.vir_conv, NULL, NULL);
2219#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002220 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221}
2222
2223/*
2224 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2225 * first part of the viminfo file which contains everything but the marks that
2226 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2227 */
2228 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002229read_viminfo_up_to_marks(
2230 vir_T *virp,
2231 int forceit,
2232 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233{
2234 int eof;
2235 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002236 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237
2238#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002239 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002241
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 eof = viminfo_readline(virp);
2243 while (!eof && virp->vir_line[0] != '>')
2244 {
2245 switch (virp->vir_line[0])
2246 {
2247 /* Characters reserved for future expansion, ignored now */
2248 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 case '^': /* to be defined */
2250 case '<': /* long line - ignored */
2251 /* A comment or empty line. */
2252 case NUL:
2253 case '\r':
2254 case '\n':
2255 case '#':
2256 eof = viminfo_readline(virp);
2257 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002258 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002259 eof = read_viminfo_barline(virp, got_encoding,
2260 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002261 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002263 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 eof = viminfo_encoding(virp);
2265 break;
2266 case '!': /* global variable */
2267#ifdef FEAT_EVAL
2268 eof = read_viminfo_varlist(virp, writing);
2269#else
2270 eof = viminfo_readline(virp);
2271#endif
2272 break;
2273 case '%': /* entry for buffer list */
2274 eof = read_viminfo_bufferlist(virp, writing);
2275 break;
2276 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002277 /* When registers are in bar lines skip the old style register
2278 * lines. */
2279 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2280 eof = read_viminfo_register(virp, forceit);
2281 else
2282 do {
2283 eof = viminfo_readline(virp);
2284 } while (!eof && (virp->vir_line[0] == TAB
2285 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 break;
2287 case '/': /* Search string */
2288 case '&': /* Substitute search string */
2289 case '~': /* Last search string, followed by '/' or '&' */
2290 eof = read_viminfo_search_pattern(virp, forceit);
2291 break;
2292 case '$':
2293 eof = read_viminfo_sub_string(virp, forceit);
2294 break;
2295 case ':':
2296 case '?':
2297 case '=':
2298 case '@':
2299#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002300 /* When history is in bar lines skip the old style history
2301 * lines. */
2302 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2303 eof = read_viminfo_history(virp, writing);
2304 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002306 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 break;
2308 case '-':
2309 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002310 /* When file marks are in bar lines skip the old style lines. */
2311 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2312 eof = read_viminfo_filemark(virp, forceit);
2313 else
2314 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 break;
2316 default:
2317 if (viminfo_error("E575: ", _("Illegal starting char"),
2318 virp->vir_line))
2319 eof = TRUE;
2320 else
2321 eof = viminfo_readline(virp);
2322 break;
2323 }
2324 }
2325
2326#ifdef FEAT_CMDHIST
2327 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002328 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002329 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330#endif
2331
2332 /* Change file names to buffer numbers for fmarks. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002333 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 fmarks_check_names(buf);
2335
2336 return eof;
2337}
2338
2339/*
2340 * Compare the 'encoding' value in the viminfo file with the current value of
2341 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2342 * conversion of text with iconv() in viminfo_readstring().
2343 */
2344 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002345viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346{
2347#ifdef FEAT_MBYTE
2348 char_u *p;
2349 int i;
2350
2351 if (get_viminfo_parameter('c') != 0)
2352 {
2353 p = vim_strchr(virp->vir_line, '=');
2354 if (p != NULL)
2355 {
2356 /* remove trailing newline */
2357 ++p;
2358 for (i = 0; vim_isprintc(p[i]); ++i)
2359 ;
2360 p[i] = NUL;
2361
2362 convert_setup(&virp->vir_conv, p, p_enc);
2363 }
2364 }
2365#endif
2366 return viminfo_readline(virp);
2367}
2368
2369/*
2370 * Read a line from the viminfo file.
2371 * Returns TRUE for end-of-file;
2372 */
2373 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002374viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375{
2376 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2377}
2378
2379/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002380 * Check string read from viminfo file.
2381 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 * - replace CTRL-V CTRL-V with CTRL-V
2383 * - replace CTRL-V 'n' with '\n'
2384 *
2385 * Check for a long line as written by viminfo_writestring().
2386 *
2387 * Return the string in allocated memory (NULL when out of memory).
2388 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002390viminfo_readstring(
2391 vir_T *virp,
2392 int off, /* offset for virp->vir_line */
2393 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394{
2395 char_u *retval;
2396 char_u *s, *d;
2397 long len;
2398
2399 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2400 {
2401 len = atol((char *)virp->vir_line + off + 1);
2402 retval = lalloc(len, TRUE);
2403 if (retval == NULL)
2404 {
2405 /* Line too long? File messed up? Skip next line. */
2406 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2407 return NULL;
2408 }
2409 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2410 s = retval + 1; /* Skip the leading '<' */
2411 }
2412 else
2413 {
2414 retval = vim_strsave(virp->vir_line + off);
2415 if (retval == NULL)
2416 return NULL;
2417 s = retval;
2418 }
2419
2420 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2421 d = retval;
2422 while (*s != NUL && *s != '\n')
2423 {
2424 if (s[0] == Ctrl_V && s[1] != NUL)
2425 {
2426 if (s[1] == 'n')
2427 *d++ = '\n';
2428 else
2429 *d++ = Ctrl_V;
2430 s += 2;
2431 }
2432 else
2433 *d++ = *s++;
2434 }
2435 *d = NUL;
2436
2437#ifdef FEAT_MBYTE
2438 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2439 {
2440 d = string_convert(&virp->vir_conv, retval, NULL);
2441 if (d != NULL)
2442 {
2443 vim_free(retval);
2444 retval = d;
2445 }
2446 }
2447#endif
2448
2449 return retval;
2450}
2451
2452/*
2453 * write string to viminfo file
2454 * - replace CTRL-V with CTRL-V CTRL-V
2455 * - replace '\n' with CTRL-V 'n'
2456 * - add a '\n' at the end
2457 *
2458 * For a long line:
2459 * - write " CTRL-V <length> \n " in first line
2460 * - write " < <string> \n " in second line
2461 */
2462 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002463viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464{
2465 int c;
2466 char_u *s;
2467 int len = 0;
2468
2469 for (s = p; *s != NUL; ++s)
2470 {
2471 if (*s == Ctrl_V || *s == '\n')
2472 ++len;
2473 ++len;
2474 }
2475
2476 /* If the string will be too long, write its length and put it in the next
2477 * line. Take into account that some room is needed for what comes before
2478 * the string (e.g., variable name). Add something to the length for the
2479 * '<', NL and trailing NUL. */
2480 if (len > LSIZE / 2)
2481 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2482
2483 while ((c = *p++) != NUL)
2484 {
2485 if (c == Ctrl_V || c == '\n')
2486 {
2487 putc(Ctrl_V, fd);
2488 if (c == '\n')
2489 c = 'n';
2490 }
2491 putc(c, fd);
2492 }
2493 putc('\n', fd);
2494}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002495
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002496/*
2497 * Write a string in quotes that barline_parse() can read back.
2498 * Breaks the line in less than LSIZE pieces when needed.
2499 * Returns remaining characters in the line.
2500 */
2501 int
2502barline_writestring(FILE *fd, char_u *s, int remaining_start)
2503{
2504 char_u *p;
2505 int remaining = remaining_start;
2506 int len = 2;
2507
2508 /* Count the number of characters produced, including quotes. */
2509 for (p = s; *p != NUL; ++p)
2510 {
2511 if (*p == NL)
2512 len += 2;
2513 else if (*p == '"' || *p == '\\')
2514 len += 2;
2515 else
2516 ++len;
2517 }
Bram Moolenaar25709572016-08-26 20:41:16 +02002518 if (len > remaining - 2)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002519 {
2520 fprintf(fd, ">%d\n|<", len);
2521 remaining = LSIZE - 20;
2522 }
2523
2524 putc('"', fd);
2525 for (p = s; *p != NUL; ++p)
2526 {
2527 if (*p == NL)
2528 {
2529 putc('\\', fd);
2530 putc('n', fd);
2531 --remaining;
2532 }
2533 else if (*p == '"' || *p == '\\')
2534 {
2535 putc('\\', fd);
2536 putc(*p, fd);
2537 --remaining;
2538 }
2539 else
2540 putc(*p, fd);
2541 --remaining;
2542
2543 if (remaining < 3)
2544 {
2545 putc('\n', fd);
2546 putc('|', fd);
2547 putc('<', fd);
2548 /* Leave enough space for another continuation. */
2549 remaining = LSIZE - 20;
2550 }
2551 }
2552 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002553 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002554}
2555
2556/*
2557 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002558 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002559 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002560 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002561 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002562barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002563{
2564 char_u *p = text;
2565 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002566 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002567 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002568 int i;
2569 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002570 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002571#ifdef FEAT_MBYTE
2572 char_u *sconv;
2573 int converted;
2574#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002575
2576 while (*p == ',')
2577 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002578 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002579 if (ga_grow(values, 1) == FAIL)
2580 break;
2581 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002582
2583 if (*p == '>')
2584 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002585 /* Need to read a continuation line. Put strings in allocated
2586 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002587 if (!allocated)
2588 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002589 for (i = 0; i < values->ga_len; ++i)
2590 {
2591 bval_T *vp = (bval_T *)(values->ga_data) + i;
2592
2593 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002594 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002595 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2596 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002597 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002598 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002599 allocated = TRUE;
2600 }
2601
2602 if (vim_isdigit(p[1]))
2603 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002604 size_t len;
2605 size_t todo;
2606 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002607
2608 /* String value was split into lines that are each shorter
2609 * than LSIZE:
2610 * |{bartype},>{length of "{text}{text2}"}
2611 * |<"{text1}
2612 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002613 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002614 */
2615 ++p;
2616 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002617 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002618 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002619 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002620 p = buf;
2621 for (todo = len; todo > 0; todo -= n)
2622 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002623 eof = viminfo_readline(virp);
2624 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002625 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002626 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002627 /* File was truncated or garbled. Read another line if
2628 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002629 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002630 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002631 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002632 /* Get length of text, excluding |< and NL chars. */
2633 n = STRLEN(virp->vir_line);
2634 while (n > 0 && (virp->vir_line[n - 1] == NL
2635 || virp->vir_line[n - 1] == CAR))
2636 --n;
2637 n -= 2;
2638 if (n > todo)
2639 {
2640 /* more values follow after the string */
2641 nextp = virp->vir_line + 2 + todo;
2642 n = todo;
2643 }
2644 mch_memmove(p, virp->vir_line + 2, n);
2645 p += n;
2646 }
2647 *p = NUL;
2648 p = buf;
2649 }
2650 else
2651 {
2652 /* Line ending in ">" continues in the next line:
2653 * |{bartype},{lots of values},>
2654 * |<{value},{value}
2655 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002656 eof = viminfo_readline(virp);
2657 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002658 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002659 /* File was truncated or garbled. Read another line if
2660 * this one starts with '|'. */
2661 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002662 p = virp->vir_line + 2;
2663 }
2664 }
2665
2666 if (isdigit(*p))
2667 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002668 value->bv_type = BVAL_NR;
2669 value->bv_nr = getdigits(&p);
2670 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002671 }
2672 else if (*p == '"')
2673 {
2674 int len = 0;
2675 char_u *s = p;
2676
2677 /* Unescape special characters in-place. */
2678 ++p;
2679 while (*p != '"')
2680 {
2681 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002682 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002683 if (*p == '\\')
2684 {
2685 ++p;
2686 if (*p == 'n')
2687 s[len++] = '\n';
2688 else
2689 s[len++] = *p;
2690 ++p;
2691 }
2692 else
2693 s[len++] = *p++;
2694 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002695 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002696 s[len] = NUL;
2697
Bram Moolenaar01227092016-06-11 14:47:40 +02002698#ifdef FEAT_MBYTE
2699 converted = FALSE;
2700 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2701 {
2702 sconv = string_convert(&virp->vir_conv, s, NULL);
2703 if (sconv != NULL)
2704 {
2705 if (s == buf)
2706 vim_free(s);
2707 s = sconv;
2708 buf = s;
2709 converted = TRUE;
2710 }
2711 }
2712#endif
2713 /* Need to copy in allocated memory if the string wasn't allocated
2714 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002715 if (s != buf && allocated)
2716 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002717 value->bv_string = s;
2718 value->bv_type = BVAL_STRING;
2719 value->bv_len = len;
2720 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002721#ifdef FEAT_MBYTE
2722 || converted
2723#endif
2724 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002725 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002726 if (nextp != NULL)
2727 {
2728 /* values following a long string */
2729 p = nextp;
2730 nextp = NULL;
2731 }
2732 }
2733 else if (*p == ',')
2734 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002735 value->bv_type = BVAL_EMPTY;
2736 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002737 }
2738 else
2739 break;
2740 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002741 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002742}
2743
2744 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002745read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002746{
2747 char_u *p = virp->vir_line + 1;
2748 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002749 garray_T values;
2750 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002751 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002752 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002753
2754 /* The format is: |{bartype},{value},...
2755 * For a very long string:
2756 * |{bartype},>{length of "{text}{text2}"}
2757 * |<{text1}
2758 * |<{text2},{value}
2759 * For a long line not using a string
2760 * |{bartype},{lots of values},>
2761 * |<{value},{value}
2762 */
2763 if (*p == '<')
2764 {
2765 /* Continuation line of an unrecognized item. */
2766 if (writing)
2767 ga_add_string(&virp->vir_barlines, virp->vir_line);
2768 }
2769 else
2770 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002771 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002772 bartype = getdigits(&p);
2773 switch (bartype)
2774 {
2775 case BARTYPE_VERSION:
2776 /* Only use the version when it comes before the encoding.
2777 * If it comes later it was copied by a Vim version that
2778 * doesn't understand the version. */
2779 if (!got_encoding)
2780 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002781 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002782 vp = (bval_T *)values.ga_data;
2783 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2784 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002785 }
2786 break;
2787
2788 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002789 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002790 handle_viminfo_history(&values, writing);
2791 break;
2792
2793 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002794 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002795 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002796 break;
2797
Bram Moolenaar2d358992016-06-12 21:20:54 +02002798 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002799 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002800 handle_viminfo_mark(&values, force);
2801 break;
2802
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002803 default:
2804 /* copy unrecognized line (for future use) */
2805 if (writing)
2806 ga_add_string(&virp->vir_barlines, virp->vir_line);
2807 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002808 for (i = 0; i < values.ga_len; ++i)
2809 {
2810 vp = (bval_T *)values.ga_data + i;
2811 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2812 vim_free(vp->bv_string);
2813 }
2814 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002815 }
2816
Bram Moolenaarecefe712016-06-20 12:50:17 +02002817 if (read_next)
2818 return viminfo_readline(virp);
2819 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002820}
2821
2822 static void
2823write_viminfo_version(FILE *fp_out)
2824{
2825 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2826 BARTYPE_VERSION, VIMINFO_VERSION);
2827}
2828
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002829 static void
2830write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2831{
2832 int i;
2833 garray_T *gap = &virp->vir_barlines;
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002834 int seen_useful = FALSE;
2835 char *line;
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002836
2837 if (gap->ga_len > 0)
2838 {
2839 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2840
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002841 /* Skip over continuation lines until seeing a useful line. */
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002842 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaardec85cf2016-07-02 22:33:46 +02002843 {
2844 line = ((char **)(gap->ga_data))[i];
2845 if (seen_useful || line[1] != '<')
2846 {
2847 fputs(line, fp_out);
2848 seen_useful = TRUE;
2849 }
2850 }
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002851 }
2852}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853#endif /* FEAT_VIMINFO */
2854
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002855/*
2856 * Return the current time in seconds. Calls time(), unless test_settime()
2857 * was used.
2858 */
Bram Moolenaarf4fba6d2016-06-26 16:44:24 +02002859 time_T
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002860vim_time(void)
2861{
2862# ifdef FEAT_EVAL
2863 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2864# else
2865 return time(NULL);
2866# endif
2867}
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002868
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869/*
2870 * Implementation of ":fixdel", also used by get_stty().
2871 * <BS> resulting <Del>
2872 * ^? ^H
2873 * not ^? ^?
2874 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002876do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877{
2878 char_u *p;
2879
2880 p = find_termcode((char_u *)"kb");
2881 add_termcode((char_u *)"kD", p != NULL
2882 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2883}
2884
2885 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002886print_line_no_prefix(
2887 linenr_T lnum,
2888 int use_number,
2889 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002891 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892
2893 if (curwin->w_p_nu || use_number)
2894 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002895 vim_snprintf((char *)numbuf, sizeof(numbuf),
2896 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar8820b482017-03-16 17:23:31 +01002897 msg_puts_attr(numbuf, HL_ATTR(HLF_N)); /* Highlight line nrs */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002899 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900}
2901
2902/*
2903 * Print a text line. Also in silent mode ("ex -s").
2904 */
2905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002906print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907{
2908 int save_silent = silent_mode;
2909
Bram Moolenaard29459b2016-08-26 22:29:11 +02002910 /* apply :filter /pat/ */
2911 if (message_filtered(ml_get(lnum)))
2912 return;
2913
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002915 silent_mode = FALSE;
2916 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2917 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 if (save_silent)
2919 {
2920 msg_putchar('\n');
2921 cursor_on(); /* msg_start() switches it off */
2922 out_flush();
2923 silent_mode = save_silent;
2924 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002925 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926}
2927
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002928 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002929rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002930{
2931 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002932 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002933
Bram Moolenaar7e283842013-05-30 11:43:15 +02002934#ifdef FEAT_AUTOCMD
2935 buf = curbuf;
2936 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002937 /* buffer changed, don't change name now */
2938 if (buf != curbuf)
2939 return FAIL;
2940# ifdef FEAT_EVAL
2941 if (aborting()) /* autocmds may abort script processing */
2942 return FAIL;
2943# endif
2944#endif
2945 /*
2946 * The name of the current buffer will be changed.
2947 * A new (unlisted) buffer entry needs to be made to hold the old file
2948 * name, which will become the alternate file name.
2949 * But don't set the alternate file name if the buffer didn't have a
2950 * name.
2951 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002952 fname = curbuf->b_ffname;
2953 sfname = curbuf->b_sfname;
2954 xfname = curbuf->b_fname;
2955 curbuf->b_ffname = NULL;
2956 curbuf->b_sfname = NULL;
2957 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002958 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002959 curbuf->b_ffname = fname;
2960 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002961 return FAIL;
2962 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002963 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002964 if (xfname != NULL && *xfname != NUL)
2965 {
2966 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2967 if (buf != NULL && !cmdmod.keepalt)
2968 curwin->w_alt_fnum = buf->b_fnum;
2969 }
2970 vim_free(fname);
2971 vim_free(sfname);
2972#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002973 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002974#endif
2975 /* Change directories when the 'acd' option is set. */
2976 DO_AUTOCHDIR
2977 return OK;
2978}
2979
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980/*
2981 * ":file[!] [fname]".
2982 */
2983 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002984ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002986 /* ":0file" removes the file name. Check for illegal uses ":3file",
2987 * "0file name", etc. */
2988 if (eap->addr_count > 0
2989 && (*eap->arg != NUL
2990 || eap->line2 > 0
2991 || eap->addr_count > 1))
2992 {
2993 EMSG(_(e_invarg));
2994 return;
2995 }
2996
2997 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002999 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 }
3002 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01003003 if (!shortmess(SHM_FILEINFO))
3004 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005}
3006
3007/*
3008 * ":update".
3009 */
3010 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003011ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012{
3013 if (curbufIsChanged())
3014 (void)do_write(eap);
3015}
3016
3017/*
3018 * ":write" and ":saveas".
3019 */
3020 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003021ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022{
3023 if (eap->usefilter) /* input lines to shell command */
3024 do_bang(1, eap, FALSE, TRUE, FALSE);
3025 else
3026 (void)do_write(eap);
3027}
3028
3029/*
3030 * write current buffer to file 'eap->arg'
3031 * if 'eap->append' is TRUE, append to the file
3032 *
3033 * if *eap->arg == NUL write to current file
3034 *
3035 * return FAIL for failure, OK otherwise
3036 */
3037 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003038do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039{
3040 int other;
3041 char_u *fname = NULL; /* init to shut up gcc */
3042 char_u *ffname;
3043 int retval = FAIL;
3044 char_u *free_fname = NULL;
3045#ifdef FEAT_BROWSE
3046 char_u *browse_file = NULL;
3047#endif
3048 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003049 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050
3051 if (not_writing()) /* check 'write' option */
3052 return FAIL;
3053
3054 ffname = eap->arg;
3055#ifdef FEAT_BROWSE
3056 if (cmdmod.browse)
3057 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003058 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 NULL, NULL, NULL, curbuf);
3060 if (browse_file == NULL)
3061 goto theend;
3062 ffname = browse_file;
3063 }
3064#endif
3065 if (*ffname == NUL)
3066 {
3067 if (eap->cmdidx == CMD_saveas)
3068 {
3069 EMSG(_(e_argreq));
3070 goto theend;
3071 }
3072 other = FALSE;
3073 }
3074 else
3075 {
3076 fname = ffname;
3077 free_fname = fix_fname(ffname);
3078 /*
3079 * When out-of-memory, keep unexpanded file name, because we MUST be
3080 * able to write the file in this situation.
3081 */
3082 if (free_fname != NULL)
3083 ffname = free_fname;
3084 other = otherfile(ffname);
3085 }
3086
3087 /*
3088 * If we have a new file, put its name in the list of alternate file names.
3089 */
3090 if (other)
3091 {
3092 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3093 || eap->cmdidx == CMD_saveas)
3094 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3095 else
3096 alt_buf = buflist_findname(ffname);
3097 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3098 {
3099 /* Overwriting a file that is loaded in another buffer is not a
3100 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003101 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 goto theend;
3103 }
3104 }
3105
3106 /*
3107 * Writing to the current file is not allowed in readonly mode
3108 * and a file name is required.
3109 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3110 */
3111 if (!other && (
3112#ifdef FEAT_QUICKFIX
3113 bt_dontwrite_msg(curbuf) ||
3114#endif
3115 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3116 goto theend;
3117
3118 if (!other)
3119 {
3120 ffname = curbuf->b_ffname;
3121 fname = curbuf->b_fname;
3122 /*
3123 * Not writing the whole file is only allowed with '!'.
3124 */
3125 if ( (eap->line1 != 1
3126 || eap->line2 != curbuf->b_ml.ml_line_count)
3127 && !eap->forceit
3128 && !eap->append
3129 && !p_wa)
3130 {
3131#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3132 if (p_confirm || cmdmod.confirm)
3133 {
3134 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3135 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3136 goto theend;
3137 eap->forceit = TRUE;
3138 }
3139 else
3140#endif
3141 {
3142 EMSG(_("E140: Use ! to write partial buffer"));
3143 goto theend;
3144 }
3145 }
3146 }
3147
3148 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3149 {
3150 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3151 {
3152#ifdef FEAT_AUTOCMD
3153 buf_T *was_curbuf = curbuf;
3154
3155 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003156 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157# ifdef FEAT_EVAL
3158 if (curbuf != was_curbuf || aborting())
3159# else
3160 if (curbuf != was_curbuf)
3161# endif
3162 {
3163 /* buffer changed, don't change name now */
3164 retval = FAIL;
3165 goto theend;
3166 }
3167#endif
3168 /* Exchange the file names for the current and the alternate
3169 * buffer. This makes it look like we are now editing the buffer
3170 * under the new name. Must be done before buf_write(), because
3171 * if there is no file name and 'cpo' contains 'F', it will set
3172 * the file name. */
3173 fname = alt_buf->b_fname;
3174 alt_buf->b_fname = curbuf->b_fname;
3175 curbuf->b_fname = fname;
3176 fname = alt_buf->b_ffname;
3177 alt_buf->b_ffname = curbuf->b_ffname;
3178 curbuf->b_ffname = fname;
3179 fname = alt_buf->b_sfname;
3180 alt_buf->b_sfname = curbuf->b_sfname;
3181 curbuf->b_sfname = fname;
3182 buf_name_changed(curbuf);
3183#ifdef FEAT_AUTOCMD
3184 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003185 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 if (!alt_buf->b_p_bl)
3187 {
3188 alt_buf->b_p_bl = TRUE;
3189 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3190 }
3191# ifdef FEAT_EVAL
3192 if (curbuf != was_curbuf || aborting())
3193# else
3194 if (curbuf != was_curbuf)
3195# endif
3196 {
3197 /* buffer changed, don't write the file */
3198 retval = FAIL;
3199 goto theend;
3200 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003201
3202 /* If 'filetype' was empty try detecting it now. */
3203 if (*curbuf->b_p_ft == NUL)
3204 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003205 if (au_has_group((char_u *)"filetypedetect"))
3206 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003207 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003208 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003209 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003210
3211 /* Autocommands may have changed buffer names, esp. when
3212 * 'autochdir' is set. */
3213 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214#endif
3215 }
3216
Bram Moolenaar5c719942016-07-09 23:40:45 +02003217 name_was_missing = curbuf->b_ffname == NULL;
3218
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3220 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003221
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003222 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003223 if (eap->cmdidx == CMD_saveas)
3224 {
3225 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003226 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003227 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003228 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003229 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003230 }
3231
3232 /* Change directories when the 'acd' option is set and the file name
3233 * got changed or set. */
3234 if (eap->cmdidx == CMD_saveas || name_was_missing)
3235 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003236 DO_AUTOCHDIR
3237 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 }
3239
3240theend:
3241#ifdef FEAT_BROWSE
3242 vim_free(browse_file);
3243#endif
3244 vim_free(free_fname);
3245 return retval;
3246}
3247
3248/*
3249 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3250 * BF_NEW or BF_READERR, check for overwriting current file.
3251 * May set eap->forceit if a dialog says it's OK to overwrite.
3252 * Return OK if it's OK, FAIL if it is not.
3253 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003254 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003255check_overwrite(
3256 exarg_T *eap,
3257 buf_T *buf,
3258 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003260 char_u *ffname, /* full path version of fname */
3261 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262{
3263 /*
3264 * write to other file or b_flags set or not writing the whole file:
3265 * overwriting only allowed with '!'
3266 */
3267 if ( (other
3268 || (buf->b_flags & BF_NOTEDITED)
3269 || ((buf->b_flags & BF_NEW)
3270 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3271 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003273#ifdef FEAT_QUICKFIX
3274 && !bt_nofile(buf)
3275#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 && vim_fexists(ffname))
3277 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003278 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003280#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003281 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003282 if (mch_isdir(ffname))
3283 {
3284 EMSG2(_(e_isadir2), ffname);
3285 return FAIL;
3286 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287#endif
3288#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003289 if (p_confirm || cmdmod.confirm)
3290 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003291 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003293 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3294 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3295 return FAIL;
3296 eap->forceit = TRUE;
3297 }
3298 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003300 {
3301 EMSG(_(e_exists));
3302 return FAIL;
3303 }
3304 }
3305
3306 /* For ":w! filename" check that no swap file exists for "filename". */
3307 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003309 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003310 char_u *p;
3311 int r;
3312 char_u *swapname;
3313
3314 /* We only try the first entry in 'directory', without checking if
3315 * it's writable. If the "." directory is not writable the write
3316 * will probably fail anyway.
3317 * Use 'shortname' of the current buffer, since there is no buffer
3318 * for the written file. */
3319 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003320 {
3321 dir = alloc(5);
3322 if (dir == NULL)
3323 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003324 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003325 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003326 else
3327 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003328 dir = alloc(MAXPATHL);
3329 if (dir == NULL)
3330 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003331 p = p_dir;
3332 copy_option_part(&p, dir, MAXPATHL, ",");
3333 }
3334 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003335 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003336 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003337 if (r)
3338 {
3339#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3340 if (p_confirm || cmdmod.confirm)
3341 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003342 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003343
3344 dialog_msg(buff,
3345 _("Swap file \"%s\" exists, overwrite anyway?"),
3346 swapname);
3347 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3348 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003349 {
3350 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003351 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003352 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003353 eap->forceit = TRUE;
3354 }
3355 else
3356#endif
3357 {
3358 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3359 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003360 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003361 return FAIL;
3362 }
3363 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003364 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 }
3366 }
3367 return OK;
3368}
3369
3370/*
3371 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3372 */
3373 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003374ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375{
3376 int i;
3377
3378 if (eap->cmd[1] == 'n')
3379 i = curwin->w_arg_idx + (int)eap->line2;
3380 else
3381 i = curwin->w_arg_idx - (int)eap->line2;
3382 eap->line1 = 1;
3383 eap->line2 = curbuf->b_ml.ml_line_count;
3384 if (do_write(eap) != FAIL)
3385 do_argfile(eap, i);
3386}
3387
3388/*
3389 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3390 */
3391 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003392do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393{
3394 buf_T *buf;
3395 int error = 0;
3396 int save_forceit = eap->forceit;
3397
3398 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3399 exiting = TRUE;
3400
Bram Moolenaar29323592016-07-24 22:04:11 +02003401 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 {
3403 if (bufIsChanged(buf))
3404 {
3405 /*
3406 * Check if there is a reason the buffer cannot be written:
3407 * 1. if the 'write' option is set
3408 * 2. if there is no file name (even after browsing)
3409 * 3. if the 'readonly' is set (even after a dialog)
3410 * 4. if overwriting is allowed (even after a dialog)
3411 */
3412 if (not_writing())
3413 {
3414 ++error;
3415 break;
3416 }
3417#ifdef FEAT_BROWSE
3418 /* ":browse wall": ask for file name if there isn't one */
3419 if (buf->b_ffname == NULL && cmdmod.browse)
3420 browse_save_fname(buf);
3421#endif
3422 if (buf->b_ffname == NULL)
3423 {
3424 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3425 ++error;
3426 }
3427 else if (check_readonly(&eap->forceit, buf)
3428 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3429 FALSE) == FAIL)
3430 {
3431 ++error;
3432 }
3433 else
3434 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003435#ifdef FEAT_AUTOCMD
3436 bufref_T bufref;
3437
3438 set_bufref(&bufref, buf);
3439#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 if (buf_write_all(buf, eap->forceit) == FAIL)
3441 ++error;
3442#ifdef FEAT_AUTOCMD
3443 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003444 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 buf = firstbuf;
3446#endif
3447 }
3448 eap->forceit = save_forceit; /* check_overwrite() may set it */
3449 }
3450 }
3451 if (exiting)
3452 {
3453 if (!error)
3454 getout(0); /* exit Vim */
3455 not_exiting();
3456 }
3457}
3458
3459/*
3460 * Check the 'write' option.
3461 * Return TRUE and give a message when it's not st.
3462 */
3463 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003464not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465{
3466 if (p_write)
3467 return FALSE;
3468 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3469 return TRUE;
3470}
3471
3472/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003473 * Check if a buffer is read-only (either 'readonly' option is set or file is
3474 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3475 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 */
3477 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003478check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003480 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003481
3482 /* Handle a file being readonly when the 'readonly' option is set or when
3483 * the file exists and permissions are read-only.
3484 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3485 * important for device checks but not here. */
3486 if (!*forceit && (buf->b_p_ro
3487 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3488 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 {
3490#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3491 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3492 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003493 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494
Bram Moolenaar5386a122007-06-28 20:02:32 +00003495 if (buf->b_p_ro)
3496 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3497 buf->b_fname);
3498 else
3499 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 +00003500 buf->b_fname);
3501
3502 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3503 {
3504 /* Set forceit, to force the writing of a readonly file */
3505 *forceit = TRUE;
3506 return FALSE;
3507 }
3508 else
3509 return TRUE;
3510 }
3511 else
3512#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003513 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003515 else
3516 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3517 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 return TRUE;
3519 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003520
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 return FALSE;
3522}
3523
3524/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003525 * Try to abandon current file and edit a new or existing file.
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003526 * "fnum" is the number of the file, if zero use ffname/sfname.
3527 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003529 * Return:
3530 * GETFILE_ERROR for "normal" error,
3531 * GETFILE_NOT_WRITTEN for "not written" error,
3532 * GETFILE_SAME_FILE for success
3533 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 */
3535 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003536getfile(
3537 int fnum,
3538 char_u *ffname,
3539 char_u *sfname,
3540 int setpm,
3541 linenr_T lnum,
3542 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543{
3544 int other;
3545 int retval;
3546 char_u *free_me = NULL;
3547
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003548 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003549 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003550#ifdef FEAT_AUTOCMD
3551 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003552 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003553#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
3555 if (fnum == 0)
3556 {
3557 /* make ffname full path, set sfname */
3558 fname_expand(curbuf, &ffname, &sfname);
3559 other = otherfile(ffname);
3560 free_me = ffname; /* has been allocated, free() later */
3561 }
3562 else
3563 other = (fnum != curbuf->b_fnum);
3564
3565 if (other)
3566 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003567 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3569 {
3570#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3571 if (p_confirm && p_write)
3572 dialog_changed(curbuf, FALSE);
3573 if (curbufIsChanged())
3574#endif
3575 {
3576 if (other)
3577 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003578 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003579 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 goto theend;
3581 }
3582 }
3583 if (other)
3584 --no_wait_return;
3585 if (setpm)
3586 setpcmark();
3587 if (!other)
3588 {
3589 if (lnum != 0)
3590 curwin->w_cursor.lnum = lnum;
3591 check_cursor_lnum();
3592 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003593 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 }
3595 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003596 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003597 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003598 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003600 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601
3602theend:
3603 vim_free(free_me);
3604 return retval;
3605}
3606
3607/*
3608 * start editing a new file
3609 *
3610 * fnum: file number; if zero use ffname/sfname
3611 * ffname: the file name
3612 * - full path if sfname used,
3613 * - any file name if sfname is NULL
3614 * - empty string to re-edit with the same file name (but may be
3615 * in a different directory)
3616 * - NULL to start an empty buffer
3617 * sfname: the short file name (or NULL)
3618 * eap: contains the command to be executed after loading the file and
3619 * forced 'ff' and 'fenc'
3620 * newlnum: if > 0: put cursor on this line number (if possible)
3621 * if ECMD_LASTL: use last position in loaded file
3622 * if ECMD_LAST: use last position in all files
3623 * if ECMD_ONE: use first line
3624 * flags:
3625 * ECMD_HIDE: if TRUE don't free the current buffer
3626 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3627 * ECMD_OLDBUF: use existing buffer if it exists
3628 * ECMD_FORCEIT: ! used for Ex command
3629 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003630 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003631 * window, NULL when splitting the window first. When not NULL info
3632 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 *
3634 * return FAIL for failure, OK otherwise
3635 */
3636 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003637do_ecmd(
3638 int fnum,
3639 char_u *ffname,
3640 char_u *sfname,
3641 exarg_T *eap, /* can be NULL! */
3642 linenr_T newlnum,
3643 int flags,
3644 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645{
3646 int other_file; /* TRUE if editing another file */
3647 int oldbuf; /* TRUE if using existing buffer */
3648#ifdef FEAT_AUTOCMD
3649 int auto_buf = FALSE; /* TRUE if autocommands brought us
3650 into the buffer unexpectedly */
3651 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003652 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653#endif
3654 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003655 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003657 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658#endif
3659 char_u *free_fname = NULL;
3660#ifdef FEAT_BROWSE
3661 char_u *browse_file = NULL;
3662#endif
3663 int retval = FAIL;
3664 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003665 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 linenr_T topline = 0;
3667 int newcol = -1;
3668 int solcol = -1;
3669 pos_T *pos;
3670#ifdef FEAT_SUN_WORKSHOP
3671 char_u *cp;
3672#endif
3673 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003674#ifdef FEAT_SPELL
3675 int did_get_winopts = FALSE;
3676#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003677 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003678 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679
3680 if (eap != NULL)
3681 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003682#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3683 set_bufref(&old_curbuf, curbuf);
3684#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685
3686 if (fnum != 0)
3687 {
3688 if (fnum == curbuf->b_fnum) /* file is already being edited */
3689 return OK; /* nothing to do */
3690 other_file = TRUE;
3691 }
3692 else
3693 {
3694#ifdef FEAT_BROWSE
3695 if (cmdmod.browse)
3696 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003697# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003698 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003699# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003700 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003701# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003702 au_has_group((char_u *)"FileExplorer"))
3703 {
3704 /* No browsing supported but we do have the file explorer:
3705 * Edit the directory. */
3706 if (ffname == NULL || !mch_isdir(ffname))
3707 ffname = (char_u *)".";
3708 }
3709 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003710# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003711 {
3712 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003714 if (browse_file == NULL)
3715 goto theend;
3716 ffname = browse_file;
3717 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 }
3719#endif
3720 /* if no short name given, use ffname for short name */
3721 if (sfname == NULL)
3722 sfname = ffname;
3723#ifdef USE_FNAME_CASE
3724# ifdef USE_LONG_FNAME
3725 if (USE_LONG_FNAME)
3726# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003727 if (sfname != NULL)
3728 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729#endif
3730
3731#ifdef FEAT_LISTCMDS
3732 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3733 goto theend;
3734#endif
3735
3736 if (ffname == NULL)
3737 other_file = TRUE;
3738 /* there is no file name */
3739 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3740 other_file = FALSE;
3741 else
3742 {
3743 if (*ffname == NUL) /* re-edit with same file name */
3744 {
3745 ffname = curbuf->b_ffname;
3746 sfname = curbuf->b_fname;
3747 }
3748 free_fname = fix_fname(ffname); /* may expand to full path name */
3749 if (free_fname != NULL)
3750 ffname = free_fname;
3751 other_file = otherfile(ffname);
3752#ifdef FEAT_SUN_WORKSHOP
3753 if (usingSunWorkShop && p_acd
3754 && (cp = vim_strrchr(sfname, '/')) != NULL)
3755 sfname = ++cp;
3756#endif
3757 }
3758 }
3759
3760 /*
3761 * if the file was changed we may not be allowed to abandon it
3762 * - if we are going to re-edit the same file
3763 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3764 */
3765 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3766 || (curbuf->b_nwindows == 1
3767 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003768 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3769 | (other_file ? 0 : CCGD_MULTWIN)
3770 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3771 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 {
3773 if (fnum == 0 && other_file && ffname != NULL)
3774 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3775 goto theend;
3776 }
3777
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 /*
3779 * End Visual mode before switching to another buffer, so the text can be
3780 * copied into the GUI selection buffer.
3781 */
3782 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003784#ifdef FEAT_AUTOCMD
3785 if ((command != NULL || newlnum > (linenr_T)0)
3786 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3787 {
3788 int len;
3789 char_u *p;
3790
3791 /* Set v:swapcommand for the SwapExists autocommands. */
3792 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003793 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003794 else
3795 len = 30;
3796 p = alloc((unsigned)len);
3797 if (p != NULL)
3798 {
3799 if (command != NULL)
3800 vim_snprintf((char *)p, len, ":%s\r", command);
3801 else
3802 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3803 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3804 did_set_swapcommand = TRUE;
3805 vim_free(p);
3806 }
3807 }
3808#endif
3809
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 /*
3811 * If we are starting to edit another file, open a (new) buffer.
3812 * Otherwise we re-use the current buffer.
3813 */
3814 if (other_file)
3815 {
3816#ifdef FEAT_LISTCMDS
3817 if (!(flags & ECMD_ADDBUF))
3818#endif
3819 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003820 if (!cmdmod.keepalt)
3821 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003822 if (oldwin != NULL)
3823 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 }
3825
3826 if (fnum)
3827 buf = buflist_findnr(fnum);
3828 else
3829 {
3830#ifdef FEAT_LISTCMDS
3831 if (flags & ECMD_ADDBUF)
3832 {
3833 linenr_T tlnum = 1L;
3834
3835 if (command != NULL)
3836 {
3837 tlnum = atol((char *)command);
3838 if (tlnum <= 0)
3839 tlnum = 1L;
3840 }
3841 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3842 goto theend;
3843 }
3844#endif
3845 buf = buflist_new(ffname, sfname, 0L,
3846 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003847#ifdef FEAT_AUTOCMD
3848 /* autocommands may change curwin and curbuf */
3849 if (oldwin != NULL)
3850 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003851 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003852#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 }
3854 if (buf == NULL)
3855 goto theend;
3856 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3857 {
3858 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 }
3860 else /* existing memfile */
3861 {
3862 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003863 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003865 /* Check if autocommands made the buffer invalid or changed the
3866 * current buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003867 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003869 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870#endif
3871 )
3872 goto theend;
3873#ifdef FEAT_EVAL
3874 if (aborting()) /* autocmds may abort script processing */
3875 goto theend;
3876#endif
3877 }
3878
3879 /* May jump to last used line number for a loaded buffer or when asked
3880 * for explicitly */
3881 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3882 {
3883 pos = buflist_findfpos(buf);
3884 newlnum = pos->lnum;
3885 solcol = pos->col;
3886 }
3887
3888 /*
3889 * Make the (new) buffer the one used by the current window.
3890 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3891 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003892 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 */
3894 if (buf != curbuf)
3895 {
3896#ifdef FEAT_AUTOCMD
3897 /*
3898 * Be careful: The autocommands may delete any buffer and change
3899 * the current buffer.
3900 * - If the buffer we are going to edit is deleted, give up.
3901 * - If the current buffer is deleted, prefer to load the new
3902 * buffer when loading a buffer is required. This avoids
3903 * loading another buffer which then must be closed again.
3904 * - If we ended up in the new buffer already, need to skip a few
3905 * things, set auto_buf.
3906 */
3907 if (buf->b_fname != NULL)
3908 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003909 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003911 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003913 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 delbuf_msg(new_name); /* frees new_name */
3915 goto theend;
3916 }
3917# ifdef FEAT_EVAL
3918 if (aborting()) /* autocmds may abort script processing */
3919 {
3920 vim_free(new_name);
3921 goto theend;
3922 }
3923# endif
3924 if (buf == curbuf) /* already in new buffer */
3925 auto_buf = TRUE;
3926 else
3927 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02003928 win_T *the_curwin = curwin;
3929
3930 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003931 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02003932 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003933 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02003934
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003935 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936#endif
3937 buf_copy_options(buf, BCO_ENTER);
3938
Bram Moolenaar5a497892016-09-03 16:29:04 +02003939 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02003940 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003941 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003942 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003943 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944
3945#ifdef FEAT_AUTOCMD
Bram Moolenaar5a497892016-09-03 16:29:04 +02003946 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003947 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01003948
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949# ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02003950 /* autocmds may abort script processing */
3951 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 {
3953 vim_free(new_name);
3954 goto theend;
3955 }
3956# endif
3957 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003958 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003960 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 delbuf_msg(new_name); /* frees new_name */
3962 goto theend;
3963 }
3964 if (buf == curbuf) /* already in new buffer */
3965 auto_buf = TRUE;
3966 else
3967#endif
3968 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003969#ifdef FEAT_SYN_HL
3970 /*
3971 * <VN> We could instead free the synblock
3972 * and re-attach to buffer, perhaps.
3973 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02003974 if (curwin->w_buffer == NULL
3975 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003976 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003977#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 curwin->w_buffer = buf;
3979 curbuf = buf;
3980 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003981
3982 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3983 if (!oldbuf && eap != NULL)
3984 {
3985 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003986#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003987 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003988#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003989 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 }
3991
3992 /* May get the window options from the last time this buffer
3993 * was in this window (or another window). If not used
3994 * before, reset the local window options to the global
3995 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003996 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003997#ifdef FEAT_SPELL
3998 did_get_winopts = TRUE;
3999#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000
4001#ifdef FEAT_AUTOCMD
4002 }
4003 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004004 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004005 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006#endif
4007 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008
4009 curwin->w_pcmark.lnum = 1;
4010 curwin->w_pcmark.col = 0;
4011 }
4012 else /* !other_file */
4013 {
4014 if (
4015#ifdef FEAT_LISTCMDS
4016 (flags & ECMD_ADDBUF) ||
4017#endif
4018 check_fname() == FAIL)
4019 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004020
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 oldbuf = (flags & ECMD_OLDBUF);
4022 }
4023
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004024 /* Don't redraw until the cursor is in the right line, otherwise
4025 * autocommands may cause ml_get errors. */
4026 ++RedrawingDisabled;
4027 did_inc_redrawing_disabled = TRUE;
4028
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004029#ifdef FEAT_AUTOCMD
4030 buf = curbuf;
4031#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4033 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004034 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 }
4036 else
4037 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 /* Don't make a buffer listed if it's a help buffer. Useful when
4039 * using CTRL-O to go back to a help file. */
4040 if (!curbuf->b_help)
4041 set_buflisted(TRUE);
4042 }
4043
4044#ifdef FEAT_AUTOCMD
4045 /* If autocommands change buffers under our fingers, forget about
4046 * editing the file. */
4047 if (buf != curbuf)
4048 goto theend;
4049# ifdef FEAT_EVAL
4050 if (aborting()) /* autocmds may abort script processing */
4051 goto theend;
4052# endif
4053
4054 /* Since we are starting to edit a file, consider the filetype to be
4055 * unset. Helps for when an autocommand changes files and expects syntax
4056 * highlighting to work in the other file. */
4057 did_filetype = FALSE;
4058#endif
4059
4060/*
4061 * other_file oldbuf
4062 * FALSE FALSE re-edit same file, buffer is re-used
4063 * FALSE TRUE re-edit same file, nothing changes
4064 * TRUE FALSE start editing new file, new buffer
4065 * TRUE TRUE start editing in existing buffer (nothing to do)
4066 */
4067 if (!other_file && !oldbuf) /* re-use the buffer */
4068 {
4069 set_last_cursor(curwin); /* may set b_last_cursor */
4070 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4071 {
4072 newlnum = curwin->w_cursor.lnum;
4073 solcol = curwin->w_cursor.col;
4074 }
4075#ifdef FEAT_AUTOCMD
4076 buf = curbuf;
4077 if (buf->b_fname != NULL)
4078 new_name = vim_strsave(buf->b_fname);
4079 else
4080 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004081 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004083 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4084 {
4085 /* Save all the text, so that the reload can be undone.
4086 * Sync first so that this is a separate undo-able action. */
4087 u_sync(FALSE);
4088 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4089 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004090 {
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004091#ifdef FEAT_AUTOCMD
Bram Moolenaar1e225822016-07-30 21:48:59 +02004092 vim_free(new_name);
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004093#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004094 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004095 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004096 u_unchanged(curbuf);
4097 buf_freeall(curbuf, BFA_KEEP_UNDO);
4098
4099 /* tell readfile() not to clear or reload undo info */
4100 readfile_flags = READ_KEEP_UNDO;
4101 }
4102 else
4103 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104#ifdef FEAT_AUTOCMD
4105 /* If autocommands deleted the buffer we were going to re-edit, give
4106 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004107 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 {
4109 delbuf_msg(new_name); /* frees new_name */
4110 goto theend;
4111 }
4112 vim_free(new_name);
4113
4114 /* If autocommands change buffers under our fingers, forget about
4115 * re-editing the file. Should do the buf_clear_file(), but perhaps
4116 * the autocommands changed the buffer... */
4117 if (buf != curbuf)
4118 goto theend;
4119# ifdef FEAT_EVAL
4120 if (aborting()) /* autocmds may abort script processing */
4121 goto theend;
4122# endif
4123#endif
4124 buf_clear_file(curbuf);
4125 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4126 curbuf->b_op_end.lnum = 0;
4127 }
4128
4129/*
4130 * If we get here we are sure to start editing
4131 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 /* Assume success now */
4133 retval = OK;
4134
4135 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 * Check if we are editing the w_arg_idx file in the argument list.
4137 */
4138 check_arg_idx(curwin);
4139
4140#ifdef FEAT_AUTOCMD
4141 if (!auto_buf)
4142#endif
4143 {
4144 /*
4145 * Set cursor and init window before reading the file and executing
4146 * autocommands. This allows for the autocommands to position the
4147 * cursor.
4148 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004149 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150
4151#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004152 /* It's possible that all lines in the buffer changed. Need to update
4153 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004154 {
4155 win_T *win;
4156 tabpage_T *tp;
4157
4158 FOR_ALL_TAB_WINDOWS(tp, win)
4159 if (win->w_buffer == curbuf)
4160 foldUpdateAll(win);
4161 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162#endif
4163
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004164 /* Change directories when the 'acd' option is set. */
4165 DO_AUTOCHDIR
4166
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 /*
4168 * Careful: open_buffer() and apply_autocmds() may change the current
4169 * buffer and window.
4170 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004171 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 topline = curwin->w_topline;
4173 if (!oldbuf) /* need to read the file */
4174 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004175#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 swap_exists_action = SEA_DIALOG;
4177#endif
4178 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4179
4180 /*
4181 * Open the buffer and read the file.
4182 */
4183#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004184 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 retval = FAIL;
4186#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004187 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188#endif
4189
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004190#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 if (swap_exists_action == SEA_QUIT)
4192 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004193 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194#endif
4195 }
4196#ifdef FEAT_AUTOCMD
4197 else
4198 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004199 /* Read the modelines, but only to set window-local options. Any
4200 * buffer-local options have already been set and may have been
4201 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004202 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004203
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4205 &retval);
4206 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4207 &retval);
4208 }
4209 check_arg_idx(curwin);
4210#endif
4211
Bram Moolenaareab316b2015-03-24 11:46:30 +01004212 /* If autocommands change the cursor position or topline, we should
4213 * keep it. Also when it moves within a line. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004214 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 {
4216 newlnum = curwin->w_cursor.lnum;
4217 newcol = curwin->w_cursor.col;
4218 }
4219 if (curwin->w_topline == topline)
4220 topline = 0;
4221
4222 /* Even when cursor didn't move we need to recompute topline. */
4223 changed_line_abv_curs();
4224
4225#ifdef FEAT_TITLE
4226 maketitle();
4227#endif
4228 }
4229
4230#ifdef FEAT_DIFF
4231 /* Tell the diff stuff that this buffer is new and/or needs updating.
4232 * Also needed when re-editing the same buffer, because unloading will
4233 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004234 if (curwin->w_p_diff)
4235 {
4236 diff_buf_add(curbuf);
4237 diff_invalidate(curbuf);
4238 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239#endif
4240
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004241#ifdef FEAT_SPELL
4242 /* If the window options were changed may need to set the spell language.
4243 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004244 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4245 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004246#endif
4247
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 if (command == NULL)
4249 {
4250 if (newcol >= 0) /* position set by autocommands */
4251 {
4252 curwin->w_cursor.lnum = newlnum;
4253 curwin->w_cursor.col = newcol;
4254 check_cursor();
4255 }
4256 else if (newlnum > 0) /* line number from caller or old position */
4257 {
4258 curwin->w_cursor.lnum = newlnum;
4259 check_cursor_lnum();
4260 if (solcol >= 0 && !p_sol)
4261 {
4262 /* 'sol' is off: Use last known column. */
4263 curwin->w_cursor.col = solcol;
4264 check_cursor_col();
4265#ifdef FEAT_VIRTUALEDIT
4266 curwin->w_cursor.coladd = 0;
4267#endif
4268 curwin->w_set_curswant = TRUE;
4269 }
4270 else
4271 beginline(BL_SOL | BL_FIX);
4272 }
4273 else /* no line number, go to last line in Ex mode */
4274 {
4275 if (exmode_active)
4276 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4277 beginline(BL_WHITE | BL_FIX);
4278 }
4279 }
4280
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 /* Check if cursors in other windows on the same buffer are still valid */
4282 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283
4284 /*
4285 * Did not read the file, need to show some info about the file.
4286 * Do this after setting the cursor.
4287 */
4288 if (oldbuf
4289#ifdef FEAT_AUTOCMD
4290 && !auto_buf
4291#endif
4292 )
4293 {
4294 int msg_scroll_save = msg_scroll;
4295
4296 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4297 * message. */
4298 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4299 msg_scroll = FALSE;
4300 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4301 check_for_delay(FALSE);
4302 msg_start();
4303 msg_scroll = msg_scroll_save;
4304 msg_scrolled_ign = TRUE;
4305
Bram Moolenaar426dd022016-03-15 15:09:29 +01004306 if (!shortmess(SHM_FILEINFO))
4307 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308
4309 msg_scrolled_ign = FALSE;
4310 }
4311
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004312#ifdef FEAT_VIMINFO
4313 curbuf->b_last_used = vim_time();
4314#endif
4315
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 if (command != NULL)
4317 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4318
4319#ifdef FEAT_KEYMAP
4320 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004321 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322#endif
4323
4324 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004325 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 if (!skip_redraw)
4327 {
4328 n = p_so;
4329 if (topline == 0 && command == NULL)
4330 p_so = 999; /* force cursor halfway the window */
4331 update_topline();
4332#ifdef FEAT_SCROLLBIND
4333 curwin->w_scbind_pos = curwin->w_topline;
4334#endif
4335 p_so = n;
4336 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4337 }
4338
4339 if (p_im)
4340 need_start_insertmode = TRUE;
4341
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004342 /* Change directories when the 'acd' option is set. */
4343 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004345#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004346 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 {
4348# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004349 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4351# endif
4352# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004353 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004354 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355# endif
4356 }
4357#endif
4358
4359theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004360 if (did_inc_redrawing_disabled)
4361 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004362#ifdef FEAT_AUTOCMD
4363 if (did_set_swapcommand)
4364 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4365#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366#ifdef FEAT_BROWSE
4367 vim_free(browse_file);
4368#endif
4369 vim_free(free_fname);
4370 return retval;
4371}
4372
4373#ifdef FEAT_AUTOCMD
4374 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004375delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376{
4377 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4378 name == NULL ? (char_u *)"" : name);
4379 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004380 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004381 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382}
4383#endif
4384
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004385static int append_indent = 0; /* autoindent for first line */
4386
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387/*
4388 * ":insert" and ":append", also used by ":change"
4389 */
4390 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004391ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392{
4393 char_u *theline;
4394 int did_undo = FALSE;
4395 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004396 int indent = 0;
4397 char_u *p;
4398 int vcol;
4399 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004401 /* the ! flag toggles autoindent */
4402 if (eap->forceit)
4403 curbuf->b_p_ai = !curbuf->b_p_ai;
4404
4405 /* First autoindent comes from the line we start on */
4406 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4407 append_indent = get_indent_lnum(lnum);
4408
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 if (eap->cmdidx != CMD_append)
4410 --lnum;
4411
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004412 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004413 if (empty && lnum == 1)
4414 lnum = 0;
4415
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 State = INSERT; /* behave like in Insert mode */
4417 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4418 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004419
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004420 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 {
4422 msg_scroll = TRUE;
4423 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004424 if (curbuf->b_p_ai)
4425 {
4426 if (append_indent >= 0)
4427 {
4428 indent = append_indent;
4429 append_indent = -1;
4430 }
4431 else if (lnum > 0)
4432 indent = get_indent_lnum(lnum);
4433 }
4434 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004436 {
4437 /* No getline() function, use the lines that follow. This ends
4438 * when there is no more. */
4439 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4440 break;
4441 p = vim_strchr(eap->nextcmd, NL);
4442 if (p == NULL)
4443 p = eap->nextcmd + STRLEN(eap->nextcmd);
4444 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4445 if (*p != NUL)
4446 ++p;
4447 eap->nextcmd = p;
4448 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004450 {
4451 int save_State = State;
4452
4453 /* Set State to avoid the cursor shape to be set to INSERT mode
4454 * when getline() returns. */
4455 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 theline = eap->getline(
4457#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004458 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004460 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004461 State = save_State;
4462 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004464 if (theline == NULL)
4465 break;
4466
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004467 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4468 if (ex_keep_indent)
4469 append_indent = indent;
4470
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004471 /* Look for the "." after automatic indent. */
4472 vcol = 0;
4473 for (p = theline; indent > vcol; ++p)
4474 {
4475 if (*p == ' ')
4476 ++vcol;
4477 else if (*p == TAB)
4478 vcol += 8 - vcol % 8;
4479 else
4480 break;
4481 }
4482 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004483 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4484 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 {
4486 vim_free(theline);
4487 break;
4488 }
4489
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004490 /* don't use autoindent if nothing was typed. */
4491 if (p[0] == NUL)
4492 theline[0] = NUL;
4493
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 did_undo = TRUE;
4495 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004496 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497
4498 vim_free(theline);
4499 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004500
4501 if (empty)
4502 {
4503 ml_delete(2L, FALSE);
4504 empty = FALSE;
4505 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 }
4507 State = NORMAL;
4508
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004509 if (eap->forceit)
4510 curbuf->b_p_ai = !curbuf->b_p_ai;
4511
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004513 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 * "end" is set to lnum when something has been appended, otherwise
4515 * it is the same than "start" -- Acevedo */
4516 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4517 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4518 if (eap->cmdidx != CMD_append)
4519 --curbuf->b_op_start.lnum;
4520 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4521 ? lnum : curbuf->b_op_start.lnum;
4522 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4523 curwin->w_cursor.lnum = lnum;
4524 check_cursor_lnum();
4525 beginline(BL_SOL | BL_FIX);
4526
4527 need_wait_return = FALSE; /* don't use wait_return() now */
4528 ex_no_reprint = TRUE;
4529}
4530
4531/*
4532 * ":change"
4533 */
4534 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004535ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536{
4537 linenr_T lnum;
4538
4539 if (eap->line2 >= eap->line1
4540 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4541 return;
4542
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004543 /* the ! flag toggles autoindent */
4544 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4545 append_indent = get_indent_lnum(eap->line1);
4546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4548 {
4549 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4550 break;
4551 ml_delete(eap->line1, FALSE);
4552 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004553
4554 /* make sure the cursor is not beyond the end of the file now */
4555 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4557
4558 /* ":append" on the line above the deleted lines. */
4559 eap->line2 = eap->line1;
4560 ex_append(eap);
4561}
4562
4563 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004564ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565{
4566 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004567 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004568 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 int minus = 0;
4570 linenr_T start, end, curs, i;
4571 int j;
4572 linenr_T lnum = eap->line2;
4573
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004574 /* Vi compatible: ":z!" uses display height, without a count uses
4575 * 'scroll' */
4576 if (eap->forceit)
4577 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004578 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004579 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004580 else
4581 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 if (bigness < 1)
4583 bigness = 1;
4584
4585 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004586 kind = x;
4587 if (*kind == '-' || *kind == '+' || *kind == '='
4588 || *kind == '^' || *kind == '.')
4589 ++x;
4590 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 ++x;
4592
4593 if (*x != 0)
4594 {
4595 if (!VIM_ISDIGIT(*x))
4596 {
4597 EMSG(_("E144: non-numeric argument to :z"));
4598 return;
4599 }
4600 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004601 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004602 bigness = atol((char *)x);
4603
4604 /* bigness could be < 0 if atol(x) overflows. */
4605 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4606 bigness = 2 * curbuf->b_ml.ml_line_count;
4607
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004608 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004609 if (*kind == '=')
4610 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004611 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 }
4613
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004614 /* the number of '-' and '+' multiplies the distance */
4615 if (*kind == '-' || *kind == '+')
4616 for (x = kind + 1; *x == *kind; ++x)
4617 ;
4618
4619 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 {
4621 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004622 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4623 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004624 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 break;
4626
4627 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004628 start = lnum - (bigness + 1) / 2 + 1;
4629 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 curs = lnum;
4631 minus = 1;
4632 break;
4633
4634 case '^':
4635 start = lnum - bigness * 2;
4636 end = lnum - bigness;
4637 curs = lnum - bigness;
4638 break;
4639
4640 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004641 start = lnum - (bigness + 1) / 2 + 1;
4642 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 curs = end;
4644 break;
4645
4646 default: /* '+' */
4647 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004648 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004649 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004650 else if (eap->addr_count == 0)
4651 ++start;
4652 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 curs = end;
4654 break;
4655 }
4656
4657 if (start < 1)
4658 start = 1;
4659
4660 if (end > curbuf->b_ml.ml_line_count)
4661 end = curbuf->b_ml.ml_line_count;
4662
4663 if (curs > curbuf->b_ml.ml_line_count)
4664 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004665 else if (curs < 1)
4666 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667
4668 for (i = start; i <= end; i++)
4669 {
4670 if (minus && i == lnum)
4671 {
4672 msg_putchar('\n');
4673
4674 for (j = 1; j < Columns; j++)
4675 msg_putchar('-');
4676 }
4677
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004678 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679
4680 if (minus && i == lnum)
4681 {
4682 msg_putchar('\n');
4683
4684 for (j = 1; j < Columns; j++)
4685 msg_putchar('-');
4686 }
4687 }
4688
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004689 if (curwin->w_cursor.lnum != curs)
4690 {
4691 curwin->w_cursor.lnum = curs;
4692 curwin->w_cursor.col = 0;
4693 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 ex_no_reprint = TRUE;
4695}
4696
4697/*
4698 * Check if the restricted flag is set.
4699 * If so, give an error message and return TRUE.
4700 * Otherwise, return FALSE.
4701 */
4702 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004703check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704{
4705 if (restricted)
4706 {
4707 EMSG(_("E145: Shell commands not allowed in rvim"));
4708 return TRUE;
4709 }
4710 return FALSE;
4711}
4712
4713/*
4714 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4715 * If so, give an error message and return TRUE.
4716 * Otherwise, return FALSE.
4717 */
4718 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004719check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720{
4721 if (secure)
4722 {
4723 secure = 2;
4724 EMSG(_(e_curdir));
4725 return TRUE;
4726 }
4727#ifdef HAVE_SANDBOX
4728 /*
4729 * In the sandbox more things are not allowed, including the things
4730 * disallowed in secure mode.
4731 */
4732 if (sandbox != 0)
4733 {
4734 EMSG(_(e_sandbox));
4735 return TRUE;
4736 }
4737#endif
4738 return FALSE;
4739}
4740
4741static char_u *old_sub = NULL; /* previous substitute pattern */
4742static int global_need_beginline; /* call beginline() after ":g" */
4743
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004744/*
4745 * Flags that are kept between calls to :substitute.
4746 */
4747typedef struct {
4748 int do_all; /* do multiple substitutions per line */
4749 int do_ask; /* ask for confirmation */
4750 int do_count; /* count only */
4751 int do_error; /* if false, ignore errors */
4752 int do_print; /* print last line with subs. */
4753 int do_list; /* list last line with subs. */
4754 int do_number; /* list last line with line nr*/
4755 int do_ic; /* ignore case flag */
4756} subflags_T;
4757
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758/* do_sub()
4759 *
4760 * Perform a substitution from line eap->line1 to line eap->line2 using the
4761 * command pointed to by eap->arg which should be of the form:
4762 *
4763 * /pattern/substitution/{flags}
4764 *
4765 * The usual escapes are supported as described in the regexp docs.
4766 */
4767 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004768do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769{
4770 linenr_T lnum;
4771 long i = 0;
4772 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004773 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4774 FALSE, FALSE, 0};
4775#ifdef FEAT_EVAL
4776 subflags_T subflags_save;
4777#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004778 int save_do_all; /* remember user specified 'g' flag */
4779 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4781 int delimiter;
4782 int sublen;
4783 int got_quit = FALSE;
4784 int got_match = FALSE;
4785 int temp;
4786 int which_pat;
4787 char_u *cmd;
4788 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004789 linenr_T first_line = 0; /* first changed line */
4790 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 * change */
4792 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4793 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004794 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004795 char_u *sub_firstline; /* allocated copy of first sub line */
4796 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004797 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004798 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004799#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004800 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004801#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
4803 cmd = eap->arg;
4804 if (!global_busy)
4805 {
4806 sub_nsubs = 0;
4807 sub_nlines = 0;
4808 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004809 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 if (eap->cmdidx == CMD_tilde)
4812 which_pat = RE_LAST; /* use last used regexp */
4813 else
4814 which_pat = RE_SUBST; /* use last substitute regexp */
4815
4816 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004817 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4819 {
4820 /* don't accept alphanumeric for separator */
4821 if (isalpha(*cmd))
4822 {
4823 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4824 return;
4825 }
4826 /*
4827 * undocumented vi feature:
4828 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4829 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4830 */
4831 if (*cmd == '\\')
4832 {
4833 ++cmd;
4834 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4835 {
4836 EMSG(_(e_backslash));
4837 return;
4838 }
4839 if (*cmd != '&')
4840 which_pat = RE_SEARCH; /* use last '/' pattern */
4841 pat = (char_u *)""; /* empty search pattern */
4842 delimiter = *cmd++; /* remember delimiter character */
4843 }
4844 else /* find the end of the regexp */
4845 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004846#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4847 if (p_altkeymap && curwin->w_p_rl)
4848 lrF_sub(cmd);
4849#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 which_pat = RE_LAST; /* use last used regexp */
4851 delimiter = *cmd++; /* remember delimiter character */
4852 pat = cmd; /* remember start of search pat */
4853 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4854 if (cmd[0] == delimiter) /* end delimiter found */
4855 *cmd++ = NUL; /* replace it with a NUL */
4856 }
4857
4858 /*
4859 * Small incompatibility: vi sees '\n' as end of the command, but in
4860 * Vim we want to use '\n' to find/substitute a NUL.
4861 */
4862 sub = cmd; /* remember the start of the substitution */
4863
4864 while (cmd[0])
4865 {
4866 if (cmd[0] == delimiter) /* end delimiter found */
4867 {
4868 *cmd++ = NUL; /* replace it with a NUL */
4869 break;
4870 }
4871 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4872 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004873 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 }
4875
4876 if (!eap->skip)
4877 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004878 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4879 if (STRCMP(sub, "%") == 0
4880 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4881 {
4882 if (old_sub == NULL) /* there is no previous command */
4883 {
4884 EMSG(_(e_nopresub));
4885 return;
4886 }
4887 sub = old_sub;
4888 }
4889 else
4890 {
4891 vim_free(old_sub);
4892 old_sub = vim_strsave(sub);
4893 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 }
4895 }
4896 else if (!eap->skip) /* use previous pattern and substitution */
4897 {
4898 if (old_sub == NULL) /* there is no previous command */
4899 {
4900 EMSG(_(e_nopresub));
4901 return;
4902 }
4903 pat = NULL; /* search_regcomp() will use previous pattern */
4904 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004905
4906 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4907 * last column after using "$". */
4908 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 }
4910
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004911 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4912 * more efficient.
4913 * TODO: find a generic solution to make line-joining operations more
4914 * efficient, avoid allocating a string that grows in size.
4915 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004916 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004917 && *sub == NUL
4918 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4919 || *cmd == 'p' || *cmd == '#'))))
4920 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004921 linenr_T joined_lines_count;
4922
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004923 curwin->w_cursor.lnum = eap->line1;
4924 if (*cmd == 'l')
4925 eap->flags = EXFLAG_LIST;
4926 else if (*cmd == '#')
4927 eap->flags = EXFLAG_NR;
4928 else if (*cmd == 'p')
4929 eap->flags = EXFLAG_PRINT;
4930
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004931 /* The number of lines joined is the number of lines in the range plus
4932 * one. One less when the last line is included. */
4933 joined_lines_count = eap->line2 - eap->line1 + 1;
4934 if (eap->line2 < curbuf->b_ml.ml_line_count)
4935 ++joined_lines_count;
4936 if (joined_lines_count > 1)
4937 {
4938 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4939 sub_nsubs = joined_lines_count - 1;
4940 sub_nlines = 1;
4941 (void)do_sub_msg(FALSE);
4942 ex_may_print(eap);
4943 }
4944
4945 if (!cmdmod.keeppatterns)
4946 save_re_pat(RE_SUBST, pat, p_magic);
4947#ifdef FEAT_CMDHIST
4948 /* put pattern in history */
4949 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4950#endif
4951
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004952 return;
4953 }
4954
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 /*
4956 * Find trailing options. When '&' is used, keep old options.
4957 */
4958 if (*cmd == '&')
4959 ++cmd;
4960 else
4961 {
4962 if (!p_ed)
4963 {
4964 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004965 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004967 subflags.do_all = FALSE;
4968 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004970 subflags.do_error = TRUE;
4971 subflags.do_print = FALSE;
4972 subflags.do_count = FALSE;
4973 subflags.do_number = FALSE;
4974 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 }
4976 while (*cmd)
4977 {
4978 /*
4979 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4980 * 'r' is never inverted.
4981 */
4982 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004983 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004985 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004986 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004987 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004989 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 else if (*cmd == 'r') /* use last used regexp */
4991 which_pat = RE_LAST;
4992 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004993 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004994 else if (*cmd == '#')
4995 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004996 subflags.do_print = TRUE;
4997 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004998 }
4999 else if (*cmd == 'l')
5000 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005001 subflags.do_print = TRUE;
5002 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005003 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005005 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005007 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 else
5009 break;
5010 ++cmd;
5011 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005012 if (subflags.do_count)
5013 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005015 save_do_all = subflags.do_all;
5016 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005017
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 /*
5019 * check for a trailing count
5020 */
5021 cmd = skipwhite(cmd);
5022 if (VIM_ISDIGIT(*cmd))
5023 {
5024 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005025 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 {
5027 EMSG(_(e_zerocount));
5028 return;
5029 }
5030 eap->line1 = eap->line2;
5031 eap->line2 += i - 1;
5032 if (eap->line2 > curbuf->b_ml.ml_line_count)
5033 eap->line2 = curbuf->b_ml.ml_line_count;
5034 }
5035
5036 /*
5037 * check for trailing command or garbage
5038 */
5039 cmd = skipwhite(cmd);
5040 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5041 {
5042 eap->nextcmd = check_nextcmd(cmd);
5043 if (eap->nextcmd == NULL)
5044 {
5045 EMSG(_(e_trailing));
5046 return;
5047 }
5048 }
5049
5050 if (eap->skip) /* not executing commands, only parsing */
5051 return;
5052
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005053 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005054 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005055 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005056 EMSG(_(e_modifiable));
5057 return;
5058 }
5059
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5061 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005062 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 EMSG(_(e_invcmd));
5064 return;
5065 }
5066
5067 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005068 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005070 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 regmatch.rmm_ic = FALSE;
5072
5073 sub_firstline = NULL;
5074
5075 /*
5076 * ~ in the substitute pattern is replaced with the old pattern.
5077 * We do it here once to avoid it to be replaced over and over again.
5078 * But don't do it when it starts with "\=", then it's an expression.
5079 */
5080 if (!(sub[0] == '\\' && sub[1] == '='))
5081 sub = regtilde(sub, p_magic);
5082
5083 /*
5084 * Check for a match on each line.
5085 */
5086 line2 = eap->line2;
5087 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5088#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5089 || aborting()
5090#endif
5091 ); ++lnum)
5092 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005093 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005094 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 if (nmatch)
5096 {
5097 colnr_T copycol;
5098 colnr_T matchcol;
5099 colnr_T prev_matchcol = MAXCOL;
5100 char_u *new_end, *new_start = NULL;
5101 unsigned new_start_len = 0;
5102 char_u *p1;
5103 int did_sub = FALSE;
5104 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005105 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 long nmatch_tl = 0; /* nr of lines matched below lnum */
5107 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005108 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005109 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110
5111 /*
5112 * The new text is build up step by step, to avoid too much
5113 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005114 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 * copycol Column in the old text where we started
5116 * looking for a match; from here old text still
5117 * needs to be copied to the new text.
5118 * matchcol Column number of the old text where to look
5119 * for the next match. It's just after the
5120 * previous match or one further.
5121 * prev_matchcol Column just after the previous match (if any).
5122 * Mostly equal to matchcol, except for the first
5123 * match and after skipping an empty match.
5124 * regmatch.*pos Where the pattern matched in the old text.
5125 * new_start The new text, all that has been produced so
5126 * far.
5127 * new_end The new text, where to append new text.
5128 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005129 * lnum The line number where we found the start of
5130 * the match. Can be below the line we searched
5131 * when there is a \n before a \zs in the
5132 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 * sub_firstlnum The line number in the buffer where to look
5134 * for a match. Can be different from "lnum"
5135 * when the pattern or substitute string contains
5136 * line breaks.
5137 *
5138 * Special situations:
5139 * - When the substitute string contains a line break, the part up
5140 * to the line break is inserted in the text, but the copy of
5141 * the original line is kept. "sub_firstlnum" is adjusted for
5142 * the inserted lines.
5143 * - When the matched pattern contains a line break, the old line
5144 * is taken from the line at the end of the pattern. The lines
5145 * in the match are deleted later, "sub_firstlnum" is adjusted
5146 * accordingly.
5147 *
5148 * The new text is built up in new_start[]. It has some extra
5149 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005150 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 *
5152 * Make a copy of the old line, so it won't be taken away when
5153 * updating the screen or handling a multi-line match. The "old_"
5154 * pointers point into this copy.
5155 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005156 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 copycol = 0;
5158 matchcol = 0;
5159
5160 /* At first match, remember current cursor position. */
5161 if (!got_match)
5162 {
5163 setpcmark();
5164 got_match = TRUE;
5165 }
5166
5167 /*
5168 * Loop until nothing more to replace in this line.
5169 * 1. Handle match with empty string.
5170 * 2. If do_ask is set, ask for confirmation.
5171 * 3. substitute the string.
5172 * 4. if do_all is set, find next match
5173 * 5. break if there isn't another match in this line
5174 */
5175 for (;;)
5176 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005177 /* Advance "lnum" to the line where the match starts. The
5178 * match does not start in the first line when there is a line
5179 * break before \zs. */
5180 if (regmatch.startpos[0].lnum > 0)
5181 {
5182 lnum += regmatch.startpos[0].lnum;
5183 sub_firstlnum += regmatch.startpos[0].lnum;
5184 nmatch -= regmatch.startpos[0].lnum;
5185 vim_free(sub_firstline);
5186 sub_firstline = NULL;
5187 }
5188
5189 if (sub_firstline == NULL)
5190 {
5191 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5192 if (sub_firstline == NULL)
5193 {
5194 vim_free(new_start);
5195 goto outofmem;
5196 }
5197 }
5198
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 /* Save the line number of the last change for the final
5200 * cursor position (just like Vi). */
5201 curwin->w_cursor.lnum = lnum;
5202 do_again = FALSE;
5203
5204 /*
5205 * 1. Match empty string does not count, except for first
5206 * match. This reproduces the strange vi behaviour.
5207 * This also catches endless loops.
5208 */
5209 if (matchcol == prev_matchcol
5210 && regmatch.endpos[0].lnum == 0
5211 && matchcol == regmatch.endpos[0].col)
5212 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005213 if (sub_firstline[matchcol] == NUL)
5214 /* We already were at the end of the line. Don't look
5215 * for a match in this line again. */
5216 skip_match = TRUE;
5217 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005218 {
5219 /* search for a match at next column */
5220#ifdef FEAT_MBYTE
5221 if (has_mbyte)
5222 matchcol += mb_ptr2len(sub_firstline + matchcol);
5223 else
5224#endif
5225 ++matchcol;
5226 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 goto skip;
5228 }
5229
5230 /* Normally we continue searching for a match just after the
5231 * previous match. */
5232 matchcol = regmatch.endpos[0].col;
5233 prev_matchcol = matchcol;
5234
5235 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005236 * 2. If do_count is set only increase the counter.
5237 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005239 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005240 {
5241 /* For a multi-line match, put matchcol at the NUL at
5242 * the end of the line and set nmatch to one, so that
5243 * we continue looking for a match on the next line.
5244 * Avoids that ":s/\nB\@=//gc" get stuck. */
5245 if (nmatch > 1)
5246 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005247 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005248 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005249 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005250 }
5251 sub_nsubs++;
5252 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005253#ifdef FEAT_EVAL
5254 /* Skip the substitution, unless an expression is used,
5255 * then it is evaluated in the sandbox. */
5256 if (!(sub[0] == '\\' && sub[1] == '='))
5257#endif
5258 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005259 }
5260
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005261 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005263 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005264
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 /* change State to CONFIRM, so that the mouse works
5266 * properly */
5267 save_State = State;
5268 State = CONFIRM;
5269#ifdef FEAT_MOUSE
5270 setmouse(); /* disable mouse in xterm */
5271#endif
5272 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005273#ifdef FEAT_CURSORBIND
5274 if (curwin->w_p_crb)
5275 do_check_cursorbind();
5276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277
5278 /* When 'cpoptions' contains "u" don't sync undo when
5279 * asking for confirmation. */
5280 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5281 ++no_u_sync;
5282
5283 /*
5284 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5285 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005286 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005288 if (exmode_active)
5289 {
5290 char_u *resp;
5291 colnr_T sc, ec;
5292
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005293 print_line_no_prefix(lnum,
5294 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005295
5296 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5297 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005298 if (curwin->w_cursor.col < 0)
5299 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005300 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005301 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005302 {
5303 int numw = number_width(curwin) + 1;
5304 sc += numw;
5305 ec += numw;
5306 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005307 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005308 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005309 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005310 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005311 msg_putchar('^');
5312
5313 resp = getexmodeline('?', NULL, 0);
5314 if (resp != NULL)
5315 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005316 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005317 vim_free(resp);
5318 }
5319 }
5320 else
5321 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005322 char_u *orig_line = NULL;
5323 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005325 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005327 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005329 /* Invert the matched string.
5330 * Remove the inversion afterwards. */
5331 temp = RedrawingDisabled;
5332 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005334 if (new_start != NULL)
5335 {
5336 /* There already was a substitution, we would
5337 * like to show this to the user. We cannot
5338 * really update the line, it would change
5339 * what matches. Temporarily replace the line
5340 * and change it back afterwards. */
5341 orig_line = vim_strsave(ml_get(lnum));
5342 if (orig_line != NULL)
5343 {
5344 char_u *new_line = concat_str(new_start,
5345 sub_firstline + copycol);
5346
5347 if (new_line == NULL)
5348 {
5349 vim_free(orig_line);
5350 orig_line = NULL;
5351 }
5352 else
5353 {
5354 /* Position the cursor relative to the
5355 * end of the line, the previous
5356 * substitute may have inserted or
5357 * deleted characters before the
5358 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005359 len_change = (int)STRLEN(new_line)
5360 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005361 curwin->w_cursor.col += len_change;
5362 ml_replace(lnum, new_line, FALSE);
5363 }
5364 }
5365 }
5366
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005367 search_match_lines = regmatch.endpos[0].lnum
5368 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005369 search_match_endcol = regmatch.endpos[0].col
5370 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005371 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005373 update_topline();
5374 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005375 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005376 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005377 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
5379#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005380 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005382 if (msg_row == Rows - 1)
5383 msg_didout = FALSE; /* avoid a scroll-up */
5384 msg_starthere();
5385 i = msg_scroll;
5386 msg_scroll = 0; /* truncate msg when
5387 needed */
5388 msg_no_more = TRUE;
5389 /* write message same highlighting as for
5390 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005391 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005392 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5393 msg_no_more = FALSE;
5394 msg_scroll = i;
5395 showruler(TRUE);
5396 windgoto(msg_row, msg_col);
5397 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398
5399#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005400 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005402 ++no_mapping; /* don't map this key */
5403 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005404 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005405 --allow_keys;
5406 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005408 /* clear the question */
5409 msg_didout = FALSE; /* don't scroll up */
5410 msg_col = 0;
5411 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005412
5413 /* restore the line */
5414 if (orig_line != NULL)
5415 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005416 }
5417
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005419 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005421 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422#endif
5423 )
5424 {
5425 got_quit = TRUE;
5426 break;
5427 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005428 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005430 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005432 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 {
5434 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005435 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 line2 = lnum;
5437 break;
5438 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005439 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005441 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 break;
5443 }
5444#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005445 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005447 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 scrolldown_clamp();
5449#endif
5450 }
5451 State = save_State;
5452#ifdef FEAT_MOUSE
5453 setmouse();
5454#endif
5455 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5456 --no_u_sync;
5457
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005458 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 {
5460 /* For a multi-line match, put matchcol at the NUL at
5461 * the end of the line and set nmatch to one, so that
5462 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005463 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5464 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 if (nmatch > 1)
5466 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005467 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005468 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 }
5470 goto skip;
5471 }
5472 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005473 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 }
5475
5476 /* Move the cursor to the start of the match, so that we can
5477 * use "\=col("."). */
5478 curwin->w_cursor.col = regmatch.startpos[0].col;
5479
5480 /*
5481 * 3. substitute the string.
5482 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005483#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005484 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005485 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005486 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005487 save_ma = curbuf->b_p_ma;
5488 curbuf->b_p_ma = FALSE;
5489 sandbox++;
5490 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005491 /* Save flags for recursion. They can change for e.g.
5492 * :s/^/\=execute("s#^##gn") */
5493 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005494#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005496 sublen = vim_regsub_multi(&regmatch,
5497 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005499#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005500 /* Don't keep flags set by a recursive call. */
5501 subflags = subflags_save;
5502 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005503 {
5504 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005505 if (sandbox > 0)
5506 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005507 goto skip;
5508 }
5509#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510
Bram Moolenaar4463f292005-09-25 22:20:24 +00005511 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005512 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005513 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5514 {
5515 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5516 skip_match = TRUE;
5517 }
5518
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 /* Need room for:
5520 * - result so far in new_start (not for first sub in line)
5521 * - original text up to match
5522 * - length of substituted part
5523 * - original text after match
5524 */
5525 if (nmatch == 1)
5526 p1 = sub_firstline;
5527 else
5528 {
5529 p1 = ml_get(sub_firstlnum + nmatch - 1);
5530 nmatch_tl += nmatch - 1;
5531 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005532 copy_len = regmatch.startpos[0].col - copycol;
5533 needed_len = copy_len + ((unsigned)STRLEN(p1)
5534 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 if (new_start == NULL)
5536 {
5537 /*
5538 * Get some space for a temporary buffer to do the
5539 * substitution into (and some extra space to avoid
5540 * too many calls to alloc()/free()).
5541 */
5542 new_start_len = needed_len + 50;
5543 if ((new_start = alloc_check(new_start_len)) == NULL)
5544 goto outofmem;
5545 *new_start = NUL;
5546 new_end = new_start;
5547 }
5548 else
5549 {
5550 /*
5551 * Check if the temporary buffer is long enough to do the
5552 * substitution into. If not, make it larger (with a bit
5553 * extra to avoid too many calls to alloc()/free()).
5554 */
5555 len = (unsigned)STRLEN(new_start);
5556 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005557 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 {
5559 new_start_len = needed_len + 50;
5560 if ((p1 = alloc_check(new_start_len)) == NULL)
5561 {
5562 vim_free(new_start);
5563 goto outofmem;
5564 }
5565 mch_memmove(p1, new_start, (size_t)(len + 1));
5566 vim_free(new_start);
5567 new_start = p1;
5568 }
5569 new_end = new_start + len;
5570 }
5571
5572 /*
5573 * copy the text up to the part that matched
5574 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005575 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5576 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005578 (void)vim_regsub_multi(&regmatch,
5579 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 sub, new_end, TRUE, p_magic, TRUE);
5581 sub_nsubs++;
5582 did_sub = TRUE;
5583
5584 /* Move the cursor to the start of the line, to avoid that it
5585 * is beyond the end of the line after the substitution. */
5586 curwin->w_cursor.col = 0;
5587
5588 /* For a multi-line match, make a copy of the last matched
5589 * line and continue in that one. */
5590 if (nmatch > 1)
5591 {
5592 sub_firstlnum += nmatch - 1;
5593 vim_free(sub_firstline);
5594 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5595 /* When going beyond the last line, stop substituting. */
5596 if (sub_firstlnum <= line2)
5597 do_again = TRUE;
5598 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005599 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 }
5601
5602 /* Remember next character to be copied. */
5603 copycol = regmatch.endpos[0].col;
5604
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005605 if (skip_match)
5606 {
5607 /* Already hit end of the buffer, sub_firstlnum is one
5608 * less than what it ought to be. */
5609 vim_free(sub_firstline);
5610 sub_firstline = vim_strsave((char_u *)"");
5611 copycol = 0;
5612 }
5613
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 /*
5615 * Now the trick is to replace CTRL-M chars with a real line
5616 * break. This would make it impossible to insert a CTRL-M in
5617 * the text. The line break can be avoided by preceding the
5618 * CTRL-M with a backslash. To be able to insert a backslash,
5619 * they must be doubled in the string and are halved here.
5620 * That is Vi compatible.
5621 */
5622 for (p1 = new_end; *p1; ++p1)
5623 {
5624 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005625 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 else if (*p1 == CAR)
5627 {
5628 if (u_inssub(lnum) == OK) /* prepare for undo */
5629 {
5630 *p1 = NUL; /* truncate up to the CR */
5631 ml_append(lnum - 1, new_start,
5632 (colnr_T)(p1 - new_start + 1), FALSE);
5633 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005634 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 appended_lines(lnum - 1, 1L);
5636 else
5637 {
5638 if (first_line == 0)
5639 first_line = lnum;
5640 last_line = lnum + 1;
5641 }
5642 /* All line numbers increase. */
5643 ++sub_firstlnum;
5644 ++lnum;
5645 ++line2;
5646 /* move the cursor to the new line, like Vi */
5647 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005648 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005649 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 p1 = new_start - 1;
5651 }
5652 }
5653#ifdef FEAT_MBYTE
5654 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005655 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656#endif
5657 }
5658
5659 /*
5660 * 4. If do_all is set, find next match.
5661 * Prevent endless loop with patterns that match empty
5662 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5663 * But ":s/\n/#/" is OK.
5664 */
5665skip:
5666 /* We already know that we did the last subst when we are at
5667 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005668 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5669 * "line2" when there is a \zs in the pattern after a line
5670 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005671 lastone = (skip_match
5672 || got_int
5673 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005674 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005675 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005676 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5677 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 nmatch = -1;
5679
5680 /*
5681 * Replace the line in the buffer when needed. This is
5682 * skipped when there are more matches.
5683 * The check for nmatch_tl is needed for when multi-line
5684 * matching must replace the lines before trying to do another
5685 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005686 * When the match starts below where we start searching also
5687 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 */
5689 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 || nmatch_tl > 0
5691 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005692 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005693 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005694 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 {
5696 if (new_start != NULL)
5697 {
5698 /*
5699 * Copy the rest of the line, that didn't match.
5700 * "matchcol" has to be adjusted, we use the end of
5701 * the line as reference, because the substitute may
5702 * have changed the number of characters. Same for
5703 * "prev_matchcol".
5704 */
5705 STRCAT(new_start, sub_firstline + copycol);
5706 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5707 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5708 - prev_matchcol;
5709
5710 if (u_savesub(lnum) != OK)
5711 break;
5712 ml_replace(lnum, new_start, TRUE);
5713
5714 if (nmatch_tl > 0)
5715 {
5716 /*
5717 * Matched lines have now been substituted and are
5718 * useless, delete them. The part after the match
5719 * has been appended to new_start, we don't need
5720 * it in the buffer.
5721 */
5722 ++lnum;
5723 if (u_savedel(lnum, nmatch_tl) != OK)
5724 break;
5725 for (i = 0; i < nmatch_tl; ++i)
5726 ml_delete(lnum, (int)FALSE);
5727 mark_adjust(lnum, lnum + nmatch_tl - 1,
5728 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005729 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 deleted_lines(lnum, nmatch_tl);
5731 --lnum;
5732 line2 -= nmatch_tl; /* nr of lines decreases */
5733 nmatch_tl = 0;
5734 }
5735
5736 /* When asking, undo is saved each time, must also set
5737 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005738 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 changed_bytes(lnum, 0);
5740 else
5741 {
5742 if (first_line == 0)
5743 first_line = lnum;
5744 last_line = lnum + 1;
5745 }
5746
5747 sub_firstlnum = lnum;
5748 vim_free(sub_firstline); /* free the temp buffer */
5749 sub_firstline = new_start;
5750 new_start = NULL;
5751 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5752 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5753 - prev_matchcol;
5754 copycol = 0;
5755 }
5756 if (nmatch == -1 && !lastone)
5757 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005758 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759
5760 /*
5761 * 5. break if there isn't another match in this line
5762 */
5763 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005764 {
5765 /* If the match found didn't start where we were
5766 * searching, do the next search in the line where we
5767 * found the match. */
5768 if (nmatch == -1)
5769 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005771 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 }
5773
5774 line_breakcheck();
5775 }
5776
5777 if (did_sub)
5778 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005779 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 vim_free(sub_firstline); /* free the copy of the original line */
5781 sub_firstline = NULL;
5782 }
5783
5784 line_breakcheck();
5785 }
5786
5787 if (first_line != 0)
5788 {
5789 /* Need to subtract the number of added lines from "last_line" to get
5790 * the line number before the change (same as adding the number of
5791 * deleted lines). */
5792 i = curbuf->b_ml.ml_line_count - old_line_count;
5793 changed_lines(first_line, 0, last_line - i, i);
5794 }
5795
5796outofmem:
5797 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005798
5799 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005800 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005801 curwin->w_cursor = old_cursor;
5802
Bram Moolenaar46475522010-03-23 17:36:29 +01005803 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 {
5805 /* Set the '[ and '] marks. */
5806 curbuf->b_op_start.lnum = eap->line1;
5807 curbuf->b_op_end.lnum = line2;
5808 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5809
5810 if (!global_busy)
5811 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005812 /* when interactive leave cursor on the match */
5813 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005814 {
5815 if (endcolumn)
5816 coladvance((colnr_T)MAXCOL);
5817 else
5818 beginline(BL_WHITE | BL_FIX);
5819 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005820 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 MSG("");
5822 }
5823 else
5824 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005825 if (subflags.do_print)
5826 print_line(curwin->w_cursor.lnum,
5827 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 }
5829 else if (!global_busy)
5830 {
5831 if (got_int) /* interrupted */
5832 EMSG(_(e_interr));
5833 else if (got_match) /* did find something but nothing substituted */
5834 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005835 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 EMSG2(_(e_patnotf2), get_search_pat());
5837 }
5838
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005839#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005840 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005841 /* Cursor position may require updating */
5842 changed_window_setting();
5843#endif
5844
Bram Moolenaar473de612013-06-08 18:19:48 +02005845 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005846
5847 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005848 subflags.do_all = save_do_all;
5849 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850}
5851
5852/*
5853 * Give message for number of substitutions.
5854 * Can also be used after a ":global" command.
5855 * Return TRUE if a message was given.
5856 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005857 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005858do_sub_msg(
5859 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860{
5861 /*
5862 * Only report substitutions when:
5863 * - more than 'report' substitutions
5864 * - command was typed by user, or number of changed lines > 'report'
5865 * - giving messages is not disabled by 'lazyredraw'
5866 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005867 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5868 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 && messaging())
5870 {
5871 if (got_int)
5872 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005873 else
5874 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005876 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005877 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005879 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005880 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 sub_nsubs);
5882 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005883 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005884 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005886 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005887 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005890 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 return TRUE;
5892 }
5893 if (got_int)
5894 {
5895 EMSG(_(e_interr));
5896 return TRUE;
5897 }
5898 return FALSE;
5899}
5900
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005901 static void
5902global_exe_one(char_u *cmd, linenr_T lnum)
5903{
5904 curwin->w_cursor.lnum = lnum;
5905 curwin->w_cursor.col = 0;
5906 if (*cmd == NUL || *cmd == '\n')
5907 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5908 else
5909 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5910}
5911
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912/*
5913 * Execute a global command of the form:
5914 *
5915 * g/pattern/X : execute X on all lines where pattern matches
5916 * v/pattern/X : execute X on all lines where pattern does not match
5917 *
5918 * where 'X' is an EX command
5919 *
5920 * The command character (as well as the trailing slash) is optional, and
5921 * is assumed to be 'p' if missing.
5922 *
5923 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005924 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 * for each line that has a mark. This is required because after deleting
5926 * lines we do not know where to search for the next match.
5927 */
5928 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005929ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930{
5931 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005932 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 int type; /* first char of cmd: 'v' or 'g' */
5934 char_u *cmd; /* command argument */
5935
5936 char_u delim; /* delimiter, normally '/' */
5937 char_u *pat;
5938 regmmatch_T regmatch;
5939 int match;
5940 int which_pat;
5941
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005942 /* When nesting the command works on one line. This allows for
5943 * ":g/found/v/notfound/command". */
5944 if (global_busy && (eap->line1 != 1
5945 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005947 /* will increment global_busy to break out of the loop */
5948 EMSG(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 return;
5950 }
5951
5952 if (eap->forceit) /* ":global!" is like ":vglobal" */
5953 type = 'v';
5954 else
5955 type = *eap->cmd;
5956 cmd = eap->arg;
5957 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958
5959 /*
5960 * undocumented vi feature:
5961 * "\/" and "\?": use previous search pattern.
5962 * "\&": use previous substitute pattern.
5963 */
5964 if (*cmd == '\\')
5965 {
5966 ++cmd;
5967 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5968 {
5969 EMSG(_(e_backslash));
5970 return;
5971 }
5972 if (*cmd == '&')
5973 which_pat = RE_SUBST; /* use previous substitute pattern */
5974 else
5975 which_pat = RE_SEARCH; /* use previous search pattern */
5976 ++cmd;
5977 pat = (char_u *)"";
5978 }
5979 else if (*cmd == NUL)
5980 {
5981 EMSG(_("E148: Regular expression missing from global"));
5982 return;
5983 }
5984 else
5985 {
5986 delim = *cmd; /* get the delimiter */
5987 if (delim)
5988 ++cmd; /* skip delimiter if there is one */
5989 pat = cmd; /* remember start of pattern */
5990 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5991 if (cmd[0] == delim) /* end delimiter found */
5992 *cmd++ = NUL; /* replace it with a NUL */
5993 }
5994
5995#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5996 if (p_altkeymap && curwin->w_p_rl)
5997 lrFswap(pat,0);
5998#endif
5999
6000 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6001 {
6002 EMSG(_(e_invcmd));
6003 return;
6004 }
6005
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006006 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006008 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006009 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006010 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006012 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 }
6014 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006015 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006016 /*
6017 * pass 1: set marks for each (not) matching line
6018 */
6019 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6020 {
6021 /* a match on this line? */
6022 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006023 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006024 if ((type == 'g' && match) || (type == 'v' && !match))
6025 {
6026 ml_setmarked(lnum);
6027 ndone++;
6028 }
6029 line_breakcheck();
6030 }
6031
6032 /*
6033 * pass 2: execute the command for each line that has been marked
6034 */
6035 if (got_int)
6036 MSG(_(e_interr));
6037 else if (ndone == 0)
6038 {
6039 if (type == 'v')
6040 smsg((char_u *)_("Pattern found in every line: %s"), pat);
6041 else
6042 smsg((char_u *)_("Pattern not found: %s"), pat);
6043 }
6044 else
6045 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006046#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006047 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006048#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006049 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006050#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006051 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006052#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006053 }
6054
6055 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006056 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057
Bram Moolenaar473de612013-06-08 18:19:48 +02006058 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059}
6060
6061/*
6062 * Execute "cmd" on lines marked with ml_setmarked().
6063 */
6064 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006065global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006067 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6068 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6069 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070
6071 /*
6072 * Set current position only once for a global command.
6073 * If global_busy is set, setpcmark() will not do anything.
6074 * If there is an error, global_busy will be incremented.
6075 */
6076 setpcmark();
6077
6078 /* When the command writes a message, don't overwrite the command. */
6079 msg_didout = TRUE;
6080
Bram Moolenaard25bc232010-03-23 17:49:24 +01006081 sub_nsubs = 0;
6082 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 global_need_beginline = FALSE;
6084 global_busy = 1;
6085 old_lcount = curbuf->b_ml.ml_line_count;
6086 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6087 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006088 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 ui_breakcheck();
6090 }
6091
6092 global_busy = 0;
6093 if (global_need_beginline)
6094 beginline(BL_WHITE | BL_FIX);
6095 else
6096 check_cursor(); /* cursor may be beyond the end of the line */
6097
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006098 /* the cursor may not have moved in the text but a change in a previous
6099 * line may move it on the screen */
6100 changed_line_abv_curs();
6101
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 /* If it looks like no message was written, allow overwriting the
6103 * command with the report for number of changes. */
6104 if (msg_col == 0 && msg_scrolled == 0)
6105 msg_didout = FALSE;
6106
Bram Moolenaar45667512007-05-10 19:24:43 +00006107 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006108 * number of extra or deleted lines.
6109 * Don't report extra or deleted lines in the edge case where the buffer
6110 * we are in after execution is different from the buffer we started in. */
6111 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6113}
6114
6115#ifdef FEAT_VIMINFO
6116 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006117read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006119 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 vim_free(old_sub);
6121 if (force || old_sub == NULL)
6122 old_sub = viminfo_readstring(virp, 1, TRUE);
6123 return viminfo_readline(virp);
6124}
6125
6126 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006127write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128{
6129 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6130 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006131 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 viminfo_writestring(fp, old_sub);
6133 }
6134}
6135#endif /* FEAT_VIMINFO */
6136
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006137#if defined(EXITFREE) || defined(PROTO)
6138 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006139free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006140{
6141 vim_free(old_sub);
6142}
6143#endif
6144
Bram Moolenaar4033c552017-09-16 20:54:51 +02006145#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146/*
6147 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006148 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006150 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006151prepare_tagpreview(
6152 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153{
6154 win_T *wp;
6155
6156# ifdef FEAT_GUI
6157 need_mouse_correct = TRUE;
6158# endif
6159
6160 /*
6161 * If there is already a preview window open, use that one.
6162 */
6163 if (!curwin->w_p_pvw)
6164 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006165 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 if (wp->w_p_pvw)
6167 break;
6168 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006169 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 else
6171 {
6172 /*
6173 * There is no preview window open yet. Create one.
6174 */
6175 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6176 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006177 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 curwin->w_p_pvw = TRUE;
6179 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006180 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6181 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182# ifdef FEAT_DIFF
6183 curwin->w_p_diff = FALSE; /* no 'diff' */
6184# endif
6185# ifdef FEAT_FOLDING
6186 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6187# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006188 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 }
6190 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006191 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192}
6193
6194#endif
6195
6196
6197/*
6198 * ":help": open a read-only window on a help file
6199 */
6200 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006201ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202{
6203 char_u *arg;
6204 char_u *tag;
6205 FILE *helpfd; /* file descriptor of help file */
6206 int n;
6207 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 int num_matches;
6210 char_u **matches;
6211 char_u *p;
6212 int empty_fnum = 0;
6213 int alt_fnum = 0;
6214 buf_T *buf;
6215#ifdef FEAT_MULTI_LANG
6216 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006217 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006219#ifdef FEAT_FOLDING
6220 int old_KeyTyped = KeyTyped;
6221#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222
6223 if (eap != NULL)
6224 {
6225 /*
6226 * A ":help" command ends at the first LF, or at a '|' that is
6227 * followed by some text. Set nextcmd to the following command.
6228 */
6229 for (arg = eap->arg; *arg; ++arg)
6230 {
6231 if (*arg == '\n' || *arg == '\r'
6232 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6233 {
6234 *arg++ = NUL;
6235 eap->nextcmd = arg;
6236 break;
6237 }
6238 }
6239 arg = eap->arg;
6240
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006241 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 {
6243 EMSG(_("E478: Don't panic!"));
6244 return;
6245 }
6246
6247 if (eap->skip) /* not executing commands */
6248 return;
6249 }
6250 else
6251 arg = (char_u *)"";
6252
6253 /* remove trailing blanks */
6254 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006255 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 *p-- = NUL;
6257
6258#ifdef FEAT_MULTI_LANG
6259 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006260 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261#endif
6262
6263 /* When no argument given go to the index. */
6264 if (*arg == NUL)
6265 arg = (char_u *)"help.txt";
6266
6267 /*
6268 * Check if there is a match for the argument.
6269 */
6270 n = find_help_tags(arg, &num_matches, &matches,
6271 eap != NULL && eap->forceit);
6272
6273 i = 0;
6274#ifdef FEAT_MULTI_LANG
6275 if (n != FAIL && lang != NULL)
6276 /* Find first item with the requested language. */
6277 for (i = 0; i < num_matches; ++i)
6278 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006279 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 if (len > 3 && matches[i][len - 3] == '@'
6281 && STRICMP(matches[i] + len - 2, lang) == 0)
6282 break;
6283 }
6284#endif
6285 if (i >= num_matches || n == FAIL)
6286 {
6287#ifdef FEAT_MULTI_LANG
6288 if (lang != NULL)
6289 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6290 else
6291#endif
6292 EMSG2(_("E149: Sorry, no help for %s"), arg);
6293 if (n != FAIL)
6294 FreeWild(num_matches, matches);
6295 return;
6296 }
6297
6298 /* The first match (in the requested language) is the best match. */
6299 tag = vim_strsave(matches[i]);
6300 FreeWild(num_matches, matches);
6301
6302#ifdef FEAT_GUI
6303 need_mouse_correct = TRUE;
6304#endif
6305
6306 /*
6307 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006308 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006310 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006312 if (cmdmod.tab != 0)
6313 wp = NULL;
6314 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006315 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006316 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006317 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6319 win_enter(wp, TRUE);
6320 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 {
6322 /*
6323 * There is no help window yet.
6324 * Try to open the file specified by the "helpfile" option.
6325 */
6326 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6327 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006328 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 goto erret;
6330 }
6331 fclose(helpfd);
6332
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006334 * specified, the current window is vertically split and
6335 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006338 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006341 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 if (curwin->w_height < p_hh)
6344 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345
6346 /*
6347 * Open help file (do_ecmd() will set b_help flag, readfile() will
6348 * set b_p_ro flag).
6349 * Set the alternate file to the previously edited file.
6350 */
6351 alt_fnum = curbuf->b_fnum;
6352 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006353 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006354 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006355 if (!cmdmod.keepalt)
6356 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 empty_fnum = curbuf->b_fnum;
6358 }
6359 }
6360
6361 if (!p_im)
6362 restart_edit = 0; /* don't want insert mode in help file */
6363
Bram Moolenaar8f535582011-09-30 17:30:31 +02006364#ifdef FEAT_FOLDING
6365 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6366 * It is needed for do_tag top open folds under the cursor. */
6367 KeyTyped = old_KeyTyped;
6368#endif
6369
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 if (tag != NULL)
6371 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6372
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006373 /* Delete the empty buffer if we're not using it. Careful: autocommands
6374 * may have jumped to another window, check that the buffer is not in a
6375 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6377 {
6378 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006379 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 wipe_buffer(buf, TRUE);
6381 }
6382
6383 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006384 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 curwin->w_alt_fnum = alt_fnum;
6386
6387erret:
6388 vim_free(tag);
6389}
6390
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006391/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006392 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006393 */
6394 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006395ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006396{
6397 win_T *win;
6398
6399 FOR_ALL_WINDOWS(win)
6400 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006401 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006402 {
6403 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006404 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006405 }
6406 }
6407}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006409#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6410/*
6411 * In an argument search for a language specifiers in the form "@xx".
6412 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6413 * Returns NULL if not found.
6414 */
6415 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006416check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006417{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006418 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006419
6420 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6421 && ASCII_ISALPHA(arg[len - 1]))
6422 {
6423 arg[len - 3] = NUL; /* remove the '@' */
6424 return arg + len - 2;
6425 }
6426 return NULL;
6427}
6428#endif
6429
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430/*
6431 * Return a heuristic indicating how well the given string matches. The
6432 * smaller the number, the better the match. This is the order of priorities,
6433 * from best match to worst match:
6434 * - Match with least alpha-numeric characters is better.
6435 * - Match with least total characters is better.
6436 * - Match towards the start is better.
6437 * - Match starting with "+" is worse (feature instead of command)
6438 * Assumption is made that the matched_string passed has already been found to
6439 * match some string for which help is requested. webb.
6440 */
6441 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006442help_heuristic(
6443 char_u *matched_string,
6444 int offset, /* offset for match */
6445 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446{
6447 int num_letters;
6448 char_u *p;
6449
6450 num_letters = 0;
6451 for (p = matched_string; *p; p++)
6452 if (ASCII_ISALNUM(*p))
6453 num_letters++;
6454
6455 /*
6456 * Multiply the number of letters by 100 to give it a much bigger
6457 * weighting than the number of characters.
6458 * If there only is a match while ignoring case, add 5000.
6459 * If the match starts in the middle of a word, add 10000 to put it
6460 * somewhere in the last half.
6461 * If the match is more than 2 chars from the start, multiply by 200 to
6462 * put it after matches at the start.
6463 */
6464 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6465 && ASCII_ISALNUM(matched_string[offset - 1]))
6466 offset += 10000;
6467 else if (offset > 2)
6468 offset *= 200;
6469 if (wrong_case)
6470 offset += 5000;
6471 /* Features are less interesting than the subjects themselves, but "+"
6472 * alone is not a feature. */
6473 if (matched_string[0] == '+' && matched_string[1] != NUL)
6474 offset += 100;
6475 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6476}
6477
6478/*
6479 * Compare functions for qsort() below, that checks the help heuristics number
6480 * that has been put after the tagname by find_tags().
6481 */
6482 static int
6483#ifdef __BORLANDC__
6484_RTLENTRYF
6485#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006486help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487{
6488 char *p1;
6489 char *p2;
6490
6491 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6492 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6493 return strcmp(p1, p2);
6494}
6495
6496/*
6497 * Find all help tags matching "arg", sort them and return in matches[], with
6498 * the number of matches in num_matches.
6499 * The matches will be sorted with a "best" match algorithm.
6500 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6501 */
6502 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006503find_help_tags(
6504 char_u *arg,
6505 int *num_matches,
6506 char_u ***matches,
6507 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508{
6509 char_u *s, *d;
6510 int i;
6511 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006512 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006513 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006514 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006515 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006516 "[count]", "[quotex]",
6517 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006518 "[pattern]", "\\|", "\\%$",
6519 "s/\\~", "s/\\U", "s/\\L",
6520 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006522 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006523 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006524 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006525 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006526 "\\[count]", "\\[quotex]",
6527 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006528 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006529 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006530 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 int flags;
6532
6533 d = IObuff; /* assume IObuff is long enough! */
6534
6535 /*
6536 * Recognize a few exceptions to the rule. Some strings that contain '*'
6537 * with "star". Otherwise '*' is recognized as a wildcard.
6538 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006539 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 if (STRCMP(arg, mtable[i]) == 0)
6541 {
6542 STRCPY(d, rtable[i]);
6543 break;
6544 }
6545
6546 if (i < 0) /* no match in table */
6547 {
6548 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6549 * Also replace "\%^" and "\%(", they match every tag too.
6550 * Also "\zs", "\z1", etc.
6551 * Also "\@<", "\@=", "\@<=", etc.
6552 * And also "\_$" and "\_^". */
6553 if (arg[0] == '\\'
6554 && ((arg[1] != NUL && arg[2] == NUL)
6555 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6556 && arg[2] != NUL)))
6557 {
6558 STRCPY(d, "/\\\\");
6559 STRCPY(d + 3, arg + 1);
6560 /* Check for "/\\_$", should be "/\\_\$" */
6561 if (d[3] == '_' && d[4] == '$')
6562 STRCPY(d + 4, "\\$");
6563 }
6564 else
6565 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006566 /* Replace:
6567 * "[:...:]" with "\[:...:]"
6568 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006569 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006570 */
6571 if ((arg[0] == '[' && (arg[1] == ':'
6572 || (arg[1] == '+' && arg[2] == '+')))
6573 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 *d++ = '\\';
6575
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006576 /*
6577 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6578 */
6579 if (*arg == '(' && arg[1] == '\'')
6580 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 for (s = arg; *s; ++s)
6582 {
6583 /*
6584 * Replace "|" with "bar" and '"' with "quote" to match the name of
6585 * the tags for these commands.
6586 * Replace "*" with ".*" and "?" with "." to match command line
6587 * completion.
6588 * Insert a backslash before '~', '$' and '.' to avoid their
6589 * special meaning.
6590 */
6591 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6592 break;
6593 switch (*s)
6594 {
6595 case '|': STRCPY(d, "bar");
6596 d += 3;
6597 continue;
6598 case '"': STRCPY(d, "quote");
6599 d += 5;
6600 continue;
6601 case '*': *d++ = '.';
6602 break;
6603 case '?': *d++ = '.';
6604 continue;
6605 case '$':
6606 case '.':
6607 case '~': *d++ = '\\';
6608 break;
6609 }
6610
6611 /*
6612 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6613 * ":help i_^_CTRL-D" work.
6614 * Insert '-' before and after "CTRL-X" when applicable.
6615 */
6616 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6617 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6618 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006619 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6620 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 STRCPY(d, "CTRL-");
6622 d += 5;
6623 if (*s < ' ')
6624 {
6625#ifdef EBCDIC
6626 *d++ = CtrlChar(*s);
6627#else
6628 *d++ = *s + '@';
6629#endif
6630 if (d[-1] == '\\')
6631 *d++ = '\\'; /* double a backslash */
6632 }
6633 else
6634 *d++ = *++s;
6635 if (s[1] != NUL && s[1] != '_')
6636 *d++ = '_'; /* append a '_' */
6637 continue;
6638 }
6639 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6640 *d++ = '\\';
6641
6642 /*
6643 * Insert a backslash before a backslash after a slash, for search
6644 * pattern tags: "/\|" --> "/\\|".
6645 */
6646 else if (s[0] == '\\' && s[1] != '\\'
6647 && *arg == '/' && s == arg + 1)
6648 *d++ = '\\';
6649
6650 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6651 * "CTRL-\_CTRL-N" */
6652 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6653 {
6654 STRCPY(d, "CTRL-\\\\");
6655 d += 7;
6656 s += 6;
6657 }
6658
6659 *d++ = *s;
6660
6661 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006662 * If tag contains "({" or "([", tag terminates at the "(".
6663 * This is for help on functions, e.g.: abs({expr}).
6664 */
6665 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6666 break;
6667
6668 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 * If tag starts with ', toss everything after a second '. Fixes
6670 * CTRL-] on 'option'. (would include the trailing '.').
6671 */
6672 if (*s == '\'' && s > arg && *arg == '\'')
6673 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006674 /* Also '{' and '}'. */
6675 if (*s == '}' && s > arg && *arg == '{')
6676 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 }
6678 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006679
6680 if (*IObuff == '`')
6681 {
6682 if (d > IObuff + 2 && d[-1] == '`')
6683 {
6684 /* remove the backticks from `command` */
6685 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6686 d[-2] = NUL;
6687 }
6688 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6689 {
6690 /* remove the backticks and comma from `command`, */
6691 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6692 d[-3] = NUL;
6693 }
6694 else if (d > IObuff + 4 && d[-3] == '`'
6695 && d[-2] == '\\' && d[-1] == '.')
6696 {
6697 /* remove the backticks and dot from `command`\. */
6698 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6699 d[-4] = NUL;
6700 }
6701 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 }
6703 }
6704
6705 *matches = (char_u **)"";
6706 *num_matches = 0;
6707 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6708 if (keep_lang)
6709 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006710 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006712 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 /* Sort the matches found on the heuristic number that is after the
6714 * tag name. */
6715 qsort((void *)*matches, (size_t)*num_matches,
6716 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006717 /* Delete more than TAG_MANY to reduce the size of the listing. */
6718 while (*num_matches > TAG_MANY)
6719 vim_free((*matches)[--*num_matches]);
6720 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 return OK;
6722}
6723
6724/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006725 * Called when starting to edit a buffer for a help file.
6726 */
6727 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006728prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006729{
6730 char_u *p;
6731
6732 curbuf->b_help = TRUE;
6733#ifdef FEAT_QUICKFIX
6734 set_string_option_direct((char_u *)"buftype", -1,
6735 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6736#endif
6737
6738 /*
6739 * Always set these options after jumping to a help tag, because the
6740 * user may have an autocommand that gets in the way.
6741 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6742 * latin1 word characters (for translated help files).
6743 * Only set it when needed, buf_init_chartab() is some work.
6744 */
6745 p =
6746#ifdef EBCDIC
6747 (char_u *)"65-255,^*,^|,^\"";
6748#else
6749 (char_u *)"!-~,^*,^|,^\",192-255";
6750#endif
6751 if (STRCMP(curbuf->b_p_isk, p) != 0)
6752 {
6753 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6754 check_buf_options(curbuf);
6755 (void)buf_init_chartab(curbuf, FALSE);
6756 }
6757
Bram Moolenaar0b105412014-11-30 13:34:23 +01006758#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006759 /* Don't use the global foldmethod.*/
6760 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6761 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006762#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006763
6764 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6765 curwin->w_p_list = FALSE; /* no list mode */
6766
6767 curbuf->b_p_ma = FALSE; /* not modifiable */
6768 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6769 curwin->w_p_nu = 0; /* no line numbers */
6770 curwin->w_p_rnu = 0; /* no relative line numbers */
6771 RESET_BINDING(curwin); /* no scroll or cursor binding */
6772#ifdef FEAT_ARABIC
6773 curwin->w_p_arab = FALSE; /* no arabic mode */
6774#endif
6775#ifdef FEAT_RIGHTLEFT
6776 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6777#endif
6778#ifdef FEAT_FOLDING
6779 curwin->w_p_fen = FALSE; /* No folding in the help window */
6780#endif
6781#ifdef FEAT_DIFF
6782 curwin->w_p_diff = FALSE; /* No 'diff' */
6783#endif
6784#ifdef FEAT_SPELL
6785 curwin->w_p_spell = FALSE; /* No spell checking */
6786#endif
6787
6788 set_buflisted(FALSE);
6789}
6790
6791/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 * After reading a help file: May cleanup a help buffer when syntax
6793 * highlighting is not used.
6794 */
6795 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006796fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797{
6798 linenr_T lnum;
6799 char_u *line;
6800 int in_example = FALSE;
6801 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006802 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 char_u *p;
6804 char_u *rt;
6805 int mustfree;
6806
Bram Moolenaar157069b2017-06-22 14:56:12 +02006807#ifdef FEAT_AUTOCMD
Bram Moolenaar90492982017-06-22 14:16:31 +02006808 /* Set filetype to "help" if still needed. */
6809 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006810 {
6811 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006812 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006813 --curbuf_lock;
6814 }
Bram Moolenaar157069b2017-06-22 14:56:12 +02006815#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816
6817#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006818 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819#endif
6820 {
6821 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6822 {
6823 line = ml_get_buf(curbuf, lnum, FALSE);
6824 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006825 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 {
6827 /* End of example: non-white or '<' in first column. */
6828 if (line[0] == '<')
6829 {
6830 /* blank-out a '<' in the first column */
6831 line = ml_get_buf(curbuf, lnum, TRUE);
6832 line[0] = ' ';
6833 }
6834 in_example = FALSE;
6835 }
6836 if (!in_example && len > 0)
6837 {
6838 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6839 {
6840 /* blank-out a '>' in the last column (start of example) */
6841 line = ml_get_buf(curbuf, lnum, TRUE);
6842 line[len - 1] = ' ';
6843 in_example = TRUE;
6844 }
6845 else if (line[len - 1] == '~')
6846 {
6847 /* blank-out a '~' at the end of line (header marker) */
6848 line = ml_get_buf(curbuf, lnum, TRUE);
6849 line[len - 1] = ' ';
6850 }
6851 }
6852 }
6853 }
6854
6855 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006856 * In the "help.txt" and "help.abx" file, add the locally added help
6857 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006859 fname = gettail(curbuf->b_fname);
6860 if (fnamecmp(fname, "help.txt") == 0
6861#ifdef FEAT_MULTI_LANG
6862 || (fnamencmp(fname, "help.", 5) == 0
6863 && ASCII_ISALPHA(fname[5])
6864 && ASCII_ISALPHA(fname[6])
6865 && TOLOWER_ASC(fname[7]) == 'x'
6866 && fname[8] == NUL)
6867#endif
6868 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 {
6870 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6871 {
6872 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006873 if (strstr((char *)line, "*local-additions*") == NULL)
6874 continue;
6875
6876 /* Go through all directories in 'runtimepath', skipping
6877 * $VIMRUNTIME. */
6878 p = p_rtp;
6879 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006881 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6882 mustfree = FALSE;
6883 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6884 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006886 int fcount;
6887 char_u **fnames;
6888 FILE *fd;
6889 char_u *s;
6890 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006892 vimconv_T vc;
6893 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894#endif
6895
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006896 /* Find all "doc/ *.txt" files in this directory. */
6897 add_pathsep(NameBuff);
6898#ifdef FEAT_MULTI_LANG
6899 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006901 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006903 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6904 &fnames, EW_FILE|EW_SILENT) == OK
6905 && fcount > 0)
6906 {
6907#ifdef FEAT_MULTI_LANG
6908 int i1;
6909 int i2;
6910 char_u *f1;
6911 char_u *f2;
6912 char_u *t1;
6913 char_u *e1;
6914 char_u *e2;
6915
6916 /* If foo.abx is found use it instead of foo.txt in
6917 * the same directory. */
6918 for (i1 = 0; i1 < fcount; ++i1)
6919 {
6920 for (i2 = 0; i2 < fcount; ++i2)
6921 {
6922 if (i1 == i2)
6923 continue;
6924 if (fnames[i1] == NULL || fnames[i2] == NULL)
6925 continue;
6926 f1 = fnames[i1];
6927 f2 = fnames[i2];
6928 t1 = gettail(f1);
6929 if (fnamencmp(f1, f2, t1 - f1) != 0)
6930 continue;
6931 e1 = vim_strrchr(t1, '.');
6932 e2 = vim_strrchr(gettail(f2), '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02006933 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006934 continue;
6935 if (fnamecmp(e1, ".txt") != 0
6936 && fnamecmp(e1, fname + 4) != 0)
6937 {
6938 /* Not .txt and not .abx, remove it. */
6939 vim_free(fnames[i1]);
6940 fnames[i1] = NULL;
6941 continue;
6942 }
6943 if (fnamencmp(f1, f2, e1 - f1) != 0)
6944 continue;
6945 if (fnamecmp(e1, ".txt") == 0
6946 && fnamecmp(e2, fname + 4) == 0)
6947 {
6948 /* use .abx instead of .txt */
6949 vim_free(fnames[i1]);
6950 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 }
6952 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006954#endif
6955 for (fi = 0; fi < fcount; ++fi)
6956 {
6957 if (fnames[fi] == NULL)
6958 continue;
6959 fd = mch_fopen((char *)fnames[fi], "r");
6960 if (fd != NULL)
6961 {
6962 vim_fgets(IObuff, IOSIZE, fd);
6963 if (IObuff[0] == '*'
6964 && (s = vim_strchr(IObuff + 1, '*'))
6965 != NULL)
6966 {
6967#ifdef FEAT_MBYTE
6968 int this_utf = MAYBE;
6969#endif
6970 /* Change tag definition to a
6971 * reference and remove <CR>/<NL>. */
6972 IObuff[0] = '|';
6973 *s = '|';
6974 while (*s != NUL)
6975 {
6976 if (*s == '\r' || *s == '\n')
6977 *s = NUL;
6978#ifdef FEAT_MBYTE
6979 /* The text is utf-8 when a byte
6980 * above 127 is found and no
6981 * illegal byte sequence is found.
6982 */
6983 if (*s >= 0x80 && this_utf != FALSE)
6984 {
6985 int l;
6986
6987 this_utf = TRUE;
6988 l = utf_ptr2len(s);
6989 if (l == 1)
6990 this_utf = FALSE;
6991 s += l - 1;
6992 }
6993#endif
6994 ++s;
6995 }
6996#ifdef FEAT_MBYTE
6997 /* The help file is latin1 or utf-8;
6998 * conversion to the current
6999 * 'encoding' may be required. */
7000 vc.vc_type = CONV_NONE;
7001 convert_setup(&vc, (char_u *)(
7002 this_utf == TRUE ? "utf-8"
7003 : "latin1"), p_enc);
7004 if (vc.vc_type == CONV_NONE)
7005 /* No conversion needed. */
7006 cp = IObuff;
7007 else
7008 {
7009 /* Do the conversion. If it fails
7010 * use the unconverted text. */
7011 cp = string_convert(&vc, IObuff,
7012 NULL);
7013 if (cp == NULL)
7014 cp = IObuff;
7015 }
7016 convert_setup(&vc, NULL, NULL);
7017
7018 ml_append(lnum, cp, (colnr_T)0, FALSE);
7019 if (cp != IObuff)
7020 vim_free(cp);
7021#else
7022 ml_append(lnum, IObuff, (colnr_T)0,
7023 FALSE);
7024#endif
7025 ++lnum;
7026 }
7027 fclose(fd);
7028 }
7029 }
7030 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007033 if (mustfree)
7034 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007036 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 }
7038 }
7039}
7040
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007041/*
7042 * ":exusage"
7043 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007045ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007046{
7047 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7048}
7049
7050/*
7051 * ":viusage"
7052 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007053 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007054ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007055{
7056 do_cmdline_cmd((char_u *)"help normal-index");
7057}
7058
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007060 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007063helptags_one(
7064 char_u *dir, /* doc directory */
7065 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7066 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7067 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068{
7069 FILE *fd_tags;
7070 FILE *fd;
7071 garray_T ga;
7072 int filecount;
7073 char_u **files;
7074 char_u *p1, *p2;
7075 int fi;
7076 char_u *s;
7077 int i;
7078 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007079 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080# ifdef FEAT_MBYTE
7081 int utf8 = MAYBE;
7082 int this_utf8;
7083 int firstline;
7084 int mix = FALSE; /* detected mixed encodings */
7085# endif
7086
7087 /*
7088 * Find all *.txt files.
7089 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007090 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007092 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 STRCAT(NameBuff, ext);
7094 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7095 EW_FILE|EW_SILENT) == FAIL
7096 || filecount == 0)
7097 {
7098 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007099 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 return;
7101 }
7102
7103 /*
7104 * Open the tags file for writing.
7105 * Do this before scanning through all the files.
7106 */
7107 STRCPY(NameBuff, dir);
7108 add_pathsep(NameBuff);
7109 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007110 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 if (fd_tags == NULL)
7112 {
7113 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7114 FreeWild(filecount, files);
7115 return;
7116 }
7117
7118 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007119 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7120 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 */
7122 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007123 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7124 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 {
7126 if (ga_grow(&ga, 1) == FAIL)
7127 got_int = TRUE;
7128 else
7129 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007130 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 if (s == NULL)
7132 got_int = TRUE;
7133 else
7134 {
7135 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7136 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7137 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 }
7139 }
7140 }
7141
7142 /*
7143 * Go over all the files and extract the tags.
7144 */
7145 for (fi = 0; fi < filecount && !got_int; ++fi)
7146 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007147 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 if (fd == NULL)
7149 {
7150 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7151 continue;
7152 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007153 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154
7155# ifdef FEAT_MBYTE
7156 firstline = TRUE;
7157# endif
7158 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7159 {
7160# ifdef FEAT_MBYTE
7161 if (firstline)
7162 {
7163 /* Detect utf-8 file by a non-ASCII char in the first line. */
7164 this_utf8 = MAYBE;
7165 for (s = IObuff; *s != NUL; ++s)
7166 if (*s >= 0x80)
7167 {
7168 int l;
7169
7170 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007171 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 if (l == 1)
7173 {
7174 /* Illegal UTF-8 byte sequence. */
7175 this_utf8 = FALSE;
7176 break;
7177 }
7178 s += l - 1;
7179 }
7180 if (this_utf8 == MAYBE) /* only ASCII characters found */
7181 this_utf8 = FALSE;
7182 if (utf8 == MAYBE) /* first file */
7183 utf8 = this_utf8;
7184 else if (utf8 != this_utf8)
7185 {
7186 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7187 mix = !got_int;
7188 got_int = TRUE;
7189 }
7190 firstline = FALSE;
7191 }
7192# endif
7193 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7194 while (p1 != NULL)
7195 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007196 /* Use vim_strbyte() instead of vim_strchr() so that when
7197 * 'encoding' is dbcs it still works, don't find '*' in the
7198 * second byte. */
7199 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7201 {
7202 for (s = p1 + 1; s < p2; ++s)
7203 if (*s == ' ' || *s == '\t' || *s == '|')
7204 break;
7205
7206 /*
7207 * Only accept a *tag* when it consists of valid
7208 * characters, there is white space before it and is
7209 * followed by a white character or end-of-line.
7210 */
7211 if (s == p2
7212 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7213 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7214 || s[1] == '\0'))
7215 {
7216 *p2 = '\0';
7217 ++p1;
7218 if (ga_grow(&ga, 1) == FAIL)
7219 {
7220 got_int = TRUE;
7221 break;
7222 }
7223 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7224 if (s == NULL)
7225 {
7226 got_int = TRUE;
7227 break;
7228 }
7229 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7230 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 sprintf((char *)s, "%s\t%s", p1, fname);
7232
7233 /* find next '*' */
7234 p2 = vim_strchr(p2 + 1, '*');
7235 }
7236 }
7237 p1 = p2;
7238 }
7239 line_breakcheck();
7240 }
7241
7242 fclose(fd);
7243 }
7244
7245 FreeWild(filecount, files);
7246
7247 if (!got_int)
7248 {
7249 /*
7250 * Sort the tags.
7251 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007252 if (ga.ga_data != NULL)
7253 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254
7255 /*
7256 * Check for duplicates.
7257 */
7258 for (i = 1; i < ga.ga_len; ++i)
7259 {
7260 p1 = ((char_u **)ga.ga_data)[i - 1];
7261 p2 = ((char_u **)ga.ga_data)[i];
7262 while (*p1 == *p2)
7263 {
7264 if (*p2 == '\t')
7265 {
7266 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007267 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7269 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7270 EMSG(NameBuff);
7271 *p2 = '\t';
7272 break;
7273 }
7274 ++p1;
7275 ++p2;
7276 }
7277 }
7278
7279# ifdef FEAT_MBYTE
7280 if (utf8 == TRUE)
7281 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7282# endif
7283
7284 /*
7285 * Write the tags into the file.
7286 */
7287 for (i = 0; i < ga.ga_len; ++i)
7288 {
7289 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007290 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007292 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 else
7294 {
7295 fprintf(fd_tags, "%s\t/*", s);
7296 for (p1 = s; *p1 != '\t'; ++p1)
7297 {
7298 /* insert backslash before '\\' and '/' */
7299 if (*p1 == '\\' || *p1 == '/')
7300 putc('\\', fd_tags);
7301 putc(*p1, fd_tags);
7302 }
7303 fprintf(fd_tags, "*\n");
7304 }
7305 }
7306 }
7307#ifdef FEAT_MBYTE
7308 if (mix)
7309 got_int = FALSE; /* continue with other languages */
7310#endif
7311
7312 for (i = 0; i < ga.ga_len; ++i)
7313 vim_free(((char_u **)ga.ga_data)[i]);
7314 ga_clear(&ga);
7315 fclose(fd_tags); /* there is no check for an error... */
7316}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007318/*
7319 * Generate tags in one help directory, taking care of translations.
7320 */
7321 static void
7322do_helptags(char_u *dirname, int add_help_tags)
7323{
7324#ifdef FEAT_MULTI_LANG
7325 int len;
7326 int i, j;
7327 garray_T ga;
7328 char_u lang[2];
7329 char_u ext[5];
7330 char_u fname[8];
7331 int filecount;
7332 char_u **files;
7333
7334 /* Get a list of all files in the help directory and in subdirectories. */
7335 STRCPY(NameBuff, dirname);
7336 add_pathsep(NameBuff);
7337 STRCAT(NameBuff, "**");
7338 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7339 EW_FILE|EW_SILENT) == FAIL
7340 || filecount == 0)
7341 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007342 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007343 return;
7344 }
7345
7346 /* Go over all files in the directory to find out what languages are
7347 * present. */
7348 ga_init2(&ga, 1, 10);
7349 for (i = 0; i < filecount; ++i)
7350 {
7351 len = (int)STRLEN(files[i]);
7352 if (len > 4)
7353 {
7354 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7355 {
7356 /* ".txt" -> language "en" */
7357 lang[0] = 'e';
7358 lang[1] = 'n';
7359 }
7360 else if (files[i][len - 4] == '.'
7361 && ASCII_ISALPHA(files[i][len - 3])
7362 && ASCII_ISALPHA(files[i][len - 2])
7363 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7364 {
7365 /* ".abx" -> language "ab" */
7366 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7367 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7368 }
7369 else
7370 continue;
7371
7372 /* Did we find this language already? */
7373 for (j = 0; j < ga.ga_len; j += 2)
7374 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7375 break;
7376 if (j == ga.ga_len)
7377 {
7378 /* New language, add it. */
7379 if (ga_grow(&ga, 2) == FAIL)
7380 break;
7381 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7382 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7383 }
7384 }
7385 }
7386
7387 /*
7388 * Loop over the found languages to generate a tags file for each one.
7389 */
7390 for (j = 0; j < ga.ga_len; j += 2)
7391 {
7392 STRCPY(fname, "tags-xx");
7393 fname[5] = ((char_u *)ga.ga_data)[j];
7394 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7395 if (fname[5] == 'e' && fname[6] == 'n')
7396 {
7397 /* English is an exception: use ".txt" and "tags". */
7398 fname[4] = NUL;
7399 STRCPY(ext, ".txt");
7400 }
7401 else
7402 {
7403 /* Language "ab" uses ".abx" and "tags-ab". */
7404 STRCPY(ext, ".xxx");
7405 ext[1] = fname[5];
7406 ext[2] = fname[6];
7407 }
7408 helptags_one(dirname, ext, fname, add_help_tags);
7409 }
7410
7411 ga_clear(&ga);
7412 FreeWild(filecount, files);
7413
7414#else
7415 /* No language support, just use "*.txt" and "tags". */
7416 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7417#endif
7418}
7419
7420 static void
7421helptags_cb(char_u *fname, void *cookie)
7422{
7423 do_helptags(fname, *(int *)cookie);
7424}
7425
7426/*
7427 * ":helptags"
7428 */
7429 void
7430ex_helptags(exarg_T *eap)
7431{
7432 expand_T xpc;
7433 char_u *dirname;
7434 int add_help_tags = FALSE;
7435
7436 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007437 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007438 {
7439 add_help_tags = TRUE;
7440 eap->arg = skipwhite(eap->arg + 3);
7441 }
7442
7443 if (STRCMP(eap->arg, "ALL") == 0)
7444 {
7445 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7446 helptags_cb, &add_help_tags);
7447 }
7448 else
7449 {
7450 ExpandInit(&xpc);
7451 xpc.xp_context = EXPAND_DIRECTORIES;
7452 dirname = ExpandOne(&xpc, eap->arg, NULL,
7453 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7454 if (dirname == NULL || !mch_isdir(dirname))
7455 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7456 else
7457 do_helptags(dirname, add_help_tags);
7458 vim_free(dirname);
7459 }
7460}
7461
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462#if defined(FEAT_SIGNS) || defined(PROTO)
7463
7464/*
7465 * Struct to hold the sign properties.
7466 */
7467typedef struct sign sign_T;
7468
7469struct sign
7470{
7471 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007472 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 char_u *sn_name; /* name of sign */
7474 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007475# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007477# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 char_u *sn_text; /* text used instead of pixmap */
7479 int sn_line_hl; /* highlight ID for line */
7480 int sn_text_hl; /* highlight ID for text */
7481};
7482
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007484static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007486static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7487static void sign_list_defined(sign_T *sp);
7488static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007490static char *cmds[] = {
7491 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007492# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007493 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007494# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007495 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007496# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007497 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007498# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007499 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007500# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007501 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007502# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007503 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007504# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007505};
7506
7507/*
7508 * Find index of a ":sign" subcmd from its name.
7509 * "*end_cmd" must be writable.
7510 */
7511 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007512sign_cmd_idx(
7513 char_u *begin_cmd, /* begin of sign subcmd */
7514 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007515{
7516 int idx;
7517 char save = *end_cmd;
7518
7519 *end_cmd = NUL;
7520 for (idx = 0; ; ++idx)
7521 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7522 break;
7523 *end_cmd = save;
7524 return idx;
7525}
7526
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527/*
7528 * ":sign" command
7529 */
7530 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007531ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532{
7533 char_u *arg = eap->arg;
7534 char_u *p;
7535 int idx;
7536 sign_T *sp;
7537 sign_T *sp_prev;
7538 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539
7540 /* Parse the subcommand. */
7541 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007542 idx = sign_cmd_idx(arg, p);
7543 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007545 EMSG2(_("E160: Unknown sign command: %s"), arg);
7546 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 }
7548 arg = skipwhite(p);
7549
7550 if (idx <= SIGNCMD_LIST)
7551 {
7552 /*
7553 * Define, undefine or list signs.
7554 */
7555 if (idx == SIGNCMD_LIST && *arg == NUL)
7556 {
7557 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007558 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 sign_list_defined(sp);
7560 }
7561 else if (*arg == NUL)
7562 EMSG(_("E156: Missing sign name"));
7563 else
7564 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007565 /* Isolate the sign name. If it's a number skip leading zeroes,
7566 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 p = skiptowhite(arg);
7568 if (*p != NUL)
7569 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007570 while (arg[0] == '0' && arg[1] != NUL)
7571 ++arg;
7572
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 sp_prev = NULL;
7574 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7575 {
7576 if (STRCMP(sp->sn_name, arg) == 0)
7577 break;
7578 sp_prev = sp;
7579 }
7580 if (idx == SIGNCMD_DEFINE)
7581 {
7582 /* ":sign define {name} ...": define a sign */
7583 if (sp == NULL)
7584 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007585 sign_T *lp;
7586 int start = next_sign_typenr;
7587
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 /* Allocate a new sign. */
7589 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7590 if (sp == NULL)
7591 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007593 /* Check that next_sign_typenr is not already being used.
7594 * This only happens after wrapping around. Hopefully
7595 * another one got deleted and we can use its number. */
7596 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007598 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007600 ++next_sign_typenr;
7601 if (next_sign_typenr == MAX_TYPENR)
7602 next_sign_typenr = 1;
7603 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007605 vim_free(sp);
7606 EMSG(_("E612: Too many signs defined"));
7607 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007609 lp = first_sign; /* start all over */
7610 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007612 lp = lp->sn_next;
7613 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007615 sp->sn_typenr = next_sign_typenr;
7616 if (++next_sign_typenr == MAX_TYPENR)
7617 next_sign_typenr = 1; /* wrap around */
7618
7619 sp->sn_name = vim_strsave(arg);
7620 if (sp->sn_name == NULL) /* out of memory */
7621 {
7622 vim_free(sp);
7623 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007625
7626 /* add the new sign to the list of signs */
7627 if (sp_prev == NULL)
7628 first_sign = sp;
7629 else
7630 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 }
7632
7633 /* set values for a defined sign. */
7634 for (;;)
7635 {
7636 arg = skipwhite(p);
7637 if (*arg == NUL)
7638 break;
7639 p = skiptowhite_esc(arg);
7640 if (STRNCMP(arg, "icon=", 5) == 0)
7641 {
7642 arg += 5;
7643 vim_free(sp->sn_icon);
7644 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7645 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007646# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 if (gui.in_use)
7648 {
7649 out_flush();
7650 if (sp->sn_image != NULL)
7651 gui_mch_destroy_sign(sp->sn_image);
7652 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7653 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007654# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 }
7656 else if (STRNCMP(arg, "text=", 5) == 0)
7657 {
7658 char_u *s;
7659 int cells;
7660 int len;
7661
7662 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007663# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 /* Count cells and check for non-printable chars */
7665 if (has_mbyte)
7666 {
7667 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007668 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 {
7670 if (!vim_isprintc((*mb_ptr2char)(s)))
7671 break;
7672 cells += (*mb_ptr2cells)(s);
7673 }
7674 }
7675 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007676# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 {
7678 for (s = arg; s < p; ++s)
7679 if (!vim_isprintc(*s))
7680 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007681 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 }
7683 /* Currently must be one or two display cells */
7684 if (s != p || cells < 1 || cells > 2)
7685 {
7686 *p = NUL;
7687 EMSG2(_("E239: Invalid sign text: %s"), arg);
7688 return;
7689 }
7690
7691 vim_free(sp->sn_text);
7692 /* Allocate one byte more if we need to pad up
7693 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007694 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 sp->sn_text = vim_strnsave(arg, len);
7696
7697 if (sp->sn_text != NULL && cells == 1)
7698 STRCPY(sp->sn_text + len - 1, " ");
7699 }
7700 else if (STRNCMP(arg, "linehl=", 7) == 0)
7701 {
7702 arg += 7;
7703 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7704 }
7705 else if (STRNCMP(arg, "texthl=", 7) == 0)
7706 {
7707 arg += 7;
7708 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7709 }
7710 else
7711 {
7712 EMSG2(_(e_invarg2), arg);
7713 return;
7714 }
7715 }
7716 }
7717 else if (sp == NULL)
7718 EMSG2(_("E155: Unknown sign: %s"), arg);
7719 else if (idx == SIGNCMD_LIST)
7720 /* ":sign list {name}" */
7721 sign_list_defined(sp);
7722 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007724 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 }
7726 }
7727 else
7728 {
7729 int id = -1;
7730 linenr_T lnum = -1;
7731 char_u *sign_name = NULL;
7732 char_u *arg1;
7733
7734 if (*arg == NUL)
7735 {
7736 if (idx == SIGNCMD_PLACE)
7737 {
7738 /* ":sign place": list placed signs in all buffers */
7739 sign_list_placed(NULL);
7740 }
7741 else if (idx == SIGNCMD_UNPLACE)
7742 {
7743 /* ":sign unplace": remove placed sign at cursor */
7744 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7745 if (id > 0)
7746 {
7747 buf_delsign(curwin->w_buffer, id);
7748 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7749 }
7750 else
7751 EMSG(_("E159: Missing sign number"));
7752 }
7753 else
7754 EMSG(_(e_argreq));
7755 return;
7756 }
7757
7758 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7759 {
7760 /* ":sign unplace *": remove all placed signs */
7761 buf_delete_all_signs();
7762 return;
7763 }
7764
7765 /* first arg could be placed sign id */
7766 arg1 = arg;
7767 if (VIM_ISDIGIT(*arg))
7768 {
7769 id = getdigits(&arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01007770 if (!VIM_ISWHITE(*arg) && *arg != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 {
7772 id = -1;
7773 arg = arg1;
7774 }
7775 else
7776 {
7777 arg = skipwhite(arg);
7778 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7779 {
7780 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007781 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 if ((lnum = buf_delsign(buf, id)) != 0)
7783 update_debug_sign(buf, lnum);
7784 return;
7785 }
7786 }
7787 }
7788
7789 /*
7790 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7791 * Leave "arg" pointing to {fname}.
7792 */
7793 for (;;)
7794 {
7795 if (STRNCMP(arg, "line=", 5) == 0)
7796 {
7797 arg += 5;
7798 lnum = atoi((char *)arg);
7799 arg = skiptowhite(arg);
7800 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007801 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7802 {
7803 if (id != -1)
7804 {
7805 EMSG(_(e_invarg));
7806 return;
7807 }
7808 id = -2;
7809 arg = skiptowhite(arg + 1);
7810 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 else if (STRNCMP(arg, "name=", 5) == 0)
7812 {
7813 arg += 5;
7814 sign_name = arg;
7815 arg = skiptowhite(arg);
7816 if (*arg != NUL)
7817 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007818 while (sign_name[0] == '0' && sign_name[1] != NUL)
7819 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 }
7821 else if (STRNCMP(arg, "file=", 5) == 0)
7822 {
7823 arg += 5;
7824 buf = buflist_findname(arg);
7825 break;
7826 }
7827 else if (STRNCMP(arg, "buffer=", 7) == 0)
7828 {
7829 arg += 7;
7830 buf = buflist_findnr((int)getdigits(&arg));
7831 if (*skipwhite(arg) != NUL)
7832 EMSG(_(e_trailing));
7833 break;
7834 }
7835 else
7836 {
7837 EMSG(_(e_invarg));
7838 return;
7839 }
7840 arg = skipwhite(arg);
7841 }
7842
7843 if (buf == NULL)
7844 {
7845 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7846 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007847 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 {
7849 if (lnum >= 0 || sign_name != NULL)
7850 EMSG(_(e_invarg));
7851 else
7852 /* ":sign place file={fname}": list placed signs in one file */
7853 sign_list_placed(buf);
7854 }
7855 else if (idx == SIGNCMD_JUMP)
7856 {
7857 /* ":sign jump {id} file={fname}" */
7858 if (lnum >= 0 || sign_name != NULL)
7859 EMSG(_(e_invarg));
7860 else if ((lnum = buf_findsign(buf, id)) > 0)
7861 { /* goto a sign ... */
7862 if (buf_jump_open_win(buf) != NULL)
7863 { /* ... in a current window */
7864 curwin->w_cursor.lnum = lnum;
7865 check_cursor_lnum();
7866 beginline(BL_WHITE);
7867 }
7868 else
7869 { /* ... not currently in a window */
7870 char_u *cmd;
7871
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007872 if (buf->b_fname == NULL)
7873 {
7874 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7875 return;
7876 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7878 if (cmd == NULL)
7879 return;
7880 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7881 do_cmdline_cmd(cmd);
7882 vim_free(cmd);
7883 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007884# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007886# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 }
7888 else
7889 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7890 }
7891 else if (idx == SIGNCMD_UNPLACE)
7892 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 if (lnum >= 0 || sign_name != NULL)
7894 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007895 else if (id == -2)
7896 {
7897 /* ":sign unplace * file={fname}" */
7898 redraw_buf_later(buf, NOT_VALID);
7899 buf_delete_signs(buf);
7900 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 else
7902 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007903 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 lnum = buf_delsign(buf, id);
7905 update_debug_sign(buf, lnum);
7906 }
7907 }
7908 /* idx == SIGNCMD_PLACE */
7909 else if (sign_name != NULL)
7910 {
7911 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7912 if (STRCMP(sp->sn_name, sign_name) == 0)
7913 break;
7914 if (sp == NULL)
7915 {
7916 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7917 return;
7918 }
7919 if (lnum > 0)
7920 /* ":sign place {id} line={lnum} name={name} file={fname}":
7921 * place a sign */
7922 buf_addsign(buf, id, lnum, sp->sn_typenr);
7923 else
7924 /* ":sign place {id} file={fname}": change sign type */
7925 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007926 if (lnum > 0)
7927 update_debug_sign(buf, lnum);
7928 else
7929 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 }
7931 else
7932 EMSG(_(e_invarg));
7933 }
7934}
7935
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007936# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937/*
7938 * Allocate the icons. Called when the GUI has started. Allows defining
7939 * signs before it starts.
7940 */
7941 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007942sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943{
7944 sign_T *sp;
7945
7946 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7947 if (sp->sn_icon != NULL)
7948 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7949}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007950# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951
7952/*
7953 * List one sign.
7954 */
7955 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007956sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957{
7958 char_u *p;
7959
Bram Moolenaar555b2802005-05-19 21:08:39 +00007960 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 if (sp->sn_icon != NULL)
7962 {
7963 MSG_PUTS(" icon=");
7964 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007965# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 if (sp->sn_image == NULL)
7967 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007968# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007970# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 }
7972 if (sp->sn_text != NULL)
7973 {
7974 MSG_PUTS(" text=");
7975 msg_outtrans(sp->sn_text);
7976 }
7977 if (sp->sn_line_hl > 0)
7978 {
7979 MSG_PUTS(" linehl=");
Bram Moolenaarc96272e2017-03-26 13:50:09 +02007980 p = get_highlight_name_ext(NULL, sp->sn_line_hl - 1, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 if (p == NULL)
7982 MSG_PUTS("NONE");
7983 else
7984 msg_puts(p);
7985 }
7986 if (sp->sn_text_hl > 0)
7987 {
7988 MSG_PUTS(" texthl=");
Bram Moolenaarc96272e2017-03-26 13:50:09 +02007989 p = get_highlight_name_ext(NULL, sp->sn_text_hl - 1, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 if (p == NULL)
7991 MSG_PUTS("NONE");
7992 else
7993 msg_puts(p);
7994 }
7995}
7996
7997/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007998 * Undefine a sign and free its memory.
7999 */
8000 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008001sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008002{
8003 vim_free(sp->sn_name);
8004 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008005# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008006 if (sp->sn_image != NULL)
8007 {
8008 out_flush();
8009 gui_mch_destroy_sign(sp->sn_image);
8010 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008011# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008012 vim_free(sp->sn_text);
8013 if (sp_prev == NULL)
8014 first_sign = sp->sn_next;
8015 else
8016 sp_prev->sn_next = sp->sn_next;
8017 vim_free(sp);
8018}
8019
8020/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 * Get highlighting attribute for sign "typenr".
8022 * If "line" is TRUE: line highl, if FALSE: text highl.
8023 */
8024 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008025sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026{
8027 sign_T *sp;
8028
8029 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8030 if (sp->sn_typenr == typenr)
8031 {
8032 if (line)
8033 {
8034 if (sp->sn_line_hl > 0)
8035 return syn_id2attr(sp->sn_line_hl);
8036 }
8037 else
8038 {
8039 if (sp->sn_text_hl > 0)
8040 return syn_id2attr(sp->sn_text_hl);
8041 }
8042 break;
8043 }
8044 return 0;
8045}
8046
8047/*
8048 * Get text mark for sign "typenr".
8049 * Returns NULL if there isn't one.
8050 */
8051 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008052sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053{
8054 sign_T *sp;
8055
8056 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8057 if (sp->sn_typenr == typenr)
8058 return sp->sn_text;
8059 return NULL;
8060}
8061
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008062# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008064sign_get_image(
8065 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066{
8067 sign_T *sp;
8068
8069 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8070 if (sp->sn_typenr == typenr)
8071 return sp->sn_image;
8072 return NULL;
8073}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008074# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075
8076/*
8077 * Get the name of a sign by its typenr.
8078 */
8079 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008080sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081{
8082 sign_T *sp;
8083
8084 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8085 if (sp->sn_typenr == typenr)
8086 return sp->sn_name;
8087 return (char_u *)_("[Deleted]");
8088}
8089
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008090# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008091/*
8092 * Undefine/free all signs.
8093 */
8094 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008095free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008096{
8097 while (first_sign != NULL)
8098 sign_undefine(first_sign, NULL);
8099}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008100# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008101
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008102# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008103static enum
8104{
8105 EXP_SUBCMD, /* expand :sign sub-commands */
8106 EXP_DEFINE, /* expand :sign define {name} args */
8107 EXP_PLACE, /* expand :sign place {id} args */
8108 EXP_UNPLACE, /* expand :sign unplace" */
8109 EXP_SIGN_NAMES /* expand with name of placed signs */
8110} expand_what;
8111
8112/*
8113 * Function given to ExpandGeneric() to obtain the sign command
8114 * expansion.
8115 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008116 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008117get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008118{
8119 sign_T *sp;
8120 int current_idx;
8121
8122 switch (expand_what)
8123 {
8124 case EXP_SUBCMD:
8125 return (char_u *)cmds[idx];
8126 case EXP_DEFINE:
8127 {
8128 char *define_arg[] =
8129 {
8130 "icon=", "linehl=", "text=", "texthl=", NULL
8131 };
8132 return (char_u *)define_arg[idx];
8133 }
8134 case EXP_PLACE:
8135 {
8136 char *place_arg[] =
8137 {
8138 "line=", "name=", "file=", "buffer=", NULL
8139 };
8140 return (char_u *)place_arg[idx];
8141 }
8142 case EXP_UNPLACE:
8143 {
8144 char *unplace_arg[] = { "file=", "buffer=", NULL };
8145 return (char_u *)unplace_arg[idx];
8146 }
8147 case EXP_SIGN_NAMES:
8148 /* Complete with name of signs already defined */
8149 current_idx = 0;
8150 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8151 if (current_idx++ == idx)
8152 return sp->sn_name;
8153 return NULL;
8154 default:
8155 return NULL;
8156 }
8157}
8158
8159/*
8160 * Handle command line completion for :sign command.
8161 */
8162 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008163set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008164{
8165 char_u *p;
8166 char_u *end_subcmd;
8167 char_u *last;
8168 int cmd_idx;
8169 char_u *begin_subcmd_args;
8170
8171 /* Default: expand subcommands. */
8172 xp->xp_context = EXPAND_SIGN;
8173 expand_what = EXP_SUBCMD;
8174 xp->xp_pattern = arg;
8175
8176 end_subcmd = skiptowhite(arg);
8177 if (*end_subcmd == NUL)
8178 /* expand subcmd name
8179 * :sign {subcmd}<CTRL-D>*/
8180 return;
8181
8182 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8183
8184 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008185 * |
8186 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008187 begin_subcmd_args = skipwhite(end_subcmd);
8188 p = skiptowhite(begin_subcmd_args);
8189 if (*p == NUL)
8190 {
8191 /*
8192 * Expand first argument of subcmd when possible.
8193 * For ":jump {id}" and ":unplace {id}", we could
8194 * possibly expand the ids of all signs already placed.
8195 */
8196 xp->xp_pattern = begin_subcmd_args;
8197 switch (cmd_idx)
8198 {
8199 case SIGNCMD_LIST:
8200 case SIGNCMD_UNDEFINE:
8201 /* :sign list <CTRL-D>
8202 * :sign undefine <CTRL-D> */
8203 expand_what = EXP_SIGN_NAMES;
8204 break;
8205 default:
8206 xp->xp_context = EXPAND_NOTHING;
8207 }
8208 return;
8209 }
8210
8211 /* expand last argument of subcmd */
8212
8213 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008214 * |
8215 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008216
8217 /* Loop until reaching last argument. */
8218 do
8219 {
8220 p = skipwhite(p);
8221 last = p;
8222 p = skiptowhite(p);
8223 } while (*p != NUL);
8224
8225 p = vim_strchr(last, '=');
8226
8227 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008228 * | |
8229 * last p */
Bram Moolenaar7756e742016-10-21 20:35:37 +02008230 if (p == NULL)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008231 {
8232 /* Expand last argument name (before equal sign). */
8233 xp->xp_pattern = last;
8234 switch (cmd_idx)
8235 {
8236 case SIGNCMD_DEFINE:
8237 expand_what = EXP_DEFINE;
8238 break;
8239 case SIGNCMD_PLACE:
8240 expand_what = EXP_PLACE;
8241 break;
8242 case SIGNCMD_JUMP:
8243 case SIGNCMD_UNPLACE:
8244 expand_what = EXP_UNPLACE;
8245 break;
8246 default:
8247 xp->xp_context = EXPAND_NOTHING;
8248 }
8249 }
8250 else
8251 {
8252 /* Expand last argument value (after equal sign). */
8253 xp->xp_pattern = p + 1;
8254 switch (cmd_idx)
8255 {
8256 case SIGNCMD_DEFINE:
8257 if (STRNCMP(last, "texthl", p - last) == 0 ||
8258 STRNCMP(last, "linehl", p - last) == 0)
8259 xp->xp_context = EXPAND_HIGHLIGHT;
8260 else if (STRNCMP(last, "icon", p - last) == 0)
8261 xp->xp_context = EXPAND_FILES;
8262 else
8263 xp->xp_context = EXPAND_NOTHING;
8264 break;
8265 case SIGNCMD_PLACE:
8266 if (STRNCMP(last, "name", p - last) == 0)
8267 expand_what = EXP_SIGN_NAMES;
8268 else
8269 xp->xp_context = EXPAND_NOTHING;
8270 break;
8271 default:
8272 xp->xp_context = EXPAND_NOTHING;
8273 }
8274 }
8275}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008276# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008277#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008278
8279/*
8280 * Make the user happy.
8281 */
8282 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008283ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008284{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008285 static char *code[] = {
8286 "\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$",
8287 "\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"
8288 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008289 char *p;
8290 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008291 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008292
8293 msg_start();
8294 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008295 for (i = 0; i < 2; ++i)
8296 for (p = code[i]; *p != NUL; ++p)
8297 if (*p == 'x')
8298 msg_putchar('\n');
8299 else
8300 for (n = *p++; n > 0; --n)
8301 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01008302 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008303 else
8304 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008305 msg_clr_eos();
8306}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307
8308#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8309/*
8310 * ":drop"
8311 * Opens the first argument in a window. When there are two or more arguments
8312 * the argument list is redefined.
8313 */
8314 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008315ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316{
8317 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 win_T *wp;
8319 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008320 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321
8322 /*
8323 * Check if the first argument is already being edited in a window. If
8324 * so, jump to that window.
8325 * We would actually need to check all arguments, but that's complicated
8326 * and mostly only one file is dropped.
8327 * This also ignores wildcards, since it is very unlikely the user is
8328 * editing a file name with a wildcard character.
8329 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008330 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008332 /*
8333 * Expanding wildcards may result in an empty argument list. E.g. when
8334 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8335 * already did an error message for this.
8336 */
8337 if (ARGCOUNT == 0)
8338 return;
8339
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008340 if (cmdmod.tab)
8341 {
8342 /* ":tab drop file ...": open a tab for each argument that isn't
8343 * edited in a window yet. It's like ":tab all" but without closing
8344 * windows or tabs. */
8345 ex_all(eap);
8346 }
8347 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008348 {
8349 /* ":drop file ...": Edit the first argument. Jump to an existing
8350 * window if possible, edit in current window if the current buffer
8351 * can be abandoned, otherwise open a new window. */
8352 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8353
8354 FOR_ALL_TAB_WINDOWS(tp, wp)
8355 {
8356 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008358 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 return;
8361 }
8362 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008364 /*
8365 * Check whether the current buffer is changed. If so, we will need
8366 * to split the current window or data could be lost.
8367 * Skip the check if the 'hidden' option is set, as in this case the
8368 * buffer won't be lost.
8369 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02008370 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008371 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008372 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008373 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008374 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008375 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008377 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8378 if (split)
8379 {
8380 eap->cmdidx = CMD_sfirst;
8381 eap->cmd[0] = 's';
8382 }
8383 else
8384 eap->cmdidx = CMD_first;
8385 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387}
8388#endif
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008389
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008390/*
8391 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8392 * Put the start of the pattern in "*s", unless "s" is NULL.
8393 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8394 * If "s" is not NULL terminate the pattern with a NUL.
8395 * Return a pointer to the char just past the pattern plus flags.
8396 */
8397 char_u *
8398skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8399{
8400 int c;
8401
8402 if (vim_isIDc(*p))
8403 {
8404 /* ":vimgrep pattern fname" */
8405 if (s != NULL)
8406 *s = p;
8407 p = skiptowhite(p);
8408 if (s != NULL && *p != NUL)
8409 *p++ = NUL;
8410 }
8411 else
8412 {
8413 /* ":vimgrep /pattern/[g][j] fname" */
8414 if (s != NULL)
8415 *s = p + 1;
8416 c = *p;
8417 p = skip_regexp(p + 1, c, TRUE, NULL);
8418 if (*p != c)
8419 return NULL;
8420
8421 /* Truncate the pattern. */
8422 if (s != NULL)
8423 *p = NUL;
8424 ++p;
8425
8426 /* Find the flags */
8427 while (*p == 'g' || *p == 'j')
8428 {
8429 if (flags != NULL)
8430 {
8431 if (*p == 'g')
8432 *flags |= VGR_GLOBAL;
8433 else
8434 *flags |= VGR_NOJUMP;
8435 }
8436 ++p;
8437 }
8438 }
8439 return p;
8440}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008441
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008442#if defined(FEAT_EVAL) || defined(PROTO)
8443/*
8444 * List v:oldfiles in a nice way.
8445 */
8446 void
8447ex_oldfiles(exarg_T *eap UNUSED)
8448{
8449 list_T *l = get_vim_var_list(VV_OLDFILES);
8450 listitem_T *li;
8451 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008452 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008453
8454 if (l == NULL)
8455 msg((char_u *)_("No old files"));
8456 else
8457 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008458 msg_start();
8459 msg_scroll = TRUE;
8460 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8461 {
8462 ++nr;
8463 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008464 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008465 {
8466 msg_outnum((long)nr);
8467 MSG_PUTS(": ");
8468 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02008469 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008470 msg_putchar('\n');
8471 out_flush(); /* output one line at a time */
8472 ui_breakcheck();
8473 }
8474 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008475
8476 /* Assume "got_int" was set to truncate the listing. */
8477 got_int = FALSE;
8478
8479# ifdef FEAT_BROWSE_CMD
8480 if (cmdmod.browse)
8481 {
8482 quit_more = FALSE;
8483 nr = prompt_for_number(FALSE);
8484 msg_starthere();
8485 if (nr > 0)
8486 {
8487 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8488 (long)nr);
8489
8490 if (p != NULL)
8491 {
8492 p = expand_env_save(p);
8493 eap->arg = p;
8494 eap->cmdidx = CMD_edit;
8495 cmdmod.browse = FALSE;
8496 do_exedit(eap, NULL);
8497 vim_free(p);
8498 }
8499 }
8500 }
8501# endif
8502 }
8503}
8504#endif