blob: aff2bddcae27ecf1e28aeb853ae954fd9027aa01 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds.c: some functions for command line commands
12 */
13
Bram Moolenaar8c8de832008-06-24 22:58:06 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaar17576a12016-01-20 20:05:44 +010017#ifdef FEAT_FLOAT
18# include <float.h>
19#endif
20
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010021static int linelen(int *has_tab);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010022static void do_filter(linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +000023#ifdef FEAT_VIMINFO
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010024static char_u *viminfo_filename(char_u *);
25static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags);
26static int viminfo_encoding(vir_T *virp);
27static int read_viminfo_up_to_marks(vir_T *virp, int forceit, int writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +000028#endif
29
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010030static int check_readonly(int *forceit, buf_T *buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +000031#ifdef FEAT_AUTOCMD
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010032static void delbuf_msg(char_u *name);
Bram Moolenaar071d4272004-06-13 20:20:40 +000033#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000034static int
35#ifdef __BORLANDC__
36 _RTLENTRYF
37#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010038 help_compare(const void *s1, const void *s2);
39static void prepare_help_buffer(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +000040
41/*
42 * ":ascii" and "ga".
43 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010045do_ascii(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +000046{
47 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000048 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000049 char buf1[20];
50 char buf2[20];
51 char_u buf3[7];
52#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000053 int cc[MAX_MCO];
54 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 int len;
56
57 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000058 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000059 else
60#endif
61 c = gchar_cursor();
62 if (c == NUL)
63 {
64 MSG("NUL");
65 return;
66 }
67
68#ifdef FEAT_MBYTE
69 IObuff[0] = NUL;
70 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
71#endif
72 {
73 if (c == NL) /* NUL is stored as NL */
74 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000075 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
76 cval = NL; /* NL is stored as CR */
77 else
78 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 if (vim_isprintc_strict(c) && (c < ' '
80#ifndef EBCDIC
81 || c > '~'
82#endif
83 ))
84 {
85 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000086 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 }
88 else
89 buf1[0] = NUL;
90#ifndef EBCDIC
91 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000092 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
93 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 else
95#endif
96 buf2[0] = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +000097 vim_snprintf((char *)IObuff, IOSIZE,
98 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000099 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000101 if (enc_utf8)
102 c = cc[ci++];
103 else
104 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105#endif
106 }
107
108#ifdef FEAT_MBYTE
109 /* Repeat for combining characters. */
110 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
111 {
112 len = (int)STRLEN(IObuff);
113 /* This assumes every multi-byte char is printable... */
114 if (len > 0)
115 IObuff[len++] = ' ';
116 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000117 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000118# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000120# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 )
122 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000123 len += (*mb_char2bytes)(c, IObuff + len);
124 vim_snprintf((char *)IObuff + len, IOSIZE - len,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
126 : _("> %d, Hex %08x, Octal %o"), c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000127 if (ci == MAX_MCO)
128 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000129 if (enc_utf8)
130 c = cc[ci++];
131 else
132 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 }
134#endif
135
136 msg(IObuff);
137}
138
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139/*
140 * ":left", ":center" and ":right": align text.
141 */
142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100143ex_align(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144{
145 pos_T save_curpos;
146 int len;
147 int indent = 0;
148 int new_indent;
149 int has_tab;
150 int width;
151
152#ifdef FEAT_RIGHTLEFT
153 if (curwin->w_p_rl)
154 {
155 /* switch left and right aligning */
156 if (eap->cmdidx == CMD_right)
157 eap->cmdidx = CMD_left;
158 else if (eap->cmdidx == CMD_left)
159 eap->cmdidx = CMD_right;
160 }
161#endif
162
163 width = atoi((char *)eap->arg);
164 save_curpos = curwin->w_cursor;
165 if (eap->cmdidx == CMD_left) /* width is used for new indent */
166 {
167 if (width >= 0)
168 indent = width;
169 }
170 else
171 {
172 /*
173 * if 'textwidth' set, use it
174 * else if 'wrapmargin' set, use it
175 * if invalid value, use 80
176 */
177 if (width <= 0)
178 width = curbuf->b_p_tw;
179 if (width == 0 && curbuf->b_p_wm > 0)
180 width = W_WIDTH(curwin) - curbuf->b_p_wm;
181 if (width <= 0)
182 width = 80;
183 }
184
185 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
186 return;
187
188 for (curwin->w_cursor.lnum = eap->line1;
189 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
190 {
191 if (eap->cmdidx == CMD_left) /* left align */
192 new_indent = indent;
193 else
194 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000195 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196 len = linelen(eap->cmdidx == CMD_right ? &has_tab
197 : NULL) - get_indent();
198
199 if (len <= 0) /* skip blank lines */
200 continue;
201
202 if (eap->cmdidx == CMD_center)
203 new_indent = (width - len) / 2;
204 else
205 {
206 new_indent = width - len; /* right align */
207
208 /*
209 * Make sure that embedded TABs don't make the text go too far
210 * to the right.
211 */
212 if (has_tab)
213 while (new_indent > 0)
214 {
215 (void)set_indent(new_indent, 0);
216 if (linelen(NULL) <= width)
217 {
218 /*
219 * Now try to move the line as much as possible to
220 * the right. Stop when it moves too far.
221 */
222 do
223 (void)set_indent(++new_indent, 0);
224 while (linelen(NULL) <= width);
225 --new_indent;
226 break;
227 }
228 --new_indent;
229 }
230 }
231 }
232 if (new_indent < 0)
233 new_indent = 0;
234 (void)set_indent(new_indent, 0); /* set indent */
235 }
236 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
237 curwin->w_cursor = save_curpos;
238 beginline(BL_WHITE | BL_FIX);
239}
240
241/*
242 * Get the length of the current line, excluding trailing white space.
243 */
244 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100245linelen(int *has_tab)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246{
247 char_u *line;
248 char_u *first;
249 char_u *last;
250 int save;
251 int len;
252
253 /* find the first non-blank character */
254 line = ml_get_curline();
255 first = skipwhite(line);
256
257 /* find the character after the last non-blank character */
258 for (last = first + STRLEN(first);
259 last > first && vim_iswhite(last[-1]); --last)
260 ;
261 save = *last;
262 *last = NUL;
263 len = linetabsize(line); /* get line length */
264 if (has_tab != NULL) /* check for embedded TAB */
265 *has_tab = (vim_strrchr(first, TAB) != NULL);
266 *last = save;
267
268 return len;
269}
270
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000271/* Buffer for two lines used during sorting. They are allocated to
272 * contain the longest line being sorted. */
273static char_u *sortbuf1;
274static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000275
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100276static int sort_ic; /* ignore case */
277static int sort_nr; /* sort on number */
278static int sort_rx; /* sort on regex instead of skipping it */
279#ifdef FEAT_FLOAT
280static int sort_flt; /* sort on floating number */
281#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000282
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100283static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000284
285/* Struct to store info to be sorted. */
286typedef struct
287{
288 linenr_T lnum; /* line number */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100289 union {
290 struct
291 {
292 long start_col_nr; /* starting column number */
293 long end_col_nr; /* ending column number */
294 } line;
295 long value; /* value if sorting by integer */
296#ifdef FEAT_FLOAT
297 float_T value_flt; /* value if sorting by float */
298#endif
299 } st_u;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000300} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000301
302static int
303#ifdef __BORLANDC__
304_RTLENTRYF
305#endif
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100306sort_compare(const void *s1, const void *s2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000307
308 static int
309#ifdef __BORLANDC__
310_RTLENTRYF
311#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100312sort_compare(const void *s1, const void *s2)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000313{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000314 sorti_T l1 = *(sorti_T *)s1;
315 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000316 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000317
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000318 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000319 * if we return 0 every time, qsort will assume it's done sorting and
320 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000321 if (sort_abort)
322 return 0;
323 fast_breakcheck();
324 if (got_int)
325 sort_abort = TRUE;
326
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000327 /* When sorting numbers "start_col_nr" is the number, not the column
328 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000329 if (sort_nr)
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100330 result = l1.st_u.value == l2.st_u.value ? 0
331 : l1.st_u.value > l2.st_u.value ? 1 : -1;
332#ifdef FEAT_FLOAT
333 else if (sort_flt)
334 result = l1.st_u.value_flt == l2.st_u.value_flt ? 0
335 : l1.st_u.value_flt > l2.st_u.value_flt ? 1 : -1;
336#endif
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 else
338 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000339 /* We need to copy one line into "sortbuf1", because there is no
340 * guarantee that the first pointer becomes invalid when obtaining the
341 * second one. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100342 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.st_u.line.start_col_nr,
343 l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr + 1);
344 sortbuf1[l1.st_u.line.end_col_nr - l1.st_u.line.start_col_nr] = 0;
345 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.st_u.line.start_col_nr,
346 l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr + 1);
347 sortbuf2[l2.st_u.line.end_col_nr - l2.st_u.line.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000348
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000349 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
350 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000351 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000352
353 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000354 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000355 return (int)(l1.lnum - l2.lnum);
356 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000357}
358
359/*
360 * ":sort".
361 */
362 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100363ex_sort(exarg_T *eap)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000364{
365 regmatch_T regmatch;
366 int len;
367 linenr_T lnum;
368 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000369 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000370 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000371 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000372 char_u *p;
373 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000374 char_u *s2;
375 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000376 int unique = FALSE;
377 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000378 colnr_T start_col;
379 colnr_T end_col;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100380 int sort_what = 0;
381 int format_found = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382
Bram Moolenaar48c99162008-02-18 18:42:52 +0000383 /* Sorting one line is really quick! */
384 if (count <= 1)
385 return;
386
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000387 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
388 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000389 sortbuf1 = NULL;
390 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000391 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000392 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000393 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000394 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000395
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100396 sort_abort = sort_ic = sort_rx = sort_nr = 0;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100397#ifdef FEAT_FLOAT
398 sort_flt = 0;
399#endif
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000400
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000401 for (p = eap->arg; *p != NUL; ++p)
402 {
403 if (vim_iswhite(*p))
404 ;
405 else if (*p == 'i')
406 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000407 else if (*p == 'r')
408 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000409 else if (*p == 'n')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100410 {
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100411 sort_nr = 1;
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100412 ++format_found;
413 }
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100414#ifdef FEAT_FLOAT
415 else if (*p == 'f')
416 {
417 sort_flt = 1;
418 ++format_found;
419 }
420#endif
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100421 else if (*p == 'b')
422 {
423 sort_what = STR2NR_BIN + STR2NR_FORCE;
424 ++format_found;
425 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000426 else if (*p == 'o')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100427 {
428 sort_what = STR2NR_OCT + STR2NR_FORCE;
429 ++format_found;
430 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000431 else if (*p == 'x')
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100432 {
433 sort_what = STR2NR_HEX + STR2NR_FORCE;
434 ++format_found;
435 }
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000436 else if (*p == 'u')
437 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000438 else if (*p == '"') /* comment start */
439 break;
440 else if (check_nextcmd(p) != NULL)
441 {
442 eap->nextcmd = check_nextcmd(p);
443 break;
444 }
445 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000446 {
447 s = skip_regexp(p + 1, *p, TRUE, NULL);
448 if (*s != *p)
449 {
450 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000451 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000452 }
453 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000454 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100455 if (s == p + 1)
456 {
457 if (last_search_pat() == NULL)
458 {
459 EMSG(_(e_noprevre));
460 goto sortend;
461 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000462 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100463 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000464 else
465 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000466 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000467 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000468 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000469 regmatch.rm_ic = p_ic;
470 }
471 else
472 {
473 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000475 }
476 }
477
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100478 /* Can only have one of 'n', 'b', 'o' and 'x'. */
479 if (format_found > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000480 {
481 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000482 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000483 }
484
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100485 /* From here on "sort_nr" is used as a flag for any integer number
486 * sorting. */
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100487 sort_nr += sort_what;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000488
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000489 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000491 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000492 * When sorting on strings "start_col_nr" is the offset in the line, for
493 * numbers sorting it's the number to sort on. This means the pattern
494 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000495 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000496 */
497 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
498 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000499 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000500 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000501 if (maxlen < len)
502 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000503
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000504 start_col = 0;
505 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000506 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000507 {
508 if (sort_rx)
509 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000510 start_col = (colnr_T)(regmatch.startp[0] - s);
511 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000512 }
513 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000514 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000515 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000516 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000517 if (regmatch.regprog != NULL)
518 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000519
Bram Moolenaar937204a2016-01-30 23:37:38 +0100520 if (sort_nr
521#ifdef FEAT_FLOAT
522 || sort_flt
523#endif
524 )
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000525 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000526 /* Make sure vim_str2nr doesn't read any digits past the end
527 * of the match, by temporarily terminating the string there */
528 s2 = s + end_col;
529 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200530 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000531 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000532 p = s + start_col;
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100533 if (sort_nr)
534 {
535 if (sort_what & STR2NR_HEX)
536 s = skiptohex(p);
537 else if (sort_what & STR2NR_BIN)
538 s = skiptobin(p);
539 else
540 s = skiptodigit(p);
541 if (s > p && s[-1] == '-')
542 --s; /* include preceding negative sign */
543 if (*s == NUL)
544 /* empty line should sort before any number */
545 nrs[lnum - eap->line1].st_u.value = -MAXLNUM;
546 else
547 vim_str2nr(s, NULL, NULL, sort_what,
548 &nrs[lnum - eap->line1].st_u.value, NULL, 0);
549 }
550#ifdef FEAT_FLOAT
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000551 else
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100552 {
553 s = skipwhite(p);
554 if (*s == '+')
555 s = skipwhite(s + 1);
556
557 if (*s == NUL)
558 /* empty line should sort before any number */
559 nrs[lnum - eap->line1].st_u.value_flt = -DBL_MAX;
560 else
561 nrs[lnum - eap->line1].st_u.value_flt =
562 strtod((char *)s, NULL);
563 }
564#endif
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200565 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000566 }
567 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000568 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000569 /* Store the column to sort at. */
Bram Moolenaarf7edf402016-01-19 23:36:15 +0100570 nrs[lnum - eap->line1].st_u.line.start_col_nr = start_col;
571 nrs[lnum - eap->line1].st_u.line.end_col_nr = end_col;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000572 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000573
574 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000575
576 if (regmatch.regprog != NULL)
577 fast_breakcheck();
578 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000579 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000580 }
581
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000582 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000583 sortbuf1 = alloc((unsigned)maxlen + 1);
584 if (sortbuf1 == NULL)
585 goto sortend;
586 sortbuf2 = alloc((unsigned)maxlen + 1);
587 if (sortbuf2 == NULL)
588 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000589
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000590 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000591 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000592
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000593 if (sort_abort)
594 goto sortend;
595
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000596 /* Insert the lines in the sorted order below the last one. */
597 lnum = eap->line2;
598 for (i = 0; i < count; ++i)
599 {
600 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
601 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000602 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000603 {
Bram Moolenaar75e3ad02015-12-17 15:07:32 +0100604 /* Copy the line into a buffer, it may become invalid in
605 * ml_append(). And it's needed for "unique". */
606 STRCPY(sortbuf1, s);
607 if (ml_append(lnum++, sortbuf1, (colnr_T)0, FALSE) == FAIL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000608 break;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000609 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000610 fast_breakcheck();
611 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000612 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000613 }
614
615 /* delete the original lines if appending worked */
616 if (i == count)
617 for (i = 0; i < count; ++i)
618 ml_delete(eap->line1, FALSE);
619 else
620 count = 0;
621
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000622 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000623 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000624 if (deleted > 0)
625 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
626 else if (deleted < 0)
627 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
628 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000629
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000630 curwin->w_cursor.lnum = eap->line1;
631 beginline(BL_WHITE | BL_FIX);
632
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000633sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000634 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000635 vim_free(sortbuf1);
636 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200637 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000638 if (got_int)
639 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000640}
641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642/*
643 * ":retab".
644 */
645 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100646ex_retab(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647{
648 linenr_T lnum;
649 int got_tab = FALSE;
650 long num_spaces = 0;
651 long num_tabs;
652 long len;
653 long col;
654 long vcol;
655 long start_col = 0; /* For start of white-space string */
656 long start_vcol = 0; /* For start of white-space string */
657 int temp;
658 long old_len;
659 char_u *ptr;
660 char_u *new_line = (char_u *)1; /* init to non-NULL */
661 int did_undo; /* called u_save for current line */
662 int new_ts;
663 int save_list;
664 linenr_T first_line = 0; /* first changed line */
665 linenr_T last_line = 0; /* last changed line */
666
667 save_list = curwin->w_p_list;
668 curwin->w_p_list = 0; /* don't want list mode here */
669
670 new_ts = getdigits(&(eap->arg));
671 if (new_ts < 0)
672 {
673 EMSG(_(e_positive));
674 return;
675 }
676 if (new_ts == 0)
677 new_ts = curbuf->b_p_ts;
678 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
679 {
680 ptr = ml_get(lnum);
681 col = 0;
682 vcol = 0;
683 did_undo = FALSE;
684 for (;;)
685 {
686 if (vim_iswhite(ptr[col]))
687 {
688 if (!got_tab && num_spaces == 0)
689 {
690 /* First consecutive white-space */
691 start_vcol = vcol;
692 start_col = col;
693 }
694 if (ptr[col] == ' ')
695 num_spaces++;
696 else
697 got_tab = TRUE;
698 }
699 else
700 {
701 if (got_tab || (eap->forceit && num_spaces > 1))
702 {
703 /* Retabulate this string of white-space */
704
705 /* len is virtual length of white string */
706 len = num_spaces = vcol - start_vcol;
707 num_tabs = 0;
708 if (!curbuf->b_p_et)
709 {
710 temp = new_ts - (start_vcol % new_ts);
711 if (num_spaces >= temp)
712 {
713 num_spaces -= temp;
714 num_tabs++;
715 }
716 num_tabs += num_spaces / new_ts;
717 num_spaces -= (num_spaces / new_ts) * new_ts;
718 }
719 if (curbuf->b_p_et || got_tab ||
720 (num_spaces + num_tabs < len))
721 {
722 if (did_undo == FALSE)
723 {
724 did_undo = TRUE;
725 if (u_save((linenr_T)(lnum - 1),
726 (linenr_T)(lnum + 1)) == FAIL)
727 {
728 new_line = NULL; /* flag out-of-memory */
729 break;
730 }
731 }
732
733 /* len is actual number of white characters used */
734 len = num_spaces + num_tabs;
735 old_len = (long)STRLEN(ptr);
736 new_line = lalloc(old_len - col + start_col + len + 1,
737 TRUE);
738 if (new_line == NULL)
739 break;
740 if (start_col > 0)
741 mch_memmove(new_line, ptr, (size_t)start_col);
742 mch_memmove(new_line + start_col + len,
743 ptr + col, (size_t)(old_len - col + 1));
744 ptr = new_line + start_col;
745 for (col = 0; col < len; col++)
746 ptr[col] = (col < num_tabs) ? '\t' : ' ';
747 ml_replace(lnum, new_line, FALSE);
748 if (first_line == 0)
749 first_line = lnum;
750 last_line = lnum;
751 ptr = new_line;
752 col = start_col + len;
753 }
754 }
755 got_tab = FALSE;
756 num_spaces = 0;
757 }
758 if (ptr[col] == NUL)
759 break;
760 vcol += chartabsize(ptr + col, (colnr_T)vcol);
761#ifdef FEAT_MBYTE
762 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000763 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 else
765#endif
766 ++col;
767 }
768 if (new_line == NULL) /* out of memory */
769 break;
770 line_breakcheck();
771 }
772 if (got_int)
773 EMSG(_(e_interr));
774
775 if (curbuf->b_p_ts != new_ts)
776 redraw_curbuf_later(NOT_VALID);
777 if (first_line != 0)
778 changed_lines(first_line, 0, last_line + 1, 0L);
779
780 curwin->w_p_list = save_list; /* restore 'list' */
781
782 curbuf->b_p_ts = new_ts;
783 coladvance(curwin->w_curswant);
784
785 u_clearline();
786}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788/*
789 * :move command - move lines line1-line2 to line dest
790 *
791 * return FAIL for failure, OK otherwise
792 */
793 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100794do_move(linenr_T line1, linenr_T line2, linenr_T dest)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795{
796 char_u *str;
797 linenr_T l;
798 linenr_T extra; /* Num lines added before line1 */
799 linenr_T num_lines; /* Num lines moved */
800 linenr_T last_line; /* Last line in file after adding new text */
Bram Moolenaard5f69332015-04-15 12:43:50 +0200801#ifdef FEAT_FOLDING
802 int isFolded;
803
804 /* Moving lines seems to corrupt the folds, delete folding info now
805 * and recreate it when finished. Don't do this for manual folding, it
806 * would delete all folds. */
807 isFolded = hasAnyFolding(curwin) && !foldmethodIsManual(curwin);
808 if (isFolded)
809 deleteFoldRecurse(&curwin->w_folds);
810#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812 if (dest >= line1 && dest < line2)
813 {
814 EMSG(_("E134: Move lines into themselves"));
815 return FAIL;
816 }
817
818 num_lines = line2 - line1 + 1;
819
820 /*
821 * First we copy the old text to its new location -- webb
822 * Also copy the flag that ":global" command uses.
823 */
824 if (u_save(dest, dest + 1) == FAIL)
825 return FAIL;
826 for (extra = 0, l = line1; l <= line2; l++)
827 {
828 str = vim_strsave(ml_get(l + extra));
829 if (str != NULL)
830 {
831 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
832 vim_free(str);
833 if (dest < line1)
834 extra++;
835 }
836 }
837
838 /*
839 * Now we must be careful adjusting our marks so that we don't overlap our
840 * mark_adjust() calls.
841 *
842 * We adjust the marks within the old text so that they refer to the
843 * last lines of the file (temporarily), because we know no other marks
844 * will be set there since these line numbers did not exist until we added
845 * our new lines.
846 *
847 * Then we adjust the marks on lines between the old and new text positions
848 * (either forwards or backwards).
849 *
850 * And Finally we adjust the marks we put at the end of the file back to
851 * their final destination at the new text position -- webb
852 */
853 last_line = curbuf->b_ml.ml_line_count;
854 mark_adjust(line1, line2, last_line - line2, 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200855 changed_lines(last_line - num_lines + 1, 0, last_line + 1, num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 if (dest >= line2)
857 {
858 mark_adjust(line2 + 1, dest, -num_lines, 0L);
859 curbuf->b_op_start.lnum = dest - num_lines + 1;
860 curbuf->b_op_end.lnum = dest;
861 }
862 else
863 {
864 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
865 curbuf->b_op_start.lnum = dest + 1;
866 curbuf->b_op_end.lnum = dest + num_lines;
867 }
868 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
869 mark_adjust(last_line - num_lines + 1, last_line,
870 -(last_line - dest - extra), 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200871 changed_lines(last_line - num_lines + 1, 0, last_line + 1, -extra);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 /*
874 * Now we delete the original text -- webb
875 */
876 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
877 return FAIL;
878
879 for (l = line1; l <= line2; l++)
880 ml_delete(line1 + extra, TRUE);
881
882 if (!global_busy && num_lines > p_report)
883 {
884 if (num_lines == 1)
885 MSG(_("1 line moved"));
886 else
887 smsg((char_u *)_("%ld lines moved"), num_lines);
888 }
889
890 /*
891 * Leave the cursor on the last of the moved lines.
892 */
893 if (dest >= line1)
894 curwin->w_cursor.lnum = dest;
895 else
896 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
897
898 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100899 {
900 dest += num_lines + 1;
901 last_line = curbuf->b_ml.ml_line_count;
902 if (dest > last_line + 1)
903 dest = last_line + 1;
904 changed_lines(line1, 0, dest, 0L);
905 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 else
907 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
908
Bram Moolenaard5f69332015-04-15 12:43:50 +0200909#ifdef FEAT_FOLDING
910 /* recreate folds */
911 if (isFolded)
912 foldUpdateAll(curwin);
913#endif
914
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 return OK;
916}
917
918/*
919 * ":copy"
920 */
921 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100922ex_copy(linenr_T line1, linenr_T line2, linenr_T n)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923{
924 linenr_T count;
925 char_u *p;
926
927 count = line2 - line1 + 1;
928 curbuf->b_op_start.lnum = n + 1;
929 curbuf->b_op_end.lnum = n + count;
930 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
931
932 /*
933 * there are three situations:
934 * 1. destination is above line1
935 * 2. destination is between line1 and line2
936 * 3. destination is below line2
937 *
938 * n = destination (when starting)
939 * curwin->w_cursor.lnum = destination (while copying)
940 * line1 = start of source (while copying)
941 * line2 = end of source (while copying)
942 */
943 if (u_save(n, n + 1) == FAIL)
944 return;
945
946 curwin->w_cursor.lnum = n;
947 while (line1 <= line2)
948 {
949 /* need to use vim_strsave() because the line will be unlocked within
950 * ml_append() */
951 p = vim_strsave(ml_get(line1));
952 if (p != NULL)
953 {
954 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
955 vim_free(p);
956 }
957 /* situation 2: skip already copied lines */
958 if (line1 == n)
959 line1 = curwin->w_cursor.lnum;
960 ++line1;
961 if (curwin->w_cursor.lnum < line1)
962 ++line1;
963 if (curwin->w_cursor.lnum < line2)
964 ++line2;
965 ++curwin->w_cursor.lnum;
966 }
967
968 appended_lines_mark(n, count);
969
970 msgmore((long)count);
971}
972
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000973static char_u *prevcmd = NULL; /* the previous command */
974
975#if defined(EXITFREE) || defined(PROTO)
976 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100977free_prev_shellcmd(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000978{
979 vim_free(prevcmd);
980}
981#endif
982
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983/*
984 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
985 * Bangs in the argument are replaced with the previously entered command.
986 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 */
988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100989do_bang(
990 int addr_count,
991 exarg_T *eap,
992 int forceit,
993 int do_in,
994 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995{
996 char_u *arg = eap->arg; /* command */
997 linenr_T line1 = eap->line1; /* start of range */
998 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 char_u *newcmd = NULL; /* the new command */
1000 int free_newcmd = FALSE; /* need to free() newcmd */
1001 int ins_prevcmd;
1002 char_u *t;
1003 char_u *p;
1004 char_u *trailarg;
1005 int len;
1006 int scroll_save = msg_scroll;
1007
1008 /*
1009 * Disallow shell commands for "rvim".
1010 * Disallow shell commands from .exrc and .vimrc in current directory for
1011 * security reasons.
1012 */
1013 if (check_restricted() || check_secure())
1014 return;
1015
1016 if (addr_count == 0) /* :! */
1017 {
1018 msg_scroll = FALSE; /* don't scroll here */
1019 autowrite_all();
1020 msg_scroll = scroll_save;
1021 }
1022
1023 /*
1024 * Try to find an embedded bang, like in :!<cmd> ! [args]
1025 * (:!! is indicated by the 'forceit' variable)
1026 */
1027 ins_prevcmd = forceit;
1028 trailarg = arg;
1029 do
1030 {
1031 len = (int)STRLEN(trailarg) + 1;
1032 if (newcmd != NULL)
1033 len += (int)STRLEN(newcmd);
1034 if (ins_prevcmd)
1035 {
1036 if (prevcmd == NULL)
1037 {
1038 EMSG(_(e_noprev));
1039 vim_free(newcmd);
1040 return;
1041 }
1042 len += (int)STRLEN(prevcmd);
1043 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001044 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 {
1046 vim_free(newcmd);
1047 return;
1048 }
1049 *t = NUL;
1050 if (newcmd != NULL)
1051 STRCAT(t, newcmd);
1052 if (ins_prevcmd)
1053 STRCAT(t, prevcmd);
1054 p = t + STRLEN(t);
1055 STRCAT(t, trailarg);
1056 vim_free(newcmd);
1057 newcmd = t;
1058
1059 /*
1060 * Scan the rest of the argument for '!', which is replaced by the
1061 * previous command. "\!" is replaced by "!" (this is vi compatible).
1062 */
1063 trailarg = NULL;
1064 while (*p)
1065 {
Bram Moolenaare60acc12011-05-10 16:41:25 +02001066 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 {
1068 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +00001069 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 else
1071 {
1072 trailarg = p;
1073 *trailarg++ = NUL;
1074 ins_prevcmd = TRUE;
1075 break;
1076 }
1077 }
1078 ++p;
1079 }
1080 } while (trailarg != NULL);
1081
1082 vim_free(prevcmd);
1083 prevcmd = newcmd;
1084
1085 if (bangredo) /* put cmd in redo buffer for ! command */
1086 {
Bram Moolenaar529d2d62014-03-19 17:41:23 +01001087 /* If % or # appears in the command, it must have been escaped.
1088 * Reescape them, so that redoing them does not substitute them by the
1089 * buffername. */
1090 char_u *cmd = vim_strsave_escaped(prevcmd, (char_u *)"%#");
1091
1092 if (cmd != NULL)
1093 {
1094 AppendToRedobuffLit(cmd, -1);
1095 vim_free(cmd);
1096 }
1097 else
1098 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 AppendToRedobuff((char_u *)"\n");
1100 bangredo = FALSE;
1101 }
1102 /*
1103 * Add quotes around the command, for shells that need them.
1104 */
1105 if (*p_shq != NUL)
1106 {
1107 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1108 if (newcmd == NULL)
1109 return;
1110 STRCPY(newcmd, p_shq);
1111 STRCAT(newcmd, prevcmd);
1112 STRCAT(newcmd, p_shq);
1113 free_newcmd = TRUE;
1114 }
1115 if (addr_count == 0) /* :! */
1116 {
1117 /* echo the command */
1118 msg_start();
1119 msg_putchar(':');
1120 msg_putchar('!');
1121 msg_outtrans(newcmd);
1122 msg_clr_eos();
1123 windgoto(msg_row, msg_col);
1124
1125 do_shell(newcmd, 0);
1126 }
1127 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001128 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 /* Careful: This may recursively call do_bang() again! (because of
1130 * autocommands) */
1131 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001132#ifdef FEAT_AUTOCMD
1133 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1134#endif
1135 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 if (free_newcmd)
1137 vim_free(newcmd);
1138}
1139
1140/*
1141 * do_filter: filter lines through a command given by the user
1142 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001143 * We mostly use temp files and the call_shell() routine here. This would
1144 * normally be done using pipes on a UNIX machine, but this is more portable
1145 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 * to deal with redirection somehow, and should handle things like looking
1147 * at the PATH env. variable, and adding reasonable extensions to the
1148 * command name given by the user. All reasonable versions of call_shell()
1149 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001150 * Alternatively, if on Unix and redirecting input or output, but not both,
1151 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 * We use input redirection if do_in is TRUE.
1153 * We use output redirection if do_out is TRUE.
1154 */
1155 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001156do_filter(
1157 linenr_T line1,
1158 linenr_T line2,
1159 exarg_T *eap, /* for forced 'ff' and 'fenc' */
1160 char_u *cmd,
1161 int do_in,
1162 int do_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163{
1164 char_u *itmp = NULL;
1165 char_u *otmp = NULL;
1166 linenr_T linecount;
1167 linenr_T read_linecount;
1168 pos_T cursor_save;
1169 char_u *cmd_buf;
1170#ifdef FEAT_AUTOCMD
1171 buf_T *old_curbuf = curbuf;
1172#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001173 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174
1175 if (*cmd == NUL) /* no filter command */
1176 return;
1177
1178#ifdef WIN3264
1179 /*
1180 * Check if external commands are allowed now.
1181 */
1182 if (can_end_termcap_mode(TRUE) == FALSE)
1183 return;
1184#endif
1185
1186 cursor_save = curwin->w_cursor;
1187 linecount = line2 - line1 + 1;
1188 curwin->w_cursor.lnum = line1;
1189 curwin->w_cursor.col = 0;
1190 changed_line_abv_curs();
1191 invalidate_botline();
1192
1193 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001194 * When using temp files:
1195 * 1. * Form temp file names
1196 * 2. * Write the lines to a temp file
1197 * 3. Run the filter command on the temp file
1198 * 4. * Read the output of the command into the buffer
1199 * 5. * Delete the original lines to be filtered
1200 * 6. * Remove the temp files
1201 *
1202 * When writing the input with a pipe or when catching the output with a
1203 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 */
1205
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001206 if (do_out)
1207 shell_flags |= SHELL_DOOUT;
1208
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001209#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001210 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001212 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1213 shell_flags |= SHELL_READ;
1214 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001216 else if (do_in && !do_out && !p_stmp)
1217 {
1218 /* Use a pipe to write stdin of the command, do not use a temp file. */
1219 shell_flags |= SHELL_WRITE;
1220 curbuf->b_op_start.lnum = line1;
1221 curbuf->b_op_end.lnum = line2;
1222 }
1223 else if (do_in && do_out && !p_stmp)
1224 {
1225 /* Use a pipe to write stdin and fetch stdout of the command, do not
1226 * use a temp file. */
1227 shell_flags |= SHELL_READ|SHELL_WRITE;
1228 curbuf->b_op_start.lnum = line1;
1229 curbuf->b_op_end.lnum = line2;
1230 curwin->w_cursor.lnum = line2;
1231 }
1232 else
1233#endif
Bram Moolenaare5c421c2015-03-31 13:33:08 +02001234 if ((do_in && (itmp = vim_tempname('i', FALSE)) == NULL)
1235 || (do_out && (otmp = vim_tempname('o', FALSE)) == NULL))
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 {
1237 EMSG(_(e_notmp));
1238 goto filterend;
1239 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
1241/*
1242 * The writing and reading of temp files will not be shown.
1243 * Vi also doesn't do this and the messages are not very informative.
1244 */
1245 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001246 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 FALSE, FALSE, FALSE, TRUE) == FAIL)
1248 {
1249 msg_putchar('\n'); /* keep message from buf_write() */
1250 --no_wait_return;
1251#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1252 if (!aborting())
1253#endif
1254 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1255 goto filterend;
1256 }
1257#ifdef FEAT_AUTOCMD
1258 if (curbuf != old_curbuf)
1259 goto filterend;
1260#endif
1261
1262 if (!do_out)
1263 msg_putchar('\n');
1264
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001265 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1267 if (cmd_buf == NULL)
1268 goto filterend;
1269
1270 windgoto((int)Rows - 1, 0);
1271 cursor_on();
1272
1273 /*
1274 * When not redirecting the output the command can write anything to the
1275 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1276 * stderr output of external command. Clear the screen later.
1277 * If do_in is FALSE, this could be something like ":r !cat", which may
1278 * also mess up the screen, clear it later.
1279 */
1280 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1281 redraw_later_clear();
1282
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001283 if (do_out)
1284 {
1285 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001286 {
1287 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001288 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001289 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001290 redraw_curbuf_later(VALID);
1291 }
1292 read_linecount = curbuf->b_ml.ml_line_count;
1293
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 /*
1295 * When call_shell() fails wait_return() is called to give the user a
1296 * chance to read the error messages. Otherwise errors are ignored, so you
1297 * can see the error messages from the command that appear on stdout; use
1298 * 'u' to fix the text
1299 * Switch to cooked mode when not redirecting stdin, avoids that something
1300 * like ":r !cat" hangs.
1301 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1302 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001303 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 {
1305 redraw_later_clear();
1306 wait_return(FALSE);
1307 }
1308 vim_free(cmd_buf);
1309
1310 did_check_timestamps = FALSE;
1311 need_check_timestamps = TRUE;
1312
1313 /* When interrupting the shell command, it may still have produced some
1314 * useful output. Reset got_int here, so that readfile() won't cancel
1315 * reading. */
1316 ui_breakcheck();
1317 got_int = FALSE;
1318
1319 if (do_out)
1320 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001321 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001323 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1324 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001326#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1327 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001329 {
1330 msg_putchar('\n');
1331 EMSG2(_(e_notread), otmp);
1332 }
1333 goto error;
1334 }
1335#ifdef FEAT_AUTOCMD
1336 if (curbuf != old_curbuf)
1337 goto filterend;
1338#endif
1339 }
1340
1341 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1342
1343 if (shell_flags & SHELL_READ)
1344 {
1345 curbuf->b_op_start.lnum = line2 + 1;
1346 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1347 appended_lines_mark(line2, read_linecount);
1348 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349
1350 if (do_in)
1351 {
1352 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1353 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 if (read_linecount >= linecount)
1355 /* move all marks from old lines to new lines */
1356 mark_adjust(line1, line2, linecount, 0L);
1357 else
1358 {
1359 /* move marks from old lines to new lines, delete marks
1360 * that are in deleted lines */
1361 mark_adjust(line1, line1 + read_linecount - 1,
1362 linecount, 0L);
1363 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1364 }
1365 }
1366
1367 /*
1368 * Put cursor on first filtered line for ":range!cmd".
1369 * Adjust '[ and '] (set by buf_write()).
1370 */
1371 curwin->w_cursor.lnum = line1;
1372 del_lines(linecount, TRUE);
1373 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1374 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1375 write_lnum_adjust(-linecount); /* adjust last line
1376 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001377#ifdef FEAT_FOLDING
1378 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1379#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 }
1381 else
1382 {
1383 /*
1384 * Put cursor on last new line for ":r !cmd".
1385 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001387 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001389
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1391 --no_wait_return;
1392
1393 if (linecount > p_report)
1394 {
1395 if (do_in)
1396 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001397 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1398 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001401 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402 }
1403 else
1404 msgmore((long)linecount);
1405 }
1406 }
1407 else
1408 {
1409error:
1410 /* put cursor back in same position for ":w !cmd" */
1411 curwin->w_cursor = cursor_save;
1412 --no_wait_return;
1413 wait_return(FALSE);
1414 }
1415
1416filterend:
1417
1418#ifdef FEAT_AUTOCMD
1419 if (curbuf != old_curbuf)
1420 {
1421 --no_wait_return;
1422 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1423 }
1424#endif
1425 if (itmp != NULL)
1426 mch_remove(itmp);
1427 if (otmp != NULL)
1428 mch_remove(otmp);
1429 vim_free(itmp);
1430 vim_free(otmp);
1431}
1432
1433/*
1434 * Call a shell to execute a command.
1435 * When "cmd" is NULL start an interactive shell.
1436 */
1437 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001438do_shell(
1439 char_u *cmd,
1440 int flags) /* may be SHELL_DOOUT when output is redirected */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441{
1442 buf_T *buf;
1443#ifndef FEAT_GUI_MSWIN
1444 int save_nwr;
1445#endif
1446#ifdef MSWIN
1447 int winstart = FALSE;
1448#endif
1449
1450 /*
1451 * Disallow shell commands for "rvim".
1452 * Disallow shell commands from .exrc and .vimrc in current directory for
1453 * security reasons.
1454 */
1455 if (check_restricted() || check_secure())
1456 {
1457 msg_end();
1458 return;
1459 }
1460
1461#ifdef MSWIN
1462 /*
1463 * Check if external commands are allowed now.
1464 */
1465 if (can_end_termcap_mode(TRUE) == FALSE)
1466 return;
1467
1468 /*
1469 * Check if ":!start" is used.
1470 */
1471 if (cmd != NULL)
1472 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1473#endif
1474
1475 /*
1476 * For autocommands we want to get the output on the current screen, to
1477 * avoid having to type return below.
1478 */
1479 msg_putchar('\r'); /* put cursor at start of line */
1480#ifdef FEAT_AUTOCMD
1481 if (!autocmd_busy)
1482#endif
1483 {
1484#ifdef MSWIN
1485 if (!winstart)
1486#endif
1487 stoptermcap();
1488 }
1489#ifdef MSWIN
1490 if (!winstart)
1491#endif
1492 msg_putchar('\n'); /* may shift screen one line up */
1493
1494 /* warning message before calling the shell */
1495 if (p_warn
1496#ifdef FEAT_AUTOCMD
1497 && !autocmd_busy
1498#endif
1499 && msg_silent == 0)
1500 for (buf = firstbuf; buf; buf = buf->b_next)
1501 if (bufIsChanged(buf))
1502 {
1503#ifdef FEAT_GUI_MSWIN
1504 if (!winstart)
1505 starttermcap(); /* don't want a message box here */
1506#endif
1507 MSG_PUTS(_("[No write since last change]\n"));
1508#ifdef FEAT_GUI_MSWIN
1509 if (!winstart)
1510 stoptermcap();
1511#endif
1512 break;
1513 }
1514
1515 /* This windgoto is required for when the '\n' resulted in a "delete line
1516 * 1" command to the terminal. */
1517 if (!swapping_screen())
1518 windgoto(msg_row, msg_col);
1519 cursor_on();
1520 (void)call_shell(cmd, SHELL_COOKED | flags);
1521 did_check_timestamps = FALSE;
1522 need_check_timestamps = TRUE;
1523
1524 /*
1525 * put the message cursor at the end of the screen, avoids wait_return()
1526 * to overwrite the text that the external command showed
1527 */
1528 if (!swapping_screen())
1529 {
1530 msg_row = Rows - 1;
1531 msg_col = 0;
1532 }
1533
1534#ifdef FEAT_AUTOCMD
1535 if (autocmd_busy)
1536 {
1537 if (msg_silent == 0)
1538 redraw_later_clear();
1539 }
1540 else
1541#endif
1542 {
1543 /*
1544 * For ":sh" there is no need to call wait_return(), just redraw.
1545 * Also for the Win32 GUI (the output is in a console window).
1546 * Otherwise there is probably text on the screen that the user wants
1547 * to read before redrawing, so call wait_return().
1548 */
1549#ifndef FEAT_GUI_MSWIN
1550 if (cmd == NULL
1551# ifdef WIN3264
1552 || (winstart && !need_wait_return)
1553# endif
1554 )
1555 {
1556 if (msg_silent == 0)
1557 redraw_later_clear();
1558 need_wait_return = FALSE;
1559 }
1560 else
1561 {
1562 /*
1563 * If we switch screens when starttermcap() is called, we really
1564 * want to wait for "hit return to continue".
1565 */
1566 save_nwr = no_wait_return;
1567 if (swapping_screen())
1568 no_wait_return = FALSE;
1569# ifdef AMIGA
1570 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1571# else
1572 wait_return(msg_silent == 0);
1573# endif
1574 no_wait_return = save_nwr;
1575 }
1576#endif /* FEAT_GUI_W32 */
1577
1578#ifdef MSWIN
1579 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1580#endif
1581 starttermcap(); /* start termcap if not done by wait_return() */
1582
1583 /*
1584 * In an Amiga window redrawing is caused by asking the window size.
1585 * If we got an interrupt this will not work. The chance that the
1586 * window size is wrong is very small, but we need to redraw the
1587 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1588 * but it saves an extra redraw.
1589 */
1590#ifdef AMIGA
1591 if (skip_redraw) /* ':' hit in wait_return() */
1592 {
1593 if (msg_silent == 0)
1594 redraw_later_clear();
1595 }
1596 else if (term_console)
1597 {
1598 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1599 if (got_int && msg_silent == 0)
1600 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1601 else
1602 must_redraw = 0; /* no extra redraw needed */
1603 }
1604#endif
1605 }
1606
1607 /* display any error messages now */
1608 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001609
1610#ifdef FEAT_AUTOCMD
1611 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1612#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613}
1614
1615/*
1616 * Create a shell command from a command string, input redirection file and
1617 * output redirection file.
1618 * Returns an allocated string with the shell command, or NULL for failure.
1619 */
1620 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001621make_filter_cmd(
1622 char_u *cmd, /* command */
1623 char_u *itmp, /* NULL or name of input file */
1624 char_u *otmp) /* NULL or name of output file */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625{
1626 char_u *buf;
1627 long_u len;
1628
Bram Moolenaar53076832015-12-31 19:53:21 +01001629#if defined(UNIX)
Bram Moolenaard442ec72014-05-09 20:33:04 +02001630 int is_fish_shell;
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001631 char_u *shell_name = get_isolated_shell_name();
Bram Moolenaard442ec72014-05-09 20:33:04 +02001632
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001633 /* Account for fish's different syntax for subshells */
Bram Moolenaar050fe7e2014-05-22 14:00:16 +02001634 is_fish_shell = (fnamecmp(shell_name, "fish") == 0);
1635 vim_free(shell_name);
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001636 if (is_fish_shell)
1637 len = (long_u)STRLEN(cmd) + 13; /* "begin; " + "; end" + NUL */
1638 else
1639#endif
1640 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 if (itmp != NULL)
1642 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1643 if (otmp != NULL)
1644 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1645 buf = lalloc(len, TRUE);
1646 if (buf == NULL)
1647 return NULL;
1648
Bram Moolenaar53076832015-12-31 19:53:21 +01001649#if defined(UNIX)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001651 * Put braces around the command (for concatenated commands) when
1652 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001654 if (itmp != NULL || otmp != NULL)
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001655 {
1656 if (is_fish_shell)
1657 vim_snprintf((char *)buf, len, "begin; %s; end", (char *)cmd);
1658 else
1659 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1660 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001661 else
1662 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 if (itmp != NULL)
1664 {
1665 STRCAT(buf, " < ");
1666 STRCAT(buf, itmp);
1667 }
1668#else
1669 /*
Bram Moolenaar75a8d742014-05-07 15:10:21 +02001670 * For shells that don't understand braces around commands, at least allow
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 * the use of commands in a pipe.
1672 */
1673 STRCPY(buf, cmd);
1674 if (itmp != NULL)
1675 {
1676 char_u *p;
1677
1678 /*
1679 * If there is a pipe, we have to put the '<' in front of it.
1680 * Don't do this when 'shellquote' is not empty, otherwise the
1681 * redirection would be inside the quotes.
1682 */
1683 if (*p_shq == NUL)
1684 {
1685 p = vim_strchr(buf, '|');
1686 if (p != NULL)
1687 *p = NUL;
1688 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1690 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 if (*p_shq == NUL)
1692 {
1693 p = vim_strchr(cmd, '|');
1694 if (p != NULL)
1695 {
1696 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1697 STRCAT(buf, p);
1698 }
1699 }
1700 }
1701#endif
1702 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001703 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704
1705 return buf;
1706}
1707
1708/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001709 * Append output redirection for file "fname" to the end of string buffer
1710 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 * Works with the 'shellredir' and 'shellpipe' options.
1712 * The caller should make sure that there is enough room:
1713 * STRLEN(opt) + STRLEN(fname) + 3
1714 */
1715 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001716append_redir(
1717 char_u *buf,
1718 int buflen,
1719 char_u *opt,
1720 char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721{
1722 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001723 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001725 end = buf + STRLEN(buf);
Bram Moolenaar542805a2013-08-02 14:15:13 +02001726 /* find "%s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
Bram Moolenaar542805a2013-08-02 14:15:13 +02001728 {
1729 if (p[1] == 's') /* found %s */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 break;
Bram Moolenaar542805a2013-08-02 14:15:13 +02001731 if (p[1] == '%') /* skip %% */
1732 ++p;
1733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 if (p != NULL)
1735 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001736 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1737 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1738 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 }
1740 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001741 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 " %s %s",
1744#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746#endif
1747 (char *)opt, (char *)fname);
1748}
1749
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001750#if defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001752static int no_viminfo(void);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02001753static int read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02001754static void write_viminfo_version(FILE *fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01001755static void write_viminfo_barlines(vir_T *virp, FILE *fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756static int viminfo_errcnt;
1757
1758 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001759no_viminfo(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760{
1761 /* "vim -i NONE" does not read or write a viminfo file */
1762 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1763}
1764
1765/*
1766 * Report an error for reading a viminfo file.
1767 * Count the number of errors. When there are more than 10, return TRUE.
1768 */
1769 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001770viminfo_error(char *errnum, char *message, char_u *line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001772 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1773 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001774 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001775 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1776 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 emsg(IObuff);
1778 if (++viminfo_errcnt >= 10)
1779 {
1780 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1781 return TRUE;
1782 }
1783 return FALSE;
1784}
1785
1786/*
1787 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001788 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 */
1790 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001791read_viminfo(
1792 char_u *file, /* file name or NULL to use default name */
1793 int flags) /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794{
1795 FILE *fp;
1796 char_u *fname;
1797
1798 if (no_viminfo())
1799 return FAIL;
1800
Bram Moolenaard812df62008-11-09 12:46:09 +00001801 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 if (fname == NULL)
1803 return FAIL;
1804 fp = mch_fopen((char *)fname, READBIN);
1805
1806 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001807 {
1808 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001809 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1810 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001811 (flags & VIF_WANT_INFO) ? _(" info") : "",
1812 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1813 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001814 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001815 verbose_leave();
1816 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817
1818 vim_free(fname);
1819 if (fp == NULL)
1820 return FAIL;
1821
1822 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001823 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824
1825 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 return OK;
1827}
1828
1829/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001830 * Write the viminfo file. The old one is read in first so that effectively a
1831 * merge of current info and old info is done. This allows multiple vims to
1832 * run simultaneously, without losing any marks etc.
1833 * If "forceit" is TRUE, then the old file is not read in, and only internal
1834 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 */
1836 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001837write_viminfo(char_u *file, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838{
1839 char_u *fname;
1840 FILE *fp_in = NULL; /* input viminfo file, if any */
1841 FILE *fp_out = NULL; /* output viminfo file */
1842 char_u *tempname = NULL; /* name of temp viminfo file */
1843 struct stat st_new; /* mch_stat() of potential new file */
1844 char_u *wp;
1845#if defined(UNIX) || defined(VMS)
1846 mode_t umask_save;
1847#endif
1848#ifdef UNIX
1849 int shortname = FALSE; /* use 8.3 file name */
1850 struct stat st_old; /* mch_stat() of existing viminfo file */
1851#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001852#ifdef WIN3264
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001853 int hidden = FALSE;
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001854#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855
1856 if (no_viminfo())
1857 return;
1858
1859 fname = viminfo_filename(file); /* may set to default if NULL */
1860 if (fname == NULL)
1861 return;
1862
1863 fp_in = mch_fopen((char *)fname, READBIN);
1864 if (fp_in == NULL)
1865 {
1866 /* if it does exist, but we can't read it, don't try writing */
1867 if (mch_stat((char *)fname, &st_new) == 0)
1868 goto end;
1869#if defined(UNIX) || defined(VMS)
1870 /*
1871 * For Unix we create the .viminfo non-accessible for others,
1872 * because it may contain text from non-accessible documents.
1873 */
1874 umask_save = umask(077);
1875#endif
1876 fp_out = mch_fopen((char *)fname, WRITEBIN);
1877#if defined(UNIX) || defined(VMS)
1878 (void)umask(umask_save);
1879#endif
1880 }
1881 else
1882 {
1883 /*
1884 * There is an existing viminfo file. Create a temporary file to
1885 * write the new viminfo into, in the same directory as the
1886 * existing viminfo file, which will be renamed later.
1887 */
1888#ifdef UNIX
1889 /*
1890 * For Unix we check the owner of the file. It's not very nice to
1891 * overwrite a user's viminfo file after a "su root", with a
1892 * viminfo file that the user can't read.
1893 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001894 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001895 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001897 if (mch_stat((char *)fname, &st_old) == 0
1898 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001899 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 ? (st_old.st_mode & 0200)
1901 : (st_old.st_gid == getgid()
1902 ? (st_old.st_mode & 0020)
1903 : (st_old.st_mode & 0002))))
1904 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001905 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906
1907 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1909 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001910 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 goto end;
1912 }
1913#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001914#ifdef WIN3264
1915 /* Get the file attributes of the existing viminfo file. */
Bram Moolenaar8a52ba72015-11-02 14:45:56 +01001916 hidden = mch_ishidden(fname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001917#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918
1919 /*
1920 * Make tempname.
1921 * May try twice: Once normal and once with shortname set, just in
1922 * case somebody puts his viminfo file in an 8.3 filesystem.
1923 */
1924 for (;;)
1925 {
1926 tempname = buf_modname(
1927#ifdef UNIX
1928 shortname,
1929#else
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001930# ifdef FEAT_GUI_W32
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 gui_is_win32s(),
Bram Moolenaar48e330a2016-02-23 14:53:34 +01001932# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 FALSE,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934# endif
1935#endif
1936 fname,
1937#ifdef VMS
1938 (char_u *)"-tmp",
1939#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941#endif
1942 FALSE);
1943 if (tempname == NULL) /* out of memory */
1944 break;
1945
1946 /*
1947 * Check if tempfile already exists. Never overwrite an
1948 * existing file!
1949 */
1950 if (mch_stat((char *)tempname, &st_new) == 0)
1951 {
1952#ifdef UNIX
1953 /*
1954 * Check if tempfile is same as original file. May happen
1955 * when modname() gave the same file back. E.g. silly
1956 * link, or file name-length reached. Try again with
1957 * shortname set.
1958 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001959 if (!shortname && st_new.st_dev == st_old.st_dev
1960 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 {
1962 vim_free(tempname);
1963 tempname = NULL;
1964 shortname = TRUE;
1965 continue;
1966 }
1967#endif
1968 /*
1969 * Try another name. Change one character, just before
1970 * the extension. This should also work for an 8.3
1971 * file name, when after adding the extension it still is
1972 * the same file as the original.
1973 */
1974 wp = tempname + STRLEN(tempname) - 5;
1975 if (wp < gettail(tempname)) /* empty file name? */
1976 wp = gettail(tempname);
1977 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1978 --*wp)
1979 {
1980 /*
1981 * They all exist? Must be something wrong! Don't
1982 * write the viminfo file then.
1983 */
1984 if (*wp == 'a')
1985 {
Bram Moolenaar2d358992016-06-12 21:20:54 +02001986 EMSG2(_("E929: Too many viminfo temp files, like %s!"),
1987 tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 vim_free(tempname);
1989 tempname = NULL;
1990 break;
1991 }
1992 }
1993 }
1994 break;
1995 }
1996
1997 if (tempname != NULL)
1998 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001999#ifdef VMS
2000 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00002001 umask_save = umask(077);
2002 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2003 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002004#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00002005 int fd;
2006
2007 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002008 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002009 * Unix: same as original file, but strip s-bit. Reset umask to
2010 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002011 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00002012# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002013 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00002014 fd = mch_open((char *)tempname,
2015 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002016 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002017 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002018# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00002019 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00002020 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002021# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00002022 if (fd < 0)
2023 fp_out = NULL;
2024 else
2025 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00002026#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027
2028 /*
2029 * If we can't create in the same directory, try creating a
2030 * "normal" temp file.
2031 */
2032 if (fp_out == NULL)
2033 {
2034 vim_free(tempname);
Bram Moolenaare5c421c2015-03-31 13:33:08 +02002035 if ((tempname = vim_tempname('o', TRUE)) != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 fp_out = mch_fopen((char *)tempname, WRITEBIN);
2037 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00002038
2039#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00002041 * Make sure the owner can read/write it. This only works for
2042 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 */
2044 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00002045 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046#endif
2047 }
2048 }
2049
2050 /*
2051 * Check if the new viminfo file can be written to.
2052 */
2053 if (fp_out == NULL)
2054 {
2055 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00002056 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 if (fp_in != NULL)
2058 fclose(fp_in);
2059 goto end;
2060 }
2061
2062 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002063 {
2064 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002065 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002066 verbose_leave();
2067 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068
2069 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00002070 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071
Bram Moolenaar927030a2016-03-15 18:23:55 +01002072 if (fclose(fp_out) == EOF)
2073 ++viminfo_errcnt;
2074
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 if (fp_in != NULL)
2076 {
2077 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002078
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002079 /* In case of an error keep the original viminfo file. Otherwise
2080 * rename the newly written file. Give an error if that fails. */
Bram Moolenaar927030a2016-03-15 18:23:55 +01002081 if (viminfo_errcnt == 0)
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002082 {
Bram Moolenaar927030a2016-03-15 18:23:55 +01002083 if (vim_rename(tempname, fname) == -1)
2084 {
2085 ++viminfo_errcnt;
2086 EMSG2(_("E886: Can't rename viminfo file to %s!"), fname);
2087 }
2088# ifdef WIN3264
2089 /* If the viminfo file was hidden then also hide the new file. */
2090 else if (hidden)
2091 mch_hide(fname);
2092# endif
Bram Moolenaar3ed8b132014-07-09 21:18:04 +02002093 }
2094 if (viminfo_errcnt > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 mch_remove(tempname);
2096 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002097
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098end:
2099 vim_free(fname);
2100 vim_free(tempname);
2101}
2102
2103/*
2104 * Get the viminfo file name to use.
2105 * If "file" is given and not empty, use it (has already been expanded by
2106 * cmdline functions).
2107 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2108 * expand environment variables.
2109 * Returns an allocated string. NULL when out of memory.
2110 */
2111 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002112viminfo_filename(char_u *file)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113{
2114 if (file == NULL || *file == NUL)
2115 {
2116 if (use_viminfo != NULL)
2117 file = use_viminfo;
2118 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2119 {
2120#ifdef VIMINFO_FILE2
2121 /* don't use $HOME when not defined (turned into "c:/"!). */
2122# ifdef VMS
2123 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2124# else
2125 if (mch_getenv((char_u *)"HOME") == NULL)
2126# endif
2127 {
2128 /* don't use $VIM when not available. */
2129 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2130 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2131 file = (char_u *)VIMINFO_FILE2;
2132 else
2133 file = (char_u *)VIMINFO_FILE;
2134 }
2135 else
2136#endif
2137 file = (char_u *)VIMINFO_FILE;
2138 }
2139 expand_env(file, NameBuff, MAXPATHL);
2140 file = NameBuff;
2141 }
2142 return vim_strsave(file);
2143}
2144
2145/*
2146 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2147 */
2148 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002149do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150{
2151 int count = 0;
2152 int eof = FALSE;
2153 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002154 int merge = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155
2156 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2157 return;
2158 vir.vir_fd = fp_in;
2159#ifdef FEAT_MBYTE
2160 vir.vir_conv.vc_type = CONV_NONE;
2161#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002162 ga_init2(&vir.vir_barlines, (int)sizeof(char_u *), 100);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002163 vir.vir_version = -1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164
2165 if (fp_in != NULL)
2166 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002167 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002168 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002169 if (fp_out != NULL)
Bram Moolenaar2d358992016-06-12 21:20:54 +02002170 {
2171 /* Registers and marks are read and kept separate from what
2172 * this Vim is using. They are merged when writing. */
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002173 prepare_viminfo_registers();
Bram Moolenaar2d358992016-06-12 21:20:54 +02002174 prepare_viminfo_marks();
2175 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002176
Bram Moolenaard812df62008-11-09 12:46:09 +00002177 eof = read_viminfo_up_to_marks(&vir,
2178 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002179 merge = TRUE;
2180 }
2181 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 /* Skip info, find start of marks */
2183 while (!(eof = viminfo_readline(&vir))
2184 && vir.vir_line[0] != '>')
2185 ;
2186 }
2187 if (fp_out != NULL)
2188 {
2189 /* Write the info: */
2190 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2191 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002192 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002193 write_viminfo_version(fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002195 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2197#endif
2198 write_viminfo_search_pattern(fp_out);
2199 write_viminfo_sub_string(fp_out);
2200#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002201 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202#endif
2203 write_viminfo_registers(fp_out);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002204 finish_viminfo_registers();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205#ifdef FEAT_EVAL
2206 write_viminfo_varlist(fp_out);
2207#endif
2208 write_viminfo_filemarks(fp_out);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002209 finish_viminfo_marks();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 write_viminfo_bufferlist(fp_out);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002211 write_viminfo_barlines(&vir, fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 count = write_viminfo_marks(fp_out);
2213 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002214 if (fp_in != NULL
2215 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2216 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
2218 vim_free(vir.vir_line);
2219#ifdef FEAT_MBYTE
2220 if (vir.vir_conv.vc_type != CONV_NONE)
2221 convert_setup(&vir.vir_conv, NULL, NULL);
2222#endif
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002223 ga_clear_strings(&vir.vir_barlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224}
2225
2226/*
2227 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2228 * first part of the viminfo file which contains everything but the marks that
2229 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2230 */
2231 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002232read_viminfo_up_to_marks(
2233 vir_T *virp,
2234 int forceit,
2235 int writing)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236{
2237 int eof;
2238 buf_T *buf;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002239 int got_encoding = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240
2241#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002242 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243#endif
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002244
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 eof = viminfo_readline(virp);
2246 while (!eof && virp->vir_line[0] != '>')
2247 {
2248 switch (virp->vir_line[0])
2249 {
2250 /* Characters reserved for future expansion, ignored now */
2251 case '+': /* "+40 /path/dir file", for running vim without args */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 case '^': /* to be defined */
2253 case '<': /* long line - ignored */
2254 /* A comment or empty line. */
2255 case NUL:
2256 case '\r':
2257 case '\n':
2258 case '#':
2259 eof = viminfo_readline(virp);
2260 break;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002261 case '|':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002262 eof = read_viminfo_barline(virp, got_encoding,
2263 forceit, writing);
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002264 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 case '*': /* "*encoding=value" */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002266 got_encoding = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 eof = viminfo_encoding(virp);
2268 break;
2269 case '!': /* global variable */
2270#ifdef FEAT_EVAL
2271 eof = read_viminfo_varlist(virp, writing);
2272#else
2273 eof = viminfo_readline(virp);
2274#endif
2275 break;
2276 case '%': /* entry for buffer list */
2277 eof = read_viminfo_bufferlist(virp, writing);
2278 break;
2279 case '"':
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002280 /* When registers are in bar lines skip the old style register
2281 * lines. */
2282 if (virp->vir_version < VIMINFO_VERSION_WITH_REGISTERS)
2283 eof = read_viminfo_register(virp, forceit);
2284 else
2285 do {
2286 eof = viminfo_readline(virp);
2287 } while (!eof && (virp->vir_line[0] == TAB
2288 || virp->vir_line[0] == '<'));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 break;
2290 case '/': /* Search string */
2291 case '&': /* Substitute search string */
2292 case '~': /* Last search string, followed by '/' or '&' */
2293 eof = read_viminfo_search_pattern(virp, forceit);
2294 break;
2295 case '$':
2296 eof = read_viminfo_sub_string(virp, forceit);
2297 break;
2298 case ':':
2299 case '?':
2300 case '=':
2301 case '@':
2302#ifdef FEAT_CMDHIST
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002303 /* When history is in bar lines skip the old style history
2304 * lines. */
2305 if (virp->vir_version < VIMINFO_VERSION_WITH_HISTORY)
2306 eof = read_viminfo_history(virp, writing);
2307 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002309 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 break;
2311 case '-':
2312 case '\'':
Bram Moolenaara641e1d2016-06-13 21:16:03 +02002313 /* When file marks are in bar lines skip the old style lines. */
2314 if (virp->vir_version < VIMINFO_VERSION_WITH_MARKS)
2315 eof = read_viminfo_filemark(virp, forceit);
2316 else
2317 eof = viminfo_readline(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 break;
2319 default:
2320 if (viminfo_error("E575: ", _("Illegal starting char"),
2321 virp->vir_line))
2322 eof = TRUE;
2323 else
2324 eof = viminfo_readline(virp);
2325 break;
2326 }
2327 }
2328
2329#ifdef FEAT_CMDHIST
2330 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002331 if (!writing)
Bram Moolenaar1fd99c12016-06-09 20:24:28 +02002332 finish_viminfo_history(virp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333#endif
2334
2335 /* Change file names to buffer numbers for fmarks. */
2336 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2337 fmarks_check_names(buf);
2338
2339 return eof;
2340}
2341
2342/*
2343 * Compare the 'encoding' value in the viminfo file with the current value of
2344 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2345 * conversion of text with iconv() in viminfo_readstring().
2346 */
2347 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002348viminfo_encoding(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349{
2350#ifdef FEAT_MBYTE
2351 char_u *p;
2352 int i;
2353
2354 if (get_viminfo_parameter('c') != 0)
2355 {
2356 p = vim_strchr(virp->vir_line, '=');
2357 if (p != NULL)
2358 {
2359 /* remove trailing newline */
2360 ++p;
2361 for (i = 0; vim_isprintc(p[i]); ++i)
2362 ;
2363 p[i] = NUL;
2364
2365 convert_setup(&virp->vir_conv, p, p_enc);
2366 }
2367 }
2368#endif
2369 return viminfo_readline(virp);
2370}
2371
2372/*
2373 * Read a line from the viminfo file.
2374 * Returns TRUE for end-of-file;
2375 */
2376 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002377viminfo_readline(vir_T *virp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378{
2379 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2380}
2381
2382/*
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002383 * Check string read from viminfo file.
2384 * Remove '\n' at the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 * - replace CTRL-V CTRL-V with CTRL-V
2386 * - replace CTRL-V 'n' with '\n'
2387 *
2388 * Check for a long line as written by viminfo_writestring().
2389 *
2390 * Return the string in allocated memory (NULL when out of memory).
2391 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002393viminfo_readstring(
2394 vir_T *virp,
2395 int off, /* offset for virp->vir_line */
2396 int convert UNUSED) /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397{
2398 char_u *retval;
2399 char_u *s, *d;
2400 long len;
2401
2402 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2403 {
2404 len = atol((char *)virp->vir_line + off + 1);
2405 retval = lalloc(len, TRUE);
2406 if (retval == NULL)
2407 {
2408 /* Line too long? File messed up? Skip next line. */
2409 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2410 return NULL;
2411 }
2412 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2413 s = retval + 1; /* Skip the leading '<' */
2414 }
2415 else
2416 {
2417 retval = vim_strsave(virp->vir_line + off);
2418 if (retval == NULL)
2419 return NULL;
2420 s = retval;
2421 }
2422
2423 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2424 d = retval;
2425 while (*s != NUL && *s != '\n')
2426 {
2427 if (s[0] == Ctrl_V && s[1] != NUL)
2428 {
2429 if (s[1] == 'n')
2430 *d++ = '\n';
2431 else
2432 *d++ = Ctrl_V;
2433 s += 2;
2434 }
2435 else
2436 *d++ = *s++;
2437 }
2438 *d = NUL;
2439
2440#ifdef FEAT_MBYTE
2441 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2442 {
2443 d = string_convert(&virp->vir_conv, retval, NULL);
2444 if (d != NULL)
2445 {
2446 vim_free(retval);
2447 retval = d;
2448 }
2449 }
2450#endif
2451
2452 return retval;
2453}
2454
2455/*
2456 * write string to viminfo file
2457 * - replace CTRL-V with CTRL-V CTRL-V
2458 * - replace '\n' with CTRL-V 'n'
2459 * - add a '\n' at the end
2460 *
2461 * For a long line:
2462 * - write " CTRL-V <length> \n " in first line
2463 * - write " < <string> \n " in second line
2464 */
2465 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002466viminfo_writestring(FILE *fd, char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467{
2468 int c;
2469 char_u *s;
2470 int len = 0;
2471
2472 for (s = p; *s != NUL; ++s)
2473 {
2474 if (*s == Ctrl_V || *s == '\n')
2475 ++len;
2476 ++len;
2477 }
2478
2479 /* If the string will be too long, write its length and put it in the next
2480 * line. Take into account that some room is needed for what comes before
2481 * the string (e.g., variable name). Add something to the length for the
2482 * '<', NL and trailing NUL. */
2483 if (len > LSIZE / 2)
2484 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2485
2486 while ((c = *p++) != NUL)
2487 {
2488 if (c == Ctrl_V || c == '\n')
2489 {
2490 putc(Ctrl_V, fd);
2491 if (c == '\n')
2492 c = 'n';
2493 }
2494 putc(c, fd);
2495 }
2496 putc('\n', fd);
2497}
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002498
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002499/*
2500 * Write a string in quotes that barline_parse() can read back.
2501 * Breaks the line in less than LSIZE pieces when needed.
2502 * Returns remaining characters in the line.
2503 */
2504 int
2505barline_writestring(FILE *fd, char_u *s, int remaining_start)
2506{
2507 char_u *p;
2508 int remaining = remaining_start;
2509 int len = 2;
2510
2511 /* Count the number of characters produced, including quotes. */
2512 for (p = s; *p != NUL; ++p)
2513 {
2514 if (*p == NL)
2515 len += 2;
2516 else if (*p == '"' || *p == '\\')
2517 len += 2;
2518 else
2519 ++len;
2520 }
2521 if (len > remaining)
2522 {
2523 fprintf(fd, ">%d\n|<", len);
2524 remaining = LSIZE - 20;
2525 }
2526
2527 putc('"', fd);
2528 for (p = s; *p != NUL; ++p)
2529 {
2530 if (*p == NL)
2531 {
2532 putc('\\', fd);
2533 putc('n', fd);
2534 --remaining;
2535 }
2536 else if (*p == '"' || *p == '\\')
2537 {
2538 putc('\\', fd);
2539 putc(*p, fd);
2540 --remaining;
2541 }
2542 else
2543 putc(*p, fd);
2544 --remaining;
2545
2546 if (remaining < 3)
2547 {
2548 putc('\n', fd);
2549 putc('|', fd);
2550 putc('<', fd);
2551 /* Leave enough space for another continuation. */
2552 remaining = LSIZE - 20;
2553 }
2554 }
2555 putc('"', fd);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002556 return remaining - 2;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002557}
2558
2559/*
2560 * Parse a viminfo line starting with '|'.
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002561 * Add each decoded value to "values".
Bram Moolenaarecefe712016-06-20 12:50:17 +02002562 * Returns TRUE if the next line is to be read after using the parsed values.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002563 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002564 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002565barline_parse(vir_T *virp, char_u *text, garray_T *values)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002566{
2567 char_u *p = text;
2568 char_u *nextp = NULL;
Bram Moolenaarfdd82fe2016-06-06 21:38:44 +02002569 char_u *buf = NULL;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002570 bval_T *value;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002571 int i;
2572 int allocated = FALSE;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002573 int eof;
Bram Moolenaar01227092016-06-11 14:47:40 +02002574#ifdef FEAT_MBYTE
2575 char_u *sconv;
2576 int converted;
2577#endif
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002578
2579 while (*p == ',')
2580 {
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002581 ++p;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002582 if (ga_grow(values, 1) == FAIL)
2583 break;
2584 value = (bval_T *)(values->ga_data) + values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002585
2586 if (*p == '>')
2587 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002588 /* Need to read a continuation line. Put strings in allocated
2589 * memory, because virp->vir_line is overwritten. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002590 if (!allocated)
2591 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002592 for (i = 0; i < values->ga_len; ++i)
2593 {
2594 bval_T *vp = (bval_T *)(values->ga_data) + i;
2595
2596 if (vp->bv_type == BVAL_STRING && !vp->bv_allocated)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002597 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002598 vp->bv_string = vim_strnsave(vp->bv_string, vp->bv_len);
2599 vp->bv_allocated = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002600 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002601 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002602 allocated = TRUE;
2603 }
2604
2605 if (vim_isdigit(p[1]))
2606 {
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002607 size_t len;
2608 size_t todo;
2609 size_t n;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002610
2611 /* String value was split into lines that are each shorter
2612 * than LSIZE:
2613 * |{bartype},>{length of "{text}{text2}"}
2614 * |<"{text1}
2615 * |<{text2}",{value}
Bram Moolenaarecefe712016-06-20 12:50:17 +02002616 * Length includes the quotes.
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002617 */
2618 ++p;
2619 len = getdigits(&p);
Bram Moolenaar1d5f1d02016-06-07 22:50:01 +02002620 buf = alloc((int)(len + 1));
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002621 if (buf == NULL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002622 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002623 p = buf;
2624 for (todo = len; todo > 0; todo -= n)
2625 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002626 eof = viminfo_readline(virp);
2627 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002628 || virp->vir_line[1] != '<')
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002629 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002630 /* File was truncated or garbled. Read another line if
2631 * this one starts with '|'. */
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002632 vim_free(buf);
Bram Moolenaarecefe712016-06-20 12:50:17 +02002633 return eof || virp->vir_line[0] == '|';
Bram Moolenaar62f8b4e2016-06-11 15:31:47 +02002634 }
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002635 /* Get length of text, excluding |< and NL chars. */
2636 n = STRLEN(virp->vir_line);
2637 while (n > 0 && (virp->vir_line[n - 1] == NL
2638 || virp->vir_line[n - 1] == CAR))
2639 --n;
2640 n -= 2;
2641 if (n > todo)
2642 {
2643 /* more values follow after the string */
2644 nextp = virp->vir_line + 2 + todo;
2645 n = todo;
2646 }
2647 mch_memmove(p, virp->vir_line + 2, n);
2648 p += n;
2649 }
2650 *p = NUL;
2651 p = buf;
2652 }
2653 else
2654 {
2655 /* Line ending in ">" continues in the next line:
2656 * |{bartype},{lots of values},>
2657 * |<{value},{value}
2658 */
Bram Moolenaarecefe712016-06-20 12:50:17 +02002659 eof = viminfo_readline(virp);
2660 if (eof || virp->vir_line[0] != '|'
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002661 || virp->vir_line[1] != '<')
Bram Moolenaarecefe712016-06-20 12:50:17 +02002662 /* File was truncated or garbled. Read another line if
2663 * this one starts with '|'. */
2664 return eof || virp->vir_line[0] == '|';
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002665 p = virp->vir_line + 2;
2666 }
2667 }
2668
2669 if (isdigit(*p))
2670 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002671 value->bv_type = BVAL_NR;
2672 value->bv_nr = getdigits(&p);
2673 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002674 }
2675 else if (*p == '"')
2676 {
2677 int len = 0;
2678 char_u *s = p;
2679
2680 /* Unescape special characters in-place. */
2681 ++p;
2682 while (*p != '"')
2683 {
2684 if (*p == NL || *p == NUL)
Bram Moolenaarecefe712016-06-20 12:50:17 +02002685 return TRUE; /* syntax error, drop the value */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002686 if (*p == '\\')
2687 {
2688 ++p;
2689 if (*p == 'n')
2690 s[len++] = '\n';
2691 else
2692 s[len++] = *p;
2693 ++p;
2694 }
2695 else
2696 s[len++] = *p++;
2697 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002698 ++p;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002699 s[len] = NUL;
2700
Bram Moolenaar01227092016-06-11 14:47:40 +02002701#ifdef FEAT_MBYTE
2702 converted = FALSE;
2703 if (virp->vir_conv.vc_type != CONV_NONE && *s != NUL)
2704 {
2705 sconv = string_convert(&virp->vir_conv, s, NULL);
2706 if (sconv != NULL)
2707 {
2708 if (s == buf)
2709 vim_free(s);
2710 s = sconv;
2711 buf = s;
2712 converted = TRUE;
2713 }
2714 }
2715#endif
2716 /* Need to copy in allocated memory if the string wasn't allocated
2717 * above and we did allocate before, thus vir_line may change. */
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002718 if (s != buf && allocated)
2719 s = vim_strsave(s);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002720 value->bv_string = s;
2721 value->bv_type = BVAL_STRING;
2722 value->bv_len = len;
2723 value->bv_allocated = allocated
Bram Moolenaar01227092016-06-11 14:47:40 +02002724#ifdef FEAT_MBYTE
2725 || converted
2726#endif
2727 ;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002728 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002729 if (nextp != NULL)
2730 {
2731 /* values following a long string */
2732 p = nextp;
2733 nextp = NULL;
2734 }
2735 }
2736 else if (*p == ',')
2737 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002738 value->bv_type = BVAL_EMPTY;
2739 ++values->ga_len;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002740 }
2741 else
2742 break;
2743 }
Bram Moolenaarecefe712016-06-20 12:50:17 +02002744 return TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002745}
2746
2747 static int
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002748read_viminfo_barline(vir_T *virp, int got_encoding, int force, int writing)
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002749{
2750 char_u *p = virp->vir_line + 1;
2751 int bartype;
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002752 garray_T values;
2753 bval_T *vp;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002754 int i;
Bram Moolenaarecefe712016-06-20 12:50:17 +02002755 int read_next = TRUE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002756
2757 /* The format is: |{bartype},{value},...
2758 * For a very long string:
2759 * |{bartype},>{length of "{text}{text2}"}
2760 * |<{text1}
2761 * |<{text2},{value}
2762 * For a long line not using a string
2763 * |{bartype},{lots of values},>
2764 * |<{value},{value}
2765 */
2766 if (*p == '<')
2767 {
2768 /* Continuation line of an unrecognized item. */
2769 if (writing)
2770 ga_add_string(&virp->vir_barlines, virp->vir_line);
2771 }
2772 else
2773 {
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002774 ga_init2(&values, sizeof(bval_T), 20);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002775 bartype = getdigits(&p);
2776 switch (bartype)
2777 {
2778 case BARTYPE_VERSION:
2779 /* Only use the version when it comes before the encoding.
2780 * If it comes later it was copied by a Vim version that
2781 * doesn't understand the version. */
2782 if (!got_encoding)
2783 {
Bram Moolenaarecefe712016-06-20 12:50:17 +02002784 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002785 vp = (bval_T *)values.ga_data;
2786 if (values.ga_len > 0 && vp->bv_type == BVAL_NR)
2787 virp->vir_version = vp->bv_nr;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002788 }
2789 break;
2790
2791 case BARTYPE_HISTORY:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002792 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002793 handle_viminfo_history(&values, writing);
2794 break;
2795
2796 case BARTYPE_REGISTER:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002797 read_next = barline_parse(virp, p, &values);
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002798 handle_viminfo_register(&values, force);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002799 break;
2800
Bram Moolenaar2d358992016-06-12 21:20:54 +02002801 case BARTYPE_MARK:
Bram Moolenaarecefe712016-06-20 12:50:17 +02002802 read_next = barline_parse(virp, p, &values);
Bram Moolenaar2d358992016-06-12 21:20:54 +02002803 handle_viminfo_mark(&values, force);
2804 break;
2805
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002806 default:
2807 /* copy unrecognized line (for future use) */
2808 if (writing)
2809 ga_add_string(&virp->vir_barlines, virp->vir_line);
2810 }
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002811 for (i = 0; i < values.ga_len; ++i)
2812 {
2813 vp = (bval_T *)values.ga_data + i;
2814 if (vp->bv_type == BVAL_STRING && vp->bv_allocated)
2815 vim_free(vp->bv_string);
2816 }
2817 ga_clear(&values);
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002818 }
2819
Bram Moolenaarecefe712016-06-20 12:50:17 +02002820 if (read_next)
2821 return viminfo_readline(virp);
2822 return FALSE;
Bram Moolenaar45d2eea2016-06-06 21:07:52 +02002823}
2824
2825 static void
2826write_viminfo_version(FILE *fp_out)
2827{
2828 fprintf(fp_out, "# Viminfo version\n|%d,%d\n\n",
2829 BARTYPE_VERSION, VIMINFO_VERSION);
2830}
2831
Bram Moolenaarb20e3342016-01-18 23:29:01 +01002832 static void
2833write_viminfo_barlines(vir_T *virp, FILE *fp_out)
2834{
2835 int i;
2836 garray_T *gap = &virp->vir_barlines;
2837
2838 if (gap->ga_len > 0)
2839 {
2840 fputs(_("\n# Bar lines, copied verbatim:\n"), fp_out);
2841
2842 for (i = 0; i < gap->ga_len; ++i)
2843 fputs(((char **)(gap->ga_data))[i], fp_out);
2844 }
2845}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846#endif /* FEAT_VIMINFO */
2847
Bram Moolenaar724f2ed2016-06-11 22:21:17 +02002848#if defined(FEAT_CMDHIST) || defined(FEAT_VIMINFO) || defined(PROTO)
Bram Moolenaar46bbb0c2016-06-11 21:04:39 +02002849/*
2850 * Return the current time in seconds. Calls time(), unless test_settime()
2851 * was used.
2852 */
2853 time_t
2854vim_time(void)
2855{
2856# ifdef FEAT_EVAL
2857 return time_for_testing == 0 ? time(NULL) : time_for_testing;
2858# else
2859 return time(NULL);
2860# endif
2861}
2862#endif
2863
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864/*
2865 * Implementation of ":fixdel", also used by get_stty().
2866 * <BS> resulting <Del>
2867 * ^? ^H
2868 * not ^? ^?
2869 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002871do_fixdel(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872{
2873 char_u *p;
2874
2875 p = find_termcode((char_u *)"kb");
2876 add_termcode((char_u *)"kD", p != NULL
2877 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2878}
2879
2880 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002881print_line_no_prefix(
2882 linenr_T lnum,
2883 int use_number,
2884 int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002886 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887
2888 if (curwin->w_p_nu || use_number)
2889 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002890 vim_snprintf((char *)numbuf, sizeof(numbuf),
2891 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2893 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002894 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895}
2896
2897/*
2898 * Print a text line. Also in silent mode ("ex -s").
2899 */
2900 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002901print_line(linenr_T lnum, int use_number, int list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902{
2903 int save_silent = silent_mode;
2904
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002906 silent_mode = FALSE;
2907 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2908 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 if (save_silent)
2910 {
2911 msg_putchar('\n');
2912 cursor_on(); /* msg_start() switches it off */
2913 out_flush();
2914 silent_mode = save_silent;
2915 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002916 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917}
2918
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002919 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002920rename_buffer(char_u *new_fname)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002921{
2922 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002923 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002924
Bram Moolenaar7e283842013-05-30 11:43:15 +02002925#ifdef FEAT_AUTOCMD
2926 buf = curbuf;
2927 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002928 /* buffer changed, don't change name now */
2929 if (buf != curbuf)
2930 return FAIL;
2931# ifdef FEAT_EVAL
2932 if (aborting()) /* autocmds may abort script processing */
2933 return FAIL;
2934# endif
2935#endif
2936 /*
2937 * The name of the current buffer will be changed.
2938 * A new (unlisted) buffer entry needs to be made to hold the old file
2939 * name, which will become the alternate file name.
2940 * But don't set the alternate file name if the buffer didn't have a
2941 * name.
2942 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002943 fname = curbuf->b_ffname;
2944 sfname = curbuf->b_sfname;
2945 xfname = curbuf->b_fname;
2946 curbuf->b_ffname = NULL;
2947 curbuf->b_sfname = NULL;
2948 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002949 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002950 curbuf->b_ffname = fname;
2951 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002952 return FAIL;
2953 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002954 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002955 if (xfname != NULL && *xfname != NUL)
2956 {
2957 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2958 if (buf != NULL && !cmdmod.keepalt)
2959 curwin->w_alt_fnum = buf->b_fnum;
2960 }
2961 vim_free(fname);
2962 vim_free(sfname);
2963#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002964 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002965#endif
2966 /* Change directories when the 'acd' option is set. */
2967 DO_AUTOCHDIR
2968 return OK;
2969}
2970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971/*
2972 * ":file[!] [fname]".
2973 */
2974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002975ex_file(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002977 /* ":0file" removes the file name. Check for illegal uses ":3file",
2978 * "0file name", etc. */
2979 if (eap->addr_count > 0
2980 && (*eap->arg != NUL
2981 || eap->line2 > 0
2982 || eap->addr_count > 1))
2983 {
2984 EMSG(_(e_invarg));
2985 return;
2986 }
2987
2988 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002990 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 }
2993 /* print full file name if :cd used */
Bram Moolenaar426dd022016-03-15 15:09:29 +01002994 if (!shortmess(SHM_FILEINFO))
2995 fileinfo(FALSE, FALSE, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996}
2997
2998/*
2999 * ":update".
3000 */
3001 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003002ex_update(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003{
3004 if (curbufIsChanged())
3005 (void)do_write(eap);
3006}
3007
3008/*
3009 * ":write" and ":saveas".
3010 */
3011 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003012ex_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013{
3014 if (eap->usefilter) /* input lines to shell command */
3015 do_bang(1, eap, FALSE, TRUE, FALSE);
3016 else
3017 (void)do_write(eap);
3018}
3019
3020/*
3021 * write current buffer to file 'eap->arg'
3022 * if 'eap->append' is TRUE, append to the file
3023 *
3024 * if *eap->arg == NUL write to current file
3025 *
3026 * return FAIL for failure, OK otherwise
3027 */
3028 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003029do_write(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030{
3031 int other;
3032 char_u *fname = NULL; /* init to shut up gcc */
3033 char_u *ffname;
3034 int retval = FAIL;
3035 char_u *free_fname = NULL;
3036#ifdef FEAT_BROWSE
3037 char_u *browse_file = NULL;
3038#endif
3039 buf_T *alt_buf = NULL;
3040
3041 if (not_writing()) /* check 'write' option */
3042 return FAIL;
3043
3044 ffname = eap->arg;
3045#ifdef FEAT_BROWSE
3046 if (cmdmod.browse)
3047 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003048 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 NULL, NULL, NULL, curbuf);
3050 if (browse_file == NULL)
3051 goto theend;
3052 ffname = browse_file;
3053 }
3054#endif
3055 if (*ffname == NUL)
3056 {
3057 if (eap->cmdidx == CMD_saveas)
3058 {
3059 EMSG(_(e_argreq));
3060 goto theend;
3061 }
3062 other = FALSE;
3063 }
3064 else
3065 {
3066 fname = ffname;
3067 free_fname = fix_fname(ffname);
3068 /*
3069 * When out-of-memory, keep unexpanded file name, because we MUST be
3070 * able to write the file in this situation.
3071 */
3072 if (free_fname != NULL)
3073 ffname = free_fname;
3074 other = otherfile(ffname);
3075 }
3076
3077 /*
3078 * If we have a new file, put its name in the list of alternate file names.
3079 */
3080 if (other)
3081 {
3082 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
3083 || eap->cmdidx == CMD_saveas)
3084 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
3085 else
3086 alt_buf = buflist_findname(ffname);
3087 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
3088 {
3089 /* Overwriting a file that is loaded in another buffer is not a
3090 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00003091 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 goto theend;
3093 }
3094 }
3095
3096 /*
3097 * Writing to the current file is not allowed in readonly mode
3098 * and a file name is required.
3099 * "nofile" and "nowrite" buffers cannot be written implicitly either.
3100 */
3101 if (!other && (
3102#ifdef FEAT_QUICKFIX
3103 bt_dontwrite_msg(curbuf) ||
3104#endif
3105 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
3106 goto theend;
3107
3108 if (!other)
3109 {
3110 ffname = curbuf->b_ffname;
3111 fname = curbuf->b_fname;
3112 /*
3113 * Not writing the whole file is only allowed with '!'.
3114 */
3115 if ( (eap->line1 != 1
3116 || eap->line2 != curbuf->b_ml.ml_line_count)
3117 && !eap->forceit
3118 && !eap->append
3119 && !p_wa)
3120 {
3121#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3122 if (p_confirm || cmdmod.confirm)
3123 {
3124 if (vim_dialog_yesno(VIM_QUESTION, NULL,
3125 (char_u *)_("Write partial file?"), 2) != VIM_YES)
3126 goto theend;
3127 eap->forceit = TRUE;
3128 }
3129 else
3130#endif
3131 {
3132 EMSG(_("E140: Use ! to write partial buffer"));
3133 goto theend;
3134 }
3135 }
3136 }
3137
3138 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
3139 {
3140 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
3141 {
3142#ifdef FEAT_AUTOCMD
3143 buf_T *was_curbuf = curbuf;
3144
3145 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003146 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147# ifdef FEAT_EVAL
3148 if (curbuf != was_curbuf || aborting())
3149# else
3150 if (curbuf != was_curbuf)
3151# endif
3152 {
3153 /* buffer changed, don't change name now */
3154 retval = FAIL;
3155 goto theend;
3156 }
3157#endif
3158 /* Exchange the file names for the current and the alternate
3159 * buffer. This makes it look like we are now editing the buffer
3160 * under the new name. Must be done before buf_write(), because
3161 * if there is no file name and 'cpo' contains 'F', it will set
3162 * the file name. */
3163 fname = alt_buf->b_fname;
3164 alt_buf->b_fname = curbuf->b_fname;
3165 curbuf->b_fname = fname;
3166 fname = alt_buf->b_ffname;
3167 alt_buf->b_ffname = curbuf->b_ffname;
3168 curbuf->b_ffname = fname;
3169 fname = alt_buf->b_sfname;
3170 alt_buf->b_sfname = curbuf->b_sfname;
3171 curbuf->b_sfname = fname;
3172 buf_name_changed(curbuf);
3173#ifdef FEAT_AUTOCMD
3174 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00003175 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 if (!alt_buf->b_p_bl)
3177 {
3178 alt_buf->b_p_bl = TRUE;
3179 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
3180 }
3181# ifdef FEAT_EVAL
3182 if (curbuf != was_curbuf || aborting())
3183# else
3184 if (curbuf != was_curbuf)
3185# endif
3186 {
3187 /* buffer changed, don't write the file */
3188 retval = FAIL;
3189 goto theend;
3190 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003191
3192 /* If 'filetype' was empty try detecting it now. */
3193 if (*curbuf->b_p_ft == NUL)
3194 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003195 if (au_has_group((char_u *)"filetypedetect"))
3196 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
Bram Moolenaar1610d052016-06-09 22:53:01 +02003197 TRUE, NULL);
Bram Moolenaara3227e22006-03-08 21:32:40 +00003198 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003199 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01003200
3201 /* Autocommands may have changed buffer names, esp. when
3202 * 'autochdir' is set. */
3203 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204#endif
3205 }
3206
3207 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
3208 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003209
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003210 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003211 if (eap->cmdidx == CMD_saveas)
3212 {
3213 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00003214 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003215 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00003216#ifdef FEAT_WINDOWS
3217 redraw_tabline = TRUE;
3218#endif
3219 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003220 /* Change directories when the 'acd' option is set. */
3221 DO_AUTOCHDIR
3222 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 }
3224
3225theend:
3226#ifdef FEAT_BROWSE
3227 vim_free(browse_file);
3228#endif
3229 vim_free(free_fname);
3230 return retval;
3231}
3232
3233/*
3234 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
3235 * BF_NEW or BF_READERR, check for overwriting current file.
3236 * May set eap->forceit if a dialog says it's OK to overwrite.
3237 * Return OK if it's OK, FAIL if it is not.
3238 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02003239 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003240check_overwrite(
3241 exarg_T *eap,
3242 buf_T *buf,
3243 char_u *fname, /* file name to be used (can differ from
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 buf->ffname) */
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003245 char_u *ffname, /* full path version of fname */
3246 int other) /* writing under other name */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247{
3248 /*
3249 * write to other file or b_flags set or not writing the whole file:
3250 * overwriting only allowed with '!'
3251 */
3252 if ( (other
3253 || (buf->b_flags & BF_NOTEDITED)
3254 || ((buf->b_flags & BF_NEW)
3255 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
3256 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00003258#ifdef FEAT_QUICKFIX
3259 && !bt_nofile(buf)
3260#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 && vim_fexists(ffname))
3262 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003263 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003265#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00003266 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003267 if (mch_isdir(ffname))
3268 {
3269 EMSG2(_(e_isadir2), ffname);
3270 return FAIL;
3271 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272#endif
3273#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003274 if (p_confirm || cmdmod.confirm)
3275 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003276 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003278 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
3279 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
3280 return FAIL;
3281 eap->forceit = TRUE;
3282 }
3283 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003285 {
3286 EMSG(_(e_exists));
3287 return FAIL;
3288 }
3289 }
3290
3291 /* For ":w! filename" check that no swap file exists for "filename". */
3292 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003294 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003295 char_u *p;
3296 int r;
3297 char_u *swapname;
3298
3299 /* We only try the first entry in 'directory', without checking if
3300 * it's writable. If the "." directory is not writable the write
3301 * will probably fail anyway.
3302 * Use 'shortname' of the current buffer, since there is no buffer
3303 * for the written file. */
3304 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02003305 {
3306 dir = alloc(5);
3307 if (dir == NULL)
3308 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003309 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02003310 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003311 else
3312 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003313 dir = alloc(MAXPATHL);
3314 if (dir == NULL)
3315 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003316 p = p_dir;
3317 copy_option_part(&p, dir, MAXPATHL, ",");
3318 }
3319 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02003320 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003321 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003322 if (r)
3323 {
3324#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3325 if (p_confirm || cmdmod.confirm)
3326 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003327 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003328
3329 dialog_msg(buff,
3330 _("Swap file \"%s\" exists, overwrite anyway?"),
3331 swapname);
3332 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
3333 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003334 {
3335 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003336 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003337 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003338 eap->forceit = TRUE;
3339 }
3340 else
3341#endif
3342 {
3343 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
3344 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003345 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00003346 return FAIL;
3347 }
3348 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003349 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 }
3351 }
3352 return OK;
3353}
3354
3355/*
3356 * Handle ":wnext", ":wNext" and ":wprevious" commands.
3357 */
3358 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003359ex_wnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360{
3361 int i;
3362
3363 if (eap->cmd[1] == 'n')
3364 i = curwin->w_arg_idx + (int)eap->line2;
3365 else
3366 i = curwin->w_arg_idx - (int)eap->line2;
3367 eap->line1 = 1;
3368 eap->line2 = curbuf->b_ml.ml_line_count;
3369 if (do_write(eap) != FAIL)
3370 do_argfile(eap, i);
3371}
3372
3373/*
3374 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
3375 */
3376 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003377do_wqall(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378{
3379 buf_T *buf;
3380 int error = 0;
3381 int save_forceit = eap->forceit;
3382
3383 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
3384 exiting = TRUE;
3385
3386 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
3387 {
3388 if (bufIsChanged(buf))
3389 {
3390 /*
3391 * Check if there is a reason the buffer cannot be written:
3392 * 1. if the 'write' option is set
3393 * 2. if there is no file name (even after browsing)
3394 * 3. if the 'readonly' is set (even after a dialog)
3395 * 4. if overwriting is allowed (even after a dialog)
3396 */
3397 if (not_writing())
3398 {
3399 ++error;
3400 break;
3401 }
3402#ifdef FEAT_BROWSE
3403 /* ":browse wall": ask for file name if there isn't one */
3404 if (buf->b_ffname == NULL && cmdmod.browse)
3405 browse_save_fname(buf);
3406#endif
3407 if (buf->b_ffname == NULL)
3408 {
3409 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
3410 ++error;
3411 }
3412 else if (check_readonly(&eap->forceit, buf)
3413 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
3414 FALSE) == FAIL)
3415 {
3416 ++error;
3417 }
3418 else
3419 {
3420 if (buf_write_all(buf, eap->forceit) == FAIL)
3421 ++error;
3422#ifdef FEAT_AUTOCMD
3423 /* an autocommand may have deleted the buffer */
3424 if (!buf_valid(buf))
3425 buf = firstbuf;
3426#endif
3427 }
3428 eap->forceit = save_forceit; /* check_overwrite() may set it */
3429 }
3430 }
3431 if (exiting)
3432 {
3433 if (!error)
3434 getout(0); /* exit Vim */
3435 not_exiting();
3436 }
3437}
3438
3439/*
3440 * Check the 'write' option.
3441 * Return TRUE and give a message when it's not st.
3442 */
3443 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003444not_writing(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445{
3446 if (p_write)
3447 return FALSE;
3448 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
3449 return TRUE;
3450}
3451
3452/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00003453 * Check if a buffer is read-only (either 'readonly' option is set or file is
3454 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
3455 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 */
3457 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003458check_readonly(int *forceit, buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459{
Bram Moolenaar5386a122007-06-28 20:02:32 +00003460 struct stat st;
3461
3462 /* Handle a file being readonly when the 'readonly' option is set or when
3463 * the file exists and permissions are read-only.
3464 * We will send 0777 to check_file_readonly(), as the "perm" variable is
3465 * important for device checks but not here. */
3466 if (!*forceit && (buf->b_p_ro
3467 || (mch_stat((char *)buf->b_ffname, &st) >= 0
3468 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 {
3470#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3471 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
3472 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02003473 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474
Bram Moolenaar5386a122007-06-28 20:02:32 +00003475 if (buf->b_p_ro)
3476 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
3477 buf->b_fname);
3478 else
3479 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 +00003480 buf->b_fname);
3481
3482 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
3483 {
3484 /* Set forceit, to force the writing of a readonly file */
3485 *forceit = TRUE;
3486 return FALSE;
3487 }
3488 else
3489 return TRUE;
3490 }
3491 else
3492#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003493 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003495 else
3496 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3497 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 return TRUE;
3499 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003500
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 return FALSE;
3502}
3503
3504/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003505 * Try to abandon current file and edit a new or existing file.
3506 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003508 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003509 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3511 */
3512 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003513getfile(
3514 int fnum,
3515 char_u *ffname,
3516 char_u *sfname,
3517 int setpm,
3518 linenr_T lnum,
3519 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520{
3521 int other;
3522 int retval;
3523 char_u *free_me = NULL;
3524
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003525 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003527#ifdef FEAT_AUTOCMD
3528 if (curbuf_locked())
3529 return 1;
3530#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531
3532 if (fnum == 0)
3533 {
3534 /* make ffname full path, set sfname */
3535 fname_expand(curbuf, &ffname, &sfname);
3536 other = otherfile(ffname);
3537 free_me = ffname; /* has been allocated, free() later */
3538 }
3539 else
3540 other = (fnum != curbuf->b_fnum);
3541
3542 if (other)
3543 ++no_wait_return; /* don't wait for autowrite message */
3544 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3545 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3546 {
3547#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3548 if (p_confirm && p_write)
3549 dialog_changed(curbuf, FALSE);
3550 if (curbufIsChanged())
3551#endif
3552 {
3553 if (other)
3554 --no_wait_return;
3555 EMSG(_(e_nowrtmsg));
3556 retval = 2; /* file has been changed */
3557 goto theend;
3558 }
3559 }
3560 if (other)
3561 --no_wait_return;
3562 if (setpm)
3563 setpcmark();
3564 if (!other)
3565 {
3566 if (lnum != 0)
3567 curwin->w_cursor.lnum = lnum;
3568 check_cursor_lnum();
3569 beginline(BL_SOL | BL_FIX);
3570 retval = 0; /* it's in the same file */
3571 }
3572 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003573 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3574 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 retval = -1; /* opened another file */
3576 else
3577 retval = 1; /* error encountered */
3578
3579theend:
3580 vim_free(free_me);
3581 return retval;
3582}
3583
3584/*
3585 * start editing a new file
3586 *
3587 * fnum: file number; if zero use ffname/sfname
3588 * ffname: the file name
3589 * - full path if sfname used,
3590 * - any file name if sfname is NULL
3591 * - empty string to re-edit with the same file name (but may be
3592 * in a different directory)
3593 * - NULL to start an empty buffer
3594 * sfname: the short file name (or NULL)
3595 * eap: contains the command to be executed after loading the file and
3596 * forced 'ff' and 'fenc'
3597 * newlnum: if > 0: put cursor on this line number (if possible)
3598 * if ECMD_LASTL: use last position in loaded file
3599 * if ECMD_LAST: use last position in all files
3600 * if ECMD_ONE: use first line
3601 * flags:
3602 * ECMD_HIDE: if TRUE don't free the current buffer
3603 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3604 * ECMD_OLDBUF: use existing buffer if it exists
3605 * ECMD_FORCEIT: ! used for Ex command
3606 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003607 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003608 * window, NULL when splitting the window first. When not NULL info
3609 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 *
3611 * return FAIL for failure, OK otherwise
3612 */
3613 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003614do_ecmd(
3615 int fnum,
3616 char_u *ffname,
3617 char_u *sfname,
3618 exarg_T *eap, /* can be NULL! */
3619 linenr_T newlnum,
3620 int flags,
3621 win_T *oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622{
3623 int other_file; /* TRUE if editing another file */
3624 int oldbuf; /* TRUE if using existing buffer */
3625#ifdef FEAT_AUTOCMD
3626 int auto_buf = FALSE; /* TRUE if autocommands brought us
3627 into the buffer unexpectedly */
3628 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003629 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630#endif
3631 buf_T *buf;
3632#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3633 buf_T *old_curbuf = curbuf;
3634#endif
3635 char_u *free_fname = NULL;
3636#ifdef FEAT_BROWSE
3637 char_u *browse_file = NULL;
3638#endif
3639 int retval = FAIL;
3640 long n;
Bram Moolenaareab316b2015-03-24 11:46:30 +01003641 pos_T orig_pos;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 linenr_T topline = 0;
3643 int newcol = -1;
3644 int solcol = -1;
3645 pos_T *pos;
3646#ifdef FEAT_SUN_WORKSHOP
3647 char_u *cp;
3648#endif
3649 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003650#ifdef FEAT_SPELL
3651 int did_get_winopts = FALSE;
3652#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003653 int readfile_flags = 0;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003654 int did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655
3656 if (eap != NULL)
3657 command = eap->do_ecmd_cmd;
3658
3659 if (fnum != 0)
3660 {
3661 if (fnum == curbuf->b_fnum) /* file is already being edited */
3662 return OK; /* nothing to do */
3663 other_file = TRUE;
3664 }
3665 else
3666 {
3667#ifdef FEAT_BROWSE
3668 if (cmdmod.browse)
3669 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003670# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003671 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003672# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003673 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003674# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003675 au_has_group((char_u *)"FileExplorer"))
3676 {
3677 /* No browsing supported but we do have the file explorer:
3678 * Edit the directory. */
3679 if (ffname == NULL || !mch_isdir(ffname))
3680 ffname = (char_u *)".";
3681 }
3682 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003683# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003684 {
3685 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003687 if (browse_file == NULL)
3688 goto theend;
3689 ffname = browse_file;
3690 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 }
3692#endif
3693 /* if no short name given, use ffname for short name */
3694 if (sfname == NULL)
3695 sfname = ffname;
3696#ifdef USE_FNAME_CASE
3697# ifdef USE_LONG_FNAME
3698 if (USE_LONG_FNAME)
3699# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003700 if (sfname != NULL)
3701 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702#endif
3703
3704#ifdef FEAT_LISTCMDS
3705 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3706 goto theend;
3707#endif
3708
3709 if (ffname == NULL)
3710 other_file = TRUE;
3711 /* there is no file name */
3712 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3713 other_file = FALSE;
3714 else
3715 {
3716 if (*ffname == NUL) /* re-edit with same file name */
3717 {
3718 ffname = curbuf->b_ffname;
3719 sfname = curbuf->b_fname;
3720 }
3721 free_fname = fix_fname(ffname); /* may expand to full path name */
3722 if (free_fname != NULL)
3723 ffname = free_fname;
3724 other_file = otherfile(ffname);
3725#ifdef FEAT_SUN_WORKSHOP
3726 if (usingSunWorkShop && p_acd
3727 && (cp = vim_strrchr(sfname, '/')) != NULL)
3728 sfname = ++cp;
3729#endif
3730 }
3731 }
3732
3733 /*
3734 * if the file was changed we may not be allowed to abandon it
3735 * - if we are going to re-edit the same file
3736 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3737 */
3738 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3739 || (curbuf->b_nwindows == 1
3740 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003741 && check_changed(curbuf, (p_awa ? CCGD_AW : 0)
3742 | (other_file ? 0 : CCGD_MULTWIN)
3743 | ((flags & ECMD_FORCEIT) ? CCGD_FORCEIT : 0)
3744 | (eap == NULL ? 0 : CCGD_EXCMD)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 {
3746 if (fnum == 0 && other_file && ffname != NULL)
3747 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3748 goto theend;
3749 }
3750
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 /*
3752 * End Visual mode before switching to another buffer, so the text can be
3753 * copied into the GUI selection buffer.
3754 */
3755 reset_VIsual();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003757#ifdef FEAT_AUTOCMD
3758 if ((command != NULL || newlnum > (linenr_T)0)
3759 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3760 {
3761 int len;
3762 char_u *p;
3763
3764 /* Set v:swapcommand for the SwapExists autocommands. */
3765 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003766 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003767 else
3768 len = 30;
3769 p = alloc((unsigned)len);
3770 if (p != NULL)
3771 {
3772 if (command != NULL)
3773 vim_snprintf((char *)p, len, ":%s\r", command);
3774 else
3775 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3776 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3777 did_set_swapcommand = TRUE;
3778 vim_free(p);
3779 }
3780 }
3781#endif
3782
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 /*
3784 * If we are starting to edit another file, open a (new) buffer.
3785 * Otherwise we re-use the current buffer.
3786 */
3787 if (other_file)
3788 {
3789#ifdef FEAT_LISTCMDS
3790 if (!(flags & ECMD_ADDBUF))
3791#endif
3792 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003793 if (!cmdmod.keepalt)
3794 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003795 if (oldwin != NULL)
3796 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 }
3798
3799 if (fnum)
3800 buf = buflist_findnr(fnum);
3801 else
3802 {
3803#ifdef FEAT_LISTCMDS
3804 if (flags & ECMD_ADDBUF)
3805 {
3806 linenr_T tlnum = 1L;
3807
3808 if (command != NULL)
3809 {
3810 tlnum = atol((char *)command);
3811 if (tlnum <= 0)
3812 tlnum = 1L;
3813 }
3814 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3815 goto theend;
3816 }
3817#endif
3818 buf = buflist_new(ffname, sfname, 0L,
3819 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
Bram Moolenaar4c7ab1b2014-04-06 20:45:43 +02003820#ifdef FEAT_AUTOCMD
3821 /* autocommands may change curwin and curbuf */
3822 if (oldwin != NULL)
3823 oldwin = curwin;
3824 old_curbuf = curbuf;
3825#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 }
3827 if (buf == NULL)
3828 goto theend;
3829 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3830 {
3831 oldbuf = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 }
3833 else /* existing memfile */
3834 {
3835 oldbuf = TRUE;
3836 (void)buf_check_timestamp(buf, FALSE);
3837 /* Check if autocommands made buffer invalid or changed the current
3838 * buffer. */
3839 if (!buf_valid(buf)
3840#ifdef FEAT_AUTOCMD
3841 || curbuf != old_curbuf
3842#endif
3843 )
3844 goto theend;
3845#ifdef FEAT_EVAL
3846 if (aborting()) /* autocmds may abort script processing */
3847 goto theend;
3848#endif
3849 }
3850
3851 /* May jump to last used line number for a loaded buffer or when asked
3852 * for explicitly */
3853 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3854 {
3855 pos = buflist_findfpos(buf);
3856 newlnum = pos->lnum;
3857 solcol = pos->col;
3858 }
3859
3860 /*
3861 * Make the (new) buffer the one used by the current window.
3862 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3863 * If the current buffer was empty and has no file name, curbuf
Bram Moolenaar8da9bbf2015-02-27 19:34:56 +01003864 * is returned by buflist_new(), nothing to do here.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 */
3866 if (buf != curbuf)
3867 {
3868#ifdef FEAT_AUTOCMD
3869 /*
3870 * Be careful: The autocommands may delete any buffer and change
3871 * the current buffer.
3872 * - If the buffer we are going to edit is deleted, give up.
3873 * - If the current buffer is deleted, prefer to load the new
3874 * buffer when loading a buffer is required. This avoids
3875 * loading another buffer which then must be closed again.
3876 * - If we ended up in the new buffer already, need to skip a few
3877 * things, set auto_buf.
3878 */
3879 if (buf->b_fname != NULL)
3880 new_name = vim_strsave(buf->b_fname);
3881 au_new_curbuf = buf;
3882 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3883 if (!buf_valid(buf)) /* new buffer has been deleted */
3884 {
3885 delbuf_msg(new_name); /* frees new_name */
3886 goto theend;
3887 }
3888# ifdef FEAT_EVAL
3889 if (aborting()) /* autocmds may abort script processing */
3890 {
3891 vim_free(new_name);
3892 goto theend;
3893 }
3894# endif
3895 if (buf == curbuf) /* already in new buffer */
3896 auto_buf = TRUE;
3897 else
3898 {
3899 if (curbuf == old_curbuf)
3900#endif
3901 buf_copy_options(buf, BCO_ENTER);
3902
3903 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003904 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003905 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003906 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907
3908#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003909 /* Autocommands may open a new window and leave oldwin open
3910 * which leads to crashes since the above call sets
3911 * oldwin->w_buffer to NULL. */
3912 if (curwin != oldwin && oldwin != aucmd_win
3913 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3914 win_close(oldwin, FALSE);
3915
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916# ifdef FEAT_EVAL
3917 if (aborting()) /* autocmds may abort script processing */
3918 {
3919 vim_free(new_name);
3920 goto theend;
3921 }
3922# endif
3923 /* Be careful again, like above. */
3924 if (!buf_valid(buf)) /* new buffer has been deleted */
3925 {
3926 delbuf_msg(new_name); /* frees new_name */
3927 goto theend;
3928 }
3929 if (buf == curbuf) /* already in new buffer */
3930 auto_buf = TRUE;
3931 else
3932#endif
3933 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003934#ifdef FEAT_SYN_HL
3935 /*
3936 * <VN> We could instead free the synblock
3937 * and re-attach to buffer, perhaps.
3938 */
3939 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003940 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003941#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 curwin->w_buffer = buf;
3943 curbuf = buf;
3944 ++curbuf->b_nwindows;
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003945
3946 /* Set 'fileformat', 'binary' and 'fenc' when forced. */
3947 if (!oldbuf && eap != NULL)
3948 {
3949 set_file_options(TRUE, eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003950#ifdef FEAT_MBYTE
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003951 set_forced_fenc(eap);
Bram Moolenaara2320f42013-07-28 15:16:19 +02003952#endif
Bram Moolenaarad875fb2013-07-24 15:02:03 +02003953 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 }
3955
3956 /* May get the window options from the last time this buffer
3957 * was in this window (or another window). If not used
3958 * before, reset the local window options to the global
3959 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003960 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003961#ifdef FEAT_SPELL
3962 did_get_winopts = TRUE;
3963#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964
3965#ifdef FEAT_AUTOCMD
3966 }
3967 vim_free(new_name);
3968 au_new_curbuf = NULL;
3969#endif
3970 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971
3972 curwin->w_pcmark.lnum = 1;
3973 curwin->w_pcmark.col = 0;
3974 }
3975 else /* !other_file */
3976 {
3977 if (
3978#ifdef FEAT_LISTCMDS
3979 (flags & ECMD_ADDBUF) ||
3980#endif
3981 check_fname() == FAIL)
3982 goto theend;
Bram Moolenaardf5caa02015-01-27 11:26:15 +01003983
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 oldbuf = (flags & ECMD_OLDBUF);
3985 }
3986
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01003987 /* Don't redraw until the cursor is in the right line, otherwise
3988 * autocommands may cause ml_get errors. */
3989 ++RedrawingDisabled;
3990 did_inc_redrawing_disabled = TRUE;
3991
Bram Moolenaar54fb4382014-11-12 19:28:16 +01003992#ifdef FEAT_AUTOCMD
3993 buf = curbuf;
3994#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3996 {
Bram Moolenaar54fb4382014-11-12 19:28:16 +01003997 prepare_help_buffer();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 }
3999 else
4000 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 /* Don't make a buffer listed if it's a help buffer. Useful when
4002 * using CTRL-O to go back to a help file. */
4003 if (!curbuf->b_help)
4004 set_buflisted(TRUE);
4005 }
4006
4007#ifdef FEAT_AUTOCMD
4008 /* If autocommands change buffers under our fingers, forget about
4009 * editing the file. */
4010 if (buf != curbuf)
4011 goto theend;
4012# ifdef FEAT_EVAL
4013 if (aborting()) /* autocmds may abort script processing */
4014 goto theend;
4015# endif
4016
4017 /* Since we are starting to edit a file, consider the filetype to be
4018 * unset. Helps for when an autocommand changes files and expects syntax
4019 * highlighting to work in the other file. */
4020 did_filetype = FALSE;
4021#endif
4022
4023/*
4024 * other_file oldbuf
4025 * FALSE FALSE re-edit same file, buffer is re-used
4026 * FALSE TRUE re-edit same file, nothing changes
4027 * TRUE FALSE start editing new file, new buffer
4028 * TRUE TRUE start editing in existing buffer (nothing to do)
4029 */
4030 if (!other_file && !oldbuf) /* re-use the buffer */
4031 {
4032 set_last_cursor(curwin); /* may set b_last_cursor */
4033 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
4034 {
4035 newlnum = curwin->w_cursor.lnum;
4036 solcol = curwin->w_cursor.col;
4037 }
4038#ifdef FEAT_AUTOCMD
4039 buf = curbuf;
4040 if (buf->b_fname != NULL)
4041 new_name = vim_strsave(buf->b_fname);
4042 else
4043 new_name = NULL;
4044#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004045 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
4046 {
4047 /* Save all the text, so that the reload can be undone.
4048 * Sync first so that this is a separate undo-able action. */
4049 u_sync(FALSE);
4050 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
4051 == FAIL)
4052 goto theend;
4053 u_unchanged(curbuf);
4054 buf_freeall(curbuf, BFA_KEEP_UNDO);
4055
4056 /* tell readfile() not to clear or reload undo info */
4057 readfile_flags = READ_KEEP_UNDO;
4058 }
4059 else
4060 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061#ifdef FEAT_AUTOCMD
4062 /* If autocommands deleted the buffer we were going to re-edit, give
4063 * up and jump to the end. */
4064 if (!buf_valid(buf))
4065 {
4066 delbuf_msg(new_name); /* frees new_name */
4067 goto theend;
4068 }
4069 vim_free(new_name);
4070
4071 /* If autocommands change buffers under our fingers, forget about
4072 * re-editing the file. Should do the buf_clear_file(), but perhaps
4073 * the autocommands changed the buffer... */
4074 if (buf != curbuf)
4075 goto theend;
4076# ifdef FEAT_EVAL
4077 if (aborting()) /* autocmds may abort script processing */
4078 goto theend;
4079# endif
4080#endif
4081 buf_clear_file(curbuf);
4082 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
4083 curbuf->b_op_end.lnum = 0;
4084 }
4085
4086/*
4087 * If we get here we are sure to start editing
4088 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 /* Assume success now */
4090 retval = OK;
4091
4092 /*
4093 * Reset cursor position, could be used by autocommands.
4094 */
4095 check_cursor();
4096
4097 /*
4098 * Check if we are editing the w_arg_idx file in the argument list.
4099 */
4100 check_arg_idx(curwin);
4101
4102#ifdef FEAT_AUTOCMD
4103 if (!auto_buf)
4104#endif
4105 {
4106 /*
4107 * Set cursor and init window before reading the file and executing
4108 * autocommands. This allows for the autocommands to position the
4109 * cursor.
4110 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00004111 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
4113#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004114 /* It's possible that all lines in the buffer changed. Need to update
4115 * automatic folding for all windows where it's used. */
4116# ifdef FEAT_WINDOWS
4117 {
4118 win_T *win;
4119 tabpage_T *tp;
4120
4121 FOR_ALL_TAB_WINDOWS(tp, win)
4122 if (win->w_buffer == curbuf)
4123 foldUpdateAll(win);
4124 }
4125# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00004127# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128#endif
4129
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004130 /* Change directories when the 'acd' option is set. */
4131 DO_AUTOCHDIR
4132
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 /*
4134 * Careful: open_buffer() and apply_autocmds() may change the current
4135 * buffer and window.
4136 */
Bram Moolenaareab316b2015-03-24 11:46:30 +01004137 orig_pos = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 topline = curwin->w_topline;
4139 if (!oldbuf) /* need to read the file */
4140 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004141#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 swap_exists_action = SEA_DIALOG;
4143#endif
4144 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
4145
4146 /*
4147 * Open the buffer and read the file.
4148 */
4149#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004150 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 retval = FAIL;
4152#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02004153 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154#endif
4155
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00004156#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 if (swap_exists_action == SEA_QUIT)
4158 retval = FAIL;
4159 handle_swap_exists(old_curbuf);
4160#endif
4161 }
4162#ifdef FEAT_AUTOCMD
4163 else
4164 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004165 /* Read the modelines, but only to set window-local options. Any
4166 * buffer-local options have already been set and may have been
4167 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00004168 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00004169
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
4171 &retval);
4172 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
4173 &retval);
4174 }
4175 check_arg_idx(curwin);
4176#endif
4177
Bram Moolenaareab316b2015-03-24 11:46:30 +01004178 /* If autocommands change the cursor position or topline, we should
4179 * keep it. Also when it moves within a line. */
4180 if (!equalpos(curwin->w_cursor, orig_pos))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 {
4182 newlnum = curwin->w_cursor.lnum;
4183 newcol = curwin->w_cursor.col;
4184 }
4185 if (curwin->w_topline == topline)
4186 topline = 0;
4187
4188 /* Even when cursor didn't move we need to recompute topline. */
4189 changed_line_abv_curs();
4190
4191#ifdef FEAT_TITLE
4192 maketitle();
4193#endif
4194 }
4195
4196#ifdef FEAT_DIFF
4197 /* Tell the diff stuff that this buffer is new and/or needs updating.
4198 * Also needed when re-editing the same buffer, because unloading will
4199 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00004200 if (curwin->w_p_diff)
4201 {
4202 diff_buf_add(curbuf);
4203 diff_invalidate(curbuf);
4204 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205#endif
4206
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004207#ifdef FEAT_SPELL
4208 /* If the window options were changed may need to set the spell language.
4209 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004210 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
4211 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00004212#endif
4213
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 if (command == NULL)
4215 {
4216 if (newcol >= 0) /* position set by autocommands */
4217 {
4218 curwin->w_cursor.lnum = newlnum;
4219 curwin->w_cursor.col = newcol;
4220 check_cursor();
4221 }
4222 else if (newlnum > 0) /* line number from caller or old position */
4223 {
4224 curwin->w_cursor.lnum = newlnum;
4225 check_cursor_lnum();
4226 if (solcol >= 0 && !p_sol)
4227 {
4228 /* 'sol' is off: Use last known column. */
4229 curwin->w_cursor.col = solcol;
4230 check_cursor_col();
4231#ifdef FEAT_VIRTUALEDIT
4232 curwin->w_cursor.coladd = 0;
4233#endif
4234 curwin->w_set_curswant = TRUE;
4235 }
4236 else
4237 beginline(BL_SOL | BL_FIX);
4238 }
4239 else /* no line number, go to last line in Ex mode */
4240 {
4241 if (exmode_active)
4242 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
4243 beginline(BL_WHITE | BL_FIX);
4244 }
4245 }
4246
4247#ifdef FEAT_WINDOWS
4248 /* Check if cursors in other windows on the same buffer are still valid */
4249 check_lnums(FALSE);
4250#endif
4251
4252 /*
4253 * Did not read the file, need to show some info about the file.
4254 * Do this after setting the cursor.
4255 */
4256 if (oldbuf
4257#ifdef FEAT_AUTOCMD
4258 && !auto_buf
4259#endif
4260 )
4261 {
4262 int msg_scroll_save = msg_scroll;
4263
4264 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
4265 * message. */
4266 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
4267 msg_scroll = FALSE;
4268 if (!msg_scroll) /* wait a bit when overwriting an error msg */
4269 check_for_delay(FALSE);
4270 msg_start();
4271 msg_scroll = msg_scroll_save;
4272 msg_scrolled_ign = TRUE;
4273
Bram Moolenaar426dd022016-03-15 15:09:29 +01004274 if (!shortmess(SHM_FILEINFO))
4275 fileinfo(FALSE, TRUE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276
4277 msg_scrolled_ign = FALSE;
4278 }
4279
4280 if (command != NULL)
4281 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
4282
4283#ifdef FEAT_KEYMAP
4284 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00004285 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286#endif
4287
4288 --RedrawingDisabled;
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004289 did_inc_redrawing_disabled = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 if (!skip_redraw)
4291 {
4292 n = p_so;
4293 if (topline == 0 && command == NULL)
4294 p_so = 999; /* force cursor halfway the window */
4295 update_topline();
4296#ifdef FEAT_SCROLLBIND
4297 curwin->w_scbind_pos = curwin->w_topline;
4298#endif
4299 p_so = n;
4300 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
4301 }
4302
4303 if (p_im)
4304 need_start_insertmode = TRUE;
4305
Bram Moolenaar498efdb2006-09-05 14:31:54 +00004306 /* Change directories when the 'acd' option is set. */
4307 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00004309#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02004310 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 {
4312# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02004313 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
4315# endif
4316# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02004317 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00004318 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319# endif
4320 }
4321#endif
4322
4323theend:
Bram Moolenaarab9fc7e2016-02-06 15:29:40 +01004324 if (did_inc_redrawing_disabled)
4325 --RedrawingDisabled;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004326#ifdef FEAT_AUTOCMD
4327 if (did_set_swapcommand)
4328 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
4329#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330#ifdef FEAT_BROWSE
4331 vim_free(browse_file);
4332#endif
4333 vim_free(free_fname);
4334 return retval;
4335}
4336
4337#ifdef FEAT_AUTOCMD
4338 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004339delbuf_msg(char_u *name)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340{
4341 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
4342 name == NULL ? (char_u *)"" : name);
4343 vim_free(name);
4344 au_new_curbuf = NULL;
4345}
4346#endif
4347
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004348static int append_indent = 0; /* autoindent for first line */
4349
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350/*
4351 * ":insert" and ":append", also used by ":change"
4352 */
4353 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004354ex_append(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355{
4356 char_u *theline;
4357 int did_undo = FALSE;
4358 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004359 int indent = 0;
4360 char_u *p;
4361 int vcol;
4362 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004364 /* the ! flag toggles autoindent */
4365 if (eap->forceit)
4366 curbuf->b_p_ai = !curbuf->b_p_ai;
4367
4368 /* First autoindent comes from the line we start on */
4369 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
4370 append_indent = get_indent_lnum(lnum);
4371
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 if (eap->cmdidx != CMD_append)
4373 --lnum;
4374
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004375 /* when the buffer is empty append to line 0 and delete the dummy line */
4376 if (empty && lnum == 1)
4377 lnum = 0;
4378
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 State = INSERT; /* behave like in Insert mode */
4380 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
4381 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004382
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00004383 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 {
4385 msg_scroll = TRUE;
4386 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004387 if (curbuf->b_p_ai)
4388 {
4389 if (append_indent >= 0)
4390 {
4391 indent = append_indent;
4392 append_indent = -1;
4393 }
4394 else if (lnum > 0)
4395 indent = get_indent_lnum(lnum);
4396 }
4397 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004399 {
4400 /* No getline() function, use the lines that follow. This ends
4401 * when there is no more. */
4402 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
4403 break;
4404 p = vim_strchr(eap->nextcmd, NL);
4405 if (p == NULL)
4406 p = eap->nextcmd + STRLEN(eap->nextcmd);
4407 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
4408 if (*p != NUL)
4409 ++p;
4410 eap->nextcmd = p;
4411 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 else
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004413 {
4414 int save_State = State;
4415
4416 /* Set State to avoid the cursor shape to be set to INSERT mode
4417 * when getline() returns. */
4418 State = CMDLINE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 theline = eap->getline(
4420#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00004421 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004423 NUL, eap->cookie, indent);
Bram Moolenaar26f08b02014-08-29 09:02:27 +02004424 State = save_State;
4425 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004427 if (theline == NULL)
4428 break;
4429
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004430 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
4431 if (ex_keep_indent)
4432 append_indent = indent;
4433
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004434 /* Look for the "." after automatic indent. */
4435 vcol = 0;
4436 for (p = theline; indent > vcol; ++p)
4437 {
4438 if (*p == ' ')
4439 ++vcol;
4440 else if (*p == TAB)
4441 vcol += 8 - vcol % 8;
4442 else
4443 break;
4444 }
4445 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00004446 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
4447 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 {
4449 vim_free(theline);
4450 break;
4451 }
4452
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004453 /* don't use autoindent if nothing was typed. */
4454 if (p[0] == NUL)
4455 theline[0] = NUL;
4456
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 did_undo = TRUE;
4458 ml_append(lnum, theline, (colnr_T)0, FALSE);
4459 appended_lines_mark(lnum, 1L);
4460
4461 vim_free(theline);
4462 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004463
4464 if (empty)
4465 {
4466 ml_delete(2L, FALSE);
4467 empty = FALSE;
4468 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 }
4470 State = NORMAL;
4471
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004472 if (eap->forceit)
4473 curbuf->b_p_ai = !curbuf->b_p_ai;
4474
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004476 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 * "end" is set to lnum when something has been appended, otherwise
4478 * it is the same than "start" -- Acevedo */
4479 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4480 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4481 if (eap->cmdidx != CMD_append)
4482 --curbuf->b_op_start.lnum;
4483 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4484 ? lnum : curbuf->b_op_start.lnum;
4485 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4486 curwin->w_cursor.lnum = lnum;
4487 check_cursor_lnum();
4488 beginline(BL_SOL | BL_FIX);
4489
4490 need_wait_return = FALSE; /* don't use wait_return() now */
4491 ex_no_reprint = TRUE;
4492}
4493
4494/*
4495 * ":change"
4496 */
4497 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004498ex_change(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499{
4500 linenr_T lnum;
4501
4502 if (eap->line2 >= eap->line1
4503 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4504 return;
4505
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004506 /* the ! flag toggles autoindent */
4507 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4508 append_indent = get_indent_lnum(eap->line1);
4509
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4511 {
4512 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4513 break;
4514 ml_delete(eap->line1, FALSE);
4515 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004516
4517 /* make sure the cursor is not beyond the end of the file now */
4518 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4520
4521 /* ":append" on the line above the deleted lines. */
4522 eap->line2 = eap->line1;
4523 ex_append(eap);
4524}
4525
4526 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004527ex_z(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528{
4529 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004530 int bigness;
4531 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 int minus = 0;
4533 linenr_T start, end, curs, i;
4534 int j;
4535 linenr_T lnum = eap->line2;
4536
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004537 /* Vi compatible: ":z!" uses display height, without a count uses
4538 * 'scroll' */
4539 if (eap->forceit)
4540 bigness = curwin->w_height;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004541#ifdef FEAT_WINDOWS
Bram Moolenaar631abc32014-02-22 22:27:47 +01004542 else if (firstwin != lastwin)
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004543 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004544#endif
Bram Moolenaar631abc32014-02-22 22:27:47 +01004545 else
4546 bigness = curwin->w_p_scr * 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 if (bigness < 1)
4548 bigness = 1;
4549
4550 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004551 kind = x;
4552 if (*kind == '-' || *kind == '+' || *kind == '='
4553 || *kind == '^' || *kind == '.')
4554 ++x;
4555 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 ++x;
4557
4558 if (*x != 0)
4559 {
4560 if (!VIM_ISDIGIT(*x))
4561 {
4562 EMSG(_("E144: non-numeric argument to :z"));
4563 return;
4564 }
4565 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004566 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004568 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004569 if (*kind == '=')
4570 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004571 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 }
4573
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004574 /* the number of '-' and '+' multiplies the distance */
4575 if (*kind == '-' || *kind == '+')
4576 for (x = kind + 1; *x == *kind; ++x)
4577 ;
4578
4579 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 {
4581 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004582 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4583 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004584 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 break;
4586
4587 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004588 start = lnum - (bigness + 1) / 2 + 1;
4589 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 curs = lnum;
4591 minus = 1;
4592 break;
4593
4594 case '^':
4595 start = lnum - bigness * 2;
4596 end = lnum - bigness;
4597 curs = lnum - bigness;
4598 break;
4599
4600 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004601 start = lnum - (bigness + 1) / 2 + 1;
4602 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 curs = end;
4604 break;
4605
4606 default: /* '+' */
4607 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004608 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004609 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004610 else if (eap->addr_count == 0)
4611 ++start;
4612 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 curs = end;
4614 break;
4615 }
4616
4617 if (start < 1)
4618 start = 1;
4619
4620 if (end > curbuf->b_ml.ml_line_count)
4621 end = curbuf->b_ml.ml_line_count;
4622
4623 if (curs > curbuf->b_ml.ml_line_count)
4624 curs = curbuf->b_ml.ml_line_count;
4625
4626 for (i = start; i <= end; i++)
4627 {
4628 if (minus && i == lnum)
4629 {
4630 msg_putchar('\n');
4631
4632 for (j = 1; j < Columns; j++)
4633 msg_putchar('-');
4634 }
4635
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004636 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
4638 if (minus && i == lnum)
4639 {
4640 msg_putchar('\n');
4641
4642 for (j = 1; j < Columns; j++)
4643 msg_putchar('-');
4644 }
4645 }
4646
4647 curwin->w_cursor.lnum = curs;
4648 ex_no_reprint = TRUE;
4649}
4650
4651/*
4652 * Check if the restricted flag is set.
4653 * If so, give an error message and return TRUE.
4654 * Otherwise, return FALSE.
4655 */
4656 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004657check_restricted(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658{
4659 if (restricted)
4660 {
4661 EMSG(_("E145: Shell commands not allowed in rvim"));
4662 return TRUE;
4663 }
4664 return FALSE;
4665}
4666
4667/*
4668 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4669 * If so, give an error message and return TRUE.
4670 * Otherwise, return FALSE.
4671 */
4672 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004673check_secure(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674{
4675 if (secure)
4676 {
4677 secure = 2;
4678 EMSG(_(e_curdir));
4679 return TRUE;
4680 }
4681#ifdef HAVE_SANDBOX
4682 /*
4683 * In the sandbox more things are not allowed, including the things
4684 * disallowed in secure mode.
4685 */
4686 if (sandbox != 0)
4687 {
4688 EMSG(_(e_sandbox));
4689 return TRUE;
4690 }
4691#endif
4692 return FALSE;
4693}
4694
4695static char_u *old_sub = NULL; /* previous substitute pattern */
4696static int global_need_beginline; /* call beginline() after ":g" */
4697
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698/* do_sub()
4699 *
4700 * Perform a substitution from line eap->line1 to line eap->line2 using the
4701 * command pointed to by eap->arg which should be of the form:
4702 *
4703 * /pattern/substitution/{flags}
4704 *
4705 * The usual escapes are supported as described in the regexp docs.
4706 */
4707 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004708do_sub(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709{
4710 linenr_T lnum;
4711 long i = 0;
4712 regmmatch_T regmatch;
4713 static int do_all = FALSE; /* do multiple substitutions per line */
4714 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004715 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 static int do_error = TRUE; /* if false, ignore errors */
4717 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004718 static int do_list = FALSE; /* list last line with subs. */
4719 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 static int do_ic = 0; /* ignore case flag */
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004721 int save_do_all; /* remember user specified 'g' flag */
4722 int save_do_ask; /* remember user specified 'c' flag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4724 int delimiter;
4725 int sublen;
4726 int got_quit = FALSE;
4727 int got_match = FALSE;
4728 int temp;
4729 int which_pat;
4730 char_u *cmd;
4731 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004732 linenr_T first_line = 0; /* first changed line */
4733 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 * change */
4735 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4736 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004737 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004738 char_u *sub_firstline; /* allocated copy of first sub line */
4739 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004740 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004741 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004742#ifdef FEAT_EVAL
Bram Moolenaar75a8d742014-05-07 15:10:21 +02004743 int save_ma = 0;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004744#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745
4746 cmd = eap->arg;
4747 if (!global_busy)
4748 {
4749 sub_nsubs = 0;
4750 sub_nlines = 0;
4751 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004752 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 if (eap->cmdidx == CMD_tilde)
4755 which_pat = RE_LAST; /* use last used regexp */
4756 else
4757 which_pat = RE_SUBST; /* use last substitute regexp */
4758
4759 /* new pattern and substitution */
4760 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4761 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4762 {
4763 /* don't accept alphanumeric for separator */
4764 if (isalpha(*cmd))
4765 {
4766 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4767 return;
4768 }
4769 /*
4770 * undocumented vi feature:
4771 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4772 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4773 */
4774 if (*cmd == '\\')
4775 {
4776 ++cmd;
4777 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4778 {
4779 EMSG(_(e_backslash));
4780 return;
4781 }
4782 if (*cmd != '&')
4783 which_pat = RE_SEARCH; /* use last '/' pattern */
4784 pat = (char_u *)""; /* empty search pattern */
4785 delimiter = *cmd++; /* remember delimiter character */
4786 }
4787 else /* find the end of the regexp */
4788 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004789#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4790 if (p_altkeymap && curwin->w_p_rl)
4791 lrF_sub(cmd);
4792#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 which_pat = RE_LAST; /* use last used regexp */
4794 delimiter = *cmd++; /* remember delimiter character */
4795 pat = cmd; /* remember start of search pat */
4796 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4797 if (cmd[0] == delimiter) /* end delimiter found */
4798 *cmd++ = NUL; /* replace it with a NUL */
4799 }
4800
4801 /*
4802 * Small incompatibility: vi sees '\n' as end of the command, but in
4803 * Vim we want to use '\n' to find/substitute a NUL.
4804 */
4805 sub = cmd; /* remember the start of the substitution */
4806
4807 while (cmd[0])
4808 {
4809 if (cmd[0] == delimiter) /* end delimiter found */
4810 {
4811 *cmd++ = NUL; /* replace it with a NUL */
4812 break;
4813 }
4814 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4815 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004816 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 }
4818
4819 if (!eap->skip)
4820 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004821 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4822 if (STRCMP(sub, "%") == 0
4823 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4824 {
4825 if (old_sub == NULL) /* there is no previous command */
4826 {
4827 EMSG(_(e_nopresub));
4828 return;
4829 }
4830 sub = old_sub;
4831 }
4832 else
4833 {
4834 vim_free(old_sub);
4835 old_sub = vim_strsave(sub);
4836 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 }
4838 }
4839 else if (!eap->skip) /* use previous pattern and substitution */
4840 {
4841 if (old_sub == NULL) /* there is no previous command */
4842 {
4843 EMSG(_(e_nopresub));
4844 return;
4845 }
4846 pat = NULL; /* search_regcomp() will use previous pattern */
4847 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004848
4849 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4850 * last column after using "$". */
4851 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 }
4853
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004854 /* Recognize ":%s/\n//" and turn it into a join command, which is much
4855 * more efficient.
4856 * TODO: find a generic solution to make line-joining operations more
4857 * efficient, avoid allocating a string that grows in size.
4858 */
Bram Moolenaar21e854e2014-04-04 19:00:48 +02004859 if (pat != NULL && STRCMP(pat, "\\n") == 0
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004860 && *sub == NUL
4861 && (*cmd == NUL || (cmd[1] == NUL && (*cmd == 'g' || *cmd == 'l'
4862 || *cmd == 'p' || *cmd == '#'))))
4863 {
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004864 linenr_T joined_lines_count;
4865
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004866 curwin->w_cursor.lnum = eap->line1;
4867 if (*cmd == 'l')
4868 eap->flags = EXFLAG_LIST;
4869 else if (*cmd == '#')
4870 eap->flags = EXFLAG_NR;
4871 else if (*cmd == 'p')
4872 eap->flags = EXFLAG_PRINT;
4873
Bram Moolenaarcc2b9d52014-12-13 03:17:11 +01004874 /* The number of lines joined is the number of lines in the range plus
4875 * one. One less when the last line is included. */
4876 joined_lines_count = eap->line2 - eap->line1 + 1;
4877 if (eap->line2 < curbuf->b_ml.ml_line_count)
4878 ++joined_lines_count;
4879 if (joined_lines_count > 1)
4880 {
4881 (void)do_join(joined_lines_count, FALSE, TRUE, FALSE, TRUE);
4882 sub_nsubs = joined_lines_count - 1;
4883 sub_nlines = 1;
4884 (void)do_sub_msg(FALSE);
4885 ex_may_print(eap);
4886 }
4887
4888 if (!cmdmod.keeppatterns)
4889 save_re_pat(RE_SUBST, pat, p_magic);
4890#ifdef FEAT_CMDHIST
4891 /* put pattern in history */
4892 add_to_history(HIST_SEARCH, pat, TRUE, NUL);
4893#endif
4894
Bram Moolenaarfd3fe982014-04-01 17:49:44 +02004895 return;
4896 }
4897
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 /*
4899 * Find trailing options. When '&' is used, keep old options.
4900 */
4901 if (*cmd == '&')
4902 ++cmd;
4903 else
4904 {
4905 if (!p_ed)
4906 {
4907 if (p_gd) /* default is global on */
4908 do_all = TRUE;
4909 else
4910 do_all = FALSE;
4911 do_ask = FALSE;
4912 }
4913 do_error = TRUE;
4914 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004915 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004916 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 do_ic = 0;
4918 }
4919 while (*cmd)
4920 {
4921 /*
4922 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4923 * 'r' is never inverted.
4924 */
4925 if (*cmd == 'g')
4926 do_all = !do_all;
4927 else if (*cmd == 'c')
4928 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004929 else if (*cmd == 'n')
4930 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 else if (*cmd == 'e')
4932 do_error = !do_error;
4933 else if (*cmd == 'r') /* use last used regexp */
4934 which_pat = RE_LAST;
4935 else if (*cmd == 'p')
4936 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004937 else if (*cmd == '#')
4938 {
4939 do_print = TRUE;
4940 do_number = TRUE;
4941 }
4942 else if (*cmd == 'l')
4943 {
4944 do_print = TRUE;
4945 do_list = TRUE;
4946 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 else if (*cmd == 'i') /* ignore case */
4948 do_ic = 'i';
4949 else if (*cmd == 'I') /* don't ignore case */
4950 do_ic = 'I';
4951 else
4952 break;
4953 ++cmd;
4954 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004955 if (do_count)
4956 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02004958 save_do_all = do_all;
4959 save_do_ask = do_ask;
4960
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 /*
4962 * check for a trailing count
4963 */
4964 cmd = skipwhite(cmd);
4965 if (VIM_ISDIGIT(*cmd))
4966 {
4967 i = getdigits(&cmd);
4968 if (i <= 0 && !eap->skip && do_error)
4969 {
4970 EMSG(_(e_zerocount));
4971 return;
4972 }
4973 eap->line1 = eap->line2;
4974 eap->line2 += i - 1;
4975 if (eap->line2 > curbuf->b_ml.ml_line_count)
4976 eap->line2 = curbuf->b_ml.ml_line_count;
4977 }
4978
4979 /*
4980 * check for trailing command or garbage
4981 */
4982 cmd = skipwhite(cmd);
4983 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4984 {
4985 eap->nextcmd = check_nextcmd(cmd);
4986 if (eap->nextcmd == NULL)
4987 {
4988 EMSG(_(e_trailing));
4989 return;
4990 }
4991 }
4992
4993 if (eap->skip) /* not executing commands, only parsing */
4994 return;
4995
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004996 if (!do_count && !curbuf->b_p_ma)
4997 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004998 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004999 EMSG(_(e_modifiable));
5000 return;
5001 }
5002
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5004 {
5005 if (do_error)
5006 EMSG(_(e_invcmd));
5007 return;
5008 }
5009
5010 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
5011 if (do_ic == 'i')
5012 regmatch.rmm_ic = TRUE;
5013 else if (do_ic == 'I')
5014 regmatch.rmm_ic = FALSE;
5015
5016 sub_firstline = NULL;
5017
5018 /*
5019 * ~ in the substitute pattern is replaced with the old pattern.
5020 * We do it here once to avoid it to be replaced over and over again.
5021 * But don't do it when it starts with "\=", then it's an expression.
5022 */
5023 if (!(sub[0] == '\\' && sub[1] == '='))
5024 sub = regtilde(sub, p_magic);
5025
5026 /*
5027 * Check for a match on each line.
5028 */
5029 line2 = eap->line2;
5030 for (lnum = eap->line1; lnum <= line2 && !(got_quit
5031#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
5032 || aborting()
5033#endif
5034 ); ++lnum)
5035 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005036 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5037 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 if (nmatch)
5039 {
5040 colnr_T copycol;
5041 colnr_T matchcol;
5042 colnr_T prev_matchcol = MAXCOL;
5043 char_u *new_end, *new_start = NULL;
5044 unsigned new_start_len = 0;
5045 char_u *p1;
5046 int did_sub = FALSE;
5047 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005048 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 long nmatch_tl = 0; /* nr of lines matched below lnum */
5050 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005051 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005052 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
5054 /*
5055 * The new text is build up step by step, to avoid too much
5056 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00005057 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 * copycol Column in the old text where we started
5059 * looking for a match; from here old text still
5060 * needs to be copied to the new text.
5061 * matchcol Column number of the old text where to look
5062 * for the next match. It's just after the
5063 * previous match or one further.
5064 * prev_matchcol Column just after the previous match (if any).
5065 * Mostly equal to matchcol, except for the first
5066 * match and after skipping an empty match.
5067 * regmatch.*pos Where the pattern matched in the old text.
5068 * new_start The new text, all that has been produced so
5069 * far.
5070 * new_end The new text, where to append new text.
5071 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005072 * lnum The line number where we found the start of
5073 * the match. Can be below the line we searched
5074 * when there is a \n before a \zs in the
5075 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 * sub_firstlnum The line number in the buffer where to look
5077 * for a match. Can be different from "lnum"
5078 * when the pattern or substitute string contains
5079 * line breaks.
5080 *
5081 * Special situations:
5082 * - When the substitute string contains a line break, the part up
5083 * to the line break is inserted in the text, but the copy of
5084 * the original line is kept. "sub_firstlnum" is adjusted for
5085 * the inserted lines.
5086 * - When the matched pattern contains a line break, the old line
5087 * is taken from the line at the end of the pattern. The lines
5088 * in the match are deleted later, "sub_firstlnum" is adjusted
5089 * accordingly.
5090 *
5091 * The new text is built up in new_start[]. It has some extra
5092 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00005093 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 *
5095 * Make a copy of the old line, so it won't be taken away when
5096 * updating the screen or handling a multi-line match. The "old_"
5097 * pointers point into this copy.
5098 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005099 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 copycol = 0;
5101 matchcol = 0;
5102
5103 /* At first match, remember current cursor position. */
5104 if (!got_match)
5105 {
5106 setpcmark();
5107 got_match = TRUE;
5108 }
5109
5110 /*
5111 * Loop until nothing more to replace in this line.
5112 * 1. Handle match with empty string.
5113 * 2. If do_ask is set, ask for confirmation.
5114 * 3. substitute the string.
5115 * 4. if do_all is set, find next match
5116 * 5. break if there isn't another match in this line
5117 */
5118 for (;;)
5119 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005120 /* Advance "lnum" to the line where the match starts. The
5121 * match does not start in the first line when there is a line
5122 * break before \zs. */
5123 if (regmatch.startpos[0].lnum > 0)
5124 {
5125 lnum += regmatch.startpos[0].lnum;
5126 sub_firstlnum += regmatch.startpos[0].lnum;
5127 nmatch -= regmatch.startpos[0].lnum;
5128 vim_free(sub_firstline);
5129 sub_firstline = NULL;
5130 }
5131
5132 if (sub_firstline == NULL)
5133 {
5134 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5135 if (sub_firstline == NULL)
5136 {
5137 vim_free(new_start);
5138 goto outofmem;
5139 }
5140 }
5141
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 /* Save the line number of the last change for the final
5143 * cursor position (just like Vi). */
5144 curwin->w_cursor.lnum = lnum;
5145 do_again = FALSE;
5146
5147 /*
5148 * 1. Match empty string does not count, except for first
5149 * match. This reproduces the strange vi behaviour.
5150 * This also catches endless loops.
5151 */
5152 if (matchcol == prev_matchcol
5153 && regmatch.endpos[0].lnum == 0
5154 && matchcol == regmatch.endpos[0].col)
5155 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00005156 if (sub_firstline[matchcol] == NUL)
5157 /* We already were at the end of the line. Don't look
5158 * for a match in this line again. */
5159 skip_match = TRUE;
5160 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02005161 {
5162 /* search for a match at next column */
5163#ifdef FEAT_MBYTE
5164 if (has_mbyte)
5165 matchcol += mb_ptr2len(sub_firstline + matchcol);
5166 else
5167#endif
5168 ++matchcol;
5169 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 goto skip;
5171 }
5172
5173 /* Normally we continue searching for a match just after the
5174 * previous match. */
5175 matchcol = regmatch.endpos[0].col;
5176 prev_matchcol = matchcol;
5177
5178 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00005179 * 2. If do_count is set only increase the counter.
5180 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005182 if (do_count)
5183 {
5184 /* For a multi-line match, put matchcol at the NUL at
5185 * the end of the line and set nmatch to one, so that
5186 * we continue looking for a match on the next line.
5187 * Avoids that ":s/\nB\@=//gc" get stuck. */
5188 if (nmatch > 1)
5189 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005190 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005191 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00005192 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005193 }
5194 sub_nsubs++;
5195 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005196#ifdef FEAT_EVAL
5197 /* Skip the substitution, unless an expression is used,
5198 * then it is evaluated in the sandbox. */
5199 if (!(sub[0] == '\\' && sub[1] == '='))
5200#endif
5201 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00005202 }
5203
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 if (do_ask)
5205 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00005206 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005207
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 /* change State to CONFIRM, so that the mouse works
5209 * properly */
5210 save_State = State;
5211 State = CONFIRM;
5212#ifdef FEAT_MOUSE
5213 setmouse(); /* disable mouse in xterm */
5214#endif
5215 curwin->w_cursor.col = regmatch.startpos[0].col;
5216
5217 /* When 'cpoptions' contains "u" don't sync undo when
5218 * asking for confirmation. */
5219 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5220 ++no_u_sync;
5221
5222 /*
5223 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
5224 */
5225 while (do_ask)
5226 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005227 if (exmode_active)
5228 {
5229 char_u *resp;
5230 colnr_T sc, ec;
5231
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005232 print_line_no_prefix(lnum, do_number, do_list);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005233
5234 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
5235 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
5236 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
Bram Moolenaar3eead7c2013-10-02 18:43:06 +02005237 if (do_number || curwin->w_p_nu)
5238 {
5239 int numw = number_width(curwin) + 1;
5240 sc += numw;
5241 ec += numw;
5242 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005243 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00005244 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005245 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00005246 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005247 msg_putchar('^');
5248
5249 resp = getexmodeline('?', NULL, 0);
5250 if (resp != NULL)
5251 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005252 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005253 vim_free(resp);
5254 }
5255 }
5256 else
5257 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005258 char_u *orig_line = NULL;
5259 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005261 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005263 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005265 /* Invert the matched string.
5266 * Remove the inversion afterwards. */
5267 temp = RedrawingDisabled;
5268 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005270 if (new_start != NULL)
5271 {
5272 /* There already was a substitution, we would
5273 * like to show this to the user. We cannot
5274 * really update the line, it would change
5275 * what matches. Temporarily replace the line
5276 * and change it back afterwards. */
5277 orig_line = vim_strsave(ml_get(lnum));
5278 if (orig_line != NULL)
5279 {
5280 char_u *new_line = concat_str(new_start,
5281 sub_firstline + copycol);
5282
5283 if (new_line == NULL)
5284 {
5285 vim_free(orig_line);
5286 orig_line = NULL;
5287 }
5288 else
5289 {
5290 /* Position the cursor relative to the
5291 * end of the line, the previous
5292 * substitute may have inserted or
5293 * deleted characters before the
5294 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01005295 len_change = (int)STRLEN(new_line)
5296 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005297 curwin->w_cursor.col += len_change;
5298 ml_replace(lnum, new_line, FALSE);
5299 }
5300 }
5301 }
5302
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005303 search_match_lines = regmatch.endpos[0].lnum
5304 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005305 search_match_endcol = regmatch.endpos[0].col
5306 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005307 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005309 update_topline();
5310 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00005311 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005312 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00005313 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314
5315#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005316 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005318 if (msg_row == Rows - 1)
5319 msg_didout = FALSE; /* avoid a scroll-up */
5320 msg_starthere();
5321 i = msg_scroll;
5322 msg_scroll = 0; /* truncate msg when
5323 needed */
5324 msg_no_more = TRUE;
5325 /* write message same highlighting as for
5326 * wait_return */
5327 smsg_attr(hl_attr(HLF_R),
5328 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
5329 msg_no_more = FALSE;
5330 msg_scroll = i;
5331 showruler(TRUE);
5332 windgoto(msg_row, msg_col);
5333 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
5335#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005336 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005338 ++no_mapping; /* don't map this key */
5339 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005340 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005341 --allow_keys;
5342 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005344 /* clear the question */
5345 msg_didout = FALSE; /* don't scroll up */
5346 msg_col = 0;
5347 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01005348
5349 /* restore the line */
5350 if (orig_line != NULL)
5351 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005352 }
5353
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005355 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005357 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358#endif
5359 )
5360 {
5361 got_quit = TRUE;
5362 break;
5363 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005364 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005366 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005368 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 {
5370 /* last: replace and then stop */
5371 do_all = FALSE;
5372 line2 = lnum;
5373 break;
5374 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005375 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 {
5377 do_ask = FALSE;
5378 break;
5379 }
5380#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005381 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005383 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 scrolldown_clamp();
5385#endif
5386 }
5387 State = save_State;
5388#ifdef FEAT_MOUSE
5389 setmouse();
5390#endif
5391 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
5392 --no_u_sync;
5393
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005394 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 {
5396 /* For a multi-line match, put matchcol at the NUL at
5397 * the end of the line and set nmatch to one, so that
5398 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00005399 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
5400 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 if (nmatch > 1)
5402 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005403 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00005404 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 }
5406 goto skip;
5407 }
5408 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01005409 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 }
5411
5412 /* Move the cursor to the start of the match, so that we can
5413 * use "\=col("."). */
5414 curwin->w_cursor.col = regmatch.startpos[0].col;
5415
5416 /*
5417 * 3. substitute the string.
5418 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005419#ifdef FEAT_EVAL
5420 if (do_count)
5421 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005422 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005423 save_ma = curbuf->b_p_ma;
5424 curbuf->b_p_ma = FALSE;
5425 sandbox++;
5426 }
5427#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005429 sublen = vim_regsub_multi(&regmatch,
5430 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02005432#ifdef FEAT_EVAL
5433 if (do_count)
5434 {
5435 curbuf->b_p_ma = save_ma;
5436 sandbox--;
5437 goto skip;
5438 }
5439#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440
Bram Moolenaar4463f292005-09-25 22:20:24 +00005441 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005442 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00005443 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
5444 {
5445 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
5446 skip_match = TRUE;
5447 }
5448
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 /* Need room for:
5450 * - result so far in new_start (not for first sub in line)
5451 * - original text up to match
5452 * - length of substituted part
5453 * - original text after match
5454 */
5455 if (nmatch == 1)
5456 p1 = sub_firstline;
5457 else
5458 {
5459 p1 = ml_get(sub_firstlnum + nmatch - 1);
5460 nmatch_tl += nmatch - 1;
5461 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005462 copy_len = regmatch.startpos[0].col - copycol;
5463 needed_len = copy_len + ((unsigned)STRLEN(p1)
5464 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 if (new_start == NULL)
5466 {
5467 /*
5468 * Get some space for a temporary buffer to do the
5469 * substitution into (and some extra space to avoid
5470 * too many calls to alloc()/free()).
5471 */
5472 new_start_len = needed_len + 50;
5473 if ((new_start = alloc_check(new_start_len)) == NULL)
5474 goto outofmem;
5475 *new_start = NUL;
5476 new_end = new_start;
5477 }
5478 else
5479 {
5480 /*
5481 * Check if the temporary buffer is long enough to do the
5482 * substitution into. If not, make it larger (with a bit
5483 * extra to avoid too many calls to alloc()/free()).
5484 */
5485 len = (unsigned)STRLEN(new_start);
5486 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005487 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 {
5489 new_start_len = needed_len + 50;
5490 if ((p1 = alloc_check(new_start_len)) == NULL)
5491 {
5492 vim_free(new_start);
5493 goto outofmem;
5494 }
5495 mch_memmove(p1, new_start, (size_t)(len + 1));
5496 vim_free(new_start);
5497 new_start = p1;
5498 }
5499 new_end = new_start + len;
5500 }
5501
5502 /*
5503 * copy the text up to the part that matched
5504 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005505 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5506 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005508 (void)vim_regsub_multi(&regmatch,
5509 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 sub, new_end, TRUE, p_magic, TRUE);
5511 sub_nsubs++;
5512 did_sub = TRUE;
5513
5514 /* Move the cursor to the start of the line, to avoid that it
5515 * is beyond the end of the line after the substitution. */
5516 curwin->w_cursor.col = 0;
5517
5518 /* For a multi-line match, make a copy of the last matched
5519 * line and continue in that one. */
5520 if (nmatch > 1)
5521 {
5522 sub_firstlnum += nmatch - 1;
5523 vim_free(sub_firstline);
5524 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5525 /* When going beyond the last line, stop substituting. */
5526 if (sub_firstlnum <= line2)
5527 do_again = TRUE;
5528 else
5529 do_all = FALSE;
5530 }
5531
5532 /* Remember next character to be copied. */
5533 copycol = regmatch.endpos[0].col;
5534
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005535 if (skip_match)
5536 {
5537 /* Already hit end of the buffer, sub_firstlnum is one
5538 * less than what it ought to be. */
5539 vim_free(sub_firstline);
5540 sub_firstline = vim_strsave((char_u *)"");
5541 copycol = 0;
5542 }
5543
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 /*
5545 * Now the trick is to replace CTRL-M chars with a real line
5546 * break. This would make it impossible to insert a CTRL-M in
5547 * the text. The line break can be avoided by preceding the
5548 * CTRL-M with a backslash. To be able to insert a backslash,
5549 * they must be doubled in the string and are halved here.
5550 * That is Vi compatible.
5551 */
5552 for (p1 = new_end; *p1; ++p1)
5553 {
5554 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005555 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 else if (*p1 == CAR)
5557 {
5558 if (u_inssub(lnum) == OK) /* prepare for undo */
5559 {
5560 *p1 = NUL; /* truncate up to the CR */
5561 ml_append(lnum - 1, new_start,
5562 (colnr_T)(p1 - new_start + 1), FALSE);
5563 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
5564 if (do_ask)
5565 appended_lines(lnum - 1, 1L);
5566 else
5567 {
5568 if (first_line == 0)
5569 first_line = lnum;
5570 last_line = lnum + 1;
5571 }
5572 /* All line numbers increase. */
5573 ++sub_firstlnum;
5574 ++lnum;
5575 ++line2;
5576 /* move the cursor to the new line, like Vi */
5577 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005578 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005579 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 p1 = new_start - 1;
5581 }
5582 }
5583#ifdef FEAT_MBYTE
5584 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005585 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586#endif
5587 }
5588
5589 /*
5590 * 4. If do_all is set, find next match.
5591 * Prevent endless loop with patterns that match empty
5592 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5593 * But ":s/\n/#/" is OK.
5594 */
5595skip:
5596 /* We already know that we did the last subst when we are at
5597 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005598 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5599 * "line2" when there is a \zs in the pattern after a line
5600 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005601 lastone = (skip_match
5602 || got_int
5603 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005604 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005605 || !(do_all || do_again)
5606 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5607 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 nmatch = -1;
5609
5610 /*
5611 * Replace the line in the buffer when needed. This is
5612 * skipped when there are more matches.
5613 * The check for nmatch_tl is needed for when multi-line
5614 * matching must replace the lines before trying to do another
5615 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005616 * When the match starts below where we start searching also
5617 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 */
5619 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 || nmatch_tl > 0
5621 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005622 curbuf, sub_firstlnum,
5623 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005624 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 {
5626 if (new_start != NULL)
5627 {
5628 /*
5629 * Copy the rest of the line, that didn't match.
5630 * "matchcol" has to be adjusted, we use the end of
5631 * the line as reference, because the substitute may
5632 * have changed the number of characters. Same for
5633 * "prev_matchcol".
5634 */
5635 STRCAT(new_start, sub_firstline + copycol);
5636 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5637 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5638 - prev_matchcol;
5639
5640 if (u_savesub(lnum) != OK)
5641 break;
5642 ml_replace(lnum, new_start, TRUE);
5643
5644 if (nmatch_tl > 0)
5645 {
5646 /*
5647 * Matched lines have now been substituted and are
5648 * useless, delete them. The part after the match
5649 * has been appended to new_start, we don't need
5650 * it in the buffer.
5651 */
5652 ++lnum;
5653 if (u_savedel(lnum, nmatch_tl) != OK)
5654 break;
5655 for (i = 0; i < nmatch_tl; ++i)
5656 ml_delete(lnum, (int)FALSE);
5657 mark_adjust(lnum, lnum + nmatch_tl - 1,
5658 (long)MAXLNUM, -nmatch_tl);
5659 if (do_ask)
5660 deleted_lines(lnum, nmatch_tl);
5661 --lnum;
5662 line2 -= nmatch_tl; /* nr of lines decreases */
5663 nmatch_tl = 0;
5664 }
5665
5666 /* When asking, undo is saved each time, must also set
5667 * changed flag each time. */
5668 if (do_ask)
5669 changed_bytes(lnum, 0);
5670 else
5671 {
5672 if (first_line == 0)
5673 first_line = lnum;
5674 last_line = lnum + 1;
5675 }
5676
5677 sub_firstlnum = lnum;
5678 vim_free(sub_firstline); /* free the temp buffer */
5679 sub_firstline = new_start;
5680 new_start = NULL;
5681 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5682 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5683 - prev_matchcol;
5684 copycol = 0;
5685 }
5686 if (nmatch == -1 && !lastone)
5687 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005688 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689
5690 /*
5691 * 5. break if there isn't another match in this line
5692 */
5693 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005694 {
5695 /* If the match found didn't start where we were
5696 * searching, do the next search in the line where we
5697 * found the match. */
5698 if (nmatch == -1)
5699 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005701 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 }
5703
5704 line_breakcheck();
5705 }
5706
5707 if (did_sub)
5708 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005709 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 vim_free(sub_firstline); /* free the copy of the original line */
5711 sub_firstline = NULL;
5712 }
5713
5714 line_breakcheck();
5715 }
5716
5717 if (first_line != 0)
5718 {
5719 /* Need to subtract the number of added lines from "last_line" to get
5720 * the line number before the change (same as adding the number of
5721 * deleted lines). */
5722 i = curbuf->b_ml.ml_line_count - old_line_count;
5723 changed_lines(first_line, 0, last_line - i, i);
5724 }
5725
5726outofmem:
5727 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005728
5729 /* ":s/pat//n" doesn't move the cursor */
5730 if (do_count)
5731 curwin->w_cursor = old_cursor;
5732
Bram Moolenaar46475522010-03-23 17:36:29 +01005733 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 {
5735 /* Set the '[ and '] marks. */
5736 curbuf->b_op_start.lnum = eap->line1;
5737 curbuf->b_op_end.lnum = line2;
5738 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5739
5740 if (!global_busy)
5741 {
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005742 if (!do_ask) /* when interactive leave cursor on the match */
5743 {
5744 if (endcolumn)
5745 coladvance((colnr_T)MAXCOL);
5746 else
5747 beginline(BL_WHITE | BL_FIX);
5748 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005749 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 MSG("");
5751 }
5752 else
5753 global_need_beginline = TRUE;
5754 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005755 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 }
5757 else if (!global_busy)
5758 {
5759 if (got_int) /* interrupted */
5760 EMSG(_(e_interr));
5761 else if (got_match) /* did find something but nothing substituted */
5762 MSG("");
5763 else if (do_error) /* nothing found */
5764 EMSG2(_(e_patnotf2), get_search_pat());
5765 }
5766
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005767#ifdef FEAT_FOLDING
5768 if (do_ask && hasAnyFolding(curwin))
5769 /* Cursor position may require updating */
5770 changed_window_setting();
5771#endif
5772
Bram Moolenaar473de612013-06-08 18:19:48 +02005773 vim_regfree(regmatch.regprog);
Bram Moolenaarcad2fc92015-05-04 10:46:03 +02005774
5775 /* Restore the flag values, they can be used for ":&&". */
5776 do_all = save_do_all;
5777 do_ask = save_do_ask;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778}
5779
5780/*
5781 * Give message for number of substitutions.
5782 * Can also be used after a ":global" command.
5783 * Return TRUE if a message was given.
5784 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005785 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005786do_sub_msg(
5787 int count_only) /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788{
5789 /*
5790 * Only report substitutions when:
5791 * - more than 'report' substitutions
5792 * - command was typed by user, or number of changed lines > 'report'
5793 * - giving messages is not disabled by 'lazyredraw'
5794 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005795 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5796 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 && messaging())
5798 {
5799 if (got_int)
5800 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005801 else
5802 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005804 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005805 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005807 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005808 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 sub_nsubs);
5810 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005811 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005812 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005814 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005815 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005818 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 return TRUE;
5820 }
5821 if (got_int)
5822 {
5823 EMSG(_(e_interr));
5824 return TRUE;
5825 }
5826 return FALSE;
5827}
5828
5829/*
5830 * Execute a global command of the form:
5831 *
5832 * g/pattern/X : execute X on all lines where pattern matches
5833 * v/pattern/X : execute X on all lines where pattern does not match
5834 *
5835 * where 'X' is an EX command
5836 *
5837 * The command character (as well as the trailing slash) is optional, and
5838 * is assumed to be 'p' if missing.
5839 *
5840 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005841 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 * for each line that has a mark. This is required because after deleting
5843 * lines we do not know where to search for the next match.
5844 */
5845 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005846ex_global(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847{
5848 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005849 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 int type; /* first char of cmd: 'v' or 'g' */
5851 char_u *cmd; /* command argument */
5852
5853 char_u delim; /* delimiter, normally '/' */
5854 char_u *pat;
5855 regmmatch_T regmatch;
5856 int match;
5857 int which_pat;
5858
5859 if (global_busy)
5860 {
5861 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5862 return;
5863 }
5864
5865 if (eap->forceit) /* ":global!" is like ":vglobal" */
5866 type = 'v';
5867 else
5868 type = *eap->cmd;
5869 cmd = eap->arg;
5870 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871
5872 /*
5873 * undocumented vi feature:
5874 * "\/" and "\?": use previous search pattern.
5875 * "\&": use previous substitute pattern.
5876 */
5877 if (*cmd == '\\')
5878 {
5879 ++cmd;
5880 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5881 {
5882 EMSG(_(e_backslash));
5883 return;
5884 }
5885 if (*cmd == '&')
5886 which_pat = RE_SUBST; /* use previous substitute pattern */
5887 else
5888 which_pat = RE_SEARCH; /* use previous search pattern */
5889 ++cmd;
5890 pat = (char_u *)"";
5891 }
5892 else if (*cmd == NUL)
5893 {
5894 EMSG(_("E148: Regular expression missing from global"));
5895 return;
5896 }
5897 else
5898 {
5899 delim = *cmd; /* get the delimiter */
5900 if (delim)
5901 ++cmd; /* skip delimiter if there is one */
5902 pat = cmd; /* remember start of pattern */
5903 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5904 if (cmd[0] == delim) /* end delimiter found */
5905 *cmd++ = NUL; /* replace it with a NUL */
5906 }
5907
5908#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5909 if (p_altkeymap && curwin->w_p_rl)
5910 lrFswap(pat,0);
5911#endif
5912
5913 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5914 {
5915 EMSG(_(e_invcmd));
5916 return;
5917 }
5918
5919 /*
5920 * pass 1: set marks for each (not) matching line
5921 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5923 {
5924 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005925 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5926 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 if ((type == 'g' && match) || (type == 'v' && !match))
5928 {
5929 ml_setmarked(lnum);
5930 ndone++;
5931 }
5932 line_breakcheck();
5933 }
5934
5935 /*
5936 * pass 2: execute the command for each line that has been marked
5937 */
5938 if (got_int)
5939 MSG(_(e_interr));
5940 else if (ndone == 0)
5941 {
5942 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005943 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01005945 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 }
5947 else
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005948 {
5949#ifdef FEAT_CLIPBOARD
5950 start_global_changes();
5951#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 global_exe(cmd);
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02005953#ifdef FEAT_CLIPBOARD
5954 end_global_changes();
5955#endif
5956 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957
5958 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02005959 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960}
5961
5962/*
5963 * Execute "cmd" on lines marked with ml_setmarked().
5964 */
5965 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005966global_exe(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967{
Bram Moolenaarbb993222011-05-10 16:00:47 +02005968 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5969 buf_T *old_buf = curbuf; /* remember what buffer we started in */
5970 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971
5972 /*
5973 * Set current position only once for a global command.
5974 * If global_busy is set, setpcmark() will not do anything.
5975 * If there is an error, global_busy will be incremented.
5976 */
5977 setpcmark();
5978
5979 /* When the command writes a message, don't overwrite the command. */
5980 msg_didout = TRUE;
5981
Bram Moolenaard25bc232010-03-23 17:49:24 +01005982 sub_nsubs = 0;
5983 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 global_need_beginline = FALSE;
5985 global_busy = 1;
5986 old_lcount = curbuf->b_ml.ml_line_count;
5987 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5988 {
5989 curwin->w_cursor.lnum = lnum;
5990 curwin->w_cursor.col = 0;
5991 if (*cmd == NUL || *cmd == '\n')
5992 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5993 else
5994 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5995 ui_breakcheck();
5996 }
5997
5998 global_busy = 0;
5999 if (global_need_beginline)
6000 beginline(BL_WHITE | BL_FIX);
6001 else
6002 check_cursor(); /* cursor may be beyond the end of the line */
6003
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00006004 /* the cursor may not have moved in the text but a change in a previous
6005 * line may move it on the screen */
6006 changed_line_abv_curs();
6007
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 /* If it looks like no message was written, allow overwriting the
6009 * command with the report for number of changes. */
6010 if (msg_col == 0 && msg_scrolled == 0)
6011 msg_didout = FALSE;
6012
Bram Moolenaar45667512007-05-10 19:24:43 +00006013 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02006014 * number of extra or deleted lines.
6015 * Don't report extra or deleted lines in the edge case where the buffer
6016 * we are in after execution is different from the buffer we started in. */
6017 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
6019}
6020
6021#ifdef FEAT_VIMINFO
6022 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006023read_viminfo_sub_string(vir_T *virp, int force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01006025 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 vim_free(old_sub);
6027 if (force || old_sub == NULL)
6028 old_sub = viminfo_readstring(virp, 1, TRUE);
6029 return viminfo_readline(virp);
6030}
6031
6032 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006033write_viminfo_sub_string(FILE *fp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034{
6035 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
6036 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02006037 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 viminfo_writestring(fp, old_sub);
6039 }
6040}
6041#endif /* FEAT_VIMINFO */
6042
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006043#if defined(EXITFREE) || defined(PROTO)
6044 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006045free_old_sub(void)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00006046{
6047 vim_free(old_sub);
6048}
6049#endif
6050
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
6052/*
6053 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006054 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006056 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006057prepare_tagpreview(
6058 int undo_sync) /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059{
6060 win_T *wp;
6061
6062# ifdef FEAT_GUI
6063 need_mouse_correct = TRUE;
6064# endif
6065
6066 /*
6067 * If there is already a preview window open, use that one.
6068 */
6069 if (!curwin->w_p_pvw)
6070 {
6071 for (wp = firstwin; wp != NULL; wp = wp->w_next)
6072 if (wp->w_p_pvw)
6073 break;
6074 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00006075 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006076 else
6077 {
6078 /*
6079 * There is no preview window open yet. Create one.
6080 */
6081 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
6082 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006083 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 curwin->w_p_pvw = TRUE;
6085 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02006086 RESET_BINDING(curwin); /* don't take over 'scrollbind'
6087 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088# ifdef FEAT_DIFF
6089 curwin->w_p_diff = FALSE; /* no 'diff' */
6090# endif
6091# ifdef FEAT_FOLDING
6092 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
6093# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006094 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 }
6096 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00006097 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098}
6099
6100#endif
6101
6102
6103/*
6104 * ":help": open a read-only window on a help file
6105 */
6106 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006107ex_help(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108{
6109 char_u *arg;
6110 char_u *tag;
6111 FILE *helpfd; /* file descriptor of help file */
6112 int n;
6113 int i;
6114#ifdef FEAT_WINDOWS
6115 win_T *wp;
6116#endif
6117 int num_matches;
6118 char_u **matches;
6119 char_u *p;
6120 int empty_fnum = 0;
6121 int alt_fnum = 0;
6122 buf_T *buf;
6123#ifdef FEAT_MULTI_LANG
6124 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006125 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02006127#ifdef FEAT_FOLDING
6128 int old_KeyTyped = KeyTyped;
6129#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130
6131 if (eap != NULL)
6132 {
6133 /*
6134 * A ":help" command ends at the first LF, or at a '|' that is
6135 * followed by some text. Set nextcmd to the following command.
6136 */
6137 for (arg = eap->arg; *arg; ++arg)
6138 {
6139 if (*arg == '\n' || *arg == '\r'
6140 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
6141 {
6142 *arg++ = NUL;
6143 eap->nextcmd = arg;
6144 break;
6145 }
6146 }
6147 arg = eap->arg;
6148
Bram Moolenaar3dbde622012-04-05 16:05:05 +02006149 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 {
6151 EMSG(_("E478: Don't panic!"));
6152 return;
6153 }
6154
6155 if (eap->skip) /* not executing commands */
6156 return;
6157 }
6158 else
6159 arg = (char_u *)"";
6160
6161 /* remove trailing blanks */
6162 p = arg + STRLEN(arg) - 1;
6163 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
6164 *p-- = NUL;
6165
6166#ifdef FEAT_MULTI_LANG
6167 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006168 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169#endif
6170
6171 /* When no argument given go to the index. */
6172 if (*arg == NUL)
6173 arg = (char_u *)"help.txt";
6174
6175 /*
6176 * Check if there is a match for the argument.
6177 */
6178 n = find_help_tags(arg, &num_matches, &matches,
6179 eap != NULL && eap->forceit);
6180
6181 i = 0;
6182#ifdef FEAT_MULTI_LANG
6183 if (n != FAIL && lang != NULL)
6184 /* Find first item with the requested language. */
6185 for (i = 0; i < num_matches; ++i)
6186 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006187 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 if (len > 3 && matches[i][len - 3] == '@'
6189 && STRICMP(matches[i] + len - 2, lang) == 0)
6190 break;
6191 }
6192#endif
6193 if (i >= num_matches || n == FAIL)
6194 {
6195#ifdef FEAT_MULTI_LANG
6196 if (lang != NULL)
6197 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
6198 else
6199#endif
6200 EMSG2(_("E149: Sorry, no help for %s"), arg);
6201 if (n != FAIL)
6202 FreeWild(num_matches, matches);
6203 return;
6204 }
6205
6206 /* The first match (in the requested language) is the best match. */
6207 tag = vim_strsave(matches[i]);
6208 FreeWild(num_matches, matches);
6209
6210#ifdef FEAT_GUI
6211 need_mouse_correct = TRUE;
6212#endif
6213
6214 /*
6215 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006216 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006218 if (!curwin->w_buffer->b_help
6219#ifdef FEAT_WINDOWS
6220 || cmdmod.tab != 0
6221#endif
6222 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 {
6224#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006225 if (cmdmod.tab != 0)
6226 wp = NULL;
6227 else
6228 for (wp = firstwin; wp != NULL; wp = wp->w_next)
6229 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
6230 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
6232 win_enter(wp, TRUE);
6233 else
6234#endif
6235 {
6236 /*
6237 * There is no help window yet.
6238 * Try to open the file specified by the "helpfile" option.
6239 */
6240 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
6241 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00006242 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 goto erret;
6244 }
6245 fclose(helpfd);
6246
6247#ifdef FEAT_WINDOWS
6248 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006249 * specified, the current window is vertically split and
6250 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 n = WSP_HELP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006253 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 n |= WSP_TOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006256 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257#else
6258 /* use current window */
6259 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00006261#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262
6263#ifdef FEAT_WINDOWS
6264 if (curwin->w_height < p_hh)
6265 win_setheight((int)p_hh);
6266#endif
6267
6268 /*
6269 * Open help file (do_ecmd() will set b_help flag, readfile() will
6270 * set b_p_ro flag).
6271 * Set the alternate file to the previously edited file.
6272 */
6273 alt_fnum = curbuf->b_fnum;
6274 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00006275 ECMD_HIDE + ECMD_SET_HELP,
6276#ifdef FEAT_WINDOWS
6277 NULL /* buffer is still open, don't store info */
6278#else
6279 curwin
6280#endif
6281 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006282 if (!cmdmod.keepalt)
6283 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 empty_fnum = curbuf->b_fnum;
6285 }
6286 }
6287
6288 if (!p_im)
6289 restart_edit = 0; /* don't want insert mode in help file */
6290
Bram Moolenaar8f535582011-09-30 17:30:31 +02006291#ifdef FEAT_FOLDING
6292 /* Restore KeyTyped, setting 'filetype=help' may reset it.
6293 * It is needed for do_tag top open folds under the cursor. */
6294 KeyTyped = old_KeyTyped;
6295#endif
6296
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 if (tag != NULL)
6298 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
6299
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006300 /* Delete the empty buffer if we're not using it. Careful: autocommands
6301 * may have jumped to another window, check that the buffer is not in a
6302 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
6304 {
6305 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006306 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 wipe_buffer(buf, TRUE);
6308 }
6309
6310 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006311 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 curwin->w_alt_fnum = alt_fnum;
6313
6314erret:
6315 vim_free(tag);
6316}
6317
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006318/*
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006319 * ":helpclose": Close one help window
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006320 */
6321 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006322ex_helpclose(exarg_T *eap UNUSED)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006323{
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006324#if defined(FEAT_WINDOWS)
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006325 win_T *win;
6326
6327 FOR_ALL_WINDOWS(win)
6328 {
6329 if (win->w_buffer->b_help)
6330 {
6331 win_close(win, FALSE);
Bram Moolenaareb21e4c2014-09-19 22:05:53 +02006332 return;
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006333 }
6334 }
Bram Moolenaar3fa57e02014-09-19 22:23:26 +02006335#endif
Bram Moolenaar5bfa2ed2014-09-19 19:39:34 +02006336}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006338#if defined(FEAT_MULTI_LANG) || defined(PROTO)
6339/*
6340 * In an argument search for a language specifiers in the form "@xx".
6341 * Changes the "@" to NUL if found, and returns a pointer to "xx".
6342 * Returns NULL if not found.
6343 */
6344 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006345check_help_lang(char_u *arg)
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006346{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006347 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006348
6349 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
6350 && ASCII_ISALPHA(arg[len - 1]))
6351 {
6352 arg[len - 3] = NUL; /* remove the '@' */
6353 return arg + len - 2;
6354 }
6355 return NULL;
6356}
6357#endif
6358
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359/*
6360 * Return a heuristic indicating how well the given string matches. The
6361 * smaller the number, the better the match. This is the order of priorities,
6362 * from best match to worst match:
6363 * - Match with least alpha-numeric characters is better.
6364 * - Match with least total characters is better.
6365 * - Match towards the start is better.
6366 * - Match starting with "+" is worse (feature instead of command)
6367 * Assumption is made that the matched_string passed has already been found to
6368 * match some string for which help is requested. webb.
6369 */
6370 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006371help_heuristic(
6372 char_u *matched_string,
6373 int offset, /* offset for match */
6374 int wrong_case) /* no matching case */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375{
6376 int num_letters;
6377 char_u *p;
6378
6379 num_letters = 0;
6380 for (p = matched_string; *p; p++)
6381 if (ASCII_ISALNUM(*p))
6382 num_letters++;
6383
6384 /*
6385 * Multiply the number of letters by 100 to give it a much bigger
6386 * weighting than the number of characters.
6387 * If there only is a match while ignoring case, add 5000.
6388 * If the match starts in the middle of a word, add 10000 to put it
6389 * somewhere in the last half.
6390 * If the match is more than 2 chars from the start, multiply by 200 to
6391 * put it after matches at the start.
6392 */
6393 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
6394 && ASCII_ISALNUM(matched_string[offset - 1]))
6395 offset += 10000;
6396 else if (offset > 2)
6397 offset *= 200;
6398 if (wrong_case)
6399 offset += 5000;
6400 /* Features are less interesting than the subjects themselves, but "+"
6401 * alone is not a feature. */
6402 if (matched_string[0] == '+' && matched_string[1] != NUL)
6403 offset += 100;
6404 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
6405}
6406
6407/*
6408 * Compare functions for qsort() below, that checks the help heuristics number
6409 * that has been put after the tagname by find_tags().
6410 */
6411 static int
6412#ifdef __BORLANDC__
6413_RTLENTRYF
6414#endif
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006415help_compare(const void *s1, const void *s2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416{
6417 char *p1;
6418 char *p2;
6419
6420 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
6421 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
6422 return strcmp(p1, p2);
6423}
6424
6425/*
6426 * Find all help tags matching "arg", sort them and return in matches[], with
6427 * the number of matches in num_matches.
6428 * The matches will be sorted with a "best" match algorithm.
6429 * When "keep_lang" is TRUE try keeping the language of the current buffer.
6430 */
6431 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006432find_help_tags(
6433 char_u *arg,
6434 int *num_matches,
6435 char_u ***matches,
6436 int keep_lang)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437{
6438 char_u *s, *d;
6439 int i;
6440 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006441 "/*", "/\\*", "\"*", "**",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006442 "cpo-*", "/\\(\\)", "/\\%(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006443 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006444 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 "[count]", "[quotex]", "[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006446 "[pattern]", "\\|", "\\%$",
6447 "s/\\~", "s/\\U", "s/\\L",
6448 "s/\\1", "s/\\2", "s/\\3", "s/\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00006450 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaarc528b1d2013-08-03 13:41:15 +02006451 "cpo-star", "/\\\\(\\\\)", "/\\\\%(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00006452 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00006453 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 "\\[count]", "\\[quotex]", "\\[range]",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006455 "\\[pattern]", "\\\\bar", "/\\\\%\\$",
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006456 "s/\\\\\\~", "s/\\\\U", "s/\\\\L",
Bram Moolenaarc467d9b2014-02-11 12:15:43 +01006457 "s/\\\\1", "s/\\\\2", "s/\\\\3", "s/\\\\9"};
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 int flags;
6459
6460 d = IObuff; /* assume IObuff is long enough! */
6461
6462 /*
6463 * Recognize a few exceptions to the rule. Some strings that contain '*'
6464 * with "star". Otherwise '*' is recognized as a wildcard.
6465 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00006466 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 if (STRCMP(arg, mtable[i]) == 0)
6468 {
6469 STRCPY(d, rtable[i]);
6470 break;
6471 }
6472
6473 if (i < 0) /* no match in table */
6474 {
6475 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
6476 * Also replace "\%^" and "\%(", they match every tag too.
6477 * Also "\zs", "\z1", etc.
6478 * Also "\@<", "\@=", "\@<=", etc.
6479 * And also "\_$" and "\_^". */
6480 if (arg[0] == '\\'
6481 && ((arg[1] != NUL && arg[2] == NUL)
6482 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
6483 && arg[2] != NUL)))
6484 {
6485 STRCPY(d, "/\\\\");
6486 STRCPY(d + 3, arg + 1);
6487 /* Check for "/\\_$", should be "/\\_\$" */
6488 if (d[3] == '_' && d[4] == '$')
6489 STRCPY(d + 4, "\\$");
6490 }
6491 else
6492 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006493 /* Replace:
6494 * "[:...:]" with "\[:...:]"
6495 * "[++...]" with "\[++...]"
Bram Moolenaar75a8d742014-05-07 15:10:21 +02006496 * "\{" with "\\{" -- matching "} \}"
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02006497 */
6498 if ((arg[0] == '[' && (arg[1] == ':'
6499 || (arg[1] == '+' && arg[2] == '+')))
6500 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 *d++ = '\\';
6502
Bram Moolenaar00f9e0d2016-03-15 13:44:12 +01006503 /*
6504 * If tag starts with "('", skip the "(". Fixes CTRL-] on ('option'.
6505 */
6506 if (*arg == '(' && arg[1] == '\'')
6507 arg++;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 for (s = arg; *s; ++s)
6509 {
6510 /*
6511 * Replace "|" with "bar" and '"' with "quote" to match the name of
6512 * the tags for these commands.
6513 * Replace "*" with ".*" and "?" with "." to match command line
6514 * completion.
6515 * Insert a backslash before '~', '$' and '.' to avoid their
6516 * special meaning.
6517 */
6518 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
6519 break;
6520 switch (*s)
6521 {
6522 case '|': STRCPY(d, "bar");
6523 d += 3;
6524 continue;
6525 case '"': STRCPY(d, "quote");
6526 d += 5;
6527 continue;
6528 case '*': *d++ = '.';
6529 break;
6530 case '?': *d++ = '.';
6531 continue;
6532 case '$':
6533 case '.':
6534 case '~': *d++ = '\\';
6535 break;
6536 }
6537
6538 /*
6539 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6540 * ":help i_^_CTRL-D" work.
6541 * Insert '-' before and after "CTRL-X" when applicable.
6542 */
6543 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6544 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6545 {
Bram Moolenaard82db602013-08-07 15:24:41 +02006546 if (d > IObuff && d[-1] != '_' && d[-1] != '\\')
6547 *d++ = '_'; /* prepend a '_' to make x_CTRL-x */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 STRCPY(d, "CTRL-");
6549 d += 5;
6550 if (*s < ' ')
6551 {
6552#ifdef EBCDIC
6553 *d++ = CtrlChar(*s);
6554#else
6555 *d++ = *s + '@';
6556#endif
6557 if (d[-1] == '\\')
6558 *d++ = '\\'; /* double a backslash */
6559 }
6560 else
6561 *d++ = *++s;
6562 if (s[1] != NUL && s[1] != '_')
6563 *d++ = '_'; /* append a '_' */
6564 continue;
6565 }
6566 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6567 *d++ = '\\';
6568
6569 /*
6570 * Insert a backslash before a backslash after a slash, for search
6571 * pattern tags: "/\|" --> "/\\|".
6572 */
6573 else if (s[0] == '\\' && s[1] != '\\'
6574 && *arg == '/' && s == arg + 1)
6575 *d++ = '\\';
6576
6577 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6578 * "CTRL-\_CTRL-N" */
6579 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6580 {
6581 STRCPY(d, "CTRL-\\\\");
6582 d += 7;
6583 s += 6;
6584 }
6585
6586 *d++ = *s;
6587
6588 /*
Bram Moolenaar81edd172016-04-14 13:51:37 +02006589 * If tag contains "({" or "([", tag terminates at the "(".
6590 * This is for help on functions, e.g.: abs({expr}).
6591 */
6592 if (*s == '(' && (s[1] == '{' || s[1] =='['))
6593 break;
6594
6595 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 * If tag starts with ', toss everything after a second '. Fixes
6597 * CTRL-] on 'option'. (would include the trailing '.').
6598 */
6599 if (*s == '\'' && s > arg && *arg == '\'')
6600 break;
Bram Moolenaar28b942a2016-06-04 22:31:27 +02006601 /* Also '{' and '}'. */
6602 if (*s == '}' && s > arg && *arg == '{')
6603 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 }
6605 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006606
6607 if (*IObuff == '`')
6608 {
6609 if (d > IObuff + 2 && d[-1] == '`')
6610 {
6611 /* remove the backticks from `command` */
6612 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6613 d[-2] = NUL;
6614 }
6615 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6616 {
6617 /* remove the backticks and comma from `command`, */
6618 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6619 d[-3] = NUL;
6620 }
6621 else if (d > IObuff + 4 && d[-3] == '`'
6622 && d[-2] == '\\' && d[-1] == '.')
6623 {
6624 /* remove the backticks and dot from `command`\. */
6625 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6626 d[-4] = NUL;
6627 }
6628 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 }
6630 }
6631
6632 *matches = (char_u **)"";
6633 *num_matches = 0;
6634 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6635 if (keep_lang)
6636 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006637 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006639 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 /* Sort the matches found on the heuristic number that is after the
6641 * tag name. */
6642 qsort((void *)*matches, (size_t)*num_matches,
6643 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006644 /* Delete more than TAG_MANY to reduce the size of the listing. */
6645 while (*num_matches > TAG_MANY)
6646 vim_free((*matches)[--*num_matches]);
6647 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 return OK;
6649}
6650
6651/*
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006652 * Called when starting to edit a buffer for a help file.
6653 */
6654 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006655prepare_help_buffer(void)
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006656{
6657 char_u *p;
6658
6659 curbuf->b_help = TRUE;
6660#ifdef FEAT_QUICKFIX
6661 set_string_option_direct((char_u *)"buftype", -1,
6662 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
6663#endif
6664
6665 /*
6666 * Always set these options after jumping to a help tag, because the
6667 * user may have an autocommand that gets in the way.
6668 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
6669 * latin1 word characters (for translated help files).
6670 * Only set it when needed, buf_init_chartab() is some work.
6671 */
6672 p =
6673#ifdef EBCDIC
6674 (char_u *)"65-255,^*,^|,^\"";
6675#else
6676 (char_u *)"!-~,^*,^|,^\",192-255";
6677#endif
6678 if (STRCMP(curbuf->b_p_isk, p) != 0)
6679 {
6680 set_string_option_direct((char_u *)"isk", -1, p, OPT_FREE|OPT_LOCAL, 0);
6681 check_buf_options(curbuf);
6682 (void)buf_init_chartab(curbuf, FALSE);
6683 }
6684
Bram Moolenaar0b105412014-11-30 13:34:23 +01006685#ifdef FEAT_FOLDING
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006686 /* Don't use the global foldmethod.*/
6687 set_string_option_direct((char_u *)"fdm", -1, (char_u *)"manual",
6688 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar0b105412014-11-30 13:34:23 +01006689#endif
Bram Moolenaar54fb4382014-11-12 19:28:16 +01006690
6691 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
6692 curwin->w_p_list = FALSE; /* no list mode */
6693
6694 curbuf->b_p_ma = FALSE; /* not modifiable */
6695 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
6696 curwin->w_p_nu = 0; /* no line numbers */
6697 curwin->w_p_rnu = 0; /* no relative line numbers */
6698 RESET_BINDING(curwin); /* no scroll or cursor binding */
6699#ifdef FEAT_ARABIC
6700 curwin->w_p_arab = FALSE; /* no arabic mode */
6701#endif
6702#ifdef FEAT_RIGHTLEFT
6703 curwin->w_p_rl = FALSE; /* help window is left-to-right */
6704#endif
6705#ifdef FEAT_FOLDING
6706 curwin->w_p_fen = FALSE; /* No folding in the help window */
6707#endif
6708#ifdef FEAT_DIFF
6709 curwin->w_p_diff = FALSE; /* No 'diff' */
6710#endif
6711#ifdef FEAT_SPELL
6712 curwin->w_p_spell = FALSE; /* No spell checking */
6713#endif
6714
6715 set_buflisted(FALSE);
6716}
6717
6718/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 * After reading a help file: May cleanup a help buffer when syntax
6720 * highlighting is not used.
6721 */
6722 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006723fix_help_buffer(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724{
6725 linenr_T lnum;
6726 char_u *line;
6727 int in_example = FALSE;
6728 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006729 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 char_u *p;
6731 char_u *rt;
6732 int mustfree;
6733
6734 /* set filetype to "help". */
6735 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6736
6737#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006738 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739#endif
6740 {
6741 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6742 {
6743 line = ml_get_buf(curbuf, lnum, FALSE);
6744 len = (int)STRLEN(line);
6745 if (in_example && len > 0 && !vim_iswhite(line[0]))
6746 {
6747 /* End of example: non-white or '<' in first column. */
6748 if (line[0] == '<')
6749 {
6750 /* blank-out a '<' in the first column */
6751 line = ml_get_buf(curbuf, lnum, TRUE);
6752 line[0] = ' ';
6753 }
6754 in_example = FALSE;
6755 }
6756 if (!in_example && len > 0)
6757 {
6758 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6759 {
6760 /* blank-out a '>' in the last column (start of example) */
6761 line = ml_get_buf(curbuf, lnum, TRUE);
6762 line[len - 1] = ' ';
6763 in_example = TRUE;
6764 }
6765 else if (line[len - 1] == '~')
6766 {
6767 /* blank-out a '~' at the end of line (header marker) */
6768 line = ml_get_buf(curbuf, lnum, TRUE);
6769 line[len - 1] = ' ';
6770 }
6771 }
6772 }
6773 }
6774
6775 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006776 * In the "help.txt" and "help.abx" file, add the locally added help
6777 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006778 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006779 fname = gettail(curbuf->b_fname);
6780 if (fnamecmp(fname, "help.txt") == 0
6781#ifdef FEAT_MULTI_LANG
6782 || (fnamencmp(fname, "help.", 5) == 0
6783 && ASCII_ISALPHA(fname[5])
6784 && ASCII_ISALPHA(fname[6])
6785 && TOLOWER_ASC(fname[7]) == 'x'
6786 && fname[8] == NUL)
6787#endif
6788 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 {
6790 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6791 {
6792 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006793 if (strstr((char *)line, "*local-additions*") == NULL)
6794 continue;
6795
6796 /* Go through all directories in 'runtimepath', skipping
6797 * $VIMRUNTIME. */
6798 p = p_rtp;
6799 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006801 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6802 mustfree = FALSE;
6803 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6804 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006806 int fcount;
6807 char_u **fnames;
6808 FILE *fd;
6809 char_u *s;
6810 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006812 vimconv_T vc;
6813 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814#endif
6815
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006816 /* Find all "doc/ *.txt" files in this directory. */
6817 add_pathsep(NameBuff);
6818#ifdef FEAT_MULTI_LANG
6819 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006821 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006823 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6824 &fnames, EW_FILE|EW_SILENT) == OK
6825 && fcount > 0)
6826 {
6827#ifdef FEAT_MULTI_LANG
6828 int i1;
6829 int i2;
6830 char_u *f1;
6831 char_u *f2;
6832 char_u *t1;
6833 char_u *e1;
6834 char_u *e2;
6835
6836 /* If foo.abx is found use it instead of foo.txt in
6837 * the same directory. */
6838 for (i1 = 0; i1 < fcount; ++i1)
6839 {
6840 for (i2 = 0; i2 < fcount; ++i2)
6841 {
6842 if (i1 == i2)
6843 continue;
6844 if (fnames[i1] == NULL || fnames[i2] == NULL)
6845 continue;
6846 f1 = fnames[i1];
6847 f2 = fnames[i2];
6848 t1 = gettail(f1);
6849 if (fnamencmp(f1, f2, t1 - f1) != 0)
6850 continue;
6851 e1 = vim_strrchr(t1, '.');
6852 e2 = vim_strrchr(gettail(f2), '.');
6853 if (e1 == NUL || e2 == NUL)
6854 continue;
6855 if (fnamecmp(e1, ".txt") != 0
6856 && fnamecmp(e1, fname + 4) != 0)
6857 {
6858 /* Not .txt and not .abx, remove it. */
6859 vim_free(fnames[i1]);
6860 fnames[i1] = NULL;
6861 continue;
6862 }
6863 if (fnamencmp(f1, f2, e1 - f1) != 0)
6864 continue;
6865 if (fnamecmp(e1, ".txt") == 0
6866 && fnamecmp(e2, fname + 4) == 0)
6867 {
6868 /* use .abx instead of .txt */
6869 vim_free(fnames[i1]);
6870 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 }
6872 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006874#endif
6875 for (fi = 0; fi < fcount; ++fi)
6876 {
6877 if (fnames[fi] == NULL)
6878 continue;
6879 fd = mch_fopen((char *)fnames[fi], "r");
6880 if (fd != NULL)
6881 {
6882 vim_fgets(IObuff, IOSIZE, fd);
6883 if (IObuff[0] == '*'
6884 && (s = vim_strchr(IObuff + 1, '*'))
6885 != NULL)
6886 {
6887#ifdef FEAT_MBYTE
6888 int this_utf = MAYBE;
6889#endif
6890 /* Change tag definition to a
6891 * reference and remove <CR>/<NL>. */
6892 IObuff[0] = '|';
6893 *s = '|';
6894 while (*s != NUL)
6895 {
6896 if (*s == '\r' || *s == '\n')
6897 *s = NUL;
6898#ifdef FEAT_MBYTE
6899 /* The text is utf-8 when a byte
6900 * above 127 is found and no
6901 * illegal byte sequence is found.
6902 */
6903 if (*s >= 0x80 && this_utf != FALSE)
6904 {
6905 int l;
6906
6907 this_utf = TRUE;
6908 l = utf_ptr2len(s);
6909 if (l == 1)
6910 this_utf = FALSE;
6911 s += l - 1;
6912 }
6913#endif
6914 ++s;
6915 }
6916#ifdef FEAT_MBYTE
6917 /* The help file is latin1 or utf-8;
6918 * conversion to the current
6919 * 'encoding' may be required. */
6920 vc.vc_type = CONV_NONE;
6921 convert_setup(&vc, (char_u *)(
6922 this_utf == TRUE ? "utf-8"
6923 : "latin1"), p_enc);
6924 if (vc.vc_type == CONV_NONE)
6925 /* No conversion needed. */
6926 cp = IObuff;
6927 else
6928 {
6929 /* Do the conversion. If it fails
6930 * use the unconverted text. */
6931 cp = string_convert(&vc, IObuff,
6932 NULL);
6933 if (cp == NULL)
6934 cp = IObuff;
6935 }
6936 convert_setup(&vc, NULL, NULL);
6937
6938 ml_append(lnum, cp, (colnr_T)0, FALSE);
6939 if (cp != IObuff)
6940 vim_free(cp);
6941#else
6942 ml_append(lnum, IObuff, (colnr_T)0,
6943 FALSE);
6944#endif
6945 ++lnum;
6946 }
6947 fclose(fd);
6948 }
6949 }
6950 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006953 if (mustfree)
6954 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006956 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 }
6958 }
6959}
6960
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006961/*
6962 * ":exusage"
6963 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006964 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006965ex_exusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006966{
6967 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6968}
6969
6970/*
6971 * ":viusage"
6972 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006973 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006974ex_viusage(exarg_T *eap UNUSED)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006975{
6976 do_cmdline_cmd((char_u *)"help normal-index");
6977}
6978
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979/*
Bram Moolenaar6bef5302016-03-12 21:28:26 +01006980 * Generate tags in one help directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01006983helptags_one(
6984 char_u *dir, /* doc directory */
6985 char_u *ext, /* suffix, ".txt", ".itx", ".frx", etc. */
6986 char_u *tagfname, /* "tags" for English, "tags-fr" for French. */
6987 int add_help_tags) /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988{
6989 FILE *fd_tags;
6990 FILE *fd;
6991 garray_T ga;
6992 int filecount;
6993 char_u **files;
6994 char_u *p1, *p2;
6995 int fi;
6996 char_u *s;
6997 int i;
6998 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006999 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000# ifdef FEAT_MBYTE
7001 int utf8 = MAYBE;
7002 int this_utf8;
7003 int firstline;
7004 int mix = FALSE; /* detected mixed encodings */
7005# endif
7006
7007 /*
7008 * Find all *.txt files.
7009 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01007010 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007012 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 STRCAT(NameBuff, ext);
7014 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7015 EW_FILE|EW_SILENT) == FAIL
7016 || filecount == 0)
7017 {
7018 if (!got_int)
7019 EMSG2("E151: No match: %s", NameBuff);
7020 return;
7021 }
7022
7023 /*
7024 * Open the tags file for writing.
7025 * Do this before scanning through all the files.
7026 */
7027 STRCPY(NameBuff, dir);
7028 add_pathsep(NameBuff);
7029 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007030 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 if (fd_tags == NULL)
7032 {
7033 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
7034 FreeWild(filecount, files);
7035 return;
7036 }
7037
7038 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007039 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
7040 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 */
7042 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00007043 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
7044 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 {
7046 if (ga_grow(&ga, 1) == FAIL)
7047 got_int = TRUE;
7048 else
7049 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007050 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 if (s == NULL)
7052 got_int = TRUE;
7053 else
7054 {
7055 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
7056 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7057 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 }
7059 }
7060 }
7061
7062 /*
7063 * Go over all the files and extract the tags.
7064 */
7065 for (fi = 0; fi < filecount && !got_int; ++fi)
7066 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00007067 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 if (fd == NULL)
7069 {
7070 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
7071 continue;
7072 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01007073 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074
7075# ifdef FEAT_MBYTE
7076 firstline = TRUE;
7077# endif
7078 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7079 {
7080# ifdef FEAT_MBYTE
7081 if (firstline)
7082 {
7083 /* Detect utf-8 file by a non-ASCII char in the first line. */
7084 this_utf8 = MAYBE;
7085 for (s = IObuff; *s != NUL; ++s)
7086 if (*s >= 0x80)
7087 {
7088 int l;
7089
7090 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007091 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 if (l == 1)
7093 {
7094 /* Illegal UTF-8 byte sequence. */
7095 this_utf8 = FALSE;
7096 break;
7097 }
7098 s += l - 1;
7099 }
7100 if (this_utf8 == MAYBE) /* only ASCII characters found */
7101 this_utf8 = FALSE;
7102 if (utf8 == MAYBE) /* first file */
7103 utf8 = this_utf8;
7104 else if (utf8 != this_utf8)
7105 {
7106 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
7107 mix = !got_int;
7108 got_int = TRUE;
7109 }
7110 firstline = FALSE;
7111 }
7112# endif
7113 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
7114 while (p1 != NULL)
7115 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02007116 /* Use vim_strbyte() instead of vim_strchr() so that when
7117 * 'encoding' is dbcs it still works, don't find '*' in the
7118 * second byte. */
7119 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
7121 {
7122 for (s = p1 + 1; s < p2; ++s)
7123 if (*s == ' ' || *s == '\t' || *s == '|')
7124 break;
7125
7126 /*
7127 * Only accept a *tag* when it consists of valid
7128 * characters, there is white space before it and is
7129 * followed by a white character or end-of-line.
7130 */
7131 if (s == p2
7132 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
7133 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
7134 || s[1] == '\0'))
7135 {
7136 *p2 = '\0';
7137 ++p1;
7138 if (ga_grow(&ga, 1) == FAIL)
7139 {
7140 got_int = TRUE;
7141 break;
7142 }
7143 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
7144 if (s == NULL)
7145 {
7146 got_int = TRUE;
7147 break;
7148 }
7149 ((char_u **)ga.ga_data)[ga.ga_len] = s;
7150 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 sprintf((char *)s, "%s\t%s", p1, fname);
7152
7153 /* find next '*' */
7154 p2 = vim_strchr(p2 + 1, '*');
7155 }
7156 }
7157 p1 = p2;
7158 }
7159 line_breakcheck();
7160 }
7161
7162 fclose(fd);
7163 }
7164
7165 FreeWild(filecount, files);
7166
7167 if (!got_int)
7168 {
7169 /*
7170 * Sort the tags.
7171 */
Bram Moolenaarcde88542015-08-11 19:14:00 +02007172 if (ga.ga_data != NULL)
7173 sort_strings((char_u **)ga.ga_data, ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174
7175 /*
7176 * Check for duplicates.
7177 */
7178 for (i = 1; i < ga.ga_len; ++i)
7179 {
7180 p1 = ((char_u **)ga.ga_data)[i - 1];
7181 p2 = ((char_u **)ga.ga_data)[i];
7182 while (*p1 == *p2)
7183 {
7184 if (*p2 == '\t')
7185 {
7186 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00007187 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 _("E154: Duplicate tag \"%s\" in file %s/%s"),
7189 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
7190 EMSG(NameBuff);
7191 *p2 = '\t';
7192 break;
7193 }
7194 ++p1;
7195 ++p2;
7196 }
7197 }
7198
7199# ifdef FEAT_MBYTE
7200 if (utf8 == TRUE)
7201 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
7202# endif
7203
7204 /*
7205 * Write the tags into the file.
7206 */
7207 for (i = 0; i < ga.ga_len; ++i)
7208 {
7209 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00007210 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00007212 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 else
7214 {
7215 fprintf(fd_tags, "%s\t/*", s);
7216 for (p1 = s; *p1 != '\t'; ++p1)
7217 {
7218 /* insert backslash before '\\' and '/' */
7219 if (*p1 == '\\' || *p1 == '/')
7220 putc('\\', fd_tags);
7221 putc(*p1, fd_tags);
7222 }
7223 fprintf(fd_tags, "*\n");
7224 }
7225 }
7226 }
7227#ifdef FEAT_MBYTE
7228 if (mix)
7229 got_int = FALSE; /* continue with other languages */
7230#endif
7231
7232 for (i = 0; i < ga.ga_len; ++i)
7233 vim_free(((char_u **)ga.ga_data)[i]);
7234 ga_clear(&ga);
7235 fclose(fd_tags); /* there is no check for an error... */
7236}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007238/*
7239 * Generate tags in one help directory, taking care of translations.
7240 */
7241 static void
7242do_helptags(char_u *dirname, int add_help_tags)
7243{
7244#ifdef FEAT_MULTI_LANG
7245 int len;
7246 int i, j;
7247 garray_T ga;
7248 char_u lang[2];
7249 char_u ext[5];
7250 char_u fname[8];
7251 int filecount;
7252 char_u **files;
7253
7254 /* Get a list of all files in the help directory and in subdirectories. */
7255 STRCPY(NameBuff, dirname);
7256 add_pathsep(NameBuff);
7257 STRCAT(NameBuff, "**");
7258 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
7259 EW_FILE|EW_SILENT) == FAIL
7260 || filecount == 0)
7261 {
7262 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar6bef5302016-03-12 21:28:26 +01007263 return;
7264 }
7265
7266 /* Go over all files in the directory to find out what languages are
7267 * present. */
7268 ga_init2(&ga, 1, 10);
7269 for (i = 0; i < filecount; ++i)
7270 {
7271 len = (int)STRLEN(files[i]);
7272 if (len > 4)
7273 {
7274 if (STRICMP(files[i] + len - 4, ".txt") == 0)
7275 {
7276 /* ".txt" -> language "en" */
7277 lang[0] = 'e';
7278 lang[1] = 'n';
7279 }
7280 else if (files[i][len - 4] == '.'
7281 && ASCII_ISALPHA(files[i][len - 3])
7282 && ASCII_ISALPHA(files[i][len - 2])
7283 && TOLOWER_ASC(files[i][len - 1]) == 'x')
7284 {
7285 /* ".abx" -> language "ab" */
7286 lang[0] = TOLOWER_ASC(files[i][len - 3]);
7287 lang[1] = TOLOWER_ASC(files[i][len - 2]);
7288 }
7289 else
7290 continue;
7291
7292 /* Did we find this language already? */
7293 for (j = 0; j < ga.ga_len; j += 2)
7294 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
7295 break;
7296 if (j == ga.ga_len)
7297 {
7298 /* New language, add it. */
7299 if (ga_grow(&ga, 2) == FAIL)
7300 break;
7301 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
7302 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
7303 }
7304 }
7305 }
7306
7307 /*
7308 * Loop over the found languages to generate a tags file for each one.
7309 */
7310 for (j = 0; j < ga.ga_len; j += 2)
7311 {
7312 STRCPY(fname, "tags-xx");
7313 fname[5] = ((char_u *)ga.ga_data)[j];
7314 fname[6] = ((char_u *)ga.ga_data)[j + 1];
7315 if (fname[5] == 'e' && fname[6] == 'n')
7316 {
7317 /* English is an exception: use ".txt" and "tags". */
7318 fname[4] = NUL;
7319 STRCPY(ext, ".txt");
7320 }
7321 else
7322 {
7323 /* Language "ab" uses ".abx" and "tags-ab". */
7324 STRCPY(ext, ".xxx");
7325 ext[1] = fname[5];
7326 ext[2] = fname[6];
7327 }
7328 helptags_one(dirname, ext, fname, add_help_tags);
7329 }
7330
7331 ga_clear(&ga);
7332 FreeWild(filecount, files);
7333
7334#else
7335 /* No language support, just use "*.txt" and "tags". */
7336 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
7337#endif
7338}
7339
7340 static void
7341helptags_cb(char_u *fname, void *cookie)
7342{
7343 do_helptags(fname, *(int *)cookie);
7344}
7345
7346/*
7347 * ":helptags"
7348 */
7349 void
7350ex_helptags(exarg_T *eap)
7351{
7352 expand_T xpc;
7353 char_u *dirname;
7354 int add_help_tags = FALSE;
7355
7356 /* Check for ":helptags ++t {dir}". */
7357 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
7358 {
7359 add_help_tags = TRUE;
7360 eap->arg = skipwhite(eap->arg + 3);
7361 }
7362
7363 if (STRCMP(eap->arg, "ALL") == 0)
7364 {
7365 do_in_path(p_rtp, (char_u *)"doc", DIP_ALL + DIP_DIR,
7366 helptags_cb, &add_help_tags);
7367 }
7368 else
7369 {
7370 ExpandInit(&xpc);
7371 xpc.xp_context = EXPAND_DIRECTORIES;
7372 dirname = ExpandOne(&xpc, eap->arg, NULL,
7373 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
7374 if (dirname == NULL || !mch_isdir(dirname))
7375 EMSG2(_("E150: Not a directory: %s"), eap->arg);
7376 else
7377 do_helptags(dirname, add_help_tags);
7378 vim_free(dirname);
7379 }
7380}
7381
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382#if defined(FEAT_SIGNS) || defined(PROTO)
7383
7384/*
7385 * Struct to hold the sign properties.
7386 */
7387typedef struct sign sign_T;
7388
7389struct sign
7390{
7391 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02007392 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 char_u *sn_name; /* name of sign */
7394 char_u *sn_icon; /* name of pixmap */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007395# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 void *sn_image; /* icon image */
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007397# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 char_u *sn_text; /* text used instead of pixmap */
7399 int sn_line_hl; /* highlight ID for line */
7400 int sn_text_hl; /* highlight ID for text */
7401};
7402
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007404static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01007406static int sign_cmd_idx(char_u *begin_cmd, char_u *end_cmd);
7407static void sign_list_defined(sign_T *sp);
7408static void sign_undefine(sign_T *sp, sign_T *sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007410static char *cmds[] = {
7411 "define",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007412# define SIGNCMD_DEFINE 0
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007413 "undefine",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007414# define SIGNCMD_UNDEFINE 1
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007415 "list",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007416# define SIGNCMD_LIST 2
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007417 "place",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007418# define SIGNCMD_PLACE 3
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007419 "unplace",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007420# define SIGNCMD_UNPLACE 4
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007421 "jump",
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007422# define SIGNCMD_JUMP 5
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007423 NULL
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007424# define SIGNCMD_LAST 6
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007425};
7426
7427/*
7428 * Find index of a ":sign" subcmd from its name.
7429 * "*end_cmd" must be writable.
7430 */
7431 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007432sign_cmd_idx(
7433 char_u *begin_cmd, /* begin of sign subcmd */
7434 char_u *end_cmd) /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007435{
7436 int idx;
7437 char save = *end_cmd;
7438
7439 *end_cmd = NUL;
7440 for (idx = 0; ; ++idx)
7441 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
7442 break;
7443 *end_cmd = save;
7444 return idx;
7445}
7446
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447/*
7448 * ":sign" command
7449 */
7450 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007451ex_sign(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452{
7453 char_u *arg = eap->arg;
7454 char_u *p;
7455 int idx;
7456 sign_T *sp;
7457 sign_T *sp_prev;
7458 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459
7460 /* Parse the subcommand. */
7461 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007462 idx = sign_cmd_idx(arg, p);
7463 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007465 EMSG2(_("E160: Unknown sign command: %s"), arg);
7466 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 }
7468 arg = skipwhite(p);
7469
7470 if (idx <= SIGNCMD_LIST)
7471 {
7472 /*
7473 * Define, undefine or list signs.
7474 */
7475 if (idx == SIGNCMD_LIST && *arg == NUL)
7476 {
7477 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01007478 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 sign_list_defined(sp);
7480 }
7481 else if (*arg == NUL)
7482 EMSG(_("E156: Missing sign name"));
7483 else
7484 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007485 /* Isolate the sign name. If it's a number skip leading zeroes,
7486 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 p = skiptowhite(arg);
7488 if (*p != NUL)
7489 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007490 while (arg[0] == '0' && arg[1] != NUL)
7491 ++arg;
7492
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 sp_prev = NULL;
7494 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7495 {
7496 if (STRCMP(sp->sn_name, arg) == 0)
7497 break;
7498 sp_prev = sp;
7499 }
7500 if (idx == SIGNCMD_DEFINE)
7501 {
7502 /* ":sign define {name} ...": define a sign */
7503 if (sp == NULL)
7504 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007505 sign_T *lp;
7506 int start = next_sign_typenr;
7507
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 /* Allocate a new sign. */
7509 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
7510 if (sp == NULL)
7511 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007513 /* Check that next_sign_typenr is not already being used.
7514 * This only happens after wrapping around. Hopefully
7515 * another one got deleted and we can use its number. */
7516 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007518 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007520 ++next_sign_typenr;
7521 if (next_sign_typenr == MAX_TYPENR)
7522 next_sign_typenr = 1;
7523 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007525 vim_free(sp);
7526 EMSG(_("E612: Too many signs defined"));
7527 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007529 lp = first_sign; /* start all over */
7530 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007532 lp = lp->sn_next;
7533 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007535 sp->sn_typenr = next_sign_typenr;
7536 if (++next_sign_typenr == MAX_TYPENR)
7537 next_sign_typenr = 1; /* wrap around */
7538
7539 sp->sn_name = vim_strsave(arg);
7540 if (sp->sn_name == NULL) /* out of memory */
7541 {
7542 vim_free(sp);
7543 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02007545
7546 /* add the new sign to the list of signs */
7547 if (sp_prev == NULL)
7548 first_sign = sp;
7549 else
7550 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 }
7552
7553 /* set values for a defined sign. */
7554 for (;;)
7555 {
7556 arg = skipwhite(p);
7557 if (*arg == NUL)
7558 break;
7559 p = skiptowhite_esc(arg);
7560 if (STRNCMP(arg, "icon=", 5) == 0)
7561 {
7562 arg += 5;
7563 vim_free(sp->sn_icon);
7564 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
7565 backslash_halve(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007566# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 if (gui.in_use)
7568 {
7569 out_flush();
7570 if (sp->sn_image != NULL)
7571 gui_mch_destroy_sign(sp->sn_image);
7572 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7573 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007574# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 }
7576 else if (STRNCMP(arg, "text=", 5) == 0)
7577 {
7578 char_u *s;
7579 int cells;
7580 int len;
7581
7582 arg += 5;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007583# ifdef FEAT_MBYTE
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 /* Count cells and check for non-printable chars */
7585 if (has_mbyte)
7586 {
7587 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00007588 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 {
7590 if (!vim_isprintc((*mb_ptr2char)(s)))
7591 break;
7592 cells += (*mb_ptr2cells)(s);
7593 }
7594 }
7595 else
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007596# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 {
7598 for (s = arg; s < p; ++s)
7599 if (!vim_isprintc(*s))
7600 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007601 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 }
7603 /* Currently must be one or two display cells */
7604 if (s != p || cells < 1 || cells > 2)
7605 {
7606 *p = NUL;
7607 EMSG2(_("E239: Invalid sign text: %s"), arg);
7608 return;
7609 }
7610
7611 vim_free(sp->sn_text);
7612 /* Allocate one byte more if we need to pad up
7613 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00007614 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 sp->sn_text = vim_strnsave(arg, len);
7616
7617 if (sp->sn_text != NULL && cells == 1)
7618 STRCPY(sp->sn_text + len - 1, " ");
7619 }
7620 else if (STRNCMP(arg, "linehl=", 7) == 0)
7621 {
7622 arg += 7;
7623 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
7624 }
7625 else if (STRNCMP(arg, "texthl=", 7) == 0)
7626 {
7627 arg += 7;
7628 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7629 }
7630 else
7631 {
7632 EMSG2(_(e_invarg2), arg);
7633 return;
7634 }
7635 }
7636 }
7637 else if (sp == NULL)
7638 EMSG2(_("E155: Unknown sign: %s"), arg);
7639 else if (idx == SIGNCMD_LIST)
7640 /* ":sign list {name}" */
7641 sign_list_defined(sp);
7642 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007644 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 }
7646 }
7647 else
7648 {
7649 int id = -1;
7650 linenr_T lnum = -1;
7651 char_u *sign_name = NULL;
7652 char_u *arg1;
7653
7654 if (*arg == NUL)
7655 {
7656 if (idx == SIGNCMD_PLACE)
7657 {
7658 /* ":sign place": list placed signs in all buffers */
7659 sign_list_placed(NULL);
7660 }
7661 else if (idx == SIGNCMD_UNPLACE)
7662 {
7663 /* ":sign unplace": remove placed sign at cursor */
7664 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7665 if (id > 0)
7666 {
7667 buf_delsign(curwin->w_buffer, id);
7668 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7669 }
7670 else
7671 EMSG(_("E159: Missing sign number"));
7672 }
7673 else
7674 EMSG(_(e_argreq));
7675 return;
7676 }
7677
7678 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7679 {
7680 /* ":sign unplace *": remove all placed signs */
7681 buf_delete_all_signs();
7682 return;
7683 }
7684
7685 /* first arg could be placed sign id */
7686 arg1 = arg;
7687 if (VIM_ISDIGIT(*arg))
7688 {
7689 id = getdigits(&arg);
7690 if (!vim_iswhite(*arg) && *arg != NUL)
7691 {
7692 id = -1;
7693 arg = arg1;
7694 }
7695 else
7696 {
7697 arg = skipwhite(arg);
7698 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7699 {
7700 /* ":sign unplace {id}": remove placed sign by number */
7701 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
7702 if ((lnum = buf_delsign(buf, id)) != 0)
7703 update_debug_sign(buf, lnum);
7704 return;
7705 }
7706 }
7707 }
7708
7709 /*
7710 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7711 * Leave "arg" pointing to {fname}.
7712 */
7713 for (;;)
7714 {
7715 if (STRNCMP(arg, "line=", 5) == 0)
7716 {
7717 arg += 5;
7718 lnum = atoi((char *)arg);
7719 arg = skiptowhite(arg);
7720 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007721 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7722 {
7723 if (id != -1)
7724 {
7725 EMSG(_(e_invarg));
7726 return;
7727 }
7728 id = -2;
7729 arg = skiptowhite(arg + 1);
7730 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 else if (STRNCMP(arg, "name=", 5) == 0)
7732 {
7733 arg += 5;
7734 sign_name = arg;
7735 arg = skiptowhite(arg);
7736 if (*arg != NUL)
7737 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007738 while (sign_name[0] == '0' && sign_name[1] != NUL)
7739 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 }
7741 else if (STRNCMP(arg, "file=", 5) == 0)
7742 {
7743 arg += 5;
7744 buf = buflist_findname(arg);
7745 break;
7746 }
7747 else if (STRNCMP(arg, "buffer=", 7) == 0)
7748 {
7749 arg += 7;
7750 buf = buflist_findnr((int)getdigits(&arg));
7751 if (*skipwhite(arg) != NUL)
7752 EMSG(_(e_trailing));
7753 break;
7754 }
7755 else
7756 {
7757 EMSG(_(e_invarg));
7758 return;
7759 }
7760 arg = skipwhite(arg);
7761 }
7762
7763 if (buf == NULL)
7764 {
7765 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7766 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007767 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 {
7769 if (lnum >= 0 || sign_name != NULL)
7770 EMSG(_(e_invarg));
7771 else
7772 /* ":sign place file={fname}": list placed signs in one file */
7773 sign_list_placed(buf);
7774 }
7775 else if (idx == SIGNCMD_JUMP)
7776 {
7777 /* ":sign jump {id} file={fname}" */
7778 if (lnum >= 0 || sign_name != NULL)
7779 EMSG(_(e_invarg));
7780 else if ((lnum = buf_findsign(buf, id)) > 0)
7781 { /* goto a sign ... */
7782 if (buf_jump_open_win(buf) != NULL)
7783 { /* ... in a current window */
7784 curwin->w_cursor.lnum = lnum;
7785 check_cursor_lnum();
7786 beginline(BL_WHITE);
7787 }
7788 else
7789 { /* ... not currently in a window */
7790 char_u *cmd;
7791
7792 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7793 if (cmd == NULL)
7794 return;
7795 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7796 do_cmdline_cmd(cmd);
7797 vim_free(cmd);
7798 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007799# ifdef FEAT_FOLDING
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 foldOpenCursor();
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007801# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 }
7803 else
7804 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7805 }
7806 else if (idx == SIGNCMD_UNPLACE)
7807 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 if (lnum >= 0 || sign_name != NULL)
7809 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007810 else if (id == -2)
7811 {
7812 /* ":sign unplace * file={fname}" */
7813 redraw_buf_later(buf, NOT_VALID);
7814 buf_delete_signs(buf);
7815 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 else
7817 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007818 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 lnum = buf_delsign(buf, id);
7820 update_debug_sign(buf, lnum);
7821 }
7822 }
7823 /* idx == SIGNCMD_PLACE */
7824 else if (sign_name != NULL)
7825 {
7826 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7827 if (STRCMP(sp->sn_name, sign_name) == 0)
7828 break;
7829 if (sp == NULL)
7830 {
7831 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7832 return;
7833 }
7834 if (lnum > 0)
7835 /* ":sign place {id} line={lnum} name={name} file={fname}":
7836 * place a sign */
7837 buf_addsign(buf, id, lnum, sp->sn_typenr);
7838 else
7839 /* ":sign place {id} file={fname}": change sign type */
7840 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
Bram Moolenaarf4d7f162014-05-07 14:38:44 +02007841 if (lnum > 0)
7842 update_debug_sign(buf, lnum);
7843 else
7844 EMSG2(_("E885: Not possible to change sign %s"), sign_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 }
7846 else
7847 EMSG(_(e_invarg));
7848 }
7849}
7850
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007851# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852/*
7853 * Allocate the icons. Called when the GUI has started. Allows defining
7854 * signs before it starts.
7855 */
7856 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007857sign_gui_started(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858{
7859 sign_T *sp;
7860
7861 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7862 if (sp->sn_icon != NULL)
7863 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7864}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007865# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866
7867/*
7868 * List one sign.
7869 */
7870 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007871sign_list_defined(sign_T *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872{
7873 char_u *p;
7874
Bram Moolenaar555b2802005-05-19 21:08:39 +00007875 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 if (sp->sn_icon != NULL)
7877 {
7878 MSG_PUTS(" icon=");
7879 msg_outtrans(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007880# ifdef FEAT_SIGN_ICONS
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 if (sp->sn_image == NULL)
7882 MSG_PUTS(_(" (NOT FOUND)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007883# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 MSG_PUTS(_(" (not supported)"));
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007885# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 }
7887 if (sp->sn_text != NULL)
7888 {
7889 MSG_PUTS(" text=");
7890 msg_outtrans(sp->sn_text);
7891 }
7892 if (sp->sn_line_hl > 0)
7893 {
7894 MSG_PUTS(" linehl=");
7895 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7896 if (p == NULL)
7897 MSG_PUTS("NONE");
7898 else
7899 msg_puts(p);
7900 }
7901 if (sp->sn_text_hl > 0)
7902 {
7903 MSG_PUTS(" texthl=");
7904 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7905 if (p == NULL)
7906 MSG_PUTS("NONE");
7907 else
7908 msg_puts(p);
7909 }
7910}
7911
7912/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007913 * Undefine a sign and free its memory.
7914 */
7915 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007916sign_undefine(sign_T *sp, sign_T *sp_prev)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007917{
7918 vim_free(sp->sn_name);
7919 vim_free(sp->sn_icon);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007920# ifdef FEAT_SIGN_ICONS
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007921 if (sp->sn_image != NULL)
7922 {
7923 out_flush();
7924 gui_mch_destroy_sign(sp->sn_image);
7925 }
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007926# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007927 vim_free(sp->sn_text);
7928 if (sp_prev == NULL)
7929 first_sign = sp->sn_next;
7930 else
7931 sp_prev->sn_next = sp->sn_next;
7932 vim_free(sp);
7933}
7934
7935/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 * Get highlighting attribute for sign "typenr".
7937 * If "line" is TRUE: line highl, if FALSE: text highl.
7938 */
7939 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007940sign_get_attr(int typenr, int line)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941{
7942 sign_T *sp;
7943
7944 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7945 if (sp->sn_typenr == typenr)
7946 {
7947 if (line)
7948 {
7949 if (sp->sn_line_hl > 0)
7950 return syn_id2attr(sp->sn_line_hl);
7951 }
7952 else
7953 {
7954 if (sp->sn_text_hl > 0)
7955 return syn_id2attr(sp->sn_text_hl);
7956 }
7957 break;
7958 }
7959 return 0;
7960}
7961
7962/*
7963 * Get text mark for sign "typenr".
7964 * Returns NULL if there isn't one.
7965 */
7966 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007967sign_get_text(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968{
7969 sign_T *sp;
7970
7971 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7972 if (sp->sn_typenr == typenr)
7973 return sp->sn_text;
7974 return NULL;
7975}
7976
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007977# if defined(FEAT_SIGN_ICONS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 void *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007979sign_get_image(
7980 int typenr) /* the attribute which may have a sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981{
7982 sign_T *sp;
7983
7984 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7985 if (sp->sn_typenr == typenr)
7986 return sp->sn_image;
7987 return NULL;
7988}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01007989# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990
7991/*
7992 * Get the name of a sign by its typenr.
7993 */
7994 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01007995sign_typenr2name(int typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996{
7997 sign_T *sp;
7998
7999 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8000 if (sp->sn_typenr == typenr)
8001 return sp->sn_name;
8002 return (char_u *)_("[Deleted]");
8003}
8004
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008005# if defined(EXITFREE) || defined(PROTO)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008006/*
8007 * Undefine/free all signs.
8008 */
8009 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008010free_signs(void)
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008011{
8012 while (first_sign != NULL)
8013 sign_undefine(first_sign, NULL);
8014}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008015# endif
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00008016
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008017# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008018static enum
8019{
8020 EXP_SUBCMD, /* expand :sign sub-commands */
8021 EXP_DEFINE, /* expand :sign define {name} args */
8022 EXP_PLACE, /* expand :sign place {id} args */
8023 EXP_UNPLACE, /* expand :sign unplace" */
8024 EXP_SIGN_NAMES /* expand with name of placed signs */
8025} expand_what;
8026
8027/*
8028 * Function given to ExpandGeneric() to obtain the sign command
8029 * expansion.
8030 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008031 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008032get_sign_name(expand_T *xp UNUSED, int idx)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008033{
8034 sign_T *sp;
8035 int current_idx;
8036
8037 switch (expand_what)
8038 {
8039 case EXP_SUBCMD:
8040 return (char_u *)cmds[idx];
8041 case EXP_DEFINE:
8042 {
8043 char *define_arg[] =
8044 {
8045 "icon=", "linehl=", "text=", "texthl=", NULL
8046 };
8047 return (char_u *)define_arg[idx];
8048 }
8049 case EXP_PLACE:
8050 {
8051 char *place_arg[] =
8052 {
8053 "line=", "name=", "file=", "buffer=", NULL
8054 };
8055 return (char_u *)place_arg[idx];
8056 }
8057 case EXP_UNPLACE:
8058 {
8059 char *unplace_arg[] = { "file=", "buffer=", NULL };
8060 return (char_u *)unplace_arg[idx];
8061 }
8062 case EXP_SIGN_NAMES:
8063 /* Complete with name of signs already defined */
8064 current_idx = 0;
8065 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
8066 if (current_idx++ == idx)
8067 return sp->sn_name;
8068 return NULL;
8069 default:
8070 return NULL;
8071 }
8072}
8073
8074/*
8075 * Handle command line completion for :sign command.
8076 */
8077 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008078set_context_in_sign_cmd(expand_T *xp, char_u *arg)
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008079{
8080 char_u *p;
8081 char_u *end_subcmd;
8082 char_u *last;
8083 int cmd_idx;
8084 char_u *begin_subcmd_args;
8085
8086 /* Default: expand subcommands. */
8087 xp->xp_context = EXPAND_SIGN;
8088 expand_what = EXP_SUBCMD;
8089 xp->xp_pattern = arg;
8090
8091 end_subcmd = skiptowhite(arg);
8092 if (*end_subcmd == NUL)
8093 /* expand subcmd name
8094 * :sign {subcmd}<CTRL-D>*/
8095 return;
8096
8097 cmd_idx = sign_cmd_idx(arg, end_subcmd);
8098
8099 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008100 * |
8101 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008102 begin_subcmd_args = skipwhite(end_subcmd);
8103 p = skiptowhite(begin_subcmd_args);
8104 if (*p == NUL)
8105 {
8106 /*
8107 * Expand first argument of subcmd when possible.
8108 * For ":jump {id}" and ":unplace {id}", we could
8109 * possibly expand the ids of all signs already placed.
8110 */
8111 xp->xp_pattern = begin_subcmd_args;
8112 switch (cmd_idx)
8113 {
8114 case SIGNCMD_LIST:
8115 case SIGNCMD_UNDEFINE:
8116 /* :sign list <CTRL-D>
8117 * :sign undefine <CTRL-D> */
8118 expand_what = EXP_SIGN_NAMES;
8119 break;
8120 default:
8121 xp->xp_context = EXPAND_NOTHING;
8122 }
8123 return;
8124 }
8125
8126 /* expand last argument of subcmd */
8127
8128 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008129 * |
8130 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008131
8132 /* Loop until reaching last argument. */
8133 do
8134 {
8135 p = skipwhite(p);
8136 last = p;
8137 p = skiptowhite(p);
8138 } while (*p != NUL);
8139
8140 p = vim_strchr(last, '=');
8141
8142 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02008143 * | |
8144 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008145 if (p == NUL)
8146 {
8147 /* Expand last argument name (before equal sign). */
8148 xp->xp_pattern = last;
8149 switch (cmd_idx)
8150 {
8151 case SIGNCMD_DEFINE:
8152 expand_what = EXP_DEFINE;
8153 break;
8154 case SIGNCMD_PLACE:
8155 expand_what = EXP_PLACE;
8156 break;
8157 case SIGNCMD_JUMP:
8158 case SIGNCMD_UNPLACE:
8159 expand_what = EXP_UNPLACE;
8160 break;
8161 default:
8162 xp->xp_context = EXPAND_NOTHING;
8163 }
8164 }
8165 else
8166 {
8167 /* Expand last argument value (after equal sign). */
8168 xp->xp_pattern = p + 1;
8169 switch (cmd_idx)
8170 {
8171 case SIGNCMD_DEFINE:
8172 if (STRNCMP(last, "texthl", p - last) == 0 ||
8173 STRNCMP(last, "linehl", p - last) == 0)
8174 xp->xp_context = EXPAND_HIGHLIGHT;
8175 else if (STRNCMP(last, "icon", p - last) == 0)
8176 xp->xp_context = EXPAND_FILES;
8177 else
8178 xp->xp_context = EXPAND_NOTHING;
8179 break;
8180 case SIGNCMD_PLACE:
8181 if (STRNCMP(last, "name", p - last) == 0)
8182 expand_what = EXP_SIGN_NAMES;
8183 else
8184 xp->xp_context = EXPAND_NOTHING;
8185 break;
8186 default:
8187 xp->xp_context = EXPAND_NOTHING;
8188 }
8189 }
8190}
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008191# endif
Bram Moolenaar3c65e312009-04-29 16:47:23 +00008192#endif
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008193
8194/*
8195 * Make the user happy.
8196 */
8197 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008198ex_smile(exarg_T *eap UNUSED)
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008199{
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008200 static char *code[] = {
8201 "\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$",
8202 "\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"
8203 };
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008204 char *p;
8205 int n;
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008206 int i;
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008207
8208 msg_start();
8209 msg_putchar('\n');
Bram Moolenaar700eefe2016-04-13 21:14:37 +02008210 for (i = 0; i < 2; ++i)
8211 for (p = code[i]; *p != NUL; ++p)
8212 if (*p == 'x')
8213 msg_putchar('\n');
8214 else
8215 for (n = *p++; n > 0; --n)
8216 if (*p == 'o' || *p == '$')
8217 msg_putchar_attr(*p, hl_attr(HLF_L));
8218 else
8219 msg_putchar(*p);
Bram Moolenaar86e179d2015-12-31 16:10:23 +01008220 msg_clr_eos();
8221}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222
8223#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
8224/*
8225 * ":drop"
8226 * Opens the first argument in a window. When there are two or more arguments
8227 * the argument list is redefined.
8228 */
8229 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01008230ex_drop(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231{
8232 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 win_T *wp;
8234 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008235# ifdef FEAT_WINDOWS
8236 tabpage_T *tp;
8237# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238
8239 /*
8240 * Check if the first argument is already being edited in a window. If
8241 * so, jump to that window.
8242 * We would actually need to check all arguments, but that's complicated
8243 * and mostly only one file is dropped.
8244 * This also ignores wildcards, since it is very unlikely the user is
8245 * editing a file name with a wildcard character.
8246 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008247 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00008249 /*
8250 * Expanding wildcards may result in an empty argument list. E.g. when
8251 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
8252 * already did an error message for this.
8253 */
8254 if (ARGCOUNT == 0)
8255 return;
8256
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008257# ifdef FEAT_WINDOWS
8258 if (cmdmod.tab)
8259 {
8260 /* ":tab drop file ...": open a tab for each argument that isn't
8261 * edited in a window yet. It's like ":tab all" but without closing
8262 * windows or tabs. */
8263 ex_all(eap);
8264 }
8265 else
8266# endif
8267 {
8268 /* ":drop file ...": Edit the first argument. Jump to an existing
8269 * window if possible, edit in current window if the current buffer
8270 * can be abandoned, otherwise open a new window. */
8271 buf = buflist_findnr(ARGLIST[0].ae_fnum);
8272
8273 FOR_ALL_TAB_WINDOWS(tp, wp)
8274 {
8275 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008277# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00008278 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008279# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 return;
8282 }
8283 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008285 /*
8286 * Check whether the current buffer is changed. If so, we will need
8287 * to split the current window or data could be lost.
8288 * Skip the check if the 'hidden' option is set, as in this case the
8289 * buffer won't be lost.
8290 */
8291 if (!P_HID(curbuf))
8292 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008294 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295# endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01008296 split = check_changed(curbuf, CCGD_AW | CCGD_EXCMD);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008298 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008300 if (split)
8301 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008303 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00008305 /* Fake a ":sfirst" or ":first" command edit the first argument. */
8306 if (split)
8307 {
8308 eap->cmdidx = CMD_sfirst;
8309 eap->cmd[0] = 's';
8310 }
8311 else
8312 eap->cmdidx = CMD_first;
8313 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315}
8316#endif