blob: 154372883d83a52ffdf09bb4150884cdc7c74e97 [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 Moolenaar6ce65042017-10-24 22:32:59 +02003005 redraw_tabline = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006}
3007
3008/*
3009 * ":update".
3010 */
3011 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003012ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013{
3014 if (curbufIsChanged())
3015 (void)do_write(eap);
3016}
3017
3018/*
3019 * ":write" and ":saveas".
3020 */
3021 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003022ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023{
3024 if (eap->usefilter) /* input lines to shell command */
3025 do_bang(1, eap, FALSE, TRUE, FALSE);
3026 else
3027 (void)do_write(eap);
3028}
3029
3030/*
3031 * write current buffer to file 'eap->arg'
3032 * if 'eap->append' is TRUE, append to the file
3033 *
3034 * if *eap->arg == NUL write to current file
3035 *
3036 * return FAIL for failure, OK otherwise
3037 */
3038 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003039do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040{
3041 int other;
3042 char_u *fname = NULL; /* init to shut up gcc */
3043 char_u *ffname;
3044 int retval = FAIL;
3045 char_u *free_fname = NULL;
3046#ifdef FEAT_BROWSE
3047 char_u *browse_file = NULL;
3048#endif
3049 buf_T *alt_buf = NULL;
Bram Moolenaar5c719942016-07-09 23:40:45 +02003050 int name_was_missing;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051
3052 if (not_writing()) /* check 'write' option */
3053 return FAIL;
3054
3055 ffname = eap->arg;
3056#ifdef FEAT_BROWSE
3057 if (cmdmod.browse)
3058 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003059 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 NULL, NULL, NULL, curbuf);
3061 if (browse_file == NULL)
3062 goto theend;
3063 ffname = browse_file;
3064 }
3065#endif
3066 if (*ffname == NUL)
3067 {
3068 if (eap->cmdidx == CMD_saveas)
3069 {
3070 EMSG(_(e_argreq));
3071 goto theend;
3072 }
3073 other = FALSE;
3074 }
3075 else
3076 {
3077 fname = ffname;
3078 free_fname = fix_fname(ffname);
3079 /*
3080 * When out-of-memory, keep unexpanded file name, because we MUST be
3081 * able to write the file in this situation.
3082 */
3083 if (free_fname != NULL)
3084 ffname = free_fname;
3085 other = otherfile(ffname);
3086 }
3087
3088 /*
3089 * If we have a new file, put its name in the list of alternate file names.
3090 */
3091 if (other)
3092 {
3093 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3094 || eap->cmdidx == CMD_saveas)
3095 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3096 else
3097 alt_buf = buflist_findname(ffname);
3098 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3099 {
3100 /* Overwriting a file that is loaded in another buffer is not a
3101 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003102 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 goto theend;
3104 }
3105 }
3106
3107 /*
3108 * Writing to the current file is not allowed in readonly mode
3109 * and a file name is required.
3110 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3111 */
3112 if (!other && (
3113#ifdef FEAT_QUICKFIX
3114 bt_dontwrite_msg(curbuf) ||
3115#endif
3116 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3117 goto theend;
3118
3119 if (!other)
3120 {
3121 ffname = curbuf->b_ffname;
3122 fname = curbuf->b_fname;
3123 /*
3124 * Not writing the whole file is only allowed with '!'.
3125 */
3126 if ( (eap->line1 != 1
3127 || eap->line2 != curbuf->b_ml.ml_line_count)
3128 && !eap->forceit
3129 && !eap->append
3130 && !p_wa)
3131 {
3132#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3133 if (p_confirm || cmdmod.confirm)
3134 {
3135 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3136 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3137 goto theend;
3138 eap->forceit = TRUE;
3139 }
3140 else
3141#endif
3142 {
3143 EMSG(_("E140: Use ! to write partial buffer"));
3144 goto theend;
3145 }
3146 }
3147 }
3148
3149 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3150 {
3151 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3152 {
3153#ifdef FEAT_AUTOCMD
3154 buf_T *was_curbuf = curbuf;
3155
3156 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003157 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158# ifdef FEAT_EVAL
3159 if (curbuf != was_curbuf || aborting())
3160# else
3161 if (curbuf != was_curbuf)
3162# endif
3163 {
3164 /* buffer changed, don't change name now */
3165 retval = FAIL;
3166 goto theend;
3167 }
3168#endif
3169 /* Exchange the file names for the current and the alternate
3170 * buffer. This makes it look like we are now editing the buffer
3171 * under the new name. Must be done before buf_write(), because
3172 * if there is no file name and 'cpo' contains 'F', it will set
3173 * the file name. */
3174 fname = alt_buf->b_fname;
3175 alt_buf->b_fname = curbuf->b_fname;
3176 curbuf->b_fname = fname;
3177 fname = alt_buf->b_ffname;
3178 alt_buf->b_ffname = curbuf->b_ffname;
3179 curbuf->b_ffname = fname;
3180 fname = alt_buf->b_sfname;
3181 alt_buf->b_sfname = curbuf->b_sfname;
3182 curbuf->b_sfname = fname;
3183 buf_name_changed(curbuf);
3184#ifdef FEAT_AUTOCMD
3185 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003186 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 if (!alt_buf->b_p_bl)
3188 {
3189 alt_buf->b_p_bl = TRUE;
3190 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3191 }
3192# ifdef FEAT_EVAL
3193 if (curbuf != was_curbuf || aborting())
3194# else
3195 if (curbuf != was_curbuf)
3196# endif
3197 {
3198 /* buffer changed, don't write the file */
3199 retval = FAIL;
3200 goto theend;
3201 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003202
3203 /* If 'filetype' was empty try detecting it now. */
3204 if (*curbuf->b_p_ft == NUL)
3205 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003206 if (au_has_group((char_u *)"filetypedetect"))
3207 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003208 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003209 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003210 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003211
3212 /* Autocommands may have changed buffer names, esp. when
3213 * 'autochdir' is set. */
3214 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215#endif
3216 }
3217
Bram Moolenaar5c719942016-07-09 23:40:45 +02003218 name_was_missing = curbuf->b_ffname == NULL;
3219
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3221 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003222
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003223 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003224 if (eap->cmdidx == CMD_saveas)
3225 {
3226 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003227 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003228 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003229 redraw_tabline = TRUE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003230 }
Bram Moolenaar5c719942016-07-09 23:40:45 +02003231 }
3232
3233 /* Change directories when the 'acd' option is set and the file name
3234 * got changed or set. */
3235 if (eap->cmdidx == CMD_saveas || name_was_missing)
3236 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003237 DO_AUTOCHDIR
3238 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 }
3240
3241theend:
3242#ifdef FEAT_BROWSE
3243 vim_free(browse_file);
3244#endif
3245 vim_free(free_fname);
3246 return retval;
3247}
3248
3249/*
3250 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3251 * BF_NEW or BF_READERR, check for overwriting current file.
3252 * May set eap->forceit if a dialog says it's OK to overwrite.
3253 * Return OK if it's OK, FAIL if it is not.
3254 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003255 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003256check_overwrite(
3257 exarg_T *eap,
3258 buf_T *buf,
3259 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003261 char_u *ffname, /* full path version of fname */
3262 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263{
3264 /*
3265 * write to other file or b_flags set or not writing the whole file:
3266 * overwriting only allowed with '!'
3267 */
3268 if ( (other
3269 || (buf->b_flags & BF_NOTEDITED)
3270 || ((buf->b_flags & BF_NEW)
3271 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3272 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003274#ifdef FEAT_QUICKFIX
3275 && !bt_nofile(buf)
3276#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 && vim_fexists(ffname))
3278 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003279 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003281#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003282 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003283 if (mch_isdir(ffname))
3284 {
3285 EMSG2(_(e_isadir2), ffname);
3286 return FAIL;
3287 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288#endif
3289#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003290 if (p_confirm || cmdmod.confirm)
3291 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003292 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003294 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3295 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3296 return FAIL;
3297 eap->forceit = TRUE;
3298 }
3299 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003301 {
3302 EMSG(_(e_exists));
3303 return FAIL;
3304 }
3305 }
3306
3307 /* For ":w! filename" check that no swap file exists for "filename". */
3308 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003310 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003311 char_u *p;
3312 int r;
3313 char_u *swapname;
3314
3315 /* We only try the first entry in 'directory', without checking if
3316 * it's writable. If the "." directory is not writable the write
3317 * will probably fail anyway.
3318 * Use 'shortname' of the current buffer, since there is no buffer
3319 * for the written file. */
3320 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003321 {
3322 dir = alloc(5);
3323 if (dir == NULL)
3324 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003325 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003326 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003327 else
3328 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003329 dir = alloc(MAXPATHL);
3330 if (dir == NULL)
3331 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003332 p = p_dir;
3333 copy_option_part(&p, dir, MAXPATHL, ",");
3334 }
3335 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003336 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003337 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003338 if (r)
3339 {
3340#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3341 if (p_confirm || cmdmod.confirm)
3342 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003343 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003344
3345 dialog_msg(buff,
3346 _("Swap file \"%s\" exists, overwrite anyway?"),
3347 swapname);
3348 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3349 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003350 {
3351 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003352 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003353 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003354 eap->forceit = TRUE;
3355 }
3356 else
3357#endif
3358 {
3359 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3360 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003361 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003362 return FAIL;
3363 }
3364 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003365 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 }
3367 }
3368 return OK;
3369}
3370
3371/*
3372 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3373 */
3374 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003375ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376{
3377 int i;
3378
3379 if (eap->cmd[1] == 'n')
3380 i = curwin->w_arg_idx + (int)eap->line2;
3381 else
3382 i = curwin->w_arg_idx - (int)eap->line2;
3383 eap->line1 = 1;
3384 eap->line2 = curbuf->b_ml.ml_line_count;
3385 if (do_write(eap) != FAIL)
3386 do_argfile(eap, i);
3387}
3388
3389/*
3390 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3391 */
3392 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003393do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394{
3395 buf_T *buf;
3396 int error = 0;
3397 int save_forceit = eap->forceit;
3398
3399 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3400 exiting = TRUE;
3401
Bram Moolenaar29323592016-07-24 22:04:11 +02003402 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 {
Bram Moolenaar059db5c2017-10-15 22:42:23 +02003404 if (bufIsChanged(buf) && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 {
3406 /*
3407 * Check if there is a reason the buffer cannot be written:
3408 * 1. if the 'write' option is set
3409 * 2. if there is no file name (even after browsing)
3410 * 3. if the 'readonly' is set (even after a dialog)
3411 * 4. if overwriting is allowed (even after a dialog)
3412 */
3413 if (not_writing())
3414 {
3415 ++error;
3416 break;
3417 }
3418#ifdef FEAT_BROWSE
3419 /* ":browse wall": ask for file name if there isn't one */
3420 if (buf->b_ffname == NULL && cmdmod.browse)
3421 browse_save_fname(buf);
3422#endif
3423 if (buf->b_ffname == NULL)
3424 {
3425 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3426 ++error;
3427 }
3428 else if (check_readonly(&eap->forceit, buf)
3429 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3430 FALSE) == FAIL)
3431 {
3432 ++error;
3433 }
3434 else
3435 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003436#ifdef FEAT_AUTOCMD
3437 bufref_T bufref;
3438
3439 set_bufref(&bufref, buf);
3440#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 if (buf_write_all(buf, eap->forceit) == FAIL)
3442 ++error;
3443#ifdef FEAT_AUTOCMD
3444 /* an autocommand may have deleted the buffer */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003445 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 buf = firstbuf;
3447#endif
3448 }
3449 eap->forceit = save_forceit; /* check_overwrite() may set it */
3450 }
3451 }
3452 if (exiting)
3453 {
3454 if (!error)
3455 getout(0); /* exit Vim */
3456 not_exiting();
3457 }
3458}
3459
3460/*
3461 * Check the 'write' option.
3462 * Return TRUE and give a message when it's not st.
3463 */
3464 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003465not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466{
3467 if (p_write)
3468 return FALSE;
3469 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3470 return TRUE;
3471}
3472
3473/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003474 * Check if a buffer is read-only (either 'readonly' option is set or file is
3475 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3476 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 */
3478 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003479check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480{
Bram Moolenaar8767f522016-07-01 17:17:39 +02003481 stat_T st;
Bram Moolenaar5386a122007-06-28 20:02:32 +00003482
3483 /* Handle a file being readonly when the 'readonly' option is set or when
3484 * the file exists and permissions are read-only.
3485 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3486 * important for device checks but not here. */
3487 if (!*forceit && (buf->b_p_ro
3488 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3489 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {
3491#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3492 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3493 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003494 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495
Bram Moolenaar5386a122007-06-28 20:02:32 +00003496 if (buf->b_p_ro)
3497 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3498 buf->b_fname);
3499 else
3500 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 +00003501 buf->b_fname);
3502
3503 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3504 {
3505 /* Set forceit, to force the writing of a readonly file */
3506 *forceit = TRUE;
3507 return FALSE;
3508 }
3509 else
3510 return TRUE;
3511 }
3512 else
3513#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003514 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003516 else
3517 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3518 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 return TRUE;
3520 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003521
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 return FALSE;
3523}
3524
3525/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003526 * Try to abandon current file and edit a new or existing file.
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003527 * "fnum" is the number of the file, if zero use ffname/sfname.
3528 * "lnum" is the line number for the cursor in the new file (if non-zero).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 *
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003530 * Return:
3531 * GETFILE_ERROR for "normal" error,
3532 * GETFILE_NOT_WRITTEN for "not written" error,
3533 * GETFILE_SAME_FILE for success
3534 * GETFILE_OPEN_OTHER for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 */
3536 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003537getfile(
3538 int fnum,
3539 char_u *ffname,
3540 char_u *sfname,
3541 int setpm,
3542 linenr_T lnum,
3543 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544{
3545 int other;
3546 int retval;
3547 char_u *free_me = NULL;
3548
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003549 if (text_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003550 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003551#ifdef FEAT_AUTOCMD
3552 if (curbuf_locked())
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003553 return GETFILE_ERROR;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003554#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555
3556 if (fnum == 0)
3557 {
3558 /* make ffname full path, set sfname */
3559 fname_expand(curbuf, &ffname, &sfname);
3560 other = otherfile(ffname);
3561 free_me = ffname; /* has been allocated, free() later */
3562 }
3563 else
3564 other = (fnum != curbuf->b_fnum);
3565
3566 if (other)
3567 ++no_wait_return; /* don't wait for autowrite message */
Bram Moolenaareb44a682017-08-03 22:44:55 +02003568 if (other && !forceit && curbuf->b_nwindows == 1 && !buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3570 {
3571#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3572 if (p_confirm && p_write)
3573 dialog_changed(curbuf, FALSE);
3574 if (curbufIsChanged())
3575#endif
3576 {
3577 if (other)
3578 --no_wait_return;
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02003579 no_write_message();
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003580 retval = GETFILE_NOT_WRITTEN; /* file has been changed */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 goto theend;
3582 }
3583 }
3584 if (other)
3585 --no_wait_return;
3586 if (setpm)
3587 setpcmark();
3588 if (!other)
3589 {
3590 if (lnum != 0)
3591 curwin->w_cursor.lnum = lnum;
3592 check_cursor_lnum();
3593 beginline(BL_SOL | BL_FIX);
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003594 retval = GETFILE_SAME_FILE; /* it's in the same file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 }
3596 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaareb44a682017-08-03 22:44:55 +02003597 (buf_hide(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003598 curwin) == OK)
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003599 retval = GETFILE_OPEN_OTHER; /* opened another file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 else
Bram Moolenaar8ad80de2017-06-05 16:01:59 +02003601 retval = GETFILE_ERROR; /* error encountered */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602
3603theend:
3604 vim_free(free_me);
3605 return retval;
3606}
3607
3608/*
3609 * start editing a new file
3610 *
3611 * fnum: file number; if zero use ffname/sfname
3612 * ffname: the file name
3613 * - full path if sfname used,
3614 * - any file name if sfname is NULL
3615 * - empty string to re-edit with the same file name (but may be
3616 * in a different directory)
3617 * - NULL to start an empty buffer
3618 * sfname: the short file name (or NULL)
3619 * eap: contains the command to be executed after loading the file and
3620 * forced 'ff' and 'fenc'
3621 * newlnum: if > 0: put cursor on this line number (if possible)
3622 * if ECMD_LASTL: use last position in loaded file
3623 * if ECMD_LAST: use last position in all files
3624 * if ECMD_ONE: use first line
3625 * flags:
3626 * ECMD_HIDE: if TRUE don't free the current buffer
3627 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3628 * ECMD_OLDBUF: use existing buffer if it exists
3629 * ECMD_FORCEIT: ! used for Ex command
3630 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003631 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003632 * window, NULL when splitting the window first. When not NULL info
3633 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 *
3635 * return FAIL for failure, OK otherwise
3636 */
3637 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003638do_ecmd(
3639 int fnum,
3640 char_u *ffname,
3641 char_u *sfname,
3642 exarg_T *eap, /* can be NULL! */
3643 linenr_T newlnum,
3644 int flags,
3645 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646{
3647 int other_file; /* TRUE if editing another file */
3648 int oldbuf; /* TRUE if using existing buffer */
3649#ifdef FEAT_AUTOCMD
3650 int auto_buf = FALSE; /* TRUE if autocommands brought us
3651 into the buffer unexpectedly */
3652 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003653 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654#endif
3655 buf_T *buf;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003656 bufref_T bufref;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003658 bufref_T old_curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659#endif
3660 char_u *free_fname = NULL;
3661#ifdef FEAT_BROWSE
3662 char_u *browse_file = NULL;
3663#endif
3664 int retval = FAIL;
3665 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003666 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 linenr_T topline = 0;
3668 int newcol = -1;
3669 int solcol = -1;
3670 pos_T *pos;
3671#ifdef FEAT_SUN_WORKSHOP
3672 char_u *cp;
3673#endif
3674 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003675#ifdef FEAT_SPELL
3676 int did_get_winopts = FALSE;
3677#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003678 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003679 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680
3681 if (eap != NULL)
3682 command = eap->do_ecmd_cmd;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003683#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3684 set_bufref(&old_curbuf, curbuf);
3685#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686
3687 if (fnum != 0)
3688 {
3689 if (fnum == curbuf->b_fnum) /* file is already being edited */
3690 return OK; /* nothing to do */
3691 other_file = TRUE;
3692 }
3693 else
3694 {
3695#ifdef FEAT_BROWSE
3696 if (cmdmod.browse)
3697 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003698# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003699 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003700# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003701 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003702# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003703 au_has_group((char_u *)"FileExplorer"))
3704 {
3705 /* No browsing supported but we do have the file explorer:
3706 * Edit the directory. */
3707 if (ffname == NULL || !mch_isdir(ffname))
3708 ffname = (char_u *)".";
3709 }
3710 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003711# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003712 {
3713 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003715 if (browse_file == NULL)
3716 goto theend;
3717 ffname = browse_file;
3718 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 }
3720#endif
3721 /* if no short name given, use ffname for short name */
3722 if (sfname == NULL)
3723 sfname = ffname;
3724#ifdef USE_FNAME_CASE
3725# ifdef USE_LONG_FNAME
3726 if (USE_LONG_FNAME)
3727# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003728 if (sfname != NULL)
3729 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730#endif
3731
3732#ifdef FEAT_LISTCMDS
3733 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3734 goto theend;
3735#endif
3736
3737 if (ffname == NULL)
3738 other_file = TRUE;
3739 /* there is no file name */
3740 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3741 other_file = FALSE;
3742 else
3743 {
3744 if (*ffname == NUL) /* re-edit with same file name */
3745 {
3746 ffname = curbuf->b_ffname;
3747 sfname = curbuf->b_fname;
3748 }
3749 free_fname = fix_fname(ffname); /* may expand to full path name */
3750 if (free_fname != NULL)
3751 ffname = free_fname;
3752 other_file = otherfile(ffname);
3753#ifdef FEAT_SUN_WORKSHOP
3754 if (usingSunWorkShop && p_acd
3755 && (cp = vim_strrchr(sfname, '/')) != NULL)
3756 sfname = ++cp;
3757#endif
3758 }
3759 }
3760
3761 /*
3762 * if the file was changed we may not be allowed to abandon it
3763 * - if we are going to re-edit the same file
3764 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3765 */
3766 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3767 || (curbuf->b_nwindows == 1
3768 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003769 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3770 | (other_file ? 0 : CCGD_MULTWIN)
3771 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3772 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 {
3774 if (fnum == 0 && other_file && ffname != NULL)
3775 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3776 goto theend;
3777 }
3778
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 /*
3780 * End Visual mode before switching to another buffer, so the text can be
3781 * copied into the GUI selection buffer.
3782 */
3783 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003785#ifdef FEAT_AUTOCMD
3786 if ((command != NULL || newlnum > (linenr_T)0)
3787 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3788 {
3789 int len;
3790 char_u *p;
3791
3792 /* Set v:swapcommand for the SwapExists autocommands. */
3793 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003794 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003795 else
3796 len = 30;
3797 p = alloc((unsigned)len);
3798 if (p != NULL)
3799 {
3800 if (command != NULL)
3801 vim_snprintf((char *)p, len, ":%s\r", command);
3802 else
3803 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3804 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3805 did_set_swapcommand = TRUE;
3806 vim_free(p);
3807 }
3808 }
3809#endif
3810
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 /*
3812 * If we are starting to edit another file, open a (new) buffer.
3813 * Otherwise we re-use the current buffer.
3814 */
3815 if (other_file)
3816 {
3817#ifdef FEAT_LISTCMDS
3818 if (!(flags & ECMD_ADDBUF))
3819#endif
3820 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003821 if (!cmdmod.keepalt)
3822 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003823 if (oldwin != NULL)
3824 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 }
3826
3827 if (fnum)
3828 buf = buflist_findnr(fnum);
3829 else
3830 {
3831#ifdef FEAT_LISTCMDS
3832 if (flags & ECMD_ADDBUF)
3833 {
3834 linenr_T tlnum = 1L;
3835
3836 if (command != NULL)
3837 {
3838 tlnum = atol((char *)command);
3839 if (tlnum <= 0)
3840 tlnum = 1L;
3841 }
3842 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3843 goto theend;
3844 }
3845#endif
3846 buf = buflist_new(ffname, sfname, 0L,
3847 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003848#ifdef FEAT_AUTOCMD
3849 /* autocommands may change curwin and curbuf */
3850 if (oldwin != NULL)
3851 oldwin = curwin;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003852 set_bufref(&old_curbuf, curbuf);
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003853#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 }
3855 if (buf == NULL)
3856 goto theend;
3857 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3858 {
3859 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 }
3861 else /* existing memfile */
3862 {
3863 oldbuf = TRUE;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003864 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 (void)buf_check_timestamp(buf, FALSE);
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003866 /* Check if autocommands made the buffer invalid or changed the
3867 * current buffer. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003868 if (!bufref_valid(&bufref)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003870 || curbuf != old_curbuf.br_buf
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871#endif
3872 )
3873 goto theend;
3874#ifdef FEAT_EVAL
3875 if (aborting()) /* autocmds may abort script processing */
3876 goto theend;
3877#endif
3878 }
3879
3880 /* May jump to last used line number for a loaded buffer or when asked
3881 * for explicitly */
3882 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3883 {
3884 pos = buflist_findfpos(buf);
3885 newlnum = pos->lnum;
3886 solcol = pos->col;
3887 }
3888
3889 /*
3890 * Make the (new) buffer the one used by the current window.
3891 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3892 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003893 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 */
3895 if (buf != curbuf)
3896 {
3897#ifdef FEAT_AUTOCMD
3898 /*
3899 * Be careful: The autocommands may delete any buffer and change
3900 * the current buffer.
3901 * - If the buffer we are going to edit is deleted, give up.
3902 * - If the current buffer is deleted, prefer to load the new
3903 * buffer when loading a buffer is required. This avoids
3904 * loading another buffer which then must be closed again.
3905 * - If we ended up in the new buffer already, need to skip a few
3906 * things, set auto_buf.
3907 */
3908 if (buf->b_fname != NULL)
3909 new_name = vim_strsave(buf->b_fname);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003910 set_bufref(&au_new_curbuf, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003912 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003914 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 delbuf_msg(new_name); /* frees new_name */
3916 goto theend;
3917 }
3918# ifdef FEAT_EVAL
3919 if (aborting()) /* autocmds may abort script processing */
3920 {
3921 vim_free(new_name);
3922 goto theend;
3923 }
3924# endif
3925 if (buf == curbuf) /* already in new buffer */
3926 auto_buf = TRUE;
3927 else
3928 {
Bram Moolenaar5a497892016-09-03 16:29:04 +02003929 win_T *the_curwin = curwin;
3930
3931 /* Set the w_closing flag to avoid that autocommands close the
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003932 * window. And set b_locked for the same reason. */
Bram Moolenaar5a497892016-09-03 16:29:04 +02003933 the_curwin->w_closing = TRUE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003934 ++buf->b_locked;
Bram Moolenaar5a497892016-09-03 16:29:04 +02003935
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02003936 if (curbuf == old_curbuf.br_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937#endif
3938 buf_copy_options(buf, BCO_ENTER);
3939
Bram Moolenaar5a497892016-09-03 16:29:04 +02003940 /* Close the link to the current buffer. This will set
Bram Moolenaaraeac9002016-09-06 22:15:08 +02003941 * oldwin->w_buffer to NULL. */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003942 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003943 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003944 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945
3946#ifdef FEAT_AUTOCMD
Bram Moolenaar5a497892016-09-03 16:29:04 +02003947 the_curwin->w_closing = FALSE;
Bram Moolenaare0ab94e2016-09-04 19:50:54 +02003948 --buf->b_locked;
Bram Moolenaarfc573802011-12-30 15:01:59 +01003949
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950# ifdef FEAT_EVAL
Bram Moolenaar5a497892016-09-03 16:29:04 +02003951 /* autocmds may abort script processing */
3952 if (aborting() && curwin->w_buffer != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 {
3954 vim_free(new_name);
3955 goto theend;
3956 }
3957# endif
3958 /* Be careful again, like above. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003959 if (!bufref_valid(&au_new_curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 {
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02003961 /* new buffer has been deleted */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 delbuf_msg(new_name); /* frees new_name */
3963 goto theend;
3964 }
3965 if (buf == curbuf) /* already in new buffer */
3966 auto_buf = TRUE;
3967 else
3968#endif
3969 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003970#ifdef FEAT_SYN_HL
3971 /*
3972 * <VN> We could instead free the synblock
3973 * and re-attach to buffer, perhaps.
3974 */
Bram Moolenaarf1d13472017-07-11 18:28:46 +02003975 if (curwin->w_buffer == NULL
3976 || curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003977 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 curwin->w_buffer = buf;
3980 curbuf = buf;
3981 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003982
3983 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3984 if (!oldbuf && eap != NULL)
3985 {
3986 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003987#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003988 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003989#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003990 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 }
3992
3993 /* May get the window options from the last time this buffer
3994 * was in this window (or another window). If not used
3995 * before, reset the local window options to the global
3996 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003997 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003998#ifdef FEAT_SPELL
3999 did_get_winopts = TRUE;
4000#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001
4002#ifdef FEAT_AUTOCMD
4003 }
4004 vim_free(new_name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004005 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004006 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007#endif
4008 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009
4010 curwin->w_pcmark.lnum = 1;
4011 curwin->w_pcmark.col = 0;
4012 }
4013 else /* !other_file */
4014 {
4015 if (
4016#ifdef FEAT_LISTCMDS
4017 (flags & ECMD_ADDBUF) ||
4018#endif
4019 check_fname() == FAIL)
4020 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01004021
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 oldbuf = (flags & ECMD_OLDBUF);
4023 }
4024
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004025 /* Don't redraw until the cursor is in the right line, otherwise
4026 * autocommands may cause ml_get errors. */
4027 ++RedrawingDisabled;
4028 did_inc_redrawing_disabled = TRUE;
4029
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004030#ifdef FEAT_AUTOCMD
4031 buf = curbuf;
4032#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 if ((flags & ECMD_SET_HELP) || keep_help_flag)
4034 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01004035 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 }
4037 else
4038 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 /* Don't make a buffer listed if it's a help buffer. Useful when
4040 * using CTRL-O to go back to a help file. */
4041 if (!curbuf->b_help)
4042 set_buflisted(TRUE);
4043 }
4044
4045#ifdef FEAT_AUTOCMD
4046 /* If autocommands change buffers under our fingers, forget about
4047 * editing the file. */
4048 if (buf != curbuf)
4049 goto theend;
4050# ifdef FEAT_EVAL
4051 if (aborting()) /* autocmds may abort script processing */
4052 goto theend;
4053# endif
4054
4055 /* Since we are starting to edit a file, consider the filetype to be
4056 * unset. Helps for when an autocommand changes files and expects syntax
4057 * highlighting to work in the other file. */
4058 did_filetype = FALSE;
4059#endif
4060
4061/*
4062 * other_file oldbuf
4063 * FALSE FALSE re-edit same file, buffer is re-used
4064 * FALSE TRUE re-edit same file, nothing changes
4065 * TRUE FALSE start editing new file, new buffer
4066 * TRUE TRUE start editing in existing buffer (nothing to do)
4067 */
4068 if (!other_file && !oldbuf) /* re-use the buffer */
4069 {
4070 set_last_cursor(curwin); /* may set b_last_cursor */
4071 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4072 {
4073 newlnum = curwin->w_cursor.lnum;
4074 solcol = curwin->w_cursor.col;
4075 }
4076#ifdef FEAT_AUTOCMD
4077 buf = curbuf;
4078 if (buf->b_fname != NULL)
4079 new_name = vim_strsave(buf->b_fname);
4080 else
4081 new_name = NULL;
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004082 set_bufref(&bufref, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004084 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4085 {
4086 /* Save all the text, so that the reload can be undone.
4087 * Sync first so that this is a separate undo-able action. */
4088 u_sync(FALSE);
4089 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4090 == FAIL)
Bram Moolenaar1e225822016-07-30 21:48:59 +02004091 {
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004092#ifdef FEAT_AUTOCMD
Bram Moolenaar1e225822016-07-30 21:48:59 +02004093 vim_free(new_name);
Bram Moolenaarfc1f2012016-07-30 23:18:47 +02004094#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004095 goto theend;
Bram Moolenaar1e225822016-07-30 21:48:59 +02004096 }
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004097 u_unchanged(curbuf);
4098 buf_freeall(curbuf, BFA_KEEP_UNDO);
4099
4100 /* tell readfile() not to clear or reload undo info */
4101 readfile_flags = READ_KEEP_UNDO;
4102 }
4103 else
4104 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105#ifdef FEAT_AUTOCMD
4106 /* If autocommands deleted the buffer we were going to re-edit, give
4107 * up and jump to the end. */
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004108 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 {
4110 delbuf_msg(new_name); /* frees new_name */
4111 goto theend;
4112 }
4113 vim_free(new_name);
4114
4115 /* If autocommands change buffers under our fingers, forget about
4116 * re-editing the file. Should do the buf_clear_file(), but perhaps
4117 * the autocommands changed the buffer... */
4118 if (buf != curbuf)
4119 goto theend;
4120# ifdef FEAT_EVAL
4121 if (aborting()) /* autocmds may abort script processing */
4122 goto theend;
4123# endif
4124#endif
4125 buf_clear_file(curbuf);
4126 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4127 curbuf->b_op_end.lnum = 0;
4128 }
4129
4130/*
4131 * If we get here we are sure to start editing
4132 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 /* Assume success now */
4134 retval = OK;
4135
4136 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 * Check if we are editing the w_arg_idx file in the argument list.
4138 */
4139 check_arg_idx(curwin);
4140
4141#ifdef FEAT_AUTOCMD
4142 if (!auto_buf)
4143#endif
4144 {
4145 /*
4146 * Set cursor and init window before reading the file and executing
4147 * autocommands. This allows for the autocommands to position the
4148 * cursor.
4149 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004150 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
4152#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004153 /* It's possible that all lines in the buffer changed. Need to update
4154 * automatic folding for all windows where it's used. */
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004155 {
4156 win_T *win;
4157 tabpage_T *tp;
4158
4159 FOR_ALL_TAB_WINDOWS(tp, win)
4160 if (win->w_buffer == curbuf)
4161 foldUpdateAll(win);
4162 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163#endif
4164
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004165 /* Change directories when the 'acd' option is set. */
4166 DO_AUTOCHDIR
4167
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 /*
4169 * Careful: open_buffer() and apply_autocmds() may change the current
4170 * buffer and window.
4171 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004172 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 topline = curwin->w_topline;
4174 if (!oldbuf) /* need to read the file */
4175 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004176#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 swap_exists_action = SEA_DIALOG;
4178#endif
4179 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4180
4181 /*
4182 * Open the buffer and read the file.
4183 */
4184#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004185 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 retval = FAIL;
4187#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004188 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189#endif
4190
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004191#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 if (swap_exists_action == SEA_QUIT)
4193 retval = FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02004194 handle_swap_exists(&old_curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195#endif
4196 }
4197#ifdef FEAT_AUTOCMD
4198 else
4199 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004200 /* Read the modelines, but only to set window-local options. Any
4201 * buffer-local options have already been set and may have been
4202 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004203 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004204
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4206 &retval);
4207 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4208 &retval);
4209 }
4210 check_arg_idx(curwin);
4211#endif
4212
Bram Moolenaareab316b2015-03-24 11:46:30 +01004213 /* If autocommands change the cursor position or topline, we should
4214 * keep it. Also when it moves within a line. */
Bram Moolenaarb5aedf32017-03-12 18:23:53 +01004215 if (!EQUAL_POS(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 {
4217 newlnum = curwin->w_cursor.lnum;
4218 newcol = curwin->w_cursor.col;
4219 }
4220 if (curwin->w_topline == topline)
4221 topline = 0;
4222
4223 /* Even when cursor didn't move we need to recompute topline. */
4224 changed_line_abv_curs();
4225
4226#ifdef FEAT_TITLE
4227 maketitle();
4228#endif
4229 }
4230
4231#ifdef FEAT_DIFF
4232 /* Tell the diff stuff that this buffer is new and/or needs updating.
4233 * Also needed when re-editing the same buffer, because unloading will
4234 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004235 if (curwin->w_p_diff)
4236 {
4237 diff_buf_add(curbuf);
4238 diff_invalidate(curbuf);
4239 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240#endif
4241
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004242#ifdef FEAT_SPELL
4243 /* If the window options were changed may need to set the spell language.
4244 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004245 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4246 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004247#endif
4248
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 if (command == NULL)
4250 {
4251 if (newcol >= 0) /* position set by autocommands */
4252 {
4253 curwin->w_cursor.lnum = newlnum;
4254 curwin->w_cursor.col = newcol;
4255 check_cursor();
4256 }
4257 else if (newlnum > 0) /* line number from caller or old position */
4258 {
4259 curwin->w_cursor.lnum = newlnum;
4260 check_cursor_lnum();
4261 if (solcol >= 0 && !p_sol)
4262 {
4263 /* 'sol' is off: Use last known column. */
4264 curwin->w_cursor.col = solcol;
4265 check_cursor_col();
4266#ifdef FEAT_VIRTUALEDIT
4267 curwin->w_cursor.coladd = 0;
4268#endif
4269 curwin->w_set_curswant = TRUE;
4270 }
4271 else
4272 beginline(BL_SOL | BL_FIX);
4273 }
4274 else /* no line number, go to last line in Ex mode */
4275 {
4276 if (exmode_active)
4277 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4278 beginline(BL_WHITE | BL_FIX);
4279 }
4280 }
4281
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 /* Check if cursors in other windows on the same buffer are still valid */
4283 check_lnums(FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284
4285 /*
4286 * Did not read the file, need to show some info about the file.
4287 * Do this after setting the cursor.
4288 */
4289 if (oldbuf
4290#ifdef FEAT_AUTOCMD
4291 && !auto_buf
4292#endif
4293 )
4294 {
4295 int msg_scroll_save = msg_scroll;
4296
4297 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4298 * message. */
4299 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4300 msg_scroll = FALSE;
4301 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4302 check_for_delay(FALSE);
4303 msg_start();
4304 msg_scroll = msg_scroll_save;
4305 msg_scrolled_ign = TRUE;
4306
Bram Moolenaar426dd022016-03-15 15:09:29 +01004307 if (!shortmess(SHM_FILEINFO))
4308 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309
4310 msg_scrolled_ign = FALSE;
4311 }
4312
Bram Moolenaarab9c89b2016-07-03 17:47:26 +02004313#ifdef FEAT_VIMINFO
4314 curbuf->b_last_used = vim_time();
4315#endif
4316
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 if (command != NULL)
4318 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4319
4320#ifdef FEAT_KEYMAP
4321 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004322 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323#endif
4324
4325 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004326 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 if (!skip_redraw)
4328 {
4329 n = p_so;
4330 if (topline == 0 && command == NULL)
4331 p_so = 999; /* force cursor halfway the window */
4332 update_topline();
4333#ifdef FEAT_SCROLLBIND
4334 curwin->w_scbind_pos = curwin->w_topline;
4335#endif
4336 p_so = n;
4337 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4338 }
4339
4340 if (p_im)
4341 need_start_insertmode = TRUE;
4342
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004343 /* Change directories when the 'acd' option is set. */
4344 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004346#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004347 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 {
4349# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004350 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4352# endif
4353# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004354 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004355 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356# endif
4357 }
4358#endif
4359
4360theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004361 if (did_inc_redrawing_disabled)
4362 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004363#ifdef FEAT_AUTOCMD
4364 if (did_set_swapcommand)
4365 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4366#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367#ifdef FEAT_BROWSE
4368 vim_free(browse_file);
4369#endif
4370 vim_free(free_fname);
4371 return retval;
4372}
4373
4374#ifdef FEAT_AUTOCMD
4375 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004376delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377{
4378 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4379 name == NULL ? (char_u *)"" : name);
4380 vim_free(name);
Bram Moolenaar19ff9bf2016-07-10 19:03:57 +02004381 au_new_curbuf.br_buf = NULL;
Bram Moolenaarac77aec2016-07-26 22:02:54 +02004382 au_new_curbuf.br_buf_free_count = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383}
4384#endif
4385
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004386static int append_indent = 0; /* autoindent for first line */
4387
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388/*
4389 * ":insert" and ":append", also used by ":change"
4390 */
4391 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004392ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393{
4394 char_u *theline;
4395 int did_undo = FALSE;
4396 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004397 int indent = 0;
4398 char_u *p;
4399 int vcol;
4400 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004402 /* the ! flag toggles autoindent */
4403 if (eap->forceit)
4404 curbuf->b_p_ai = !curbuf->b_p_ai;
4405
4406 /* First autoindent comes from the line we start on */
4407 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4408 append_indent = get_indent_lnum(lnum);
4409
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 if (eap->cmdidx != CMD_append)
4411 --lnum;
4412
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004413 /* when the buffer is empty need to delete the dummy line */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004414 if (empty && lnum == 1)
4415 lnum = 0;
4416
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 State = INSERT; /* behave like in Insert mode */
4418 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4419 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004420
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004421 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 {
4423 msg_scroll = TRUE;
4424 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004425 if (curbuf->b_p_ai)
4426 {
4427 if (append_indent >= 0)
4428 {
4429 indent = append_indent;
4430 append_indent = -1;
4431 }
4432 else if (lnum > 0)
4433 indent = get_indent_lnum(lnum);
4434 }
4435 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004437 {
4438 /* No getline() function, use the lines that follow. This ends
4439 * when there is no more. */
4440 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4441 break;
4442 p = vim_strchr(eap->nextcmd, NL);
4443 if (p == NULL)
4444 p = eap->nextcmd + STRLEN(eap->nextcmd);
4445 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4446 if (*p != NUL)
4447 ++p;
4448 eap->nextcmd = p;
4449 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004451 {
4452 int save_State = State;
4453
4454 /* Set State to avoid the cursor shape to be set to INSERT mode
4455 * when getline() returns. */
4456 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 theline = eap->getline(
4458#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004459 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004461 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004462 State = save_State;
4463 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004465 if (theline == NULL)
4466 break;
4467
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004468 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4469 if (ex_keep_indent)
4470 append_indent = indent;
4471
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004472 /* Look for the "." after automatic indent. */
4473 vcol = 0;
4474 for (p = theline; indent > vcol; ++p)
4475 {
4476 if (*p == ' ')
4477 ++vcol;
4478 else if (*p == TAB)
4479 vcol += 8 - vcol % 8;
4480 else
4481 break;
4482 }
4483 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004484 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4485 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 {
4487 vim_free(theline);
4488 break;
4489 }
4490
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004491 /* don't use autoindent if nothing was typed. */
4492 if (p[0] == NUL)
4493 theline[0] = NUL;
4494
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 did_undo = TRUE;
4496 ml_append(lnum, theline, (colnr_T)0, FALSE);
Bram Moolenaar70e136e2016-07-01 14:04:51 +02004497 appended_lines_mark(lnum + (empty ? 1 : 0), 1L);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 vim_free(theline);
4500 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004501
4502 if (empty)
4503 {
4504 ml_delete(2L, FALSE);
4505 empty = FALSE;
4506 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 }
4508 State = NORMAL;
4509
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004510 if (eap->forceit)
4511 curbuf->b_p_ai = !curbuf->b_p_ai;
4512
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004514 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 * "end" is set to lnum when something has been appended, otherwise
4516 * it is the same than "start" -- Acevedo */
4517 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4518 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4519 if (eap->cmdidx != CMD_append)
4520 --curbuf->b_op_start.lnum;
4521 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4522 ? lnum : curbuf->b_op_start.lnum;
4523 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4524 curwin->w_cursor.lnum = lnum;
4525 check_cursor_lnum();
4526 beginline(BL_SOL | BL_FIX);
4527
4528 need_wait_return = FALSE; /* don't use wait_return() now */
4529 ex_no_reprint = TRUE;
4530}
4531
4532/*
4533 * ":change"
4534 */
4535 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004536ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537{
4538 linenr_T lnum;
4539
4540 if (eap->line2 >= eap->line1
4541 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4542 return;
4543
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004544 /* the ! flag toggles autoindent */
4545 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4546 append_indent = get_indent_lnum(eap->line1);
4547
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4549 {
4550 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4551 break;
4552 ml_delete(eap->line1, FALSE);
4553 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004554
4555 /* make sure the cursor is not beyond the end of the file now */
4556 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4558
4559 /* ":append" on the line above the deleted lines. */
4560 eap->line2 = eap->line1;
4561 ex_append(eap);
4562}
4563
4564 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004565ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566{
4567 char_u *x;
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004568 long bigness;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004569 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 int minus = 0;
4571 linenr_T start, end, curs, i;
4572 int j;
4573 linenr_T lnum = eap->line2;
4574
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004575 /* Vi compatible: ":z!" uses display height, without a count uses
4576 * 'scroll' */
4577 if (eap->forceit)
4578 bigness = curwin->w_height;
Bram Moolenaar459ca562016-11-10 18:16:33 +01004579 else if (!ONE_WINDOW)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004580 bigness = curwin->w_height - 3;
Bram Moolenaar631abc32014-02-22 22:27:47 +01004581 else
4582 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 if (bigness < 1)
4584 bigness = 1;
4585
4586 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004587 kind = x;
4588 if (*kind == '-' || *kind == '+' || *kind == '='
4589 || *kind == '^' || *kind == '.')
4590 ++x;
4591 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 ++x;
4593
4594 if (*x != 0)
4595 {
4596 if (!VIM_ISDIGIT(*x))
4597 {
4598 EMSG(_("E144: non-numeric argument to :z"));
4599 return;
4600 }
4601 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004602 {
Bram Moolenaarfa0ad0b2017-04-02 15:45:17 +02004603 bigness = atol((char *)x);
4604
4605 /* bigness could be < 0 if atol(x) overflows. */
4606 if (bigness > 2 * curbuf->b_ml.ml_line_count || bigness < 0)
4607 bigness = 2 * curbuf->b_ml.ml_line_count;
4608
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004609 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004610 if (*kind == '=')
4611 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004612 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 }
4614
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004615 /* the number of '-' and '+' multiplies the distance */
4616 if (*kind == '-' || *kind == '+')
4617 for (x = kind + 1; *x == *kind; ++x)
4618 ;
4619
4620 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 {
4622 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004623 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4624 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004625 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 break;
4627
4628 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004629 start = lnum - (bigness + 1) / 2 + 1;
4630 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 curs = lnum;
4632 minus = 1;
4633 break;
4634
4635 case '^':
4636 start = lnum - bigness * 2;
4637 end = lnum - bigness;
4638 curs = lnum - bigness;
4639 break;
4640
4641 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004642 start = lnum - (bigness + 1) / 2 + 1;
4643 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 curs = end;
4645 break;
4646
4647 default: /* '+' */
4648 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004649 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004650 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004651 else if (eap->addr_count == 0)
4652 ++start;
4653 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 curs = end;
4655 break;
4656 }
4657
4658 if (start < 1)
4659 start = 1;
4660
4661 if (end > curbuf->b_ml.ml_line_count)
4662 end = curbuf->b_ml.ml_line_count;
4663
4664 if (curs > curbuf->b_ml.ml_line_count)
4665 curs = curbuf->b_ml.ml_line_count;
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004666 else if (curs < 1)
4667 curs = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668
4669 for (i = start; i <= end; i++)
4670 {
4671 if (minus && i == lnum)
4672 {
4673 msg_putchar('\n');
4674
4675 for (j = 1; j < Columns; j++)
4676 msg_putchar('-');
4677 }
4678
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004679 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
4681 if (minus && i == lnum)
4682 {
4683 msg_putchar('\n');
4684
4685 for (j = 1; j < Columns; j++)
4686 msg_putchar('-');
4687 }
4688 }
4689
Bram Moolenaara364cdb2017-04-20 21:12:30 +02004690 if (curwin->w_cursor.lnum != curs)
4691 {
4692 curwin->w_cursor.lnum = curs;
4693 curwin->w_cursor.col = 0;
4694 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 ex_no_reprint = TRUE;
4696}
4697
4698/*
4699 * Check if the restricted flag is set.
4700 * If so, give an error message and return TRUE.
4701 * Otherwise, return FALSE.
4702 */
4703 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004704check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705{
4706 if (restricted)
4707 {
4708 EMSG(_("E145: Shell commands not allowed in rvim"));
4709 return TRUE;
4710 }
4711 return FALSE;
4712}
4713
4714/*
4715 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4716 * If so, give an error message and return TRUE.
4717 * Otherwise, return FALSE.
4718 */
4719 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004720check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721{
4722 if (secure)
4723 {
4724 secure = 2;
4725 EMSG(_(e_curdir));
4726 return TRUE;
4727 }
4728#ifdef HAVE_SANDBOX
4729 /*
4730 * In the sandbox more things are not allowed, including the things
4731 * disallowed in secure mode.
4732 */
4733 if (sandbox != 0)
4734 {
4735 EMSG(_(e_sandbox));
4736 return TRUE;
4737 }
4738#endif
4739 return FALSE;
4740}
4741
4742static char_u *old_sub = NULL; /* previous substitute pattern */
4743static int global_need_beginline; /* call beginline() after ":g" */
4744
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004745/*
4746 * Flags that are kept between calls to :substitute.
4747 */
4748typedef struct {
4749 int do_all; /* do multiple substitutions per line */
4750 int do_ask; /* ask for confirmation */
4751 int do_count; /* count only */
4752 int do_error; /* if false, ignore errors */
4753 int do_print; /* print last line with subs. */
4754 int do_list; /* list last line with subs. */
4755 int do_number; /* list last line with line nr*/
4756 int do_ic; /* ignore case flag */
4757} subflags_T;
4758
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759/* do_sub()
4760 *
4761 * Perform a substitution from line eap->line1 to line eap->line2 using the
4762 * command pointed to by eap->arg which should be of the form:
4763 *
4764 * /pattern/substitution/{flags}
4765 *
4766 * The usual escapes are supported as described in the regexp docs.
4767 */
4768 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004769do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770{
4771 linenr_T lnum;
4772 long i = 0;
4773 regmmatch_T regmatch;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004774 static subflags_T subflags = {FALSE, FALSE, FALSE, TRUE, FALSE,
4775 FALSE, FALSE, 0};
4776#ifdef FEAT_EVAL
4777 subflags_T subflags_save;
4778#endif
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004779 int save_do_all; /* remember user specified 'g' flag */
4780 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4782 int delimiter;
4783 int sublen;
4784 int got_quit = FALSE;
4785 int got_match = FALSE;
4786 int temp;
4787 int which_pat;
4788 char_u *cmd;
4789 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004790 linenr_T first_line = 0; /* first changed line */
4791 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 * change */
4793 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4794 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004795 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004796 char_u *sub_firstline; /* allocated copy of first sub line */
4797 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004798 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004799 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004800#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004801 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004802#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803
4804 cmd = eap->arg;
4805 if (!global_busy)
4806 {
4807 sub_nsubs = 0;
4808 sub_nlines = 0;
4809 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004810 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 if (eap->cmdidx == CMD_tilde)
4813 which_pat = RE_LAST; /* use last used regexp */
4814 else
4815 which_pat = RE_SUBST; /* use last substitute regexp */
4816
4817 /* new pattern and substitution */
Bram Moolenaar1c465442017-03-12 20:10:05 +01004818 if (eap->cmd[0] == 's' && *cmd != NUL && !VIM_ISWHITE(*cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4820 {
4821 /* don't accept alphanumeric for separator */
4822 if (isalpha(*cmd))
4823 {
4824 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4825 return;
4826 }
4827 /*
4828 * undocumented vi feature:
4829 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4830 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4831 */
4832 if (*cmd == '\\')
4833 {
4834 ++cmd;
4835 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4836 {
4837 EMSG(_(e_backslash));
4838 return;
4839 }
4840 if (*cmd != '&')
4841 which_pat = RE_SEARCH; /* use last '/' pattern */
4842 pat = (char_u *)""; /* empty search pattern */
4843 delimiter = *cmd++; /* remember delimiter character */
4844 }
4845 else /* find the end of the regexp */
4846 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004847#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4848 if (p_altkeymap && curwin->w_p_rl)
4849 lrF_sub(cmd);
4850#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 which_pat = RE_LAST; /* use last used regexp */
4852 delimiter = *cmd++; /* remember delimiter character */
4853 pat = cmd; /* remember start of search pat */
4854 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4855 if (cmd[0] == delimiter) /* end delimiter found */
4856 *cmd++ = NUL; /* replace it with a NUL */
4857 }
4858
4859 /*
4860 * Small incompatibility: vi sees '\n' as end of the command, but in
4861 * Vim we want to use '\n' to find/substitute a NUL.
4862 */
4863 sub = cmd; /* remember the start of the substitution */
4864
4865 while (cmd[0])
4866 {
4867 if (cmd[0] == delimiter) /* end delimiter found */
4868 {
4869 *cmd++ = NUL; /* replace it with a NUL */
4870 break;
4871 }
4872 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4873 ++cmd;
Bram Moolenaar91acfff2017-03-12 19:22:36 +01004874 MB_PTR_ADV(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 }
4876
4877 if (!eap->skip)
4878 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004879 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4880 if (STRCMP(sub, "%") == 0
4881 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4882 {
4883 if (old_sub == NULL) /* there is no previous command */
4884 {
4885 EMSG(_(e_nopresub));
4886 return;
4887 }
4888 sub = old_sub;
4889 }
4890 else
4891 {
4892 vim_free(old_sub);
4893 old_sub = vim_strsave(sub);
4894 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 }
4896 }
4897 else if (!eap->skip) /* use previous pattern and substitution */
4898 {
4899 if (old_sub == NULL) /* there is no previous command */
4900 {
4901 EMSG(_(e_nopresub));
4902 return;
4903 }
4904 pat = NULL; /* search_regcomp() will use previous pattern */
4905 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004906
4907 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4908 * last column after using "$". */
4909 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 }
4911
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004912 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4913 * more efficient.
4914 * TODO: find a generic solution to make line-joining operations more
4915 * efficient, avoid allocating a string that grows in size.
4916 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004917 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004918 && *sub == NUL
4919 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4920 || *cmd == 'p' || *cmd == '#'))))
4921 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004922 linenr_T joined_lines_count;
4923
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004924 curwin->w_cursor.lnum = eap->line1;
4925 if (*cmd == 'l')
4926 eap->flags = EXFLAG_LIST;
4927 else if (*cmd == '#')
4928 eap->flags = EXFLAG_NR;
4929 else if (*cmd == 'p')
4930 eap->flags = EXFLAG_PRINT;
4931
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004932 /* The number of lines joined is the number of lines in the range plus
4933 * one. One less when the last line is included. */
4934 joined_lines_count = eap->line2 - eap->line1 + 1;
4935 if (eap->line2 < curbuf->b_ml.ml_line_count)
4936 ++joined_lines_count;
4937 if (joined_lines_count > 1)
4938 {
4939 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4940 sub_nsubs = joined_lines_count - 1;
4941 sub_nlines = 1;
4942 (void)do_sub_msg(FALSE);
4943 ex_may_print(eap);
4944 }
4945
4946 if (!cmdmod.keeppatterns)
4947 save_re_pat(RE_SUBST, pat, p_magic);
4948#ifdef FEAT_CMDHIST
4949 /* put pattern in history */
4950 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4951#endif
4952
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004953 return;
4954 }
4955
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 /*
4957 * Find trailing options. When '&' is used, keep old options.
4958 */
4959 if (*cmd == '&')
4960 ++cmd;
4961 else
4962 {
4963 if (!p_ed)
4964 {
4965 if (p_gd) /* default is global on */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004966 subflags.do_all = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004968 subflags.do_all = FALSE;
4969 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004971 subflags.do_error = TRUE;
4972 subflags.do_print = FALSE;
4973 subflags.do_count = FALSE;
4974 subflags.do_number = FALSE;
4975 subflags.do_ic = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 }
4977 while (*cmd)
4978 {
4979 /*
4980 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4981 * 'r' is never inverted.
4982 */
4983 if (*cmd == 'g')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004984 subflags.do_all = !subflags.do_all;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 else if (*cmd == 'c')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004986 subflags.do_ask = !subflags.do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004987 else if (*cmd == 'n')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004988 subflags.do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 else if (*cmd == 'e')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004990 subflags.do_error = !subflags.do_error;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 else if (*cmd == 'r') /* use last used regexp */
4992 which_pat = RE_LAST;
4993 else if (*cmd == 'p')
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004994 subflags.do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004995 else if (*cmd == '#')
4996 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02004997 subflags.do_print = TRUE;
4998 subflags.do_number = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004999 }
5000 else if (*cmd == 'l')
5001 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005002 subflags.do_print = TRUE;
5003 subflags.do_list = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005004 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 else if (*cmd == 'i') /* ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005006 subflags.do_ic = 'i';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 else if (*cmd == 'I') /* don't ignore case */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005008 subflags.do_ic = 'I';
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 else
5010 break;
5011 ++cmd;
5012 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005013 if (subflags.do_count)
5014 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005016 save_do_all = subflags.do_all;
5017 save_do_ask = subflags.do_ask;
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005018
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 /*
5020 * check for a trailing count
5021 */
5022 cmd = skipwhite(cmd);
5023 if (VIM_ISDIGIT(*cmd))
5024 {
5025 i = getdigits(&cmd);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005026 if (i <= 0 && !eap->skip && subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 {
5028 EMSG(_(e_zerocount));
5029 return;
5030 }
5031 eap->line1 = eap->line2;
5032 eap->line2 += i - 1;
5033 if (eap->line2 > curbuf->b_ml.ml_line_count)
5034 eap->line2 = curbuf->b_ml.ml_line_count;
5035 }
5036
5037 /*
5038 * check for trailing command or garbage
5039 */
5040 cmd = skipwhite(cmd);
5041 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
5042 {
5043 eap->nextcmd = check_nextcmd(cmd);
5044 if (eap->nextcmd == NULL)
5045 {
5046 EMSG(_(e_trailing));
5047 return;
5048 }
5049 }
5050
5051 if (eap->skip) /* not executing commands, only parsing */
5052 return;
5053
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005054 if (!subflags.do_count && !curbuf->b_p_ma)
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005055 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00005056 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005057 EMSG(_(e_modifiable));
5058 return;
5059 }
5060
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5062 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005063 if (subflags.do_error)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 EMSG(_(e_invcmd));
5065 return;
5066 }
5067
5068 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005069 if (subflags.do_ic == 'i')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 regmatch.rmm_ic = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005071 else if (subflags.do_ic == 'I')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 regmatch.rmm_ic = FALSE;
5073
5074 sub_firstline = NULL;
5075
5076 /*
5077 * ~ in the substitute pattern is replaced with the old pattern.
5078 * We do it here once to avoid it to be replaced over and over again.
5079 * But don't do it when it starts with "\=", then it's an expression.
5080 */
5081 if (!(sub[0] == '\\' && sub[1] == '='))
5082 sub = regtilde(sub, p_magic);
5083
5084 /*
5085 * Check for a match on each line.
5086 */
5087 line2 = eap->line2;
5088 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5089#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5090 || aborting()
5091#endif
5092 ); ++lnum)
5093 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005094 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005095 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 if (nmatch)
5097 {
5098 colnr_T copycol;
5099 colnr_T matchcol;
5100 colnr_T prev_matchcol = MAXCOL;
5101 char_u *new_end, *new_start = NULL;
5102 unsigned new_start_len = 0;
5103 char_u *p1;
5104 int did_sub = FALSE;
5105 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005106 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 long nmatch_tl = 0; /* nr of lines matched below lnum */
5108 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005109 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005110 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111
5112 /*
5113 * The new text is build up step by step, to avoid too much
5114 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005115 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 * copycol Column in the old text where we started
5117 * looking for a match; from here old text still
5118 * needs to be copied to the new text.
5119 * matchcol Column number of the old text where to look
5120 * for the next match. It's just after the
5121 * previous match or one further.
5122 * prev_matchcol Column just after the previous match (if any).
5123 * Mostly equal to matchcol, except for the first
5124 * match and after skipping an empty match.
5125 * regmatch.*pos Where the pattern matched in the old text.
5126 * new_start The new text, all that has been produced so
5127 * far.
5128 * new_end The new text, where to append new text.
5129 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005130 * lnum The line number where we found the start of
5131 * the match. Can be below the line we searched
5132 * when there is a \n before a \zs in the
5133 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 * sub_firstlnum The line number in the buffer where to look
5135 * for a match. Can be different from "lnum"
5136 * when the pattern or substitute string contains
5137 * line breaks.
5138 *
5139 * Special situations:
5140 * - When the substitute string contains a line break, the part up
5141 * to the line break is inserted in the text, but the copy of
5142 * the original line is kept. "sub_firstlnum" is adjusted for
5143 * the inserted lines.
5144 * - When the matched pattern contains a line break, the old line
5145 * is taken from the line at the end of the pattern. The lines
5146 * in the match are deleted later, "sub_firstlnum" is adjusted
5147 * accordingly.
5148 *
5149 * The new text is built up in new_start[]. It has some extra
5150 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005151 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 *
5153 * Make a copy of the old line, so it won't be taken away when
5154 * updating the screen or handling a multi-line match. The "old_"
5155 * pointers point into this copy.
5156 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005157 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 copycol = 0;
5159 matchcol = 0;
5160
5161 /* At first match, remember current cursor position. */
5162 if (!got_match)
5163 {
5164 setpcmark();
5165 got_match = TRUE;
5166 }
5167
5168 /*
5169 * Loop until nothing more to replace in this line.
5170 * 1. Handle match with empty string.
5171 * 2. If do_ask is set, ask for confirmation.
5172 * 3. substitute the string.
5173 * 4. if do_all is set, find next match
5174 * 5. break if there isn't another match in this line
5175 */
5176 for (;;)
5177 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005178 /* Advance "lnum" to the line where the match starts. The
5179 * match does not start in the first line when there is a line
5180 * break before \zs. */
5181 if (regmatch.startpos[0].lnum > 0)
5182 {
5183 lnum += regmatch.startpos[0].lnum;
5184 sub_firstlnum += regmatch.startpos[0].lnum;
5185 nmatch -= regmatch.startpos[0].lnum;
5186 vim_free(sub_firstline);
5187 sub_firstline = NULL;
5188 }
5189
5190 if (sub_firstline == NULL)
5191 {
5192 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5193 if (sub_firstline == NULL)
5194 {
5195 vim_free(new_start);
5196 goto outofmem;
5197 }
5198 }
5199
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 /* Save the line number of the last change for the final
5201 * cursor position (just like Vi). */
5202 curwin->w_cursor.lnum = lnum;
5203 do_again = FALSE;
5204
5205 /*
5206 * 1. Match empty string does not count, except for first
5207 * match. This reproduces the strange vi behaviour.
5208 * This also catches endless loops.
5209 */
5210 if (matchcol == prev_matchcol
5211 && regmatch.endpos[0].lnum == 0
5212 && matchcol == regmatch.endpos[0].col)
5213 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005214 if (sub_firstline[matchcol] == NUL)
5215 /* We already were at the end of the line. Don't look
5216 * for a match in this line again. */
5217 skip_match = TRUE;
5218 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005219 {
5220 /* search for a match at next column */
5221#ifdef FEAT_MBYTE
5222 if (has_mbyte)
5223 matchcol += mb_ptr2len(sub_firstline + matchcol);
5224 else
5225#endif
5226 ++matchcol;
5227 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 goto skip;
5229 }
5230
5231 /* Normally we continue searching for a match just after the
5232 * previous match. */
5233 matchcol = regmatch.endpos[0].col;
5234 prev_matchcol = matchcol;
5235
5236 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005237 * 2. If do_count is set only increase the counter.
5238 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005240 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005241 {
5242 /* For a multi-line match, put matchcol at the NUL at
5243 * the end of the line and set nmatch to one, so that
5244 * we continue looking for a match on the next line.
5245 * Avoids that ":s/\nB\@=//gc" get stuck. */
5246 if (nmatch > 1)
5247 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005248 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005249 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005250 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005251 }
5252 sub_nsubs++;
5253 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005254#ifdef FEAT_EVAL
5255 /* Skip the substitution, unless an expression is used,
5256 * then it is evaluated in the sandbox. */
5257 if (!(sub[0] == '\\' && sub[1] == '='))
5258#endif
5259 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005260 }
5261
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005262 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005264 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005265
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 /* change State to CONFIRM, so that the mouse works
5267 * properly */
5268 save_State = State;
5269 State = CONFIRM;
5270#ifdef FEAT_MOUSE
5271 setmouse(); /* disable mouse in xterm */
5272#endif
5273 curwin->w_cursor.col = regmatch.startpos[0].col;
Bram Moolenaar41baa792017-01-21 14:45:09 +01005274#ifdef FEAT_CURSORBIND
5275 if (curwin->w_p_crb)
5276 do_check_cursorbind();
5277#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278
5279 /* When 'cpoptions' contains "u" don't sync undo when
5280 * asking for confirmation. */
5281 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5282 ++no_u_sync;
5283
5284 /*
5285 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5286 */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005287 while (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005289 if (exmode_active)
5290 {
5291 char_u *resp;
5292 colnr_T sc, ec;
5293
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005294 print_line_no_prefix(lnum,
5295 subflags.do_number, subflags.do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005296
5297 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5298 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
Bram Moolenaarba748c82017-02-26 14:00:07 +01005299 if (curwin->w_cursor.col < 0)
5300 curwin->w_cursor.col = 0;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005301 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005302 if (subflags.do_number || curwin->w_p_nu)
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005303 {
5304 int numw = number_width(curwin) + 1;
5305 sc += numw;
5306 ec += numw;
5307 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005308 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005309 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005310 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005311 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005312 msg_putchar('^');
5313
5314 resp = getexmodeline('?', NULL, 0);
5315 if (resp != NULL)
5316 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005317 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005318 vim_free(resp);
5319 }
5320 }
5321 else
5322 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005323 char_u *orig_line = NULL;
5324 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005326 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005328 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005330 /* Invert the matched string.
5331 * Remove the inversion afterwards. */
5332 temp = RedrawingDisabled;
5333 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005335 if (new_start != NULL)
5336 {
5337 /* There already was a substitution, we would
5338 * like to show this to the user. We cannot
5339 * really update the line, it would change
5340 * what matches. Temporarily replace the line
5341 * and change it back afterwards. */
5342 orig_line = vim_strsave(ml_get(lnum));
5343 if (orig_line != NULL)
5344 {
5345 char_u *new_line = concat_str(new_start,
5346 sub_firstline + copycol);
5347
5348 if (new_line == NULL)
5349 {
5350 vim_free(orig_line);
5351 orig_line = NULL;
5352 }
5353 else
5354 {
5355 /* Position the cursor relative to the
5356 * end of the line, the previous
5357 * substitute may have inserted or
5358 * deleted characters before the
5359 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005360 len_change = (int)STRLEN(new_line)
5361 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005362 curwin->w_cursor.col += len_change;
5363 ml_replace(lnum, new_line, FALSE);
5364 }
5365 }
5366 }
5367
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005368 search_match_lines = regmatch.endpos[0].lnum
5369 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005370 search_match_endcol = regmatch.endpos[0].col
5371 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005372 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005374 update_topline();
5375 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005376 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005377 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005378 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
5380#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005381 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005383 if (msg_row == Rows - 1)
5384 msg_didout = FALSE; /* avoid a scroll-up */
5385 msg_starthere();
5386 i = msg_scroll;
5387 msg_scroll = 0; /* truncate msg when
5388 needed */
5389 msg_no_more = TRUE;
5390 /* write message same highlighting as for
5391 * wait_return */
Bram Moolenaar8820b482017-03-16 17:23:31 +01005392 smsg_attr(HL_ATTR(HLF_R),
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005393 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5394 msg_no_more = FALSE;
5395 msg_scroll = i;
5396 showruler(TRUE);
5397 windgoto(msg_row, msg_col);
5398 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
5400#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005401 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005403 ++no_mapping; /* don't map this key */
5404 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005405 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005406 --allow_keys;
5407 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005409 /* clear the question */
5410 msg_didout = FALSE; /* don't scroll up */
5411 msg_col = 0;
5412 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005413
5414 /* restore the line */
5415 if (orig_line != NULL)
5416 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005417 }
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005420 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005422 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423#endif
5424 )
5425 {
5426 got_quit = TRUE;
5427 break;
5428 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005429 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005431 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005433 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 {
5435 /* last: replace and then stop */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005436 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 line2 = lnum;
5438 break;
5439 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005440 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005442 subflags.do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 break;
5444 }
5445#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005446 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005448 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 scrolldown_clamp();
5450#endif
5451 }
5452 State = save_State;
5453#ifdef FEAT_MOUSE
5454 setmouse();
5455#endif
5456 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5457 --no_u_sync;
5458
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005459 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 {
5461 /* For a multi-line match, put matchcol at the NUL at
5462 * the end of the line and set nmatch to one, so that
5463 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005464 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5465 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 if (nmatch > 1)
5467 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005468 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005469 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 }
5471 goto skip;
5472 }
5473 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005474 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 }
5476
5477 /* Move the cursor to the start of the match, so that we can
5478 * use "\=col("."). */
5479 curwin->w_cursor.col = regmatch.startpos[0].col;
5480
5481 /*
5482 * 3. substitute the string.
5483 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005484#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005485 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005486 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005487 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005488 save_ma = curbuf->b_p_ma;
5489 curbuf->b_p_ma = FALSE;
5490 sandbox++;
5491 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005492 /* Save flags for recursion. They can change for e.g.
5493 * :s/^/\=execute("s#^##gn") */
5494 subflags_save = subflags;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005495#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005497 sublen = vim_regsub_multi(&regmatch,
5498 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005500#ifdef FEAT_EVAL
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005501 /* Don't keep flags set by a recursive call. */
5502 subflags = subflags_save;
5503 if (subflags.do_count)
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005504 {
5505 curbuf->b_p_ma = save_ma;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005506 if (sandbox > 0)
5507 sandbox--;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005508 goto skip;
5509 }
5510#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511
Bram Moolenaar4463f292005-09-25 22:20:24 +00005512 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005513 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005514 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5515 {
5516 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5517 skip_match = TRUE;
5518 }
5519
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 /* Need room for:
5521 * - result so far in new_start (not for first sub in line)
5522 * - original text up to match
5523 * - length of substituted part
5524 * - original text after match
5525 */
5526 if (nmatch == 1)
5527 p1 = sub_firstline;
5528 else
5529 {
5530 p1 = ml_get(sub_firstlnum + nmatch - 1);
5531 nmatch_tl += nmatch - 1;
5532 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005533 copy_len = regmatch.startpos[0].col - copycol;
5534 needed_len = copy_len + ((unsigned)STRLEN(p1)
5535 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536 if (new_start == NULL)
5537 {
5538 /*
5539 * Get some space for a temporary buffer to do the
5540 * substitution into (and some extra space to avoid
5541 * too many calls to alloc()/free()).
5542 */
5543 new_start_len = needed_len + 50;
5544 if ((new_start = alloc_check(new_start_len)) == NULL)
5545 goto outofmem;
5546 *new_start = NUL;
5547 new_end = new_start;
5548 }
5549 else
5550 {
5551 /*
5552 * Check if the temporary buffer is long enough to do the
5553 * substitution into. If not, make it larger (with a bit
5554 * extra to avoid too many calls to alloc()/free()).
5555 */
5556 len = (unsigned)STRLEN(new_start);
5557 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005558 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 {
5560 new_start_len = needed_len + 50;
5561 if ((p1 = alloc_check(new_start_len)) == NULL)
5562 {
5563 vim_free(new_start);
5564 goto outofmem;
5565 }
5566 mch_memmove(p1, new_start, (size_t)(len + 1));
5567 vim_free(new_start);
5568 new_start = p1;
5569 }
5570 new_end = new_start + len;
5571 }
5572
5573 /*
5574 * copy the text up to the part that matched
5575 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005576 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5577 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005579 (void)vim_regsub_multi(&regmatch,
5580 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581 sub, new_end, TRUE, p_magic, TRUE);
5582 sub_nsubs++;
5583 did_sub = TRUE;
5584
5585 /* Move the cursor to the start of the line, to avoid that it
5586 * is beyond the end of the line after the substitution. */
5587 curwin->w_cursor.col = 0;
5588
5589 /* For a multi-line match, make a copy of the last matched
5590 * line and continue in that one. */
5591 if (nmatch > 1)
5592 {
5593 sub_firstlnum += nmatch - 1;
5594 vim_free(sub_firstline);
5595 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5596 /* When going beyond the last line, stop substituting. */
5597 if (sub_firstlnum <= line2)
5598 do_again = TRUE;
5599 else
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005600 subflags.do_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 }
5602
5603 /* Remember next character to be copied. */
5604 copycol = regmatch.endpos[0].col;
5605
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005606 if (skip_match)
5607 {
5608 /* Already hit end of the buffer, sub_firstlnum is one
5609 * less than what it ought to be. */
5610 vim_free(sub_firstline);
5611 sub_firstline = vim_strsave((char_u *)"");
5612 copycol = 0;
5613 }
5614
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 /*
5616 * Now the trick is to replace CTRL-M chars with a real line
5617 * break. This would make it impossible to insert a CTRL-M in
5618 * the text. The line break can be avoided by preceding the
5619 * CTRL-M with a backslash. To be able to insert a backslash,
5620 * they must be doubled in the string and are halved here.
5621 * That is Vi compatible.
5622 */
5623 for (p1 = new_end; *p1; ++p1)
5624 {
5625 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005626 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 else if (*p1 == CAR)
5628 {
5629 if (u_inssub(lnum) == OK) /* prepare for undo */
5630 {
5631 *p1 = NUL; /* truncate up to the CR */
5632 ml_append(lnum - 1, new_start,
5633 (colnr_T)(p1 - new_start + 1), FALSE);
5634 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005635 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 appended_lines(lnum - 1, 1L);
5637 else
5638 {
5639 if (first_line == 0)
5640 first_line = lnum;
5641 last_line = lnum + 1;
5642 }
5643 /* All line numbers increase. */
5644 ++sub_firstlnum;
5645 ++lnum;
5646 ++line2;
5647 /* move the cursor to the new line, like Vi */
5648 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005649 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005650 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 p1 = new_start - 1;
5652 }
5653 }
5654#ifdef FEAT_MBYTE
5655 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005656 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657#endif
5658 }
5659
5660 /*
5661 * 4. If do_all is set, find next match.
5662 * Prevent endless loop with patterns that match empty
5663 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5664 * But ":s/\n/#/" is OK.
5665 */
5666skip:
5667 /* We already know that we did the last subst when we are at
5668 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005669 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5670 * "line2" when there is a \zs in the pattern after a line
5671 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005672 lastone = (skip_match
5673 || got_int
5674 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005675 || lnum > line2
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005676 || !(subflags.do_all || do_again)
Bram Moolenaar8299df92004-07-10 09:47:34 +00005677 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5678 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 nmatch = -1;
5680
5681 /*
5682 * Replace the line in the buffer when needed. This is
5683 * skipped when there are more matches.
5684 * The check for nmatch_tl is needed for when multi-line
5685 * matching must replace the lines before trying to do another
5686 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005687 * When the match starts below where we start searching also
5688 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 */
5690 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 || nmatch_tl > 0
5692 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005693 curbuf, sub_firstlnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005694 matchcol, NULL, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005695 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 {
5697 if (new_start != NULL)
5698 {
5699 /*
5700 * Copy the rest of the line, that didn't match.
5701 * "matchcol" has to be adjusted, we use the end of
5702 * the line as reference, because the substitute may
5703 * have changed the number of characters. Same for
5704 * "prev_matchcol".
5705 */
5706 STRCAT(new_start, sub_firstline + copycol);
5707 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5708 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5709 - prev_matchcol;
5710
5711 if (u_savesub(lnum) != OK)
5712 break;
5713 ml_replace(lnum, new_start, TRUE);
5714
5715 if (nmatch_tl > 0)
5716 {
5717 /*
5718 * Matched lines have now been substituted and are
5719 * useless, delete them. The part after the match
5720 * has been appended to new_start, we don't need
5721 * it in the buffer.
5722 */
5723 ++lnum;
5724 if (u_savedel(lnum, nmatch_tl) != OK)
5725 break;
5726 for (i = 0; i < nmatch_tl; ++i)
5727 ml_delete(lnum, (int)FALSE);
5728 mark_adjust(lnum, lnum + nmatch_tl - 1,
5729 (long)MAXLNUM, -nmatch_tl);
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005730 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 deleted_lines(lnum, nmatch_tl);
5732 --lnum;
5733 line2 -= nmatch_tl; /* nr of lines decreases */
5734 nmatch_tl = 0;
5735 }
5736
5737 /* When asking, undo is saved each time, must also set
5738 * changed flag each time. */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005739 if (subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 changed_bytes(lnum, 0);
5741 else
5742 {
5743 if (first_line == 0)
5744 first_line = lnum;
5745 last_line = lnum + 1;
5746 }
5747
5748 sub_firstlnum = lnum;
5749 vim_free(sub_firstline); /* free the temp buffer */
5750 sub_firstline = new_start;
5751 new_start = NULL;
5752 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5753 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5754 - prev_matchcol;
5755 copycol = 0;
5756 }
5757 if (nmatch == -1 && !lastone)
5758 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02005759 sub_firstlnum, matchcol, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760
5761 /*
5762 * 5. break if there isn't another match in this line
5763 */
5764 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005765 {
5766 /* If the match found didn't start where we were
5767 * searching, do the next search in the line where we
5768 * found the match. */
5769 if (nmatch == -1)
5770 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005772 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 }
5774
5775 line_breakcheck();
5776 }
5777
5778 if (did_sub)
5779 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005780 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 vim_free(sub_firstline); /* free the copy of the original line */
5782 sub_firstline = NULL;
5783 }
5784
5785 line_breakcheck();
5786 }
5787
5788 if (first_line != 0)
5789 {
5790 /* Need to subtract the number of added lines from "last_line" to get
5791 * the line number before the change (same as adding the number of
5792 * deleted lines). */
5793 i = curbuf->b_ml.ml_line_count - old_line_count;
5794 changed_lines(first_line, 0, last_line - i, i);
5795 }
5796
5797outofmem:
5798 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005799
5800 /* ":s/pat//n" doesn't move the cursor */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005801 if (subflags.do_count)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005802 curwin->w_cursor = old_cursor;
5803
Bram Moolenaar46475522010-03-23 17:36:29 +01005804 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 {
5806 /* Set the '[ and '] marks. */
5807 curbuf->b_op_start.lnum = eap->line1;
5808 curbuf->b_op_end.lnum = line2;
5809 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5810
5811 if (!global_busy)
5812 {
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005813 /* when interactive leave cursor on the match */
5814 if (!subflags.do_ask)
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005815 {
5816 if (endcolumn)
5817 coladvance((colnr_T)MAXCOL);
5818 else
5819 beginline(BL_WHITE | BL_FIX);
5820 }
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005821 if (!do_sub_msg(subflags.do_count) && subflags.do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 MSG("");
5823 }
5824 else
5825 global_need_beginline = TRUE;
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005826 if (subflags.do_print)
5827 print_line(curwin->w_cursor.lnum,
5828 subflags.do_number, subflags.do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 }
5830 else if (!global_busy)
5831 {
5832 if (got_int) /* interrupted */
5833 EMSG(_(e_interr));
5834 else if (got_match) /* did find something but nothing substituted */
5835 MSG("");
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005836 else if (subflags.do_error) /* nothing found */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 EMSG2(_(e_patnotf2), get_search_pat());
5838 }
5839
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005840#ifdef FEAT_FOLDING
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005841 if (subflags.do_ask && hasAnyFolding(curwin))
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005842 /* Cursor position may require updating */
5843 changed_window_setting();
5844#endif
5845
Bram Moolenaar473de612013-06-08 18:19:48 +02005846 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005847
5848 /* Restore the flag values, they can be used for ":&&". */
Bram Moolenaarf5a39442016-08-16 21:04:41 +02005849 subflags.do_all = save_do_all;
5850 subflags.do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851}
5852
5853/*
5854 * Give message for number of substitutions.
5855 * Can also be used after a ":global" command.
5856 * Return TRUE if a message was given.
5857 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005858 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005859do_sub_msg(
5860 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861{
5862 /*
5863 * Only report substitutions when:
5864 * - more than 'report' substitutions
5865 * - command was typed by user, or number of changed lines > 'report'
5866 * - giving messages is not disabled by 'lazyredraw'
5867 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005868 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5869 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 && messaging())
5871 {
5872 if (got_int)
5873 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005874 else
5875 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005877 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005878 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005880 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005881 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 sub_nsubs);
5883 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005884 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005885 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005887 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005888 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005891 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 return TRUE;
5893 }
5894 if (got_int)
5895 {
5896 EMSG(_(e_interr));
5897 return TRUE;
5898 }
5899 return FALSE;
5900}
5901
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005902 static void
5903global_exe_one(char_u *cmd, linenr_T lnum)
5904{
5905 curwin->w_cursor.lnum = lnum;
5906 curwin->w_cursor.col = 0;
5907 if (*cmd == NUL || *cmd == '\n')
5908 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5909 else
5910 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5911}
5912
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913/*
5914 * Execute a global command of the form:
5915 *
5916 * g/pattern/X : execute X on all lines where pattern matches
5917 * v/pattern/X : execute X on all lines where pattern does not match
5918 *
5919 * where 'X' is an EX command
5920 *
5921 * The command character (as well as the trailing slash) is optional, and
5922 * is assumed to be 'p' if missing.
5923 *
5924 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005925 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 * for each line that has a mark. This is required because after deleting
5927 * lines we do not know where to search for the next match.
5928 */
5929 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005930ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931{
5932 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005933 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 int type; /* first char of cmd: 'v' or 'g' */
5935 char_u *cmd; /* command argument */
5936
5937 char_u delim; /* delimiter, normally '/' */
5938 char_u *pat;
5939 regmmatch_T regmatch;
5940 int match;
5941 int which_pat;
5942
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005943 /* When nesting the command works on one line. This allows for
5944 * ":g/found/v/notfound/command". */
5945 if (global_busy && (eap->line1 != 1
5946 || eap->line2 != curbuf->b_ml.ml_line_count))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02005948 /* will increment global_busy to break out of the loop */
5949 EMSG(_("E147: Cannot do :global recursive with a range"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 return;
5951 }
5952
5953 if (eap->forceit) /* ":global!" is like ":vglobal" */
5954 type = 'v';
5955 else
5956 type = *eap->cmd;
5957 cmd = eap->arg;
5958 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959
5960 /*
5961 * undocumented vi feature:
5962 * "\/" and "\?": use previous search pattern.
5963 * "\&": use previous substitute pattern.
5964 */
5965 if (*cmd == '\\')
5966 {
5967 ++cmd;
5968 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5969 {
5970 EMSG(_(e_backslash));
5971 return;
5972 }
5973 if (*cmd == '&')
5974 which_pat = RE_SUBST; /* use previous substitute pattern */
5975 else
5976 which_pat = RE_SEARCH; /* use previous search pattern */
5977 ++cmd;
5978 pat = (char_u *)"";
5979 }
5980 else if (*cmd == NUL)
5981 {
5982 EMSG(_("E148: Regular expression missing from global"));
5983 return;
5984 }
5985 else
5986 {
5987 delim = *cmd; /* get the delimiter */
5988 if (delim)
5989 ++cmd; /* skip delimiter if there is one */
5990 pat = cmd; /* remember start of pattern */
5991 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5992 if (cmd[0] == delim) /* end delimiter found */
5993 *cmd++ = NUL; /* replace it with a NUL */
5994 }
5995
5996#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5997 if (p_altkeymap && curwin->w_p_rl)
5998 lrFswap(pat,0);
5999#endif
6000
6001 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
6002 {
6003 EMSG(_(e_invcmd));
6004 return;
6005 }
6006
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006007 if (global_busy)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006009 lnum = curwin->w_cursor.lnum;
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006010 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006011 (colnr_T)0, NULL, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 if ((type == 'g' && match) || (type == 'v' && !match))
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006013 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 }
6015 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006016 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006017 /*
6018 * pass 1: set marks for each (not) matching line
6019 */
6020 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
6021 {
6022 /* a match on this line? */
6023 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
Bram Moolenaarfbd0b0a2017-06-17 18:44:21 +02006024 (colnr_T)0, NULL, NULL);
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006025 if ((type == 'g' && match) || (type == 'v' && !match))
6026 {
6027 ml_setmarked(lnum);
6028 ndone++;
6029 }
6030 line_breakcheck();
6031 }
6032
6033 /*
6034 * pass 2: execute the command for each line that has been marked
6035 */
6036 if (got_int)
6037 MSG(_(e_interr));
6038 else if (ndone == 0)
6039 {
6040 if (type == 'v')
6041 smsg((char_u *)_("Pattern found in every line: %s"), pat);
6042 else
6043 smsg((char_u *)_("Pattern not found: %s"), pat);
6044 }
6045 else
6046 {
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006047#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006048 start_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006049#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006050 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006051#ifdef FEAT_CLIPBOARD
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006052 end_global_changes();
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006053#endif
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006054 }
6055
6056 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02006057 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058
Bram Moolenaar473de612013-06-08 18:19:48 +02006059 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060}
6061
6062/*
6063 * Execute "cmd" on lines marked with ml_setmarked().
6064 */
6065 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006066global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067{
Bram Moolenaarbb993222011-05-10 16:00:47 +02006068 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
6069 buf_T *old_buf = curbuf; /* remember what buffer we started in */
6070 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071
6072 /*
6073 * Set current position only once for a global command.
6074 * If global_busy is set, setpcmark() will not do anything.
6075 * If there is an error, global_busy will be incremented.
6076 */
6077 setpcmark();
6078
6079 /* When the command writes a message, don't overwrite the command. */
6080 msg_didout = TRUE;
6081
Bram Moolenaard25bc232010-03-23 17:49:24 +01006082 sub_nsubs = 0;
6083 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 global_need_beginline = FALSE;
6085 global_busy = 1;
6086 old_lcount = curbuf->b_ml.ml_line_count;
6087 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
6088 {
Bram Moolenaarf84b1222017-06-10 14:29:52 +02006089 global_exe_one(cmd, lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 ui_breakcheck();
6091 }
6092
6093 global_busy = 0;
6094 if (global_need_beginline)
6095 beginline(BL_WHITE | BL_FIX);
6096 else
6097 check_cursor(); /* cursor may be beyond the end of the line */
6098
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006099 /* the cursor may not have moved in the text but a change in a previous
6100 * line may move it on the screen */
6101 changed_line_abv_curs();
6102
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 /* If it looks like no message was written, allow overwriting the
6104 * command with the report for number of changes. */
6105 if (msg_col == 0 && msg_scrolled == 0)
6106 msg_didout = FALSE;
6107
Bram Moolenaar45667512007-05-10 19:24:43 +00006108 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006109 * number of extra or deleted lines.
6110 * Don't report extra or deleted lines in the edge case where the buffer
6111 * we are in after execution is different from the buffer we started in. */
6112 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6114}
6115
6116#ifdef FEAT_VIMINFO
6117 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006118read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006120 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 vim_free(old_sub);
6122 if (force || old_sub == NULL)
6123 old_sub = viminfo_readstring(virp, 1, TRUE);
6124 return viminfo_readline(virp);
6125}
6126
6127 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006128write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129{
6130 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6131 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006132 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 viminfo_writestring(fp, old_sub);
6134 }
6135}
6136#endif /* FEAT_VIMINFO */
6137
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006138#if defined(EXITFREE) || defined(PROTO)
6139 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006140free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006141{
6142 vim_free(old_sub);
6143}
6144#endif
6145
Bram Moolenaar4033c552017-09-16 20:54:51 +02006146#if defined(FEAT_QUICKFIX) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147/*
6148 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006149 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006151 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006152prepare_tagpreview(
6153 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154{
6155 win_T *wp;
6156
6157# ifdef FEAT_GUI
6158 need_mouse_correct = TRUE;
6159# endif
6160
6161 /*
6162 * If there is already a preview window open, use that one.
6163 */
6164 if (!curwin->w_p_pvw)
6165 {
Bram Moolenaar29323592016-07-24 22:04:11 +02006166 FOR_ALL_WINDOWS(wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 if (wp->w_p_pvw)
6168 break;
6169 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006170 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 else
6172 {
6173 /*
6174 * There is no preview window open yet. Create one.
6175 */
6176 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6177 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006178 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 curwin->w_p_pvw = TRUE;
6180 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006181 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6182 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183# ifdef FEAT_DIFF
6184 curwin->w_p_diff = FALSE; /* no 'diff' */
6185# endif
6186# ifdef FEAT_FOLDING
6187 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6188# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006189 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 }
6191 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006192 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193}
6194
6195#endif
6196
6197
6198/*
6199 * ":help": open a read-only window on a help file
6200 */
6201 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006202ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203{
6204 char_u *arg;
6205 char_u *tag;
6206 FILE *helpfd; /* file descriptor of help file */
6207 int n;
6208 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 int num_matches;
6211 char_u **matches;
6212 char_u *p;
6213 int empty_fnum = 0;
6214 int alt_fnum = 0;
6215 buf_T *buf;
6216#ifdef FEAT_MULTI_LANG
6217 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006218 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006220#ifdef FEAT_FOLDING
6221 int old_KeyTyped = KeyTyped;
6222#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223
6224 if (eap != NULL)
6225 {
6226 /*
6227 * A ":help" command ends at the first LF, or at a '|' that is
6228 * followed by some text. Set nextcmd to the following command.
6229 */
6230 for (arg = eap->arg; *arg; ++arg)
6231 {
6232 if (*arg == '\n' || *arg == '\r'
6233 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6234 {
6235 *arg++ = NUL;
6236 eap->nextcmd = arg;
6237 break;
6238 }
6239 }
6240 arg = eap->arg;
6241
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006242 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 {
6244 EMSG(_("E478: Don't panic!"));
6245 return;
6246 }
6247
6248 if (eap->skip) /* not executing commands */
6249 return;
6250 }
6251 else
6252 arg = (char_u *)"";
6253
6254 /* remove trailing blanks */
6255 p = arg + STRLEN(arg) - 1;
Bram Moolenaar1c465442017-03-12 20:10:05 +01006256 while (p > arg && VIM_ISWHITE(*p) && p[-1] != '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 *p-- = NUL;
6258
6259#ifdef FEAT_MULTI_LANG
6260 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006261 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262#endif
6263
6264 /* When no argument given go to the index. */
6265 if (*arg == NUL)
6266 arg = (char_u *)"help.txt";
6267
6268 /*
6269 * Check if there is a match for the argument.
6270 */
6271 n = find_help_tags(arg, &num_matches, &matches,
6272 eap != NULL && eap->forceit);
6273
6274 i = 0;
6275#ifdef FEAT_MULTI_LANG
6276 if (n != FAIL && lang != NULL)
6277 /* Find first item with the requested language. */
6278 for (i = 0; i < num_matches; ++i)
6279 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006280 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 if (len > 3 && matches[i][len - 3] == '@'
6282 && STRICMP(matches[i] + len - 2, lang) == 0)
6283 break;
6284 }
6285#endif
6286 if (i >= num_matches || n == FAIL)
6287 {
6288#ifdef FEAT_MULTI_LANG
6289 if (lang != NULL)
6290 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6291 else
6292#endif
6293 EMSG2(_("E149: Sorry, no help for %s"), arg);
6294 if (n != FAIL)
6295 FreeWild(num_matches, matches);
6296 return;
6297 }
6298
6299 /* The first match (in the requested language) is the best match. */
6300 tag = vim_strsave(matches[i]);
6301 FreeWild(num_matches, matches);
6302
6303#ifdef FEAT_GUI
6304 need_mouse_correct = TRUE;
6305#endif
6306
6307 /*
6308 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006309 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 */
Bram Moolenaar4033c552017-09-16 20:54:51 +02006311 if (!bt_help(curwin->w_buffer) || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 {
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006313 if (cmdmod.tab != 0)
6314 wp = NULL;
6315 else
Bram Moolenaar29323592016-07-24 22:04:11 +02006316 FOR_ALL_WINDOWS(wp)
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006317 if (bt_help(wp->w_buffer))
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006318 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6320 win_enter(wp, TRUE);
6321 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 {
6323 /*
6324 * There is no help window yet.
6325 * Try to open the file specified by the "helpfile" option.
6326 */
6327 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6328 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006329 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 goto erret;
6331 }
6332 fclose(helpfd);
6333
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006335 * specified, the current window is vertically split and
6336 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006339 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006342 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 if (curwin->w_height < p_hh)
6345 win_setheight((int)p_hh);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346
6347 /*
6348 * Open help file (do_ecmd() will set b_help flag, readfile() will
6349 * set b_p_ro flag).
6350 * Set the alternate file to the previously edited file.
6351 */
6352 alt_fnum = curbuf->b_fnum;
6353 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006354 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaar4033c552017-09-16 20:54:51 +02006355 NULL); /* buffer is still open, don't store info */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006356 if (!cmdmod.keepalt)
6357 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 empty_fnum = curbuf->b_fnum;
6359 }
6360 }
6361
6362 if (!p_im)
6363 restart_edit = 0; /* don't want insert mode in help file */
6364
Bram Moolenaar8f535582011-09-30 17:30:31 +02006365#ifdef FEAT_FOLDING
6366 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6367 * It is needed for do_tag top open folds under the cursor. */
6368 KeyTyped = old_KeyTyped;
6369#endif
6370
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 if (tag != NULL)
6372 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6373
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006374 /* Delete the empty buffer if we're not using it. Careful: autocommands
6375 * may have jumped to another window, check that the buffer is not in a
6376 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6378 {
6379 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006380 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 wipe_buffer(buf, TRUE);
6382 }
6383
6384 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006385 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 curwin->w_alt_fnum = alt_fnum;
6387
6388erret:
6389 vim_free(tag);
6390}
6391
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006392/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006393 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006394 */
6395 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006396ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006397{
6398 win_T *win;
6399
6400 FOR_ALL_WINDOWS(win)
6401 {
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02006402 if (bt_help(win->w_buffer))
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006403 {
6404 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006405 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006406 }
6407 }
6408}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006410#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6411/*
6412 * In an argument search for a language specifiers in the form "@xx".
6413 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6414 * Returns NULL if not found.
6415 */
6416 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006417check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006418{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006419 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006420
6421 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6422 && ASCII_ISALPHA(arg[len - 1]))
6423 {
6424 arg[len - 3] = NUL; /* remove the '@' */
6425 return arg + len - 2;
6426 }
6427 return NULL;
6428}
6429#endif
6430
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431/*
6432 * Return a heuristic indicating how well the given string matches. The
6433 * smaller the number, the better the match. This is the order of priorities,
6434 * from best match to worst match:
6435 * - Match with least alpha-numeric characters is better.
6436 * - Match with least total characters is better.
6437 * - Match towards the start is better.
6438 * - Match starting with "+" is worse (feature instead of command)
6439 * Assumption is made that the matched_string passed has already been found to
6440 * match some string for which help is requested. webb.
6441 */
6442 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006443help_heuristic(
6444 char_u *matched_string,
6445 int offset, /* offset for match */
6446 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447{
6448 int num_letters;
6449 char_u *p;
6450
6451 num_letters = 0;
6452 for (p = matched_string; *p; p++)
6453 if (ASCII_ISALNUM(*p))
6454 num_letters++;
6455
6456 /*
6457 * Multiply the number of letters by 100 to give it a much bigger
6458 * weighting than the number of characters.
6459 * If there only is a match while ignoring case, add 5000.
6460 * If the match starts in the middle of a word, add 10000 to put it
6461 * somewhere in the last half.
6462 * If the match is more than 2 chars from the start, multiply by 200 to
6463 * put it after matches at the start.
6464 */
6465 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6466 && ASCII_ISALNUM(matched_string[offset - 1]))
6467 offset += 10000;
6468 else if (offset > 2)
6469 offset *= 200;
6470 if (wrong_case)
6471 offset += 5000;
6472 /* Features are less interesting than the subjects themselves, but "+"
6473 * alone is not a feature. */
6474 if (matched_string[0] == '+' && matched_string[1] != NUL)
6475 offset += 100;
6476 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6477}
6478
6479/*
6480 * Compare functions for qsort() below, that checks the help heuristics number
6481 * that has been put after the tagname by find_tags().
6482 */
6483 static int
6484#ifdef __BORLANDC__
6485_RTLENTRYF
6486#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006487help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488{
6489 char *p1;
6490 char *p2;
6491
6492 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6493 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6494 return strcmp(p1, p2);
6495}
6496
6497/*
6498 * Find all help tags matching "arg", sort them and return in matches[], with
6499 * the number of matches in num_matches.
6500 * The matches will be sorted with a "best" match algorithm.
6501 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6502 */
6503 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006504find_help_tags(
6505 char_u *arg,
6506 int *num_matches,
6507 char_u ***matches,
6508 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509{
6510 char_u *s, *d;
6511 int i;
6512 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006513 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006514 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006515 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006516 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006517 "[count]", "[quotex]",
6518 "[range]", ":[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006519 "[pattern]", "\\|", "\\%$",
6520 "s/\\~", "s/\\U", "s/\\L",
6521 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006523 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006524 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaardad73092017-02-09 11:54:50 +01006525 "?", ":?", "?<CR>", "g?", "g?g?", "g??",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006526 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaara76f59d2017-02-09 11:41:01 +01006527 "\\[count]", "\\[quotex]",
6528 "\\[range]", ":\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006529 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006530 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006531 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 int flags;
6533
6534 d = IObuff; /* assume IObuff is long enough! */
6535
6536 /*
6537 * Recognize a few exceptions to the rule. Some strings that contain '*'
6538 * with "star". Otherwise '*' is recognized as a wildcard.
6539 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006540 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 if (STRCMP(arg, mtable[i]) == 0)
6542 {
6543 STRCPY(d, rtable[i]);
6544 break;
6545 }
6546
6547 if (i < 0) /* no match in table */
6548 {
6549 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6550 * Also replace "\%^" and "\%(", they match every tag too.
6551 * Also "\zs", "\z1", etc.
6552 * Also "\@<", "\@=", "\@<=", etc.
6553 * And also "\_$" and "\_^". */
6554 if (arg[0] == '\\'
6555 && ((arg[1] != NUL && arg[2] == NUL)
6556 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6557 && arg[2] != NUL)))
6558 {
6559 STRCPY(d, "/\\\\");
6560 STRCPY(d + 3, arg + 1);
6561 /* Check for "/\\_$", should be "/\\_\$" */
6562 if (d[3] == '_' && d[4] == '$')
6563 STRCPY(d + 4, "\\$");
6564 }
6565 else
6566 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006567 /* Replace:
6568 * "[:...:]" with "\[:...:]"
6569 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006570 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006571 */
6572 if ((arg[0] == '[' && (arg[1] == ':'
6573 || (arg[1] == '+' && arg[2] == '+')))
6574 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 *d++ = '\\';
6576
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006577 /*
6578 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6579 */
6580 if (*arg == '(' && arg[1] == '\'')
6581 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 for (s = arg; *s; ++s)
6583 {
6584 /*
6585 * Replace "|" with "bar" and '"' with "quote" to match the name of
6586 * the tags for these commands.
6587 * Replace "*" with ".*" and "?" with "." to match command line
6588 * completion.
6589 * Insert a backslash before '~', '$' and '.' to avoid their
6590 * special meaning.
6591 */
6592 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6593 break;
6594 switch (*s)
6595 {
6596 case '|': STRCPY(d, "bar");
6597 d += 3;
6598 continue;
6599 case '"': STRCPY(d, "quote");
6600 d += 5;
6601 continue;
6602 case '*': *d++ = '.';
6603 break;
6604 case '?': *d++ = '.';
6605 continue;
6606 case '$':
6607 case '.':
6608 case '~': *d++ = '\\';
6609 break;
6610 }
6611
6612 /*
6613 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6614 * ":help i_^_CTRL-D" work.
6615 * Insert '-' before and after "CTRL-X" when applicable.
6616 */
6617 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6618 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6619 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006620 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6621 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 STRCPY(d, "CTRL-");
6623 d += 5;
6624 if (*s < ' ')
6625 {
6626#ifdef EBCDIC
6627 *d++ = CtrlChar(*s);
6628#else
6629 *d++ = *s + '@';
6630#endif
6631 if (d[-1] == '\\')
6632 *d++ = '\\'; /* double a backslash */
6633 }
6634 else
6635 *d++ = *++s;
6636 if (s[1] != NUL && s[1] != '_')
6637 *d++ = '_'; /* append a '_' */
6638 continue;
6639 }
6640 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6641 *d++ = '\\';
6642
6643 /*
6644 * Insert a backslash before a backslash after a slash, for search
6645 * pattern tags: "/\|" --> "/\\|".
6646 */
6647 else if (s[0] == '\\' && s[1] != '\\'
6648 && *arg == '/' && s == arg + 1)
6649 *d++ = '\\';
6650
6651 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6652 * "CTRL-\_CTRL-N" */
6653 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6654 {
6655 STRCPY(d, "CTRL-\\\\");
6656 d += 7;
6657 s += 6;
6658 }
6659
6660 *d++ = *s;
6661
6662 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006663 * If tag contains "({" or "([", tag terminates at the "(".
6664 * This is for help on functions, e.g.: abs({expr}).
6665 */
6666 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6667 break;
6668
6669 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 * If tag starts with ', toss everything after a second '. Fixes
6671 * CTRL-] on 'option'. (would include the trailing '.').
6672 */
6673 if (*s == '\'' && s > arg && *arg == '\'')
6674 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006675 /* Also '{' and '}'. */
6676 if (*s == '}' && s > arg && *arg == '{')
6677 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 }
6679 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006680
6681 if (*IObuff == '`')
6682 {
6683 if (d > IObuff + 2 && d[-1] == '`')
6684 {
6685 /* remove the backticks from `command` */
6686 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6687 d[-2] = NUL;
6688 }
6689 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6690 {
6691 /* remove the backticks and comma from `command`, */
6692 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6693 d[-3] = NUL;
6694 }
6695 else if (d > IObuff + 4 && d[-3] == '`'
6696 && d[-2] == '\\' && d[-1] == '.')
6697 {
6698 /* remove the backticks and dot from `command`\. */
6699 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6700 d[-4] = NUL;
6701 }
6702 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 }
6704 }
6705
6706 *matches = (char_u **)"";
6707 *num_matches = 0;
6708 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6709 if (keep_lang)
6710 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006711 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006713 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 /* Sort the matches found on the heuristic number that is after the
6715 * tag name. */
6716 qsort((void *)*matches, (size_t)*num_matches,
6717 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006718 /* Delete more than TAG_MANY to reduce the size of the listing. */
6719 while (*num_matches > TAG_MANY)
6720 vim_free((*matches)[--*num_matches]);
6721 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 return OK;
6723}
6724
6725/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006726 * Called when starting to edit a buffer for a help file.
6727 */
6728 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006729prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006730{
6731 char_u *p;
6732
6733 curbuf->b_help = TRUE;
6734#ifdef FEAT_QUICKFIX
6735 set_string_option_direct((char_u *)"buftype", -1,
6736 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6737#endif
6738
6739 /*
6740 * Always set these options after jumping to a help tag, because the
6741 * user may have an autocommand that gets in the way.
6742 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6743 * latin1 word characters (for translated help files).
6744 * Only set it when needed, buf_init_chartab() is some work.
6745 */
6746 p =
6747#ifdef EBCDIC
6748 (char_u *)"65-255,^*,^|,^\"";
6749#else
6750 (char_u *)"!-~,^*,^|,^\",192-255";
6751#endif
6752 if (STRCMP(curbuf->b_p_isk, p) != 0)
6753 {
6754 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6755 check_buf_options(curbuf);
6756 (void)buf_init_chartab(curbuf, FALSE);
6757 }
6758
Bram Moolenaar0b105412014-11-30 13:34:23 +01006759#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006760 /* Don't use the global foldmethod.*/
6761 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6762 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006763#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006764
6765 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6766 curwin->w_p_list = FALSE; /* no list mode */
6767
6768 curbuf->b_p_ma = FALSE; /* not modifiable */
6769 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6770 curwin->w_p_nu = 0; /* no line numbers */
6771 curwin->w_p_rnu = 0; /* no relative line numbers */
6772 RESET_BINDING(curwin); /* no scroll or cursor binding */
6773#ifdef FEAT_ARABIC
6774 curwin->w_p_arab = FALSE; /* no arabic mode */
6775#endif
6776#ifdef FEAT_RIGHTLEFT
6777 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6778#endif
6779#ifdef FEAT_FOLDING
6780 curwin->w_p_fen = FALSE; /* No folding in the help window */
6781#endif
6782#ifdef FEAT_DIFF
6783 curwin->w_p_diff = FALSE; /* No 'diff' */
6784#endif
6785#ifdef FEAT_SPELL
6786 curwin->w_p_spell = FALSE; /* No spell checking */
6787#endif
6788
6789 set_buflisted(FALSE);
6790}
6791
6792/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 * After reading a help file: May cleanup a help buffer when syntax
6794 * highlighting is not used.
6795 */
6796 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006797fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798{
6799 linenr_T lnum;
6800 char_u *line;
6801 int in_example = FALSE;
6802 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006803 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 char_u *p;
6805 char_u *rt;
6806 int mustfree;
6807
Bram Moolenaar157069b2017-06-22 14:56:12 +02006808#ifdef FEAT_AUTOCMD
Bram Moolenaar90492982017-06-22 14:16:31 +02006809 /* Set filetype to "help" if still needed. */
6810 if (STRCMP(curbuf->b_p_ft, "help") != 0)
Bram Moolenaar18141832017-06-25 21:17:25 +02006811 {
6812 ++curbuf_lock;
Bram Moolenaar90492982017-06-22 14:16:31 +02006813 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
Bram Moolenaar18141832017-06-25 21:17:25 +02006814 --curbuf_lock;
6815 }
Bram Moolenaar157069b2017-06-22 14:56:12 +02006816#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817
6818#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006819 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820#endif
6821 {
6822 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6823 {
6824 line = ml_get_buf(curbuf, lnum, FALSE);
6825 len = (int)STRLEN(line);
Bram Moolenaar1c465442017-03-12 20:10:05 +01006826 if (in_example && len > 0 && !VIM_ISWHITE(line[0]))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 {
6828 /* End of example: non-white or '<' in first column. */
6829 if (line[0] == '<')
6830 {
6831 /* blank-out a '<' in the first column */
6832 line = ml_get_buf(curbuf, lnum, TRUE);
6833 line[0] = ' ';
6834 }
6835 in_example = FALSE;
6836 }
6837 if (!in_example && len > 0)
6838 {
6839 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6840 {
6841 /* blank-out a '>' in the last column (start of example) */
6842 line = ml_get_buf(curbuf, lnum, TRUE);
6843 line[len - 1] = ' ';
6844 in_example = TRUE;
6845 }
6846 else if (line[len - 1] == '~')
6847 {
6848 /* blank-out a '~' at the end of line (header marker) */
6849 line = ml_get_buf(curbuf, lnum, TRUE);
6850 line[len - 1] = ' ';
6851 }
6852 }
6853 }
6854 }
6855
6856 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006857 * In the "help.txt" and "help.abx" file, add the locally added help
6858 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006860 fname = gettail(curbuf->b_fname);
6861 if (fnamecmp(fname, "help.txt") == 0
6862#ifdef FEAT_MULTI_LANG
6863 || (fnamencmp(fname, "help.", 5) == 0
6864 && ASCII_ISALPHA(fname[5])
6865 && ASCII_ISALPHA(fname[6])
6866 && TOLOWER_ASC(fname[7]) == 'x'
6867 && fname[8] == NUL)
6868#endif
6869 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 {
6871 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6872 {
6873 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006874 if (strstr((char *)line, "*local-additions*") == NULL)
6875 continue;
6876
6877 /* Go through all directories in 'runtimepath', skipping
6878 * $VIMRUNTIME. */
6879 p = p_rtp;
6880 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006882 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6883 mustfree = FALSE;
6884 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6885 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006887 int fcount;
6888 char_u **fnames;
6889 FILE *fd;
6890 char_u *s;
6891 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006893 vimconv_T vc;
6894 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895#endif
6896
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006897 /* Find all "doc/ *.txt" files in this directory. */
6898 add_pathsep(NameBuff);
6899#ifdef FEAT_MULTI_LANG
6900 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006902 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006904 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6905 &fnames, EW_FILE|EW_SILENT) == OK
6906 && fcount > 0)
6907 {
6908#ifdef FEAT_MULTI_LANG
6909 int i1;
6910 int i2;
6911 char_u *f1;
6912 char_u *f2;
6913 char_u *t1;
6914 char_u *e1;
6915 char_u *e2;
6916
6917 /* If foo.abx is found use it instead of foo.txt in
6918 * the same directory. */
6919 for (i1 = 0; i1 < fcount; ++i1)
6920 {
6921 for (i2 = 0; i2 < fcount; ++i2)
6922 {
6923 if (i1 == i2)
6924 continue;
6925 if (fnames[i1] == NULL || fnames[i2] == NULL)
6926 continue;
6927 f1 = fnames[i1];
6928 f2 = fnames[i2];
6929 t1 = gettail(f1);
6930 if (fnamencmp(f1, f2, t1 - f1) != 0)
6931 continue;
6932 e1 = vim_strrchr(t1, '.');
6933 e2 = vim_strrchr(gettail(f2), '.');
Bram Moolenaar7756e742016-10-21 20:35:37 +02006934 if (e1 == NULL || e2 == NULL)
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006935 continue;
6936 if (fnamecmp(e1, ".txt") != 0
6937 && fnamecmp(e1, fname + 4) != 0)
6938 {
6939 /* Not .txt and not .abx, remove it. */
6940 vim_free(fnames[i1]);
6941 fnames[i1] = NULL;
6942 continue;
6943 }
6944 if (fnamencmp(f1, f2, e1 - f1) != 0)
6945 continue;
6946 if (fnamecmp(e1, ".txt") == 0
6947 && fnamecmp(e2, fname + 4) == 0)
6948 {
6949 /* use .abx instead of .txt */
6950 vim_free(fnames[i1]);
6951 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 }
6953 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006955#endif
6956 for (fi = 0; fi < fcount; ++fi)
6957 {
6958 if (fnames[fi] == NULL)
6959 continue;
6960 fd = mch_fopen((char *)fnames[fi], "r");
6961 if (fd != NULL)
6962 {
6963 vim_fgets(IObuff, IOSIZE, fd);
6964 if (IObuff[0] == '*'
6965 && (s = vim_strchr(IObuff + 1, '*'))
6966 != NULL)
6967 {
6968#ifdef FEAT_MBYTE
6969 int this_utf = MAYBE;
6970#endif
6971 /* Change tag definition to a
6972 * reference and remove <CR>/<NL>. */
6973 IObuff[0] = '|';
6974 *s = '|';
6975 while (*s != NUL)
6976 {
6977 if (*s == '\r' || *s == '\n')
6978 *s = NUL;
6979#ifdef FEAT_MBYTE
6980 /* The text is utf-8 when a byte
6981 * above 127 is found and no
6982 * illegal byte sequence is found.
6983 */
6984 if (*s >= 0x80 && this_utf != FALSE)
6985 {
6986 int l;
6987
6988 this_utf = TRUE;
6989 l = utf_ptr2len(s);
6990 if (l == 1)
6991 this_utf = FALSE;
6992 s += l - 1;
6993 }
6994#endif
6995 ++s;
6996 }
6997#ifdef FEAT_MBYTE
6998 /* The help file is latin1 or utf-8;
6999 * conversion to the current
7000 * 'encoding' may be required. */
7001 vc.vc_type = CONV_NONE;
7002 convert_setup(&vc, (char_u *)(
7003 this_utf == TRUE ? "utf-8"
7004 : "latin1"), p_enc);
7005 if (vc.vc_type == CONV_NONE)
7006 /* No conversion needed. */
7007 cp = IObuff;
7008 else
7009 {
7010 /* Do the conversion. If it fails
7011 * use the unconverted text. */
7012 cp = string_convert(&vc, IObuff,
7013 NULL);
7014 if (cp == NULL)
7015 cp = IObuff;
7016 }
7017 convert_setup(&vc, NULL, NULL);
7018
7019 ml_append(lnum, cp, (colnr_T)0, FALSE);
7020 if (cp != IObuff)
7021 vim_free(cp);
7022#else
7023 ml_append(lnum, IObuff, (colnr_T)0,
7024 FALSE);
7025#endif
7026 ++lnum;
7027 }
7028 fclose(fd);
7029 }
7030 }
7031 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007034 if (mustfree)
7035 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02007037 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 }
7039 }
7040}
7041
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007042/*
7043 * ":exusage"
7044 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007045 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007046ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007047{
7048 do_cmdline_cmd((char_u *)"help ex-cmd-index");
7049}
7050
7051/*
7052 * ":viusage"
7053 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007054 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007055ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007056{
7057 do_cmdline_cmd((char_u *)"help normal-index");
7058}
7059
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007061 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007064helptags_one(
7065 char_u *dir, /* doc directory */
7066 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
7067 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
7068 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069{
7070 FILE *fd_tags;
7071 FILE *fd;
7072 garray_T ga;
7073 int filecount;
7074 char_u **files;
7075 char_u *p1, *p2;
7076 int fi;
7077 char_u *s;
7078 int i;
7079 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007080 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081# ifdef FEAT_MBYTE
7082 int utf8 = MAYBE;
7083 int this_utf8;
7084 int firstline;
7085 int mix = FALSE; /* detected mixed encodings */
7086# endif
7087
7088 /*
7089 * Find all *.txt files.
7090 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007091 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007093 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 STRCAT(NameBuff, ext);
7095 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7096 EW_FILE|EW_SILENT) == FAIL
7097 || filecount == 0)
7098 {
7099 if (!got_int)
Bram Moolenaar5b302912016-08-24 22:11:55 +02007100 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007101 return;
7102 }
7103
7104 /*
7105 * Open the tags file for writing.
7106 * Do this before scanning through all the files.
7107 */
7108 STRCPY(NameBuff, dir);
7109 add_pathsep(NameBuff);
7110 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007111 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 if (fd_tags == NULL)
7113 {
7114 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7115 FreeWild(filecount, files);
7116 return;
7117 }
7118
7119 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007120 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7121 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 */
7123 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007124 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7125 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 {
7127 if (ga_grow(&ga, 1) == FAIL)
7128 got_int = TRUE;
7129 else
7130 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007131 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 if (s == NULL)
7133 got_int = TRUE;
7134 else
7135 {
7136 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7137 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7138 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 }
7140 }
7141 }
7142
7143 /*
7144 * Go over all the files and extract the tags.
7145 */
7146 for (fi = 0; fi < filecount && !got_int; ++fi)
7147 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007148 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 if (fd == NULL)
7150 {
7151 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7152 continue;
7153 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007154 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155
7156# ifdef FEAT_MBYTE
7157 firstline = TRUE;
7158# endif
7159 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7160 {
7161# ifdef FEAT_MBYTE
7162 if (firstline)
7163 {
7164 /* Detect utf-8 file by a non-ASCII char in the first line. */
7165 this_utf8 = MAYBE;
7166 for (s = IObuff; *s != NUL; ++s)
7167 if (*s >= 0x80)
7168 {
7169 int l;
7170
7171 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007172 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 if (l == 1)
7174 {
7175 /* Illegal UTF-8 byte sequence. */
7176 this_utf8 = FALSE;
7177 break;
7178 }
7179 s += l - 1;
7180 }
7181 if (this_utf8 == MAYBE) /* only ASCII characters found */
7182 this_utf8 = FALSE;
7183 if (utf8 == MAYBE) /* first file */
7184 utf8 = this_utf8;
7185 else if (utf8 != this_utf8)
7186 {
7187 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7188 mix = !got_int;
7189 got_int = TRUE;
7190 }
7191 firstline = FALSE;
7192 }
7193# endif
7194 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7195 while (p1 != NULL)
7196 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007197 /* Use vim_strbyte() instead of vim_strchr() so that when
7198 * 'encoding' is dbcs it still works, don't find '*' in the
7199 * second byte. */
7200 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7202 {
7203 for (s = p1 + 1; s < p2; ++s)
7204 if (*s == ' ' || *s == '\t' || *s == '|')
7205 break;
7206
7207 /*
7208 * Only accept a *tag* when it consists of valid
7209 * characters, there is white space before it and is
7210 * followed by a white character or end-of-line.
7211 */
7212 if (s == p2
7213 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7214 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7215 || s[1] == '\0'))
7216 {
7217 *p2 = '\0';
7218 ++p1;
7219 if (ga_grow(&ga, 1) == FAIL)
7220 {
7221 got_int = TRUE;
7222 break;
7223 }
7224 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7225 if (s == NULL)
7226 {
7227 got_int = TRUE;
7228 break;
7229 }
7230 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7231 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 sprintf((char *)s, "%s\t%s", p1, fname);
7233
7234 /* find next '*' */
7235 p2 = vim_strchr(p2 + 1, '*');
7236 }
7237 }
7238 p1 = p2;
7239 }
7240 line_breakcheck();
7241 }
7242
7243 fclose(fd);
7244 }
7245
7246 FreeWild(filecount, files);
7247
7248 if (!got_int)
7249 {
7250 /*
7251 * Sort the tags.
7252 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007253 if (ga.ga_data != NULL)
7254 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255
7256 /*
7257 * Check for duplicates.
7258 */
7259 for (i = 1; i < ga.ga_len; ++i)
7260 {
7261 p1 = ((char_u **)ga.ga_data)[i - 1];
7262 p2 = ((char_u **)ga.ga_data)[i];
7263 while (*p1 == *p2)
7264 {
7265 if (*p2 == '\t')
7266 {
7267 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007268 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7270 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7271 EMSG(NameBuff);
7272 *p2 = '\t';
7273 break;
7274 }
7275 ++p1;
7276 ++p2;
7277 }
7278 }
7279
7280# ifdef FEAT_MBYTE
7281 if (utf8 == TRUE)
7282 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7283# endif
7284
7285 /*
7286 * Write the tags into the file.
7287 */
7288 for (i = 0; i < ga.ga_len; ++i)
7289 {
7290 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007291 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007293 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 else
7295 {
7296 fprintf(fd_tags, "%s\t/*", s);
7297 for (p1 = s; *p1 != '\t'; ++p1)
7298 {
7299 /* insert backslash before '\\' and '/' */
7300 if (*p1 == '\\' || *p1 == '/')
7301 putc('\\', fd_tags);
7302 putc(*p1, fd_tags);
7303 }
7304 fprintf(fd_tags, "*\n");
7305 }
7306 }
7307 }
7308#ifdef FEAT_MBYTE
7309 if (mix)
7310 got_int = FALSE; /* continue with other languages */
7311#endif
7312
7313 for (i = 0; i < ga.ga_len; ++i)
7314 vim_free(((char_u **)ga.ga_data)[i]);
7315 ga_clear(&ga);
7316 fclose(fd_tags); /* there is no check for an error... */
7317}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007319/*
7320 * Generate tags in one help directory, taking care of translations.
7321 */
7322 static void
7323do_helptags(char_u *dirname, int add_help_tags)
7324{
7325#ifdef FEAT_MULTI_LANG
7326 int len;
7327 int i, j;
7328 garray_T ga;
7329 char_u lang[2];
7330 char_u ext[5];
7331 char_u fname[8];
7332 int filecount;
7333 char_u **files;
7334
7335 /* Get a list of all files in the help directory and in subdirectories. */
7336 STRCPY(NameBuff, dirname);
7337 add_pathsep(NameBuff);
7338 STRCAT(NameBuff, "**");
7339 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7340 EW_FILE|EW_SILENT) == FAIL
7341 || filecount == 0)
7342 {
Bram Moolenaar5b302912016-08-24 22:11:55 +02007343 EMSG2(_("E151: No match: %s"), NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007344 return;
7345 }
7346
7347 /* Go over all files in the directory to find out what languages are
7348 * present. */
7349 ga_init2(&ga, 1, 10);
7350 for (i = 0; i < filecount; ++i)
7351 {
7352 len = (int)STRLEN(files[i]);
7353 if (len > 4)
7354 {
7355 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7356 {
7357 /* ".txt" -> language "en" */
7358 lang[0] = 'e';
7359 lang[1] = 'n';
7360 }
7361 else if (files[i][len - 4] == '.'
7362 && ASCII_ISALPHA(files[i][len - 3])
7363 && ASCII_ISALPHA(files[i][len - 2])
7364 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7365 {
7366 /* ".abx" -> language "ab" */
7367 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7368 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7369 }
7370 else
7371 continue;
7372
7373 /* Did we find this language already? */
7374 for (j = 0; j < ga.ga_len; j += 2)
7375 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7376 break;
7377 if (j == ga.ga_len)
7378 {
7379 /* New language, add it. */
7380 if (ga_grow(&ga, 2) == FAIL)
7381 break;
7382 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7383 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7384 }
7385 }
7386 }
7387
7388 /*
7389 * Loop over the found languages to generate a tags file for each one.
7390 */
7391 for (j = 0; j < ga.ga_len; j += 2)
7392 {
7393 STRCPY(fname, "tags-xx");
7394 fname[5] = ((char_u *)ga.ga_data)[j];
7395 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7396 if (fname[5] == 'e' && fname[6] == 'n')
7397 {
7398 /* English is an exception: use ".txt" and "tags". */
7399 fname[4] = NUL;
7400 STRCPY(ext, ".txt");
7401 }
7402 else
7403 {
7404 /* Language "ab" uses ".abx" and "tags-ab". */
7405 STRCPY(ext, ".xxx");
7406 ext[1] = fname[5];
7407 ext[2] = fname[6];
7408 }
7409 helptags_one(dirname, ext, fname, add_help_tags);
7410 }
7411
7412 ga_clear(&ga);
7413 FreeWild(filecount, files);
7414
7415#else
7416 /* No language support, just use "*.txt" and "tags". */
7417 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7418#endif
7419}
7420
7421 static void
7422helptags_cb(char_u *fname, void *cookie)
7423{
7424 do_helptags(fname, *(int *)cookie);
7425}
7426
7427/*
7428 * ":helptags"
7429 */
7430 void
7431ex_helptags(exarg_T *eap)
7432{
7433 expand_T xpc;
7434 char_u *dirname;
7435 int add_help_tags = FALSE;
7436
7437 /* Check for ":helptags ++t {dir}". */
Bram Moolenaar1c465442017-03-12 20:10:05 +01007438 if (STRNCMP(eap->arg, "++t", 3) == 0 && VIM_ISWHITE(eap->arg[3]))
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007439 {
7440 add_help_tags = TRUE;
7441 eap->arg = skipwhite(eap->arg + 3);
7442 }
7443
7444 if (STRCMP(eap->arg, "ALL") == 0)
7445 {
7446 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7447 helptags_cb, &add_help_tags);
7448 }
7449 else
7450 {
7451 ExpandInit(&xpc);
7452 xpc.xp_context = EXPAND_DIRECTORIES;
7453 dirname = ExpandOne(&xpc, eap->arg, NULL,
7454 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7455 if (dirname == NULL || !mch_isdir(dirname))
7456 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7457 else
7458 do_helptags(dirname, add_help_tags);
7459 vim_free(dirname);
7460 }
7461}
7462
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463#if defined(FEAT_SIGNS) || defined(PROTO)
7464
7465/*
7466 * Struct to hold the sign properties.
7467 */
7468typedef struct sign sign_T;
7469
7470struct sign
7471{
7472 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007473 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 char_u *sn_name; /* name of sign */
7475 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007476# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007478# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 char_u *sn_text; /* text used instead of pixmap */
7480 int sn_line_hl; /* highlight ID for line */
7481 int sn_text_hl; /* highlight ID for text */
7482};
7483
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007485static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007487static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7488static void sign_list_defined(sign_T *sp);
7489static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007491static char *cmds[] = {
7492 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007493# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007494 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007495# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007496 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007497# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007498 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007499# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007500 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007501# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007502 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007503# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007504 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007505# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007506};
7507
7508/*
7509 * Find index of a ":sign" subcmd from its name.
7510 * "*end_cmd" must be writable.
7511 */
7512 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007513sign_cmd_idx(
7514 char_u *begin_cmd, /* begin of sign subcmd */
7515 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007516{
7517 int idx;
7518 char save = *end_cmd;
7519
7520 *end_cmd = NUL;
7521 for (idx = 0; ; ++idx)
7522 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7523 break;
7524 *end_cmd = save;
7525 return idx;
7526}
7527
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528/*
7529 * ":sign" command
7530 */
7531 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007532ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533{
7534 char_u *arg = eap->arg;
7535 char_u *p;
7536 int idx;
7537 sign_T *sp;
7538 sign_T *sp_prev;
7539 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540
7541 /* Parse the subcommand. */
7542 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007543 idx = sign_cmd_idx(arg, p);
7544 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007546 EMSG2(_("E160: Unknown sign command: %s"), arg);
7547 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 }
7549 arg = skipwhite(p);
7550
7551 if (idx <= SIGNCMD_LIST)
7552 {
7553 /*
7554 * Define, undefine or list signs.
7555 */
7556 if (idx == SIGNCMD_LIST && *arg == NUL)
7557 {
7558 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007559 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 sign_list_defined(sp);
7561 }
7562 else if (*arg == NUL)
7563 EMSG(_("E156: Missing sign name"));
7564 else
7565 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007566 /* Isolate the sign name. If it's a number skip leading zeroes,
7567 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 p = skiptowhite(arg);
7569 if (*p != NUL)
7570 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007571 while (arg[0] == '0' && arg[1] != NUL)
7572 ++arg;
7573
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 sp_prev = NULL;
7575 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7576 {
7577 if (STRCMP(sp->sn_name, arg) == 0)
7578 break;
7579 sp_prev = sp;
7580 }
7581 if (idx == SIGNCMD_DEFINE)
7582 {
7583 /* ":sign define {name} ...": define a sign */
7584 if (sp == NULL)
7585 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007586 sign_T *lp;
7587 int start = next_sign_typenr;
7588
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 /* Allocate a new sign. */
7590 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7591 if (sp == NULL)
7592 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007594 /* Check that next_sign_typenr is not already being used.
7595 * This only happens after wrapping around. Hopefully
7596 * another one got deleted and we can use its number. */
7597 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007599 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007601 ++next_sign_typenr;
7602 if (next_sign_typenr == MAX_TYPENR)
7603 next_sign_typenr = 1;
7604 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007606 vim_free(sp);
7607 EMSG(_("E612: Too many signs defined"));
7608 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007610 lp = first_sign; /* start all over */
7611 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007613 lp = lp->sn_next;
7614 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007616 sp->sn_typenr = next_sign_typenr;
7617 if (++next_sign_typenr == MAX_TYPENR)
7618 next_sign_typenr = 1; /* wrap around */
7619
7620 sp->sn_name = vim_strsave(arg);
7621 if (sp->sn_name == NULL) /* out of memory */
7622 {
7623 vim_free(sp);
7624 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007626
7627 /* add the new sign to the list of signs */
7628 if (sp_prev == NULL)
7629 first_sign = sp;
7630 else
7631 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 }
7633
7634 /* set values for a defined sign. */
7635 for (;;)
7636 {
7637 arg = skipwhite(p);
7638 if (*arg == NUL)
7639 break;
7640 p = skiptowhite_esc(arg);
7641 if (STRNCMP(arg, "icon=", 5) == 0)
7642 {
7643 arg += 5;
7644 vim_free(sp->sn_icon);
7645 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7646 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007647# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 if (gui.in_use)
7649 {
7650 out_flush();
7651 if (sp->sn_image != NULL)
7652 gui_mch_destroy_sign(sp->sn_image);
7653 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7654 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007655# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 }
7657 else if (STRNCMP(arg, "text=", 5) == 0)
7658 {
7659 char_u *s;
7660 int cells;
7661 int len;
7662
7663 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007664# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 /* Count cells and check for non-printable chars */
7666 if (has_mbyte)
7667 {
7668 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007669 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 {
7671 if (!vim_isprintc((*mb_ptr2char)(s)))
7672 break;
7673 cells += (*mb_ptr2cells)(s);
7674 }
7675 }
7676 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007677# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 {
7679 for (s = arg; s < p; ++s)
7680 if (!vim_isprintc(*s))
7681 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007682 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 }
7684 /* Currently must be one or two display cells */
7685 if (s != p || cells < 1 || cells > 2)
7686 {
7687 *p = NUL;
7688 EMSG2(_("E239: Invalid sign text: %s"), arg);
7689 return;
7690 }
7691
7692 vim_free(sp->sn_text);
7693 /* Allocate one byte more if we need to pad up
7694 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007695 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 sp->sn_text = vim_strnsave(arg, len);
7697
7698 if (sp->sn_text != NULL && cells == 1)
7699 STRCPY(sp->sn_text + len - 1, " ");
7700 }
7701 else if (STRNCMP(arg, "linehl=", 7) == 0)
7702 {
7703 arg += 7;
7704 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7705 }
7706 else if (STRNCMP(arg, "texthl=", 7) == 0)
7707 {
7708 arg += 7;
7709 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7710 }
7711 else
7712 {
7713 EMSG2(_(e_invarg2), arg);
7714 return;
7715 }
7716 }
7717 }
7718 else if (sp == NULL)
7719 EMSG2(_("E155: Unknown sign: %s"), arg);
7720 else if (idx == SIGNCMD_LIST)
7721 /* ":sign list {name}" */
7722 sign_list_defined(sp);
7723 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007725 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 }
7727 }
7728 else
7729 {
7730 int id = -1;
7731 linenr_T lnum = -1;
7732 char_u *sign_name = NULL;
7733 char_u *arg1;
7734
7735 if (*arg == NUL)
7736 {
7737 if (idx == SIGNCMD_PLACE)
7738 {
7739 /* ":sign place": list placed signs in all buffers */
7740 sign_list_placed(NULL);
7741 }
7742 else if (idx == SIGNCMD_UNPLACE)
7743 {
7744 /* ":sign unplace": remove placed sign at cursor */
7745 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7746 if (id > 0)
7747 {
7748 buf_delsign(curwin->w_buffer, id);
7749 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7750 }
7751 else
7752 EMSG(_("E159: Missing sign number"));
7753 }
7754 else
7755 EMSG(_(e_argreq));
7756 return;
7757 }
7758
7759 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7760 {
7761 /* ":sign unplace *": remove all placed signs */
7762 buf_delete_all_signs();
7763 return;
7764 }
7765
7766 /* first arg could be placed sign id */
7767 arg1 = arg;
7768 if (VIM_ISDIGIT(*arg))
7769 {
7770 id = getdigits(&arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01007771 if (!VIM_ISWHITE(*arg) && *arg != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 {
7773 id = -1;
7774 arg = arg1;
7775 }
7776 else
7777 {
7778 arg = skipwhite(arg);
7779 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7780 {
7781 /* ":sign unplace {id}": remove placed sign by number */
Bram Moolenaar29323592016-07-24 22:04:11 +02007782 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 if ((lnum = buf_delsign(buf, id)) != 0)
7784 update_debug_sign(buf, lnum);
7785 return;
7786 }
7787 }
7788 }
7789
7790 /*
7791 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7792 * Leave "arg" pointing to {fname}.
7793 */
7794 for (;;)
7795 {
7796 if (STRNCMP(arg, "line=", 5) == 0)
7797 {
7798 arg += 5;
7799 lnum = atoi((char *)arg);
7800 arg = skiptowhite(arg);
7801 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007802 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7803 {
7804 if (id != -1)
7805 {
7806 EMSG(_(e_invarg));
7807 return;
7808 }
7809 id = -2;
7810 arg = skiptowhite(arg + 1);
7811 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 else if (STRNCMP(arg, "name=", 5) == 0)
7813 {
7814 arg += 5;
7815 sign_name = arg;
7816 arg = skiptowhite(arg);
7817 if (*arg != NUL)
7818 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007819 while (sign_name[0] == '0' && sign_name[1] != NUL)
7820 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 }
7822 else if (STRNCMP(arg, "file=", 5) == 0)
7823 {
7824 arg += 5;
7825 buf = buflist_findname(arg);
7826 break;
7827 }
7828 else if (STRNCMP(arg, "buffer=", 7) == 0)
7829 {
7830 arg += 7;
7831 buf = buflist_findnr((int)getdigits(&arg));
7832 if (*skipwhite(arg) != NUL)
7833 EMSG(_(e_trailing));
7834 break;
7835 }
7836 else
7837 {
7838 EMSG(_(e_invarg));
7839 return;
7840 }
7841 arg = skipwhite(arg);
7842 }
7843
7844 if (buf == NULL)
7845 {
7846 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7847 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007848 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 {
7850 if (lnum >= 0 || sign_name != NULL)
7851 EMSG(_(e_invarg));
7852 else
7853 /* ":sign place file={fname}": list placed signs in one file */
7854 sign_list_placed(buf);
7855 }
7856 else if (idx == SIGNCMD_JUMP)
7857 {
7858 /* ":sign jump {id} file={fname}" */
7859 if (lnum >= 0 || sign_name != NULL)
7860 EMSG(_(e_invarg));
7861 else if ((lnum = buf_findsign(buf, id)) > 0)
7862 { /* goto a sign ... */
7863 if (buf_jump_open_win(buf) != NULL)
7864 { /* ... in a current window */
7865 curwin->w_cursor.lnum = lnum;
7866 check_cursor_lnum();
7867 beginline(BL_WHITE);
7868 }
7869 else
7870 { /* ... not currently in a window */
7871 char_u *cmd;
7872
Bram Moolenaarbfd096d2016-08-17 22:29:09 +02007873 if (buf->b_fname == NULL)
7874 {
7875 EMSG(_("E934: Cannot jump to a buffer that does not have a name"));
7876 return;
7877 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7879 if (cmd == NULL)
7880 return;
7881 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7882 do_cmdline_cmd(cmd);
7883 vim_free(cmd);
7884 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007885# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007887# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 }
7889 else
7890 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7891 }
7892 else if (idx == SIGNCMD_UNPLACE)
7893 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 if (lnum >= 0 || sign_name != NULL)
7895 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007896 else if (id == -2)
7897 {
7898 /* ":sign unplace * file={fname}" */
7899 redraw_buf_later(buf, NOT_VALID);
7900 buf_delete_signs(buf);
7901 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 else
7903 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007904 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 lnum = buf_delsign(buf, id);
7906 update_debug_sign(buf, lnum);
7907 }
7908 }
7909 /* idx == SIGNCMD_PLACE */
7910 else if (sign_name != NULL)
7911 {
7912 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7913 if (STRCMP(sp->sn_name, sign_name) == 0)
7914 break;
7915 if (sp == NULL)
7916 {
7917 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7918 return;
7919 }
7920 if (lnum > 0)
7921 /* ":sign place {id} line={lnum} name={name} file={fname}":
7922 * place a sign */
7923 buf_addsign(buf, id, lnum, sp->sn_typenr);
7924 else
7925 /* ":sign place {id} file={fname}": change sign type */
7926 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007927 if (lnum > 0)
7928 update_debug_sign(buf, lnum);
7929 else
7930 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 }
7932 else
7933 EMSG(_(e_invarg));
7934 }
7935}
7936
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007937# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938/*
7939 * Allocate the icons. Called when the GUI has started. Allows defining
7940 * signs before it starts.
7941 */
7942 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007943sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944{
7945 sign_T *sp;
7946
7947 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7948 if (sp->sn_icon != NULL)
7949 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7950}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007951# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952
7953/*
7954 * List one sign.
7955 */
7956 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007957sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958{
7959 char_u *p;
7960
Bram Moolenaar555b2802005-05-19 21:08:39 +00007961 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 if (sp->sn_icon != NULL)
7963 {
7964 MSG_PUTS(" icon=");
7965 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007966# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 if (sp->sn_image == NULL)
7968 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007969# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007971# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 }
7973 if (sp->sn_text != NULL)
7974 {
7975 MSG_PUTS(" text=");
7976 msg_outtrans(sp->sn_text);
7977 }
7978 if (sp->sn_line_hl > 0)
7979 {
7980 MSG_PUTS(" linehl=");
Bram Moolenaarc96272e2017-03-26 13:50:09 +02007981 p = get_highlight_name_ext(NULL, sp->sn_line_hl - 1, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 if (p == NULL)
7983 MSG_PUTS("NONE");
7984 else
7985 msg_puts(p);
7986 }
7987 if (sp->sn_text_hl > 0)
7988 {
7989 MSG_PUTS(" texthl=");
Bram Moolenaarc96272e2017-03-26 13:50:09 +02007990 p = get_highlight_name_ext(NULL, sp->sn_text_hl - 1, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 if (p == NULL)
7992 MSG_PUTS("NONE");
7993 else
7994 msg_puts(p);
7995 }
7996}
7997
7998/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007999 * Undefine a sign and free its memory.
8000 */
8001 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008002sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008003{
8004 vim_free(sp->sn_name);
8005 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008006# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008007 if (sp->sn_image != NULL)
8008 {
8009 out_flush();
8010 gui_mch_destroy_sign(sp->sn_image);
8011 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008012# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008013 vim_free(sp->sn_text);
8014 if (sp_prev == NULL)
8015 first_sign = sp->sn_next;
8016 else
8017 sp_prev->sn_next = sp->sn_next;
8018 vim_free(sp);
8019}
8020
8021/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 * Get highlighting attribute for sign "typenr".
8023 * If "line" is TRUE: line highl, if FALSE: text highl.
8024 */
8025 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008026sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027{
8028 sign_T *sp;
8029
8030 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8031 if (sp->sn_typenr == typenr)
8032 {
8033 if (line)
8034 {
8035 if (sp->sn_line_hl > 0)
8036 return syn_id2attr(sp->sn_line_hl);
8037 }
8038 else
8039 {
8040 if (sp->sn_text_hl > 0)
8041 return syn_id2attr(sp->sn_text_hl);
8042 }
8043 break;
8044 }
8045 return 0;
8046}
8047
8048/*
8049 * Get text mark for sign "typenr".
8050 * Returns NULL if there isn't one.
8051 */
8052 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008053sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054{
8055 sign_T *sp;
8056
8057 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8058 if (sp->sn_typenr == typenr)
8059 return sp->sn_text;
8060 return NULL;
8061}
8062
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008063# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008065sign_get_image(
8066 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067{
8068 sign_T *sp;
8069
8070 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8071 if (sp->sn_typenr == typenr)
8072 return sp->sn_image;
8073 return NULL;
8074}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008075# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008076
8077/*
8078 * Get the name of a sign by its typenr.
8079 */
8080 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008081sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082{
8083 sign_T *sp;
8084
8085 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8086 if (sp->sn_typenr == typenr)
8087 return sp->sn_name;
8088 return (char_u *)_("[Deleted]");
8089}
8090
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008091# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008092/*
8093 * Undefine/free all signs.
8094 */
8095 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008096free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008097{
8098 while (first_sign != NULL)
8099 sign_undefine(first_sign, NULL);
8100}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008101# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008102
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008103# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008104static enum
8105{
8106 EXP_SUBCMD, /* expand :sign sub-commands */
8107 EXP_DEFINE, /* expand :sign define {name} args */
8108 EXP_PLACE, /* expand :sign place {id} args */
8109 EXP_UNPLACE, /* expand :sign unplace" */
8110 EXP_SIGN_NAMES /* expand with name of placed signs */
8111} expand_what;
8112
8113/*
8114 * Function given to ExpandGeneric() to obtain the sign command
8115 * expansion.
8116 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008117 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008118get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008119{
8120 sign_T *sp;
8121 int current_idx;
8122
8123 switch (expand_what)
8124 {
8125 case EXP_SUBCMD:
8126 return (char_u *)cmds[idx];
8127 case EXP_DEFINE:
8128 {
8129 char *define_arg[] =
8130 {
8131 "icon=", "linehl=", "text=", "texthl=", NULL
8132 };
8133 return (char_u *)define_arg[idx];
8134 }
8135 case EXP_PLACE:
8136 {
8137 char *place_arg[] =
8138 {
8139 "line=", "name=", "file=", "buffer=", NULL
8140 };
8141 return (char_u *)place_arg[idx];
8142 }
8143 case EXP_UNPLACE:
8144 {
8145 char *unplace_arg[] = { "file=", "buffer=", NULL };
8146 return (char_u *)unplace_arg[idx];
8147 }
8148 case EXP_SIGN_NAMES:
8149 /* Complete with name of signs already defined */
8150 current_idx = 0;
8151 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8152 if (current_idx++ == idx)
8153 return sp->sn_name;
8154 return NULL;
8155 default:
8156 return NULL;
8157 }
8158}
8159
8160/*
8161 * Handle command line completion for :sign command.
8162 */
8163 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008164set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008165{
8166 char_u *p;
8167 char_u *end_subcmd;
8168 char_u *last;
8169 int cmd_idx;
8170 char_u *begin_subcmd_args;
8171
8172 /* Default: expand subcommands. */
8173 xp->xp_context = EXPAND_SIGN;
8174 expand_what = EXP_SUBCMD;
8175 xp->xp_pattern = arg;
8176
8177 end_subcmd = skiptowhite(arg);
8178 if (*end_subcmd == NUL)
8179 /* expand subcmd name
8180 * :sign {subcmd}<CTRL-D>*/
8181 return;
8182
8183 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8184
8185 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008186 * |
8187 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008188 begin_subcmd_args = skipwhite(end_subcmd);
8189 p = skiptowhite(begin_subcmd_args);
8190 if (*p == NUL)
8191 {
8192 /*
8193 * Expand first argument of subcmd when possible.
8194 * For ":jump {id}" and ":unplace {id}", we could
8195 * possibly expand the ids of all signs already placed.
8196 */
8197 xp->xp_pattern = begin_subcmd_args;
8198 switch (cmd_idx)
8199 {
8200 case SIGNCMD_LIST:
8201 case SIGNCMD_UNDEFINE:
8202 /* :sign list <CTRL-D>
8203 * :sign undefine <CTRL-D> */
8204 expand_what = EXP_SIGN_NAMES;
8205 break;
8206 default:
8207 xp->xp_context = EXPAND_NOTHING;
8208 }
8209 return;
8210 }
8211
8212 /* expand last argument of subcmd */
8213
8214 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008215 * |
8216 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008217
8218 /* Loop until reaching last argument. */
8219 do
8220 {
8221 p = skipwhite(p);
8222 last = p;
8223 p = skiptowhite(p);
8224 } while (*p != NUL);
8225
8226 p = vim_strchr(last, '=');
8227
8228 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008229 * | |
8230 * last p */
Bram Moolenaar7756e742016-10-21 20:35:37 +02008231 if (p == NULL)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008232 {
8233 /* Expand last argument name (before equal sign). */
8234 xp->xp_pattern = last;
8235 switch (cmd_idx)
8236 {
8237 case SIGNCMD_DEFINE:
8238 expand_what = EXP_DEFINE;
8239 break;
8240 case SIGNCMD_PLACE:
8241 expand_what = EXP_PLACE;
8242 break;
8243 case SIGNCMD_JUMP:
8244 case SIGNCMD_UNPLACE:
8245 expand_what = EXP_UNPLACE;
8246 break;
8247 default:
8248 xp->xp_context = EXPAND_NOTHING;
8249 }
8250 }
8251 else
8252 {
8253 /* Expand last argument value (after equal sign). */
8254 xp->xp_pattern = p + 1;
8255 switch (cmd_idx)
8256 {
8257 case SIGNCMD_DEFINE:
8258 if (STRNCMP(last, "texthl", p - last) == 0 ||
8259 STRNCMP(last, "linehl", p - last) == 0)
8260 xp->xp_context = EXPAND_HIGHLIGHT;
8261 else if (STRNCMP(last, "icon", p - last) == 0)
8262 xp->xp_context = EXPAND_FILES;
8263 else
8264 xp->xp_context = EXPAND_NOTHING;
8265 break;
8266 case SIGNCMD_PLACE:
8267 if (STRNCMP(last, "name", p - last) == 0)
8268 expand_what = EXP_SIGN_NAMES;
8269 else
8270 xp->xp_context = EXPAND_NOTHING;
8271 break;
8272 default:
8273 xp->xp_context = EXPAND_NOTHING;
8274 }
8275 }
8276}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008277# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008278#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008279
8280/*
8281 * Make the user happy.
8282 */
8283 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008284ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008285{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008286 static char *code[] = {
8287 "\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$",
8288 "\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"
8289 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008290 char *p;
8291 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008292 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008293
8294 msg_start();
8295 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008296 for (i = 0; i < 2; ++i)
8297 for (p = code[i]; *p != NUL; ++p)
8298 if (*p == 'x')
8299 msg_putchar('\n');
8300 else
8301 for (n = *p++; n > 0; --n)
8302 if (*p == 'o' || *p == '$')
Bram Moolenaar8820b482017-03-16 17:23:31 +01008303 msg_putchar_attr(*p, HL_ATTR(HLF_L));
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008304 else
8305 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008306 msg_clr_eos();
8307}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308
8309#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8310/*
8311 * ":drop"
8312 * Opens the first argument in a window. When there are two or more arguments
8313 * the argument list is redefined.
8314 */
8315 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008316ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317{
8318 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 win_T *wp;
8320 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008321 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322
8323 /*
8324 * Check if the first argument is already being edited in a window. If
8325 * so, jump to that window.
8326 * We would actually need to check all arguments, but that's complicated
8327 * and mostly only one file is dropped.
8328 * This also ignores wildcards, since it is very unlikely the user is
8329 * editing a file name with a wildcard character.
8330 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008331 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008333 /*
8334 * Expanding wildcards may result in an empty argument list. E.g. when
8335 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8336 * already did an error message for this.
8337 */
8338 if (ARGCOUNT == 0)
8339 return;
8340
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008341 if (cmdmod.tab)
8342 {
8343 /* ":tab drop file ...": open a tab for each argument that isn't
8344 * edited in a window yet. It's like ":tab all" but without closing
8345 * windows or tabs. */
8346 ex_all(eap);
8347 }
8348 else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008349 {
8350 /* ":drop file ...": Edit the first argument. Jump to an existing
8351 * window if possible, edit in current window if the current buffer
8352 * can be abandoned, otherwise open a new window. */
8353 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8354
8355 FOR_ALL_TAB_WINDOWS(tp, wp)
8356 {
8357 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008359 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 return;
8362 }
8363 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008365 /*
8366 * Check whether the current buffer is changed. If so, we will need
8367 * to split the current window or data could be lost.
8368 * Skip the check if the 'hidden' option is set, as in this case the
8369 * buffer won't be lost.
8370 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02008371 if (!buf_hide(curbuf))
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008372 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008373 ++emsg_off;
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008374 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008375 --emsg_off;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008376 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008378 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8379 if (split)
8380 {
8381 eap->cmdidx = CMD_sfirst;
8382 eap->cmd[0] = 's';
8383 }
8384 else
8385 eap->cmdidx = CMD_first;
8386 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388}
8389#endif
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008390
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008391/*
8392 * Skip over the pattern argument of ":vimgrep /pat/[g][j]".
8393 * Put the start of the pattern in "*s", unless "s" is NULL.
8394 * If "flags" is not NULL put the flags in it: VGR_GLOBAL, VGR_NOJUMP.
8395 * If "s" is not NULL terminate the pattern with a NUL.
8396 * Return a pointer to the char just past the pattern plus flags.
8397 */
8398 char_u *
8399skip_vimgrep_pat(char_u *p, char_u **s, int *flags)
8400{
8401 int c;
8402
8403 if (vim_isIDc(*p))
8404 {
8405 /* ":vimgrep pattern fname" */
8406 if (s != NULL)
8407 *s = p;
8408 p = skiptowhite(p);
8409 if (s != NULL && *p != NUL)
8410 *p++ = NUL;
8411 }
8412 else
8413 {
8414 /* ":vimgrep /pattern/[g][j] fname" */
8415 if (s != NULL)
8416 *s = p + 1;
8417 c = *p;
8418 p = skip_regexp(p + 1, c, TRUE, NULL);
8419 if (*p != c)
8420 return NULL;
8421
8422 /* Truncate the pattern. */
8423 if (s != NULL)
8424 *p = NUL;
8425 ++p;
8426
8427 /* Find the flags */
8428 while (*p == 'g' || *p == 'j')
8429 {
8430 if (flags != NULL)
8431 {
8432 if (*p == 'g')
8433 *flags |= VGR_GLOBAL;
8434 else
8435 *flags |= VGR_NOJUMP;
8436 }
8437 ++p;
8438 }
8439 }
8440 return p;
8441}
Bram Moolenaar9baf2972016-08-21 22:39:35 +02008442
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008443#if defined(FEAT_EVAL) || defined(PROTO)
8444/*
8445 * List v:oldfiles in a nice way.
8446 */
8447 void
8448ex_oldfiles(exarg_T *eap UNUSED)
8449{
8450 list_T *l = get_vim_var_list(VV_OLDFILES);
8451 listitem_T *li;
8452 int nr = 0;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008453 char_u *fname;
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008454
8455 if (l == NULL)
8456 msg((char_u *)_("No old files"));
8457 else
8458 {
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008459 msg_start();
8460 msg_scroll = TRUE;
8461 for (li = l->lv_first; li != NULL && !got_int; li = li->li_next)
8462 {
8463 ++nr;
8464 fname = get_tv_string(&li->li_tv);
Bram Moolenaard6f2ee32016-08-24 00:30:52 +02008465 if (!message_filtered(fname))
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008466 {
8467 msg_outnum((long)nr);
8468 MSG_PUTS(": ");
8469 msg_outtrans(fname);
Bram Moolenaar885c00e2016-08-28 17:08:17 +02008470 msg_clr_eos();
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008471 msg_putchar('\n');
8472 out_flush(); /* output one line at a time */
8473 ui_breakcheck();
8474 }
8475 }
Bram Moolenaare11d61a2016-08-20 18:36:54 +02008476
8477 /* Assume "got_int" was set to truncate the listing. */
8478 got_int = FALSE;
8479
8480# ifdef FEAT_BROWSE_CMD
8481 if (cmdmod.browse)
8482 {
8483 quit_more = FALSE;
8484 nr = prompt_for_number(FALSE);
8485 msg_starthere();
8486 if (nr > 0)
8487 {
8488 char_u *p = list_find_str(get_vim_var_list(VV_OLDFILES),
8489 (long)nr);
8490
8491 if (p != NULL)
8492 {
8493 p = expand_env_save(p);
8494 eap->arg = p;
8495 eap->cmdidx = CMD_edit;
8496 cmdmod.browse = FALSE;
8497 do_exedit(eap, NULL);
8498 vim_free(p);
8499 }
8500 }
8501 }
8502# endif
8503 }
8504}
8505#endif