blob: 445b66fee5b520c10638ff70842f97e1af9077ea [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
17#ifdef FEAT_EX_EXTRA
18static int linelen __ARGS((int *has_tab));
19#endif
20static void do_filter __ARGS((linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out));
21#ifdef FEAT_VIMINFO
22static char_u *viminfo_filename __ARGS((char_u *));
Bram Moolenaard812df62008-11-09 12:46:09 +000023static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int flags));
Bram Moolenaar071d4272004-06-13 20:20:40 +000024static int viminfo_encoding __ARGS((vir_T *virp));
25static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
26#endif
27
Bram Moolenaar071d4272004-06-13 20:20:40 +000028static int check_readonly __ARGS((int *forceit, buf_T *buf));
29#ifdef FEAT_AUTOCMD
30static void delbuf_msg __ARGS((char_u *name));
31#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000032static int
33#ifdef __BORLANDC__
34 _RTLENTRYF
35#endif
36 help_compare __ARGS((const void *s1, const void *s2));
37
38/*
39 * ":ascii" and "ga".
40 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000041 void
42do_ascii(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +000043 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +000044{
45 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000046 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 char buf1[20];
48 char buf2[20];
49 char_u buf3[7];
50#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000051 int cc[MAX_MCO];
52 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000053 int len;
54
55 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000056 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 else
58#endif
59 c = gchar_cursor();
60 if (c == NUL)
61 {
62 MSG("NUL");
63 return;
64 }
65
66#ifdef FEAT_MBYTE
67 IObuff[0] = NUL;
68 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
69#endif
70 {
71 if (c == NL) /* NUL is stored as NL */
72 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000073 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
74 cval = NL; /* NL is stored as CR */
75 else
76 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000077 if (vim_isprintc_strict(c) && (c < ' '
78#ifndef EBCDIC
79 || c > '~'
80#endif
81 ))
82 {
83 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000084 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000085 }
86 else
87 buf1[0] = NUL;
88#ifndef EBCDIC
89 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000090 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
91 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000092 else
93#endif
94 buf2[0] = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +000095 vim_snprintf((char *)IObuff, IOSIZE,
96 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000097 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +000098#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +000099 if (enc_utf8)
100 c = cc[ci++];
101 else
102 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103#endif
104 }
105
106#ifdef FEAT_MBYTE
107 /* Repeat for combining characters. */
108 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
109 {
110 len = (int)STRLEN(IObuff);
111 /* This assumes every multi-byte char is printable... */
112 if (len > 0)
113 IObuff[len++] = ' ';
114 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000115 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000116# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000118# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 )
120 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000121 len += (*mb_char2bytes)(c, IObuff + len);
122 vim_snprintf((char *)IObuff + len, IOSIZE - len,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
124 : _("> %d, Hex %08x, Octal %o"), c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000125 if (ci == MAX_MCO)
126 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000127 if (enc_utf8)
128 c = cc[ci++];
129 else
130 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 }
132#endif
133
134 msg(IObuff);
135}
136
137#if defined(FEAT_EX_EXTRA) || defined(PROTO)
138/*
139 * ":left", ":center" and ":right": align text.
140 */
141 void
142ex_align(eap)
143 exarg_T *eap;
144{
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
245linelen(has_tab)
246 int *has_tab;
247{
248 char_u *line;
249 char_u *first;
250 char_u *last;
251 int save;
252 int len;
253
254 /* find the first non-blank character */
255 line = ml_get_curline();
256 first = skipwhite(line);
257
258 /* find the character after the last non-blank character */
259 for (last = first + STRLEN(first);
260 last > first && vim_iswhite(last[-1]); --last)
261 ;
262 save = *last;
263 *last = NUL;
264 len = linetabsize(line); /* get line length */
265 if (has_tab != NULL) /* check for embedded TAB */
266 *has_tab = (vim_strrchr(first, TAB) != NULL);
267 *last = save;
268
269 return len;
270}
271
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000272/* Buffer for two lines used during sorting. They are allocated to
273 * contain the longest line being sorted. */
274static char_u *sortbuf1;
275static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000276
277static int sort_ic; /* ignore case */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000278static int sort_nr; /* sort on number */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000279static int sort_rx; /* sort on regex instead of skipping it */
280
281static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000282
283/* Struct to store info to be sorted. */
284typedef struct
285{
286 linenr_T lnum; /* line number */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000287 long start_col_nr; /* starting column number or number */
288 long end_col_nr; /* ending column number */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000289} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000290
291static int
292#ifdef __BORLANDC__
293_RTLENTRYF
294#endif
295sort_compare __ARGS((const void *s1, const void *s2));
296
297 static int
298#ifdef __BORLANDC__
299_RTLENTRYF
300#endif
301sort_compare(s1, s2)
302 const void *s1;
303 const void *s2;
304{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000305 sorti_T l1 = *(sorti_T *)s1;
306 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000307 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000308
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000309 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000310 * if we return 0 every time, qsort will assume it's done sorting and
311 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000312 if (sort_abort)
313 return 0;
314 fast_breakcheck();
315 if (got_int)
316 sort_abort = TRUE;
317
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000318 /* When sorting numbers "start_col_nr" is the number, not the column
319 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000320 if (sort_nr)
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200321 result = l1.start_col_nr == l2.start_col_nr ? 0
322 : l1.start_col_nr > l2.start_col_nr ? 1 : -1;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000323 else
324 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000325 /* We need to copy one line into "sortbuf1", because there is no
326 * guarantee that the first pointer becomes invalid when obtaining the
327 * second one. */
328 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
329 l1.end_col_nr - l1.start_col_nr + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000330 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000331 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
332 l2.end_col_nr - l2.start_col_nr + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000333 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000334
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000335 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
336 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000338
339 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000340 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000341 return (int)(l1.lnum - l2.lnum);
342 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000343}
344
345/*
346 * ":sort".
347 */
348 void
349ex_sort(eap)
350 exarg_T *eap;
351{
352 regmatch_T regmatch;
353 int len;
354 linenr_T lnum;
355 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000356 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000357 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000358 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000359 char_u *p;
360 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000361 char_u *s2;
362 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000363 int unique = FALSE;
364 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000365 colnr_T start_col;
366 colnr_T end_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000367 int sort_oct; /* sort on octal number */
368 int sort_hex; /* sort on hex number */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000369
Bram Moolenaar48c99162008-02-18 18:42:52 +0000370 /* Sorting one line is really quick! */
371 if (count <= 1)
372 return;
373
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000374 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
375 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000376 sortbuf1 = NULL;
377 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000378 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000379 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000380 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000381 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000383 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000384
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000385 for (p = eap->arg; *p != NUL; ++p)
386 {
387 if (vim_iswhite(*p))
388 ;
389 else if (*p == 'i')
390 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000391 else if (*p == 'r')
392 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000393 else if (*p == 'n')
394 sort_nr = 2;
395 else if (*p == 'o')
396 sort_oct = 2;
397 else if (*p == 'x')
398 sort_hex = 2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000399 else if (*p == 'u')
400 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000401 else if (*p == '"') /* comment start */
402 break;
403 else if (check_nextcmd(p) != NULL)
404 {
405 eap->nextcmd = check_nextcmd(p);
406 break;
407 }
408 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000409 {
410 s = skip_regexp(p + 1, *p, TRUE, NULL);
411 if (*s != *p)
412 {
413 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000414 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000415 }
416 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000417 /* Use last search pattern if sort pattern is empty. */
Bram Moolenaar210f3702013-03-07 16:41:30 +0100418 if (s == p + 1)
419 {
420 if (last_search_pat() == NULL)
421 {
422 EMSG(_(e_noprevre));
423 goto sortend;
424 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000425 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
Bram Moolenaar210f3702013-03-07 16:41:30 +0100426 }
Bram Moolenaar1256e722007-07-10 15:26:20 +0000427 else
428 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000429 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000430 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000431 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000432 regmatch.rm_ic = p_ic;
433 }
434 else
435 {
436 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000437 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000438 }
439 }
440
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000441 /* Can only have one of 'n', 'o' and 'x'. */
442 if (sort_nr + sort_oct + sort_hex > 2)
443 {
444 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000445 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000446 }
447
448 /* From here on "sort_nr" is used as a flag for any number sorting. */
449 sort_nr += sort_oct + sort_hex;
450
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000451 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000452 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000453 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000454 * When sorting on strings "start_col_nr" is the offset in the line, for
455 * numbers sorting it's the number to sort on. This means the pattern
456 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000457 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000458 */
459 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
460 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000461 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000462 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000463 if (maxlen < len)
464 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000465
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000466 start_col = 0;
467 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000468 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000469 {
470 if (sort_rx)
471 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000472 start_col = (colnr_T)(regmatch.startp[0] - s);
473 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 }
475 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000476 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000477 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000478 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000479 if (regmatch.regprog != NULL)
480 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000481
482 if (sort_nr)
483 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000484 /* Make sure vim_str2nr doesn't read any digits past the end
485 * of the match, by temporarily terminating the string there */
486 s2 = s + end_col;
487 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200488 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000489 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000490 p = s + start_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000491 if (sort_hex)
Bram Moolenaar1387a602008-07-24 19:31:11 +0000492 s = skiptohex(p);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000493 else
Bram Moolenaar1387a602008-07-24 19:31:11 +0000494 s = skiptodigit(p);
495 if (s > p && s[-1] == '-')
496 --s; /* include preceding negative sign */
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200497 if (*s == NUL)
498 /* empty line should sort before any number */
499 nrs[lnum - eap->line1].start_col_nr = -MAXLNUM;
500 else
501 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
502 &nrs[lnum - eap->line1].start_col_nr, NULL);
503 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000504 }
505 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000506 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000507 /* Store the column to sort at. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000508 nrs[lnum - eap->line1].start_col_nr = start_col;
509 nrs[lnum - eap->line1].end_col_nr = end_col;
510 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000511
512 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000513
514 if (regmatch.regprog != NULL)
515 fast_breakcheck();
516 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000517 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000518 }
519
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000520 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000521 sortbuf1 = alloc((unsigned)maxlen + 1);
522 if (sortbuf1 == NULL)
523 goto sortend;
524 sortbuf2 = alloc((unsigned)maxlen + 1);
525 if (sortbuf2 == NULL)
526 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000527
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000528 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000529 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000530
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000531 if (sort_abort)
532 goto sortend;
533
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000534 /* Insert the lines in the sorted order below the last one. */
535 lnum = eap->line2;
536 for (i = 0; i < count; ++i)
537 {
538 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
539 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000540 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000541 {
542 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
543 break;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000544 if (unique)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000545 STRCPY(sortbuf1, s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000546 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000547 fast_breakcheck();
548 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000549 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000550 }
551
552 /* delete the original lines if appending worked */
553 if (i == count)
554 for (i = 0; i < count; ++i)
555 ml_delete(eap->line1, FALSE);
556 else
557 count = 0;
558
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000559 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000560 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000561 if (deleted > 0)
562 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
563 else if (deleted < 0)
564 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
565 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000566
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000567 curwin->w_cursor.lnum = eap->line1;
568 beginline(BL_WHITE | BL_FIX);
569
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000570sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000571 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000572 vim_free(sortbuf1);
573 vim_free(sortbuf2);
Bram Moolenaar473de612013-06-08 18:19:48 +0200574 vim_regfree(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000575 if (got_int)
576 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000577}
578
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579/*
580 * ":retab".
581 */
582 void
583ex_retab(eap)
584 exarg_T *eap;
585{
586 linenr_T lnum;
587 int got_tab = FALSE;
588 long num_spaces = 0;
589 long num_tabs;
590 long len;
591 long col;
592 long vcol;
593 long start_col = 0; /* For start of white-space string */
594 long start_vcol = 0; /* For start of white-space string */
595 int temp;
596 long old_len;
597 char_u *ptr;
598 char_u *new_line = (char_u *)1; /* init to non-NULL */
599 int did_undo; /* called u_save for current line */
600 int new_ts;
601 int save_list;
602 linenr_T first_line = 0; /* first changed line */
603 linenr_T last_line = 0; /* last changed line */
604
605 save_list = curwin->w_p_list;
606 curwin->w_p_list = 0; /* don't want list mode here */
607
608 new_ts = getdigits(&(eap->arg));
609 if (new_ts < 0)
610 {
611 EMSG(_(e_positive));
612 return;
613 }
614 if (new_ts == 0)
615 new_ts = curbuf->b_p_ts;
616 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
617 {
618 ptr = ml_get(lnum);
619 col = 0;
620 vcol = 0;
621 did_undo = FALSE;
622 for (;;)
623 {
624 if (vim_iswhite(ptr[col]))
625 {
626 if (!got_tab && num_spaces == 0)
627 {
628 /* First consecutive white-space */
629 start_vcol = vcol;
630 start_col = col;
631 }
632 if (ptr[col] == ' ')
633 num_spaces++;
634 else
635 got_tab = TRUE;
636 }
637 else
638 {
639 if (got_tab || (eap->forceit && num_spaces > 1))
640 {
641 /* Retabulate this string of white-space */
642
643 /* len is virtual length of white string */
644 len = num_spaces = vcol - start_vcol;
645 num_tabs = 0;
646 if (!curbuf->b_p_et)
647 {
648 temp = new_ts - (start_vcol % new_ts);
649 if (num_spaces >= temp)
650 {
651 num_spaces -= temp;
652 num_tabs++;
653 }
654 num_tabs += num_spaces / new_ts;
655 num_spaces -= (num_spaces / new_ts) * new_ts;
656 }
657 if (curbuf->b_p_et || got_tab ||
658 (num_spaces + num_tabs < len))
659 {
660 if (did_undo == FALSE)
661 {
662 did_undo = TRUE;
663 if (u_save((linenr_T)(lnum - 1),
664 (linenr_T)(lnum + 1)) == FAIL)
665 {
666 new_line = NULL; /* flag out-of-memory */
667 break;
668 }
669 }
670
671 /* len is actual number of white characters used */
672 len = num_spaces + num_tabs;
673 old_len = (long)STRLEN(ptr);
674 new_line = lalloc(old_len - col + start_col + len + 1,
675 TRUE);
676 if (new_line == NULL)
677 break;
678 if (start_col > 0)
679 mch_memmove(new_line, ptr, (size_t)start_col);
680 mch_memmove(new_line + start_col + len,
681 ptr + col, (size_t)(old_len - col + 1));
682 ptr = new_line + start_col;
683 for (col = 0; col < len; col++)
684 ptr[col] = (col < num_tabs) ? '\t' : ' ';
685 ml_replace(lnum, new_line, FALSE);
686 if (first_line == 0)
687 first_line = lnum;
688 last_line = lnum;
689 ptr = new_line;
690 col = start_col + len;
691 }
692 }
693 got_tab = FALSE;
694 num_spaces = 0;
695 }
696 if (ptr[col] == NUL)
697 break;
698 vcol += chartabsize(ptr + col, (colnr_T)vcol);
699#ifdef FEAT_MBYTE
700 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000701 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 else
703#endif
704 ++col;
705 }
706 if (new_line == NULL) /* out of memory */
707 break;
708 line_breakcheck();
709 }
710 if (got_int)
711 EMSG(_(e_interr));
712
713 if (curbuf->b_p_ts != new_ts)
714 redraw_curbuf_later(NOT_VALID);
715 if (first_line != 0)
716 changed_lines(first_line, 0, last_line + 1, 0L);
717
718 curwin->w_p_list = save_list; /* restore 'list' */
719
720 curbuf->b_p_ts = new_ts;
721 coladvance(curwin->w_curswant);
722
723 u_clearline();
724}
725#endif
726
727/*
728 * :move command - move lines line1-line2 to line dest
729 *
730 * return FAIL for failure, OK otherwise
731 */
732 int
733do_move(line1, line2, dest)
734 linenr_T line1;
735 linenr_T line2;
736 linenr_T dest;
737{
738 char_u *str;
739 linenr_T l;
740 linenr_T extra; /* Num lines added before line1 */
741 linenr_T num_lines; /* Num lines moved */
742 linenr_T last_line; /* Last line in file after adding new text */
743
744 if (dest >= line1 && dest < line2)
745 {
746 EMSG(_("E134: Move lines into themselves"));
747 return FAIL;
748 }
749
750 num_lines = line2 - line1 + 1;
751
752 /*
753 * First we copy the old text to its new location -- webb
754 * Also copy the flag that ":global" command uses.
755 */
756 if (u_save(dest, dest + 1) == FAIL)
757 return FAIL;
758 for (extra = 0, l = line1; l <= line2; l++)
759 {
760 str = vim_strsave(ml_get(l + extra));
761 if (str != NULL)
762 {
763 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
764 vim_free(str);
765 if (dest < line1)
766 extra++;
767 }
768 }
769
770 /*
771 * Now we must be careful adjusting our marks so that we don't overlap our
772 * mark_adjust() calls.
773 *
774 * We adjust the marks within the old text so that they refer to the
775 * last lines of the file (temporarily), because we know no other marks
776 * will be set there since these line numbers did not exist until we added
777 * our new lines.
778 *
779 * Then we adjust the marks on lines between the old and new text positions
780 * (either forwards or backwards).
781 *
782 * And Finally we adjust the marks we put at the end of the file back to
783 * their final destination at the new text position -- webb
784 */
785 last_line = curbuf->b_ml.ml_line_count;
786 mark_adjust(line1, line2, last_line - line2, 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200787 changed_lines(last_line - num_lines + 1, 0, last_line + 1, num_lines);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 if (dest >= line2)
789 {
790 mark_adjust(line2 + 1, dest, -num_lines, 0L);
791 curbuf->b_op_start.lnum = dest - num_lines + 1;
792 curbuf->b_op_end.lnum = dest;
793 }
794 else
795 {
796 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
797 curbuf->b_op_start.lnum = dest + 1;
798 curbuf->b_op_end.lnum = dest + num_lines;
799 }
800 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
801 mark_adjust(last_line - num_lines + 1, last_line,
802 -(last_line - dest - extra), 0L);
Bram Moolenaare9ba5162013-05-29 22:02:22 +0200803 changed_lines(last_line - num_lines + 1, 0, last_line + 1, -extra);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804
805 /*
806 * Now we delete the original text -- webb
807 */
808 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
809 return FAIL;
810
811 for (l = line1; l <= line2; l++)
812 ml_delete(line1 + extra, TRUE);
813
814 if (!global_busy && num_lines > p_report)
815 {
816 if (num_lines == 1)
817 MSG(_("1 line moved"));
818 else
819 smsg((char_u *)_("%ld lines moved"), num_lines);
820 }
821
822 /*
823 * Leave the cursor on the last of the moved lines.
824 */
825 if (dest >= line1)
826 curwin->w_cursor.lnum = dest;
827 else
828 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
829
830 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100831 {
832 dest += num_lines + 1;
833 last_line = curbuf->b_ml.ml_line_count;
834 if (dest > last_line + 1)
835 dest = last_line + 1;
836 changed_lines(line1, 0, dest, 0L);
837 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 else
839 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
840
841 return OK;
842}
843
844/*
845 * ":copy"
846 */
847 void
848ex_copy(line1, line2, n)
849 linenr_T line1;
850 linenr_T line2;
851 linenr_T n;
852{
853 linenr_T count;
854 char_u *p;
855
856 count = line2 - line1 + 1;
857 curbuf->b_op_start.lnum = n + 1;
858 curbuf->b_op_end.lnum = n + count;
859 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
860
861 /*
862 * there are three situations:
863 * 1. destination is above line1
864 * 2. destination is between line1 and line2
865 * 3. destination is below line2
866 *
867 * n = destination (when starting)
868 * curwin->w_cursor.lnum = destination (while copying)
869 * line1 = start of source (while copying)
870 * line2 = end of source (while copying)
871 */
872 if (u_save(n, n + 1) == FAIL)
873 return;
874
875 curwin->w_cursor.lnum = n;
876 while (line1 <= line2)
877 {
878 /* need to use vim_strsave() because the line will be unlocked within
879 * ml_append() */
880 p = vim_strsave(ml_get(line1));
881 if (p != NULL)
882 {
883 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
884 vim_free(p);
885 }
886 /* situation 2: skip already copied lines */
887 if (line1 == n)
888 line1 = curwin->w_cursor.lnum;
889 ++line1;
890 if (curwin->w_cursor.lnum < line1)
891 ++line1;
892 if (curwin->w_cursor.lnum < line2)
893 ++line2;
894 ++curwin->w_cursor.lnum;
895 }
896
897 appended_lines_mark(n, count);
898
899 msgmore((long)count);
900}
901
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000902static char_u *prevcmd = NULL; /* the previous command */
903
904#if defined(EXITFREE) || defined(PROTO)
905 void
906free_prev_shellcmd()
907{
908 vim_free(prevcmd);
909}
910#endif
911
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912/*
913 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
914 * Bangs in the argument are replaced with the previously entered command.
915 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 */
917 void
918do_bang(addr_count, eap, forceit, do_in, do_out)
919 int addr_count;
920 exarg_T *eap;
921 int forceit;
922 int do_in, do_out;
923{
924 char_u *arg = eap->arg; /* command */
925 linenr_T line1 = eap->line1; /* start of range */
926 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 char_u *newcmd = NULL; /* the new command */
928 int free_newcmd = FALSE; /* need to free() newcmd */
929 int ins_prevcmd;
930 char_u *t;
931 char_u *p;
932 char_u *trailarg;
933 int len;
934 int scroll_save = msg_scroll;
935
936 /*
937 * Disallow shell commands for "rvim".
938 * Disallow shell commands from .exrc and .vimrc in current directory for
939 * security reasons.
940 */
941 if (check_restricted() || check_secure())
942 return;
943
944 if (addr_count == 0) /* :! */
945 {
946 msg_scroll = FALSE; /* don't scroll here */
947 autowrite_all();
948 msg_scroll = scroll_save;
949 }
950
951 /*
952 * Try to find an embedded bang, like in :!<cmd> ! [args]
953 * (:!! is indicated by the 'forceit' variable)
954 */
955 ins_prevcmd = forceit;
956 trailarg = arg;
957 do
958 {
959 len = (int)STRLEN(trailarg) + 1;
960 if (newcmd != NULL)
961 len += (int)STRLEN(newcmd);
962 if (ins_prevcmd)
963 {
964 if (prevcmd == NULL)
965 {
966 EMSG(_(e_noprev));
967 vim_free(newcmd);
968 return;
969 }
970 len += (int)STRLEN(prevcmd);
971 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000972 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 {
974 vim_free(newcmd);
975 return;
976 }
977 *t = NUL;
978 if (newcmd != NULL)
979 STRCAT(t, newcmd);
980 if (ins_prevcmd)
981 STRCAT(t, prevcmd);
982 p = t + STRLEN(t);
983 STRCAT(t, trailarg);
984 vim_free(newcmd);
985 newcmd = t;
986
987 /*
988 * Scan the rest of the argument for '!', which is replaced by the
989 * previous command. "\!" is replaced by "!" (this is vi compatible).
990 */
991 trailarg = NULL;
992 while (*p)
993 {
Bram Moolenaare60acc12011-05-10 16:41:25 +0200994 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 {
996 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000997 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 else
999 {
1000 trailarg = p;
1001 *trailarg++ = NUL;
1002 ins_prevcmd = TRUE;
1003 break;
1004 }
1005 }
1006 ++p;
1007 }
1008 } while (trailarg != NULL);
1009
1010 vim_free(prevcmd);
1011 prevcmd = newcmd;
1012
1013 if (bangredo) /* put cmd in redo buffer for ! command */
1014 {
Bram Moolenaarebefac62005-12-28 22:39:57 +00001015 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 AppendToRedobuff((char_u *)"\n");
1017 bangredo = FALSE;
1018 }
1019 /*
1020 * Add quotes around the command, for shells that need them.
1021 */
1022 if (*p_shq != NUL)
1023 {
1024 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1025 if (newcmd == NULL)
1026 return;
1027 STRCPY(newcmd, p_shq);
1028 STRCAT(newcmd, prevcmd);
1029 STRCAT(newcmd, p_shq);
1030 free_newcmd = TRUE;
1031 }
1032 if (addr_count == 0) /* :! */
1033 {
1034 /* echo the command */
1035 msg_start();
1036 msg_putchar(':');
1037 msg_putchar('!');
1038 msg_outtrans(newcmd);
1039 msg_clr_eos();
1040 windgoto(msg_row, msg_col);
1041
1042 do_shell(newcmd, 0);
1043 }
1044 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001045 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 /* Careful: This may recursively call do_bang() again! (because of
1047 * autocommands) */
1048 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001049#ifdef FEAT_AUTOCMD
1050 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1051#endif
1052 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 if (free_newcmd)
1054 vim_free(newcmd);
1055}
1056
1057/*
1058 * do_filter: filter lines through a command given by the user
1059 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001060 * We mostly use temp files and the call_shell() routine here. This would
1061 * normally be done using pipes on a UNIX machine, but this is more portable
1062 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 * to deal with redirection somehow, and should handle things like looking
1064 * at the PATH env. variable, and adding reasonable extensions to the
1065 * command name given by the user. All reasonable versions of call_shell()
1066 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001067 * Alternatively, if on Unix and redirecting input or output, but not both,
1068 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 * We use input redirection if do_in is TRUE.
1070 * We use output redirection if do_out is TRUE.
1071 */
1072 static void
1073do_filter(line1, line2, eap, cmd, do_in, do_out)
1074 linenr_T line1, line2;
1075 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1076 char_u *cmd;
1077 int do_in, do_out;
1078{
1079 char_u *itmp = NULL;
1080 char_u *otmp = NULL;
1081 linenr_T linecount;
1082 linenr_T read_linecount;
1083 pos_T cursor_save;
1084 char_u *cmd_buf;
1085#ifdef FEAT_AUTOCMD
1086 buf_T *old_curbuf = curbuf;
1087#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001088 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090 if (*cmd == NUL) /* no filter command */
1091 return;
1092
1093#ifdef WIN3264
1094 /*
1095 * Check if external commands are allowed now.
1096 */
1097 if (can_end_termcap_mode(TRUE) == FALSE)
1098 return;
1099#endif
1100
1101 cursor_save = curwin->w_cursor;
1102 linecount = line2 - line1 + 1;
1103 curwin->w_cursor.lnum = line1;
1104 curwin->w_cursor.col = 0;
1105 changed_line_abv_curs();
1106 invalidate_botline();
1107
1108 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001109 * When using temp files:
1110 * 1. * Form temp file names
1111 * 2. * Write the lines to a temp file
1112 * 3. Run the filter command on the temp file
1113 * 4. * Read the output of the command into the buffer
1114 * 5. * Delete the original lines to be filtered
1115 * 6. * Remove the temp files
1116 *
1117 * When writing the input with a pipe or when catching the output with a
1118 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119 */
1120
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001121 if (do_out)
1122 shell_flags |= SHELL_DOOUT;
1123
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001124#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001125 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001127 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1128 shell_flags |= SHELL_READ;
1129 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001131 else if (do_in && !do_out && !p_stmp)
1132 {
1133 /* Use a pipe to write stdin of the command, do not use a temp file. */
1134 shell_flags |= SHELL_WRITE;
1135 curbuf->b_op_start.lnum = line1;
1136 curbuf->b_op_end.lnum = line2;
1137 }
1138 else if (do_in && do_out && !p_stmp)
1139 {
1140 /* Use a pipe to write stdin and fetch stdout of the command, do not
1141 * use a temp file. */
1142 shell_flags |= SHELL_READ|SHELL_WRITE;
1143 curbuf->b_op_start.lnum = line1;
1144 curbuf->b_op_end.lnum = line2;
1145 curwin->w_cursor.lnum = line2;
1146 }
1147 else
1148#endif
1149 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1150 || (do_out && (otmp = vim_tempname('o')) == NULL))
1151 {
1152 EMSG(_(e_notmp));
1153 goto filterend;
1154 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155
1156/*
1157 * The writing and reading of temp files will not be shown.
1158 * Vi also doesn't do this and the messages are not very informative.
1159 */
1160 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001161 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 FALSE, FALSE, FALSE, TRUE) == FAIL)
1163 {
1164 msg_putchar('\n'); /* keep message from buf_write() */
1165 --no_wait_return;
1166#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1167 if (!aborting())
1168#endif
1169 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1170 goto filterend;
1171 }
1172#ifdef FEAT_AUTOCMD
1173 if (curbuf != old_curbuf)
1174 goto filterend;
1175#endif
1176
1177 if (!do_out)
1178 msg_putchar('\n');
1179
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001180 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1182 if (cmd_buf == NULL)
1183 goto filterend;
1184
1185 windgoto((int)Rows - 1, 0);
1186 cursor_on();
1187
1188 /*
1189 * When not redirecting the output the command can write anything to the
1190 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1191 * stderr output of external command. Clear the screen later.
1192 * If do_in is FALSE, this could be something like ":r !cat", which may
1193 * also mess up the screen, clear it later.
1194 */
1195 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1196 redraw_later_clear();
1197
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001198 if (do_out)
1199 {
1200 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001201 {
1202 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001203 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001204 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001205 redraw_curbuf_later(VALID);
1206 }
1207 read_linecount = curbuf->b_ml.ml_line_count;
1208
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 /*
1210 * When call_shell() fails wait_return() is called to give the user a
1211 * chance to read the error messages. Otherwise errors are ignored, so you
1212 * can see the error messages from the command that appear on stdout; use
1213 * 'u' to fix the text
1214 * Switch to cooked mode when not redirecting stdin, avoids that something
1215 * like ":r !cat" hangs.
1216 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1217 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001218 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 {
1220 redraw_later_clear();
1221 wait_return(FALSE);
1222 }
1223 vim_free(cmd_buf);
1224
1225 did_check_timestamps = FALSE;
1226 need_check_timestamps = TRUE;
1227
1228 /* When interrupting the shell command, it may still have produced some
1229 * useful output. Reset got_int here, so that readfile() won't cancel
1230 * reading. */
1231 ui_breakcheck();
1232 got_int = FALSE;
1233
1234 if (do_out)
1235 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001238 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1239 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001241#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1242 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001244 {
1245 msg_putchar('\n');
1246 EMSG2(_(e_notread), otmp);
1247 }
1248 goto error;
1249 }
1250#ifdef FEAT_AUTOCMD
1251 if (curbuf != old_curbuf)
1252 goto filterend;
1253#endif
1254 }
1255
1256 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1257
1258 if (shell_flags & SHELL_READ)
1259 {
1260 curbuf->b_op_start.lnum = line2 + 1;
1261 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1262 appended_lines_mark(line2, read_linecount);
1263 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264
1265 if (do_in)
1266 {
1267 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1268 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 if (read_linecount >= linecount)
1270 /* move all marks from old lines to new lines */
1271 mark_adjust(line1, line2, linecount, 0L);
1272 else
1273 {
1274 /* move marks from old lines to new lines, delete marks
1275 * that are in deleted lines */
1276 mark_adjust(line1, line1 + read_linecount - 1,
1277 linecount, 0L);
1278 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1279 }
1280 }
1281
1282 /*
1283 * Put cursor on first filtered line for ":range!cmd".
1284 * Adjust '[ and '] (set by buf_write()).
1285 */
1286 curwin->w_cursor.lnum = line1;
1287 del_lines(linecount, TRUE);
1288 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1289 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1290 write_lnum_adjust(-linecount); /* adjust last line
1291 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001292#ifdef FEAT_FOLDING
1293 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1294#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 }
1296 else
1297 {
1298 /*
1299 * Put cursor on last new line for ":r !cmd".
1300 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001302 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001304
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1306 --no_wait_return;
1307
1308 if (linecount > p_report)
1309 {
1310 if (do_in)
1311 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001312 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1313 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001316 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 }
1318 else
1319 msgmore((long)linecount);
1320 }
1321 }
1322 else
1323 {
1324error:
1325 /* put cursor back in same position for ":w !cmd" */
1326 curwin->w_cursor = cursor_save;
1327 --no_wait_return;
1328 wait_return(FALSE);
1329 }
1330
1331filterend:
1332
1333#ifdef FEAT_AUTOCMD
1334 if (curbuf != old_curbuf)
1335 {
1336 --no_wait_return;
1337 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1338 }
1339#endif
1340 if (itmp != NULL)
1341 mch_remove(itmp);
1342 if (otmp != NULL)
1343 mch_remove(otmp);
1344 vim_free(itmp);
1345 vim_free(otmp);
1346}
1347
1348/*
1349 * Call a shell to execute a command.
1350 * When "cmd" is NULL start an interactive shell.
1351 */
1352 void
1353do_shell(cmd, flags)
1354 char_u *cmd;
1355 int flags; /* may be SHELL_DOOUT when output is redirected */
1356{
1357 buf_T *buf;
1358#ifndef FEAT_GUI_MSWIN
1359 int save_nwr;
1360#endif
1361#ifdef MSWIN
1362 int winstart = FALSE;
1363#endif
1364
1365 /*
1366 * Disallow shell commands for "rvim".
1367 * Disallow shell commands from .exrc and .vimrc in current directory for
1368 * security reasons.
1369 */
1370 if (check_restricted() || check_secure())
1371 {
1372 msg_end();
1373 return;
1374 }
1375
1376#ifdef MSWIN
1377 /*
1378 * Check if external commands are allowed now.
1379 */
1380 if (can_end_termcap_mode(TRUE) == FALSE)
1381 return;
1382
1383 /*
1384 * Check if ":!start" is used.
1385 */
1386 if (cmd != NULL)
1387 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1388#endif
1389
1390 /*
1391 * For autocommands we want to get the output on the current screen, to
1392 * avoid having to type return below.
1393 */
1394 msg_putchar('\r'); /* put cursor at start of line */
1395#ifdef FEAT_AUTOCMD
1396 if (!autocmd_busy)
1397#endif
1398 {
1399#ifdef MSWIN
1400 if (!winstart)
1401#endif
1402 stoptermcap();
1403 }
1404#ifdef MSWIN
1405 if (!winstart)
1406#endif
1407 msg_putchar('\n'); /* may shift screen one line up */
1408
1409 /* warning message before calling the shell */
1410 if (p_warn
1411#ifdef FEAT_AUTOCMD
1412 && !autocmd_busy
1413#endif
1414 && msg_silent == 0)
1415 for (buf = firstbuf; buf; buf = buf->b_next)
1416 if (bufIsChanged(buf))
1417 {
1418#ifdef FEAT_GUI_MSWIN
1419 if (!winstart)
1420 starttermcap(); /* don't want a message box here */
1421#endif
1422 MSG_PUTS(_("[No write since last change]\n"));
1423#ifdef FEAT_GUI_MSWIN
1424 if (!winstart)
1425 stoptermcap();
1426#endif
1427 break;
1428 }
1429
1430 /* This windgoto is required for when the '\n' resulted in a "delete line
1431 * 1" command to the terminal. */
1432 if (!swapping_screen())
1433 windgoto(msg_row, msg_col);
1434 cursor_on();
1435 (void)call_shell(cmd, SHELL_COOKED | flags);
1436 did_check_timestamps = FALSE;
1437 need_check_timestamps = TRUE;
1438
1439 /*
1440 * put the message cursor at the end of the screen, avoids wait_return()
1441 * to overwrite the text that the external command showed
1442 */
1443 if (!swapping_screen())
1444 {
1445 msg_row = Rows - 1;
1446 msg_col = 0;
1447 }
1448
1449#ifdef FEAT_AUTOCMD
1450 if (autocmd_busy)
1451 {
1452 if (msg_silent == 0)
1453 redraw_later_clear();
1454 }
1455 else
1456#endif
1457 {
1458 /*
1459 * For ":sh" there is no need to call wait_return(), just redraw.
1460 * Also for the Win32 GUI (the output is in a console window).
1461 * Otherwise there is probably text on the screen that the user wants
1462 * to read before redrawing, so call wait_return().
1463 */
1464#ifndef FEAT_GUI_MSWIN
1465 if (cmd == NULL
1466# ifdef WIN3264
1467 || (winstart && !need_wait_return)
1468# endif
1469 )
1470 {
1471 if (msg_silent == 0)
1472 redraw_later_clear();
1473 need_wait_return = FALSE;
1474 }
1475 else
1476 {
1477 /*
1478 * If we switch screens when starttermcap() is called, we really
1479 * want to wait for "hit return to continue".
1480 */
1481 save_nwr = no_wait_return;
1482 if (swapping_screen())
1483 no_wait_return = FALSE;
1484# ifdef AMIGA
1485 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1486# else
1487 wait_return(msg_silent == 0);
1488# endif
1489 no_wait_return = save_nwr;
1490 }
1491#endif /* FEAT_GUI_W32 */
1492
1493#ifdef MSWIN
1494 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1495#endif
1496 starttermcap(); /* start termcap if not done by wait_return() */
1497
1498 /*
1499 * In an Amiga window redrawing is caused by asking the window size.
1500 * If we got an interrupt this will not work. The chance that the
1501 * window size is wrong is very small, but we need to redraw the
1502 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1503 * but it saves an extra redraw.
1504 */
1505#ifdef AMIGA
1506 if (skip_redraw) /* ':' hit in wait_return() */
1507 {
1508 if (msg_silent == 0)
1509 redraw_later_clear();
1510 }
1511 else if (term_console)
1512 {
1513 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1514 if (got_int && msg_silent == 0)
1515 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1516 else
1517 must_redraw = 0; /* no extra redraw needed */
1518 }
1519#endif
1520 }
1521
1522 /* display any error messages now */
1523 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001524
1525#ifdef FEAT_AUTOCMD
1526 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1527#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528}
1529
1530/*
1531 * Create a shell command from a command string, input redirection file and
1532 * output redirection file.
1533 * Returns an allocated string with the shell command, or NULL for failure.
1534 */
1535 char_u *
1536make_filter_cmd(cmd, itmp, otmp)
1537 char_u *cmd; /* command */
1538 char_u *itmp; /* NULL or name of input file */
1539 char_u *otmp; /* NULL or name of output file */
1540{
1541 char_u *buf;
1542 long_u len;
1543
1544 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1545 if (itmp != NULL)
1546 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1547 if (otmp != NULL)
1548 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1549 buf = lalloc(len, TRUE);
1550 if (buf == NULL)
1551 return NULL;
1552
1553#if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1554 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001555 * Put braces around the command (for concatenated commands) when
1556 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001558 if (itmp != NULL || otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001559 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001560 else
1561 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 if (itmp != NULL)
1563 {
1564 STRCAT(buf, " < ");
1565 STRCAT(buf, itmp);
1566 }
1567#else
1568 /*
1569 * for shells that don't understand braces around commands, at least allow
1570 * the use of commands in a pipe.
1571 */
1572 STRCPY(buf, cmd);
1573 if (itmp != NULL)
1574 {
1575 char_u *p;
1576
1577 /*
1578 * If there is a pipe, we have to put the '<' in front of it.
1579 * Don't do this when 'shellquote' is not empty, otherwise the
1580 * redirection would be inside the quotes.
1581 */
1582 if (*p_shq == NUL)
1583 {
1584 p = vim_strchr(buf, '|');
1585 if (p != NULL)
1586 *p = NUL;
1587 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1589 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 if (*p_shq == NUL)
1591 {
1592 p = vim_strchr(cmd, '|');
1593 if (p != NULL)
1594 {
1595 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1596 STRCAT(buf, p);
1597 }
1598 }
1599 }
1600#endif
1601 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001602 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603
1604 return buf;
1605}
1606
1607/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001608 * Append output redirection for file "fname" to the end of string buffer
1609 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 * Works with the 'shellredir' and 'shellpipe' options.
1611 * The caller should make sure that there is enough room:
1612 * STRLEN(opt) + STRLEN(fname) + 3
1613 */
1614 void
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001615append_redir(buf, buflen, opt, fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 char_u *buf;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001617 int buflen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 char_u *opt;
1619 char_u *fname;
1620{
1621 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001622 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001624 end = buf + STRLEN(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 /* find "%s", skipping "%%" */
1626 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1627 if (p[1] == 's')
1628 break;
1629 if (p != NULL)
1630 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001631 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1632 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1633 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 }
1635 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001636 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 " %s %s",
1639#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641#endif
1642 (char *)opt, (char *)fname);
1643}
1644
1645#ifdef FEAT_VIMINFO
1646
1647static int no_viminfo __ARGS((void));
1648static int viminfo_errcnt;
1649
1650 static int
1651no_viminfo()
1652{
1653 /* "vim -i NONE" does not read or write a viminfo file */
1654 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1655}
1656
1657/*
1658 * Report an error for reading a viminfo file.
1659 * Count the number of errors. When there are more than 10, return TRUE.
1660 */
1661 int
1662viminfo_error(errnum, message, line)
1663 char *errnum;
1664 char *message;
1665 char_u *line;
1666{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001667 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1668 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001669 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001670 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1671 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 emsg(IObuff);
1673 if (++viminfo_errcnt >= 10)
1674 {
1675 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1676 return TRUE;
1677 }
1678 return FALSE;
1679}
1680
1681/*
1682 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001683 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684 */
1685 int
Bram Moolenaard812df62008-11-09 12:46:09 +00001686read_viminfo(file, flags)
1687 char_u *file; /* file name or NULL to use default name */
1688 int flags; /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689{
1690 FILE *fp;
1691 char_u *fname;
1692
1693 if (no_viminfo())
1694 return FAIL;
1695
Bram Moolenaard812df62008-11-09 12:46:09 +00001696 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 if (fname == NULL)
1698 return FAIL;
1699 fp = mch_fopen((char *)fname, READBIN);
1700
1701 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001702 {
1703 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001704 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1705 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001706 (flags & VIF_WANT_INFO) ? _(" info") : "",
1707 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1708 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001709 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001710 verbose_leave();
1711 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712
1713 vim_free(fname);
1714 if (fp == NULL)
1715 return FAIL;
1716
1717 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001718 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719
1720 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 return OK;
1722}
1723
1724/*
Bram Moolenaarff1806f2013-06-15 16:31:47 +02001725 * Write the viminfo file. The old one is read in first so that effectively a
1726 * merge of current info and old info is done. This allows multiple vims to
1727 * run simultaneously, without losing any marks etc.
1728 * If "forceit" is TRUE, then the old file is not read in, and only internal
1729 * info is written to the file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 */
1731 void
1732write_viminfo(file, forceit)
1733 char_u *file;
1734 int forceit;
1735{
1736 char_u *fname;
1737 FILE *fp_in = NULL; /* input viminfo file, if any */
1738 FILE *fp_out = NULL; /* output viminfo file */
1739 char_u *tempname = NULL; /* name of temp viminfo file */
1740 struct stat st_new; /* mch_stat() of potential new file */
1741 char_u *wp;
1742#if defined(UNIX) || defined(VMS)
1743 mode_t umask_save;
1744#endif
1745#ifdef UNIX
1746 int shortname = FALSE; /* use 8.3 file name */
1747 struct stat st_old; /* mch_stat() of existing viminfo file */
1748#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001749#ifdef WIN3264
1750 long perm = -1;
1751#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752
1753 if (no_viminfo())
1754 return;
1755
1756 fname = viminfo_filename(file); /* may set to default if NULL */
1757 if (fname == NULL)
1758 return;
1759
1760 fp_in = mch_fopen((char *)fname, READBIN);
1761 if (fp_in == NULL)
1762 {
1763 /* if it does exist, but we can't read it, don't try writing */
1764 if (mch_stat((char *)fname, &st_new) == 0)
1765 goto end;
1766#if defined(UNIX) || defined(VMS)
1767 /*
1768 * For Unix we create the .viminfo non-accessible for others,
1769 * because it may contain text from non-accessible documents.
1770 */
1771 umask_save = umask(077);
1772#endif
1773 fp_out = mch_fopen((char *)fname, WRITEBIN);
1774#if defined(UNIX) || defined(VMS)
1775 (void)umask(umask_save);
1776#endif
1777 }
1778 else
1779 {
1780 /*
1781 * There is an existing viminfo file. Create a temporary file to
1782 * write the new viminfo into, in the same directory as the
1783 * existing viminfo file, which will be renamed later.
1784 */
1785#ifdef UNIX
1786 /*
1787 * For Unix we check the owner of the file. It's not very nice to
1788 * overwrite a user's viminfo file after a "su root", with a
1789 * viminfo file that the user can't read.
1790 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001791 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001792 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001794 if (mch_stat((char *)fname, &st_old) == 0
1795 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001796 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 ? (st_old.st_mode & 0200)
1798 : (st_old.st_gid == getgid()
1799 ? (st_old.st_mode & 0020)
1800 : (st_old.st_mode & 0002))))
1801 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001802 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803
1804 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1806 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001807 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 goto end;
1809 }
1810#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001811#ifdef WIN3264
1812 /* Get the file attributes of the existing viminfo file. */
1813 perm = mch_getperm(fname);
1814#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815
1816 /*
1817 * Make tempname.
1818 * May try twice: Once normal and once with shortname set, just in
1819 * case somebody puts his viminfo file in an 8.3 filesystem.
1820 */
1821 for (;;)
1822 {
1823 tempname = buf_modname(
1824#ifdef UNIX
1825 shortname,
1826#else
1827# ifdef SHORT_FNAME
1828 TRUE,
1829# else
1830# ifdef FEAT_GUI_W32
1831 gui_is_win32s(),
1832# else
1833 FALSE,
1834# endif
1835# endif
1836#endif
1837 fname,
1838#ifdef VMS
1839 (char_u *)"-tmp",
1840#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842#endif
1843 FALSE);
1844 if (tempname == NULL) /* out of memory */
1845 break;
1846
1847 /*
1848 * Check if tempfile already exists. Never overwrite an
1849 * existing file!
1850 */
1851 if (mch_stat((char *)tempname, &st_new) == 0)
1852 {
1853#ifdef UNIX
1854 /*
1855 * Check if tempfile is same as original file. May happen
1856 * when modname() gave the same file back. E.g. silly
1857 * link, or file name-length reached. Try again with
1858 * shortname set.
1859 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001860 if (!shortname && st_new.st_dev == st_old.st_dev
1861 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 {
1863 vim_free(tempname);
1864 tempname = NULL;
1865 shortname = TRUE;
1866 continue;
1867 }
1868#endif
1869 /*
1870 * Try another name. Change one character, just before
1871 * the extension. This should also work for an 8.3
1872 * file name, when after adding the extension it still is
1873 * the same file as the original.
1874 */
1875 wp = tempname + STRLEN(tempname) - 5;
1876 if (wp < gettail(tempname)) /* empty file name? */
1877 wp = gettail(tempname);
1878 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1879 --*wp)
1880 {
1881 /*
1882 * They all exist? Must be something wrong! Don't
1883 * write the viminfo file then.
1884 */
1885 if (*wp == 'a')
1886 {
1887 vim_free(tempname);
1888 tempname = NULL;
1889 break;
1890 }
1891 }
1892 }
1893 break;
1894 }
1895
1896 if (tempname != NULL)
1897 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001898#ifdef VMS
1899 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001900 umask_save = umask(077);
1901 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1902 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001903#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001904 int fd;
1905
1906 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001907 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001908 * Unix: same as original file, but strip s-bit. Reset umask to
1909 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001910 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001911# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001912 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001913 fd = mch_open((char *)tempname,
1914 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001915 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001916 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001917# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001918 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001919 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001920# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00001921 if (fd < 0)
1922 fp_out = NULL;
1923 else
1924 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001925#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926
1927 /*
1928 * If we can't create in the same directory, try creating a
1929 * "normal" temp file.
1930 */
1931 if (fp_out == NULL)
1932 {
1933 vim_free(tempname);
1934 if ((tempname = vim_tempname('o')) != NULL)
1935 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1936 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00001937
1938#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001940 * Make sure the owner can read/write it. This only works for
1941 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 */
1943 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001944 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945#endif
1946 }
1947 }
1948
1949 /*
1950 * Check if the new viminfo file can be written to.
1951 */
1952 if (fp_out == NULL)
1953 {
1954 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00001955 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 if (fp_in != NULL)
1957 fclose(fp_in);
1958 goto end;
1959 }
1960
1961 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001962 {
1963 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001964 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001965 verbose_leave();
1966 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967
1968 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001969 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970
1971 fclose(fp_out); /* errors are ignored !? */
1972 if (fp_in != NULL)
1973 {
1974 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001975
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 /*
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001977 * In case of an error keep the original viminfo file.
1978 * Otherwise rename the newly written file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 */
1980 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1981 mch_remove(tempname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001982
1983#ifdef WIN3264
1984 /* If the viminfo file was hidden then also hide the new file. */
1985 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1986 mch_hide(fname);
1987#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001989
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990end:
1991 vim_free(fname);
1992 vim_free(tempname);
1993}
1994
1995/*
1996 * Get the viminfo file name to use.
1997 * If "file" is given and not empty, use it (has already been expanded by
1998 * cmdline functions).
1999 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2000 * expand environment variables.
2001 * Returns an allocated string. NULL when out of memory.
2002 */
2003 static char_u *
2004viminfo_filename(file)
2005 char_u *file;
2006{
2007 if (file == NULL || *file == NUL)
2008 {
2009 if (use_viminfo != NULL)
2010 file = use_viminfo;
2011 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2012 {
2013#ifdef VIMINFO_FILE2
2014 /* don't use $HOME when not defined (turned into "c:/"!). */
2015# ifdef VMS
2016 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2017# else
2018 if (mch_getenv((char_u *)"HOME") == NULL)
2019# endif
2020 {
2021 /* don't use $VIM when not available. */
2022 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2023 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2024 file = (char_u *)VIMINFO_FILE2;
2025 else
2026 file = (char_u *)VIMINFO_FILE;
2027 }
2028 else
2029#endif
2030 file = (char_u *)VIMINFO_FILE;
2031 }
2032 expand_env(file, NameBuff, MAXPATHL);
2033 file = NameBuff;
2034 }
2035 return vim_strsave(file);
2036}
2037
2038/*
2039 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2040 */
2041 static void
Bram Moolenaard812df62008-11-09 12:46:09 +00002042do_viminfo(fp_in, fp_out, flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 FILE *fp_in;
2044 FILE *fp_out;
Bram Moolenaard812df62008-11-09 12:46:09 +00002045 int flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046{
2047 int count = 0;
2048 int eof = FALSE;
2049 vir_T vir;
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002050 int merge = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
2052 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2053 return;
2054 vir.vir_fd = fp_in;
2055#ifdef FEAT_MBYTE
2056 vir.vir_conv.vc_type = CONV_NONE;
2057#endif
2058
2059 if (fp_in != NULL)
2060 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002061 if (flags & VIF_WANT_INFO)
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002062 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002063 eof = read_viminfo_up_to_marks(&vir,
2064 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002065 merge = TRUE;
2066 }
2067 else if (flags != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 /* Skip info, find start of marks */
2069 while (!(eof = viminfo_readline(&vir))
2070 && vir.vir_line[0] != '>')
2071 ;
2072 }
2073 if (fp_out != NULL)
2074 {
2075 /* Write the info: */
2076 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2077 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002078 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002080 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2082#endif
2083 write_viminfo_search_pattern(fp_out);
2084 write_viminfo_sub_string(fp_out);
2085#ifdef FEAT_CMDHIST
Bram Moolenaarff1806f2013-06-15 16:31:47 +02002086 write_viminfo_history(fp_out, merge);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087#endif
2088 write_viminfo_registers(fp_out);
2089#ifdef FEAT_EVAL
2090 write_viminfo_varlist(fp_out);
2091#endif
2092 write_viminfo_filemarks(fp_out);
2093 write_viminfo_bufferlist(fp_out);
2094 count = write_viminfo_marks(fp_out);
2095 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002096 if (fp_in != NULL
2097 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2098 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099
2100 vim_free(vir.vir_line);
2101#ifdef FEAT_MBYTE
2102 if (vir.vir_conv.vc_type != CONV_NONE)
2103 convert_setup(&vir.vir_conv, NULL, NULL);
2104#endif
2105}
2106
2107/*
2108 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2109 * first part of the viminfo file which contains everything but the marks that
2110 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2111 */
2112 static int
2113read_viminfo_up_to_marks(virp, forceit, writing)
2114 vir_T *virp;
2115 int forceit;
2116 int writing;
2117{
2118 int eof;
2119 buf_T *buf;
2120
2121#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002122 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123#endif
2124 eof = viminfo_readline(virp);
2125 while (!eof && virp->vir_line[0] != '>')
2126 {
2127 switch (virp->vir_line[0])
2128 {
2129 /* Characters reserved for future expansion, ignored now */
2130 case '+': /* "+40 /path/dir file", for running vim without args */
2131 case '|': /* to be defined */
2132 case '^': /* to be defined */
2133 case '<': /* long line - ignored */
2134 /* A comment or empty line. */
2135 case NUL:
2136 case '\r':
2137 case '\n':
2138 case '#':
2139 eof = viminfo_readline(virp);
2140 break;
2141 case '*': /* "*encoding=value" */
2142 eof = viminfo_encoding(virp);
2143 break;
2144 case '!': /* global variable */
2145#ifdef FEAT_EVAL
2146 eof = read_viminfo_varlist(virp, writing);
2147#else
2148 eof = viminfo_readline(virp);
2149#endif
2150 break;
2151 case '%': /* entry for buffer list */
2152 eof = read_viminfo_bufferlist(virp, writing);
2153 break;
2154 case '"':
2155 eof = read_viminfo_register(virp, forceit);
2156 break;
2157 case '/': /* Search string */
2158 case '&': /* Substitute search string */
2159 case '~': /* Last search string, followed by '/' or '&' */
2160 eof = read_viminfo_search_pattern(virp, forceit);
2161 break;
2162 case '$':
2163 eof = read_viminfo_sub_string(virp, forceit);
2164 break;
2165 case ':':
2166 case '?':
2167 case '=':
2168 case '@':
2169#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002170 eof = read_viminfo_history(virp, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171#else
2172 eof = viminfo_readline(virp);
2173#endif
2174 break;
2175 case '-':
2176 case '\'':
2177 eof = read_viminfo_filemark(virp, forceit);
2178 break;
2179 default:
2180 if (viminfo_error("E575: ", _("Illegal starting char"),
2181 virp->vir_line))
2182 eof = TRUE;
2183 else
2184 eof = viminfo_readline(virp);
2185 break;
2186 }
2187 }
2188
2189#ifdef FEAT_CMDHIST
2190 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002191 if (!writing)
2192 finish_viminfo_history();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193#endif
2194
2195 /* Change file names to buffer numbers for fmarks. */
2196 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2197 fmarks_check_names(buf);
2198
2199 return eof;
2200}
2201
2202/*
2203 * Compare the 'encoding' value in the viminfo file with the current value of
2204 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2205 * conversion of text with iconv() in viminfo_readstring().
2206 */
2207 static int
2208viminfo_encoding(virp)
2209 vir_T *virp;
2210{
2211#ifdef FEAT_MBYTE
2212 char_u *p;
2213 int i;
2214
2215 if (get_viminfo_parameter('c') != 0)
2216 {
2217 p = vim_strchr(virp->vir_line, '=');
2218 if (p != NULL)
2219 {
2220 /* remove trailing newline */
2221 ++p;
2222 for (i = 0; vim_isprintc(p[i]); ++i)
2223 ;
2224 p[i] = NUL;
2225
2226 convert_setup(&virp->vir_conv, p, p_enc);
2227 }
2228 }
2229#endif
2230 return viminfo_readline(virp);
2231}
2232
2233/*
2234 * Read a line from the viminfo file.
2235 * Returns TRUE for end-of-file;
2236 */
2237 int
2238viminfo_readline(virp)
2239 vir_T *virp;
2240{
2241 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2242}
2243
2244/*
2245 * check string read from viminfo file
2246 * remove '\n' at the end of the line
2247 * - replace CTRL-V CTRL-V with CTRL-V
2248 * - replace CTRL-V 'n' with '\n'
2249 *
2250 * Check for a long line as written by viminfo_writestring().
2251 *
2252 * Return the string in allocated memory (NULL when out of memory).
2253 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 char_u *
2255viminfo_readstring(virp, off, convert)
2256 vir_T *virp;
2257 int off; /* offset for virp->vir_line */
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00002258 int convert UNUSED; /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259{
2260 char_u *retval;
2261 char_u *s, *d;
2262 long len;
2263
2264 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2265 {
2266 len = atol((char *)virp->vir_line + off + 1);
2267 retval = lalloc(len, TRUE);
2268 if (retval == NULL)
2269 {
2270 /* Line too long? File messed up? Skip next line. */
2271 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2272 return NULL;
2273 }
2274 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2275 s = retval + 1; /* Skip the leading '<' */
2276 }
2277 else
2278 {
2279 retval = vim_strsave(virp->vir_line + off);
2280 if (retval == NULL)
2281 return NULL;
2282 s = retval;
2283 }
2284
2285 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2286 d = retval;
2287 while (*s != NUL && *s != '\n')
2288 {
2289 if (s[0] == Ctrl_V && s[1] != NUL)
2290 {
2291 if (s[1] == 'n')
2292 *d++ = '\n';
2293 else
2294 *d++ = Ctrl_V;
2295 s += 2;
2296 }
2297 else
2298 *d++ = *s++;
2299 }
2300 *d = NUL;
2301
2302#ifdef FEAT_MBYTE
2303 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2304 {
2305 d = string_convert(&virp->vir_conv, retval, NULL);
2306 if (d != NULL)
2307 {
2308 vim_free(retval);
2309 retval = d;
2310 }
2311 }
2312#endif
2313
2314 return retval;
2315}
2316
2317/*
2318 * write string to viminfo file
2319 * - replace CTRL-V with CTRL-V CTRL-V
2320 * - replace '\n' with CTRL-V 'n'
2321 * - add a '\n' at the end
2322 *
2323 * For a long line:
2324 * - write " CTRL-V <length> \n " in first line
2325 * - write " < <string> \n " in second line
2326 */
2327 void
2328viminfo_writestring(fd, p)
2329 FILE *fd;
2330 char_u *p;
2331{
2332 int c;
2333 char_u *s;
2334 int len = 0;
2335
2336 for (s = p; *s != NUL; ++s)
2337 {
2338 if (*s == Ctrl_V || *s == '\n')
2339 ++len;
2340 ++len;
2341 }
2342
2343 /* If the string will be too long, write its length and put it in the next
2344 * line. Take into account that some room is needed for what comes before
2345 * the string (e.g., variable name). Add something to the length for the
2346 * '<', NL and trailing NUL. */
2347 if (len > LSIZE / 2)
2348 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2349
2350 while ((c = *p++) != NUL)
2351 {
2352 if (c == Ctrl_V || c == '\n')
2353 {
2354 putc(Ctrl_V, fd);
2355 if (c == '\n')
2356 c = 'n';
2357 }
2358 putc(c, fd);
2359 }
2360 putc('\n', fd);
2361}
2362#endif /* FEAT_VIMINFO */
2363
2364/*
2365 * Implementation of ":fixdel", also used by get_stty().
2366 * <BS> resulting <Del>
2367 * ^? ^H
2368 * not ^? ^?
2369 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 void
2371do_fixdel(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00002372 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373{
2374 char_u *p;
2375
2376 p = find_termcode((char_u *)"kb");
2377 add_termcode((char_u *)"kD", p != NULL
2378 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2379}
2380
2381 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002382print_line_no_prefix(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 linenr_T lnum;
2384 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002385 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002387 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388
2389 if (curwin->w_p_nu || use_number)
2390 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002391 vim_snprintf((char *)numbuf, sizeof(numbuf),
2392 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2394 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002395 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396}
2397
2398/*
2399 * Print a text line. Also in silent mode ("ex -s").
2400 */
2401 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002402print_line(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 linenr_T lnum;
2404 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002405 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406{
2407 int save_silent = silent_mode;
2408
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002410 silent_mode = FALSE;
2411 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2412 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 if (save_silent)
2414 {
2415 msg_putchar('\n');
2416 cursor_on(); /* msg_start() switches it off */
2417 out_flush();
2418 silent_mode = save_silent;
2419 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002420 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421}
2422
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002423 int
2424rename_buffer(new_fname)
2425 char_u *new_fname;
2426{
2427 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002428 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002429
Bram Moolenaar7e283842013-05-30 11:43:15 +02002430#ifdef FEAT_AUTOCMD
2431 buf = curbuf;
2432 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002433 /* buffer changed, don't change name now */
2434 if (buf != curbuf)
2435 return FAIL;
2436# ifdef FEAT_EVAL
2437 if (aborting()) /* autocmds may abort script processing */
2438 return FAIL;
2439# endif
2440#endif
2441 /*
2442 * The name of the current buffer will be changed.
2443 * A new (unlisted) buffer entry needs to be made to hold the old file
2444 * name, which will become the alternate file name.
2445 * But don't set the alternate file name if the buffer didn't have a
2446 * name.
2447 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002448 fname = curbuf->b_ffname;
2449 sfname = curbuf->b_sfname;
2450 xfname = curbuf->b_fname;
2451 curbuf->b_ffname = NULL;
2452 curbuf->b_sfname = NULL;
2453 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002454 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002455 curbuf->b_ffname = fname;
2456 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002457 return FAIL;
2458 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002459 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002460 if (xfname != NULL && *xfname != NUL)
2461 {
2462 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2463 if (buf != NULL && !cmdmod.keepalt)
2464 curwin->w_alt_fnum = buf->b_fnum;
2465 }
2466 vim_free(fname);
2467 vim_free(sfname);
2468#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002469 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002470#endif
2471 /* Change directories when the 'acd' option is set. */
2472 DO_AUTOCHDIR
2473 return OK;
2474}
2475
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476/*
2477 * ":file[!] [fname]".
2478 */
2479 void
2480ex_file(eap)
2481 exarg_T *eap;
2482{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002483 /* ":0file" removes the file name. Check for illegal uses ":3file",
2484 * "0file name", etc. */
2485 if (eap->addr_count > 0
2486 && (*eap->arg != NUL
2487 || eap->line2 > 0
2488 || eap->addr_count > 1))
2489 {
2490 EMSG(_(e_invarg));
2491 return;
2492 }
2493
2494 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002496 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 }
2499 /* print full file name if :cd used */
2500 fileinfo(FALSE, FALSE, eap->forceit);
2501}
2502
2503/*
2504 * ":update".
2505 */
2506 void
2507ex_update(eap)
2508 exarg_T *eap;
2509{
2510 if (curbufIsChanged())
2511 (void)do_write(eap);
2512}
2513
2514/*
2515 * ":write" and ":saveas".
2516 */
2517 void
2518ex_write(eap)
2519 exarg_T *eap;
2520{
2521 if (eap->usefilter) /* input lines to shell command */
2522 do_bang(1, eap, FALSE, TRUE, FALSE);
2523 else
2524 (void)do_write(eap);
2525}
2526
2527/*
2528 * write current buffer to file 'eap->arg'
2529 * if 'eap->append' is TRUE, append to the file
2530 *
2531 * if *eap->arg == NUL write to current file
2532 *
2533 * return FAIL for failure, OK otherwise
2534 */
2535 int
2536do_write(eap)
2537 exarg_T *eap;
2538{
2539 int other;
2540 char_u *fname = NULL; /* init to shut up gcc */
2541 char_u *ffname;
2542 int retval = FAIL;
2543 char_u *free_fname = NULL;
2544#ifdef FEAT_BROWSE
2545 char_u *browse_file = NULL;
2546#endif
2547 buf_T *alt_buf = NULL;
2548
2549 if (not_writing()) /* check 'write' option */
2550 return FAIL;
2551
2552 ffname = eap->arg;
2553#ifdef FEAT_BROWSE
2554 if (cmdmod.browse)
2555 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002556 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 NULL, NULL, NULL, curbuf);
2558 if (browse_file == NULL)
2559 goto theend;
2560 ffname = browse_file;
2561 }
2562#endif
2563 if (*ffname == NUL)
2564 {
2565 if (eap->cmdidx == CMD_saveas)
2566 {
2567 EMSG(_(e_argreq));
2568 goto theend;
2569 }
2570 other = FALSE;
2571 }
2572 else
2573 {
2574 fname = ffname;
2575 free_fname = fix_fname(ffname);
2576 /*
2577 * When out-of-memory, keep unexpanded file name, because we MUST be
2578 * able to write the file in this situation.
2579 */
2580 if (free_fname != NULL)
2581 ffname = free_fname;
2582 other = otherfile(ffname);
2583 }
2584
2585 /*
2586 * If we have a new file, put its name in the list of alternate file names.
2587 */
2588 if (other)
2589 {
2590 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2591 || eap->cmdidx == CMD_saveas)
2592 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2593 else
2594 alt_buf = buflist_findname(ffname);
2595 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2596 {
2597 /* Overwriting a file that is loaded in another buffer is not a
2598 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00002599 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 goto theend;
2601 }
2602 }
2603
2604 /*
2605 * Writing to the current file is not allowed in readonly mode
2606 * and a file name is required.
2607 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2608 */
2609 if (!other && (
2610#ifdef FEAT_QUICKFIX
2611 bt_dontwrite_msg(curbuf) ||
2612#endif
2613 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2614 goto theend;
2615
2616 if (!other)
2617 {
2618 ffname = curbuf->b_ffname;
2619 fname = curbuf->b_fname;
2620 /*
2621 * Not writing the whole file is only allowed with '!'.
2622 */
2623 if ( (eap->line1 != 1
2624 || eap->line2 != curbuf->b_ml.ml_line_count)
2625 && !eap->forceit
2626 && !eap->append
2627 && !p_wa)
2628 {
2629#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2630 if (p_confirm || cmdmod.confirm)
2631 {
2632 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2633 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2634 goto theend;
2635 eap->forceit = TRUE;
2636 }
2637 else
2638#endif
2639 {
2640 EMSG(_("E140: Use ! to write partial buffer"));
2641 goto theend;
2642 }
2643 }
2644 }
2645
2646 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2647 {
2648 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2649 {
2650#ifdef FEAT_AUTOCMD
2651 buf_T *was_curbuf = curbuf;
2652
2653 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002654 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655# ifdef FEAT_EVAL
2656 if (curbuf != was_curbuf || aborting())
2657# else
2658 if (curbuf != was_curbuf)
2659# endif
2660 {
2661 /* buffer changed, don't change name now */
2662 retval = FAIL;
2663 goto theend;
2664 }
2665#endif
2666 /* Exchange the file names for the current and the alternate
2667 * buffer. This makes it look like we are now editing the buffer
2668 * under the new name. Must be done before buf_write(), because
2669 * if there is no file name and 'cpo' contains 'F', it will set
2670 * the file name. */
2671 fname = alt_buf->b_fname;
2672 alt_buf->b_fname = curbuf->b_fname;
2673 curbuf->b_fname = fname;
2674 fname = alt_buf->b_ffname;
2675 alt_buf->b_ffname = curbuf->b_ffname;
2676 curbuf->b_ffname = fname;
2677 fname = alt_buf->b_sfname;
2678 alt_buf->b_sfname = curbuf->b_sfname;
2679 curbuf->b_sfname = fname;
2680 buf_name_changed(curbuf);
2681#ifdef FEAT_AUTOCMD
2682 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002683 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 if (!alt_buf->b_p_bl)
2685 {
2686 alt_buf->b_p_bl = TRUE;
2687 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2688 }
2689# ifdef FEAT_EVAL
2690 if (curbuf != was_curbuf || aborting())
2691# else
2692 if (curbuf != was_curbuf)
2693# endif
2694 {
2695 /* buffer changed, don't write the file */
2696 retval = FAIL;
2697 goto theend;
2698 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002699
2700 /* If 'filetype' was empty try detecting it now. */
2701 if (*curbuf->b_p_ft == NUL)
2702 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002703 if (au_has_group((char_u *)"filetypedetect"))
2704 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2705 TRUE);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002706 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002707 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002708
2709 /* Autocommands may have changed buffer names, esp. when
2710 * 'autochdir' is set. */
2711 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712#endif
2713 }
2714
2715 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2716 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002717
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002718 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002719 if (eap->cmdidx == CMD_saveas)
2720 {
2721 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002722 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002723 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002724#ifdef FEAT_WINDOWS
2725 redraw_tabline = TRUE;
2726#endif
2727 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002728 /* Change directories when the 'acd' option is set. */
2729 DO_AUTOCHDIR
2730 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 }
2732
2733theend:
2734#ifdef FEAT_BROWSE
2735 vim_free(browse_file);
2736#endif
2737 vim_free(free_fname);
2738 return retval;
2739}
2740
2741/*
2742 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2743 * BF_NEW or BF_READERR, check for overwriting current file.
2744 * May set eap->forceit if a dialog says it's OK to overwrite.
2745 * Return OK if it's OK, FAIL if it is not.
2746 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002747 int
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748check_overwrite(eap, buf, fname, ffname, other)
2749 exarg_T *eap;
2750 buf_T *buf;
2751 char_u *fname; /* file name to be used (can differ from
2752 buf->ffname) */
2753 char_u *ffname; /* full path version of fname */
2754 int other; /* writing under other name */
2755{
2756 /*
2757 * write to other file or b_flags set or not writing the whole file:
2758 * overwriting only allowed with '!'
2759 */
2760 if ( (other
2761 || (buf->b_flags & BF_NOTEDITED)
2762 || ((buf->b_flags & BF_NEW)
2763 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2764 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002766#ifdef FEAT_QUICKFIX
2767 && !bt_nofile(buf)
2768#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 && vim_fexists(ffname))
2770 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002771 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002773#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002774 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002775 if (mch_isdir(ffname))
2776 {
2777 EMSG2(_(e_isadir2), ffname);
2778 return FAIL;
2779 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780#endif
2781#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002782 if (p_confirm || cmdmod.confirm)
2783 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002784 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002786 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2787 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2788 return FAIL;
2789 eap->forceit = TRUE;
2790 }
2791 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002793 {
2794 EMSG(_(e_exists));
2795 return FAIL;
2796 }
2797 }
2798
2799 /* For ":w! filename" check that no swap file exists for "filename". */
2800 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002802 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002803 char_u *p;
2804 int r;
2805 char_u *swapname;
2806
2807 /* We only try the first entry in 'directory', without checking if
2808 * it's writable. If the "." directory is not writable the write
2809 * will probably fail anyway.
2810 * Use 'shortname' of the current buffer, since there is no buffer
2811 * for the written file. */
2812 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002813 {
2814 dir = alloc(5);
2815 if (dir == NULL)
2816 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002817 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002818 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002819 else
2820 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002821 dir = alloc(MAXPATHL);
2822 if (dir == NULL)
2823 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002824 p = p_dir;
2825 copy_option_part(&p, dir, MAXPATHL, ",");
2826 }
2827 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002828 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002829 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002830 if (r)
2831 {
2832#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2833 if (p_confirm || cmdmod.confirm)
2834 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002835 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002836
2837 dialog_msg(buff,
2838 _("Swap file \"%s\" exists, overwrite anyway?"),
2839 swapname);
2840 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2841 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002842 {
2843 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002844 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002845 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002846 eap->forceit = TRUE;
2847 }
2848 else
2849#endif
2850 {
2851 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2852 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002853 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002854 return FAIL;
2855 }
2856 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002857 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 }
2859 }
2860 return OK;
2861}
2862
2863/*
2864 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2865 */
2866 void
2867ex_wnext(eap)
2868 exarg_T *eap;
2869{
2870 int i;
2871
2872 if (eap->cmd[1] == 'n')
2873 i = curwin->w_arg_idx + (int)eap->line2;
2874 else
2875 i = curwin->w_arg_idx - (int)eap->line2;
2876 eap->line1 = 1;
2877 eap->line2 = curbuf->b_ml.ml_line_count;
2878 if (do_write(eap) != FAIL)
2879 do_argfile(eap, i);
2880}
2881
2882/*
2883 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2884 */
2885 void
2886do_wqall(eap)
2887 exarg_T *eap;
2888{
2889 buf_T *buf;
2890 int error = 0;
2891 int save_forceit = eap->forceit;
2892
2893 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2894 exiting = TRUE;
2895
2896 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2897 {
2898 if (bufIsChanged(buf))
2899 {
2900 /*
2901 * Check if there is a reason the buffer cannot be written:
2902 * 1. if the 'write' option is set
2903 * 2. if there is no file name (even after browsing)
2904 * 3. if the 'readonly' is set (even after a dialog)
2905 * 4. if overwriting is allowed (even after a dialog)
2906 */
2907 if (not_writing())
2908 {
2909 ++error;
2910 break;
2911 }
2912#ifdef FEAT_BROWSE
2913 /* ":browse wall": ask for file name if there isn't one */
2914 if (buf->b_ffname == NULL && cmdmod.browse)
2915 browse_save_fname(buf);
2916#endif
2917 if (buf->b_ffname == NULL)
2918 {
2919 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2920 ++error;
2921 }
2922 else if (check_readonly(&eap->forceit, buf)
2923 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2924 FALSE) == FAIL)
2925 {
2926 ++error;
2927 }
2928 else
2929 {
2930 if (buf_write_all(buf, eap->forceit) == FAIL)
2931 ++error;
2932#ifdef FEAT_AUTOCMD
2933 /* an autocommand may have deleted the buffer */
2934 if (!buf_valid(buf))
2935 buf = firstbuf;
2936#endif
2937 }
2938 eap->forceit = save_forceit; /* check_overwrite() may set it */
2939 }
2940 }
2941 if (exiting)
2942 {
2943 if (!error)
2944 getout(0); /* exit Vim */
2945 not_exiting();
2946 }
2947}
2948
2949/*
2950 * Check the 'write' option.
2951 * Return TRUE and give a message when it's not st.
2952 */
2953 int
2954not_writing()
2955{
2956 if (p_write)
2957 return FALSE;
2958 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2959 return TRUE;
2960}
2961
2962/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002963 * Check if a buffer is read-only (either 'readonly' option is set or file is
2964 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2965 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 */
2967 static int
2968check_readonly(forceit, buf)
2969 int *forceit;
2970 buf_T *buf;
2971{
Bram Moolenaar5386a122007-06-28 20:02:32 +00002972 struct stat st;
2973
2974 /* Handle a file being readonly when the 'readonly' option is set or when
2975 * the file exists and permissions are read-only.
2976 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2977 * important for device checks but not here. */
2978 if (!*forceit && (buf->b_p_ro
2979 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2980 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 {
2982#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2983 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2984 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002985 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986
Bram Moolenaar5386a122007-06-28 20:02:32 +00002987 if (buf->b_p_ro)
2988 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2989 buf->b_fname);
2990 else
2991 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 +00002992 buf->b_fname);
2993
2994 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2995 {
2996 /* Set forceit, to force the writing of a readonly file */
2997 *forceit = TRUE;
2998 return FALSE;
2999 }
3000 else
3001 return TRUE;
3002 }
3003 else
3004#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003005 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003007 else
3008 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3009 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 return TRUE;
3011 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003012
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 return FALSE;
3014}
3015
3016/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003017 * Try to abandon current file and edit a new or existing file.
3018 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003020 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003021 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3023 */
3024 int
3025getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3026 int fnum;
3027 char_u *ffname;
3028 char_u *sfname;
3029 int setpm;
3030 linenr_T lnum;
3031 int forceit;
3032{
3033 int other;
3034 int retval;
3035 char_u *free_me = NULL;
3036
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003037 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003039#ifdef FEAT_AUTOCMD
3040 if (curbuf_locked())
3041 return 1;
3042#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043
3044 if (fnum == 0)
3045 {
3046 /* make ffname full path, set sfname */
3047 fname_expand(curbuf, &ffname, &sfname);
3048 other = otherfile(ffname);
3049 free_me = ffname; /* has been allocated, free() later */
3050 }
3051 else
3052 other = (fnum != curbuf->b_fnum);
3053
3054 if (other)
3055 ++no_wait_return; /* don't wait for autowrite message */
3056 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3057 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3058 {
3059#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3060 if (p_confirm && p_write)
3061 dialog_changed(curbuf, FALSE);
3062 if (curbufIsChanged())
3063#endif
3064 {
3065 if (other)
3066 --no_wait_return;
3067 EMSG(_(e_nowrtmsg));
3068 retval = 2; /* file has been changed */
3069 goto theend;
3070 }
3071 }
3072 if (other)
3073 --no_wait_return;
3074 if (setpm)
3075 setpcmark();
3076 if (!other)
3077 {
3078 if (lnum != 0)
3079 curwin->w_cursor.lnum = lnum;
3080 check_cursor_lnum();
3081 beginline(BL_SOL | BL_FIX);
3082 retval = 0; /* it's in the same file */
3083 }
3084 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003085 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3086 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 retval = -1; /* opened another file */
3088 else
3089 retval = 1; /* error encountered */
3090
3091theend:
3092 vim_free(free_me);
3093 return retval;
3094}
3095
3096/*
3097 * start editing a new file
3098 *
3099 * fnum: file number; if zero use ffname/sfname
3100 * ffname: the file name
3101 * - full path if sfname used,
3102 * - any file name if sfname is NULL
3103 * - empty string to re-edit with the same file name (but may be
3104 * in a different directory)
3105 * - NULL to start an empty buffer
3106 * sfname: the short file name (or NULL)
3107 * eap: contains the command to be executed after loading the file and
3108 * forced 'ff' and 'fenc'
3109 * newlnum: if > 0: put cursor on this line number (if possible)
3110 * if ECMD_LASTL: use last position in loaded file
3111 * if ECMD_LAST: use last position in all files
3112 * if ECMD_ONE: use first line
3113 * flags:
3114 * ECMD_HIDE: if TRUE don't free the current buffer
3115 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3116 * ECMD_OLDBUF: use existing buffer if it exists
3117 * ECMD_FORCEIT: ! used for Ex command
3118 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003119 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003120 * window, NULL when splitting the window first. When not NULL info
3121 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 *
3123 * return FAIL for failure, OK otherwise
3124 */
3125 int
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003126do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 int fnum;
3128 char_u *ffname;
3129 char_u *sfname;
3130 exarg_T *eap; /* can be NULL! */
3131 linenr_T newlnum;
3132 int flags;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003133 win_T *oldwin;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134{
3135 int other_file; /* TRUE if editing another file */
3136 int oldbuf; /* TRUE if using existing buffer */
3137#ifdef FEAT_AUTOCMD
3138 int auto_buf = FALSE; /* TRUE if autocommands brought us
3139 into the buffer unexpectedly */
3140 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003141 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142#endif
3143 buf_T *buf;
3144#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3145 buf_T *old_curbuf = curbuf;
3146#endif
3147 char_u *free_fname = NULL;
3148#ifdef FEAT_BROWSE
3149 char_u *browse_file = NULL;
3150#endif
3151 int retval = FAIL;
3152 long n;
3153 linenr_T lnum;
3154 linenr_T topline = 0;
3155 int newcol = -1;
3156 int solcol = -1;
3157 pos_T *pos;
3158#ifdef FEAT_SUN_WORKSHOP
3159 char_u *cp;
3160#endif
3161 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003162#ifdef FEAT_SPELL
3163 int did_get_winopts = FALSE;
3164#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003165 int readfile_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166
3167 if (eap != NULL)
3168 command = eap->do_ecmd_cmd;
3169
3170 if (fnum != 0)
3171 {
3172 if (fnum == curbuf->b_fnum) /* file is already being edited */
3173 return OK; /* nothing to do */
3174 other_file = TRUE;
3175 }
3176 else
3177 {
3178#ifdef FEAT_BROWSE
3179 if (cmdmod.browse)
3180 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003181# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003182 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003183# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003184 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003185# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003186 au_has_group((char_u *)"FileExplorer"))
3187 {
3188 /* No browsing supported but we do have the file explorer:
3189 * Edit the directory. */
3190 if (ffname == NULL || !mch_isdir(ffname))
3191 ffname = (char_u *)".";
3192 }
3193 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003194# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003195 {
3196 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003198 if (browse_file == NULL)
3199 goto theend;
3200 ffname = browse_file;
3201 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 }
3203#endif
3204 /* if no short name given, use ffname for short name */
3205 if (sfname == NULL)
3206 sfname = ffname;
3207#ifdef USE_FNAME_CASE
3208# ifdef USE_LONG_FNAME
3209 if (USE_LONG_FNAME)
3210# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003211 if (sfname != NULL)
3212 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213#endif
3214
3215#ifdef FEAT_LISTCMDS
3216 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3217 goto theend;
3218#endif
3219
3220 if (ffname == NULL)
3221 other_file = TRUE;
3222 /* there is no file name */
3223 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3224 other_file = FALSE;
3225 else
3226 {
3227 if (*ffname == NUL) /* re-edit with same file name */
3228 {
3229 ffname = curbuf->b_ffname;
3230 sfname = curbuf->b_fname;
3231 }
3232 free_fname = fix_fname(ffname); /* may expand to full path name */
3233 if (free_fname != NULL)
3234 ffname = free_fname;
3235 other_file = otherfile(ffname);
3236#ifdef FEAT_SUN_WORKSHOP
3237 if (usingSunWorkShop && p_acd
3238 && (cp = vim_strrchr(sfname, '/')) != NULL)
3239 sfname = ++cp;
3240#endif
3241 }
3242 }
3243
3244 /*
3245 * if the file was changed we may not be allowed to abandon it
3246 * - if we are going to re-edit the same file
3247 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3248 */
3249 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3250 || (curbuf->b_nwindows == 1
3251 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3252 && check_changed(curbuf, p_awa, !other_file,
3253 (flags & ECMD_FORCEIT), FALSE))
3254 {
3255 if (fnum == 0 && other_file && ffname != NULL)
3256 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3257 goto theend;
3258 }
3259
3260#ifdef FEAT_VISUAL
3261 /*
3262 * End Visual mode before switching to another buffer, so the text can be
3263 * copied into the GUI selection buffer.
3264 */
3265 reset_VIsual();
3266#endif
3267
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003268#ifdef FEAT_AUTOCMD
3269 if ((command != NULL || newlnum > (linenr_T)0)
3270 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3271 {
3272 int len;
3273 char_u *p;
3274
3275 /* Set v:swapcommand for the SwapExists autocommands. */
3276 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003277 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003278 else
3279 len = 30;
3280 p = alloc((unsigned)len);
3281 if (p != NULL)
3282 {
3283 if (command != NULL)
3284 vim_snprintf((char *)p, len, ":%s\r", command);
3285 else
3286 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3287 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3288 did_set_swapcommand = TRUE;
3289 vim_free(p);
3290 }
3291 }
3292#endif
3293
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 /*
3295 * If we are starting to edit another file, open a (new) buffer.
3296 * Otherwise we re-use the current buffer.
3297 */
3298 if (other_file)
3299 {
3300#ifdef FEAT_LISTCMDS
3301 if (!(flags & ECMD_ADDBUF))
3302#endif
3303 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003304 if (!cmdmod.keepalt)
3305 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003306 if (oldwin != NULL)
3307 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 }
3309
3310 if (fnum)
3311 buf = buflist_findnr(fnum);
3312 else
3313 {
3314#ifdef FEAT_LISTCMDS
3315 if (flags & ECMD_ADDBUF)
3316 {
3317 linenr_T tlnum = 1L;
3318
3319 if (command != NULL)
3320 {
3321 tlnum = atol((char *)command);
3322 if (tlnum <= 0)
3323 tlnum = 1L;
3324 }
3325 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3326 goto theend;
3327 }
3328#endif
3329 buf = buflist_new(ffname, sfname, 0L,
3330 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3331 }
3332 if (buf == NULL)
3333 goto theend;
3334 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3335 {
3336 oldbuf = FALSE;
3337 buf->b_nwindows = 0;
3338 }
3339 else /* existing memfile */
3340 {
3341 oldbuf = TRUE;
3342 (void)buf_check_timestamp(buf, FALSE);
3343 /* Check if autocommands made buffer invalid or changed the current
3344 * buffer. */
3345 if (!buf_valid(buf)
3346#ifdef FEAT_AUTOCMD
3347 || curbuf != old_curbuf
3348#endif
3349 )
3350 goto theend;
3351#ifdef FEAT_EVAL
3352 if (aborting()) /* autocmds may abort script processing */
3353 goto theend;
3354#endif
3355 }
3356
3357 /* May jump to last used line number for a loaded buffer or when asked
3358 * for explicitly */
3359 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3360 {
3361 pos = buflist_findfpos(buf);
3362 newlnum = pos->lnum;
3363 solcol = pos->col;
3364 }
3365
3366 /*
3367 * Make the (new) buffer the one used by the current window.
3368 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3369 * If the current buffer was empty and has no file name, curbuf
3370 * is returned by buflist_new().
3371 */
3372 if (buf != curbuf)
3373 {
3374#ifdef FEAT_AUTOCMD
3375 /*
3376 * Be careful: The autocommands may delete any buffer and change
3377 * the current buffer.
3378 * - If the buffer we are going to edit is deleted, give up.
3379 * - If the current buffer is deleted, prefer to load the new
3380 * buffer when loading a buffer is required. This avoids
3381 * loading another buffer which then must be closed again.
3382 * - If we ended up in the new buffer already, need to skip a few
3383 * things, set auto_buf.
3384 */
3385 if (buf->b_fname != NULL)
3386 new_name = vim_strsave(buf->b_fname);
3387 au_new_curbuf = buf;
3388 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3389 if (!buf_valid(buf)) /* new buffer has been deleted */
3390 {
3391 delbuf_msg(new_name); /* frees new_name */
3392 goto theend;
3393 }
3394# ifdef FEAT_EVAL
3395 if (aborting()) /* autocmds may abort script processing */
3396 {
3397 vim_free(new_name);
3398 goto theend;
3399 }
3400# endif
3401 if (buf == curbuf) /* already in new buffer */
3402 auto_buf = TRUE;
3403 else
3404 {
3405 if (curbuf == old_curbuf)
3406#endif
3407 buf_copy_options(buf, BCO_ENTER);
3408
3409 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003410 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003411 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003412 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413
3414#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003415 /* Autocommands may open a new window and leave oldwin open
3416 * which leads to crashes since the above call sets
3417 * oldwin->w_buffer to NULL. */
3418 if (curwin != oldwin && oldwin != aucmd_win
3419 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3420 win_close(oldwin, FALSE);
3421
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422# ifdef FEAT_EVAL
3423 if (aborting()) /* autocmds may abort script processing */
3424 {
3425 vim_free(new_name);
3426 goto theend;
3427 }
3428# endif
3429 /* Be careful again, like above. */
3430 if (!buf_valid(buf)) /* new buffer has been deleted */
3431 {
3432 delbuf_msg(new_name); /* frees new_name */
3433 goto theend;
3434 }
3435 if (buf == curbuf) /* already in new buffer */
3436 auto_buf = TRUE;
3437 else
3438#endif
3439 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003440#ifdef FEAT_SYN_HL
3441 /*
3442 * <VN> We could instead free the synblock
3443 * and re-attach to buffer, perhaps.
3444 */
3445 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003446 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003447#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 curwin->w_buffer = buf;
3449 curbuf = buf;
3450 ++curbuf->b_nwindows;
3451 /* set 'fileformat' */
3452 if (*p_ffs && !oldbuf)
3453 set_fileformat(default_fileformat(), OPT_LOCAL);
3454 }
3455
3456 /* May get the window options from the last time this buffer
3457 * was in this window (or another window). If not used
3458 * before, reset the local window options to the global
3459 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003460 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003461#ifdef FEAT_SPELL
3462 did_get_winopts = TRUE;
3463#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464
3465#ifdef FEAT_AUTOCMD
3466 }
3467 vim_free(new_name);
3468 au_new_curbuf = NULL;
3469#endif
3470 }
3471 else
3472 ++curbuf->b_nwindows;
3473
3474 curwin->w_pcmark.lnum = 1;
3475 curwin->w_pcmark.col = 0;
3476 }
3477 else /* !other_file */
3478 {
3479 if (
3480#ifdef FEAT_LISTCMDS
3481 (flags & ECMD_ADDBUF) ||
3482#endif
3483 check_fname() == FAIL)
3484 goto theend;
3485 oldbuf = (flags & ECMD_OLDBUF);
3486 }
3487
3488 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3489 {
3490 char_u *p;
3491
3492 curbuf->b_help = TRUE;
3493#ifdef FEAT_QUICKFIX
3494 set_string_option_direct((char_u *)"buftype", -1,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003495 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496#endif
3497
3498 /*
3499 * Always set these options after jumping to a help tag, because the
3500 * user may have an autocommand that gets in the way.
3501 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3502 * latin1 word characters (for translated help files).
3503 * Only set it when needed, buf_init_chartab() is some work.
3504 */
3505 p =
3506#ifdef EBCDIC
3507 (char_u *)"65-255,^*,^|,^\"";
3508#else
3509 (char_u *)"!-~,^*,^|,^\",192-255";
3510#endif
3511 if (STRCMP(curbuf->b_p_isk, p) != 0)
3512 {
3513 set_string_option_direct((char_u *)"isk", -1, p,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003514 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 check_buf_options(curbuf);
3516 (void)buf_init_chartab(curbuf, FALSE);
3517 }
3518
3519 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3520 curwin->w_p_list = FALSE; /* no list mode */
3521
3522 curbuf->b_p_ma = FALSE; /* not modifiable */
3523 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3524 curwin->w_p_nu = 0; /* no line numbers */
Bram Moolenaar64486672010-05-16 15:46:46 +02003525 curwin->w_p_rnu = 0; /* no relative line numbers */
Bram Moolenaar3368ea22010-09-21 16:56:35 +02003526 RESET_BINDING(curwin); /* no scroll or cursor binding */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527#ifdef FEAT_ARABIC
3528 curwin->w_p_arab = FALSE; /* no arabic mode */
3529#endif
3530#ifdef FEAT_RIGHTLEFT
3531 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3532#endif
3533#ifdef FEAT_FOLDING
3534 curwin->w_p_fen = FALSE; /* No folding in the help window */
3535#endif
3536#ifdef FEAT_DIFF
3537 curwin->w_p_diff = FALSE; /* No 'diff' */
3538#endif
Bram Moolenaara1956f62006-03-12 22:18:00 +00003539#ifdef FEAT_SPELL
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00003540 curwin->w_p_spell = FALSE; /* No spell checking */
3541#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542
3543#ifdef FEAT_AUTOCMD
3544 buf = curbuf;
3545#endif
3546 set_buflisted(FALSE);
3547 }
3548 else
3549 {
3550#ifdef FEAT_AUTOCMD
3551 buf = curbuf;
3552#endif
3553 /* Don't make a buffer listed if it's a help buffer. Useful when
3554 * using CTRL-O to go back to a help file. */
3555 if (!curbuf->b_help)
3556 set_buflisted(TRUE);
3557 }
3558
3559#ifdef FEAT_AUTOCMD
3560 /* If autocommands change buffers under our fingers, forget about
3561 * editing the file. */
3562 if (buf != curbuf)
3563 goto theend;
3564# ifdef FEAT_EVAL
3565 if (aborting()) /* autocmds may abort script processing */
3566 goto theend;
3567# endif
3568
3569 /* Since we are starting to edit a file, consider the filetype to be
3570 * unset. Helps for when an autocommand changes files and expects syntax
3571 * highlighting to work in the other file. */
3572 did_filetype = FALSE;
3573#endif
3574
3575/*
3576 * other_file oldbuf
3577 * FALSE FALSE re-edit same file, buffer is re-used
3578 * FALSE TRUE re-edit same file, nothing changes
3579 * TRUE FALSE start editing new file, new buffer
3580 * TRUE TRUE start editing in existing buffer (nothing to do)
3581 */
3582 if (!other_file && !oldbuf) /* re-use the buffer */
3583 {
3584 set_last_cursor(curwin); /* may set b_last_cursor */
3585 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3586 {
3587 newlnum = curwin->w_cursor.lnum;
3588 solcol = curwin->w_cursor.col;
3589 }
3590#ifdef FEAT_AUTOCMD
3591 buf = curbuf;
3592 if (buf->b_fname != NULL)
3593 new_name = vim_strsave(buf->b_fname);
3594 else
3595 new_name = NULL;
3596#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003597 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
3598 {
3599 /* Save all the text, so that the reload can be undone.
3600 * Sync first so that this is a separate undo-able action. */
3601 u_sync(FALSE);
3602 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
3603 == FAIL)
3604 goto theend;
3605 u_unchanged(curbuf);
3606 buf_freeall(curbuf, BFA_KEEP_UNDO);
3607
3608 /* tell readfile() not to clear or reload undo info */
3609 readfile_flags = READ_KEEP_UNDO;
3610 }
3611 else
3612 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613#ifdef FEAT_AUTOCMD
3614 /* If autocommands deleted the buffer we were going to re-edit, give
3615 * up and jump to the end. */
3616 if (!buf_valid(buf))
3617 {
3618 delbuf_msg(new_name); /* frees new_name */
3619 goto theend;
3620 }
3621 vim_free(new_name);
3622
3623 /* If autocommands change buffers under our fingers, forget about
3624 * re-editing the file. Should do the buf_clear_file(), but perhaps
3625 * the autocommands changed the buffer... */
3626 if (buf != curbuf)
3627 goto theend;
3628# ifdef FEAT_EVAL
3629 if (aborting()) /* autocmds may abort script processing */
3630 goto theend;
3631# endif
3632#endif
3633 buf_clear_file(curbuf);
3634 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3635 curbuf->b_op_end.lnum = 0;
3636 }
3637
3638/*
3639 * If we get here we are sure to start editing
3640 */
3641 /* don't redraw until the cursor is in the right line */
3642 ++RedrawingDisabled;
3643
3644 /* Assume success now */
3645 retval = OK;
3646
3647 /*
3648 * Reset cursor position, could be used by autocommands.
3649 */
3650 check_cursor();
3651
3652 /*
3653 * Check if we are editing the w_arg_idx file in the argument list.
3654 */
3655 check_arg_idx(curwin);
3656
3657#ifdef FEAT_AUTOCMD
3658 if (!auto_buf)
3659#endif
3660 {
3661 /*
3662 * Set cursor and init window before reading the file and executing
3663 * autocommands. This allows for the autocommands to position the
3664 * cursor.
3665 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003666 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667
3668#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003669 /* It's possible that all lines in the buffer changed. Need to update
3670 * automatic folding for all windows where it's used. */
3671# ifdef FEAT_WINDOWS
3672 {
3673 win_T *win;
3674 tabpage_T *tp;
3675
3676 FOR_ALL_TAB_WINDOWS(tp, win)
3677 if (win->w_buffer == curbuf)
3678 foldUpdateAll(win);
3679 }
3680# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003682# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683#endif
3684
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003685 /* Change directories when the 'acd' option is set. */
3686 DO_AUTOCHDIR
3687
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 /*
3689 * Careful: open_buffer() and apply_autocmds() may change the current
3690 * buffer and window.
3691 */
3692 lnum = curwin->w_cursor.lnum;
3693 topline = curwin->w_topline;
3694 if (!oldbuf) /* need to read the file */
3695 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003696#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 swap_exists_action = SEA_DIALOG;
3698#endif
3699 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3700
3701 /*
3702 * Open the buffer and read the file.
3703 */
3704#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003705 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 retval = FAIL;
3707#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003708 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709#endif
3710
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003711#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 if (swap_exists_action == SEA_QUIT)
3713 retval = FAIL;
3714 handle_swap_exists(old_curbuf);
3715#endif
3716 }
3717#ifdef FEAT_AUTOCMD
3718 else
3719 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003720 /* Read the modelines, but only to set window-local options. Any
3721 * buffer-local options have already been set and may have been
3722 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003723 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003724
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3726 &retval);
3727 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3728 &retval);
3729 }
3730 check_arg_idx(curwin);
3731#endif
3732
3733 /*
3734 * If autocommands change the cursor position or topline, we should
3735 * keep it.
3736 */
3737 if (curwin->w_cursor.lnum != lnum)
3738 {
3739 newlnum = curwin->w_cursor.lnum;
3740 newcol = curwin->w_cursor.col;
3741 }
3742 if (curwin->w_topline == topline)
3743 topline = 0;
3744
3745 /* Even when cursor didn't move we need to recompute topline. */
3746 changed_line_abv_curs();
3747
3748#ifdef FEAT_TITLE
3749 maketitle();
3750#endif
3751 }
3752
3753#ifdef FEAT_DIFF
3754 /* Tell the diff stuff that this buffer is new and/or needs updating.
3755 * Also needed when re-editing the same buffer, because unloading will
3756 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003757 if (curwin->w_p_diff)
3758 {
3759 diff_buf_add(curbuf);
3760 diff_invalidate(curbuf);
3761 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762#endif
3763
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003764#ifdef FEAT_SPELL
3765 /* If the window options were changed may need to set the spell language.
3766 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003767 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3768 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003769#endif
3770
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 if (command == NULL)
3772 {
3773 if (newcol >= 0) /* position set by autocommands */
3774 {
3775 curwin->w_cursor.lnum = newlnum;
3776 curwin->w_cursor.col = newcol;
3777 check_cursor();
3778 }
3779 else if (newlnum > 0) /* line number from caller or old position */
3780 {
3781 curwin->w_cursor.lnum = newlnum;
3782 check_cursor_lnum();
3783 if (solcol >= 0 && !p_sol)
3784 {
3785 /* 'sol' is off: Use last known column. */
3786 curwin->w_cursor.col = solcol;
3787 check_cursor_col();
3788#ifdef FEAT_VIRTUALEDIT
3789 curwin->w_cursor.coladd = 0;
3790#endif
3791 curwin->w_set_curswant = TRUE;
3792 }
3793 else
3794 beginline(BL_SOL | BL_FIX);
3795 }
3796 else /* no line number, go to last line in Ex mode */
3797 {
3798 if (exmode_active)
3799 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3800 beginline(BL_WHITE | BL_FIX);
3801 }
3802 }
3803
3804#ifdef FEAT_WINDOWS
3805 /* Check if cursors in other windows on the same buffer are still valid */
3806 check_lnums(FALSE);
3807#endif
3808
3809 /*
3810 * Did not read the file, need to show some info about the file.
3811 * Do this after setting the cursor.
3812 */
3813 if (oldbuf
3814#ifdef FEAT_AUTOCMD
3815 && !auto_buf
3816#endif
3817 )
3818 {
3819 int msg_scroll_save = msg_scroll;
3820
3821 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3822 * message. */
3823 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3824 msg_scroll = FALSE;
3825 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3826 check_for_delay(FALSE);
3827 msg_start();
3828 msg_scroll = msg_scroll_save;
3829 msg_scrolled_ign = TRUE;
3830
3831 fileinfo(FALSE, TRUE, FALSE);
3832
3833 msg_scrolled_ign = FALSE;
3834 }
3835
3836 if (command != NULL)
3837 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3838
3839#ifdef FEAT_KEYMAP
3840 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003841 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842#endif
3843
3844 --RedrawingDisabled;
3845 if (!skip_redraw)
3846 {
3847 n = p_so;
3848 if (topline == 0 && command == NULL)
3849 p_so = 999; /* force cursor halfway the window */
3850 update_topline();
3851#ifdef FEAT_SCROLLBIND
3852 curwin->w_scbind_pos = curwin->w_topline;
3853#endif
3854 p_so = n;
3855 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3856 }
3857
3858 if (p_im)
3859 need_start_insertmode = TRUE;
3860
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003861 /* Change directories when the 'acd' option is set. */
3862 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00003864#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003865 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 {
3867# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02003868 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3870# endif
3871# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003872 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003873 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874# endif
3875 }
3876#endif
3877
3878theend:
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003879#ifdef FEAT_AUTOCMD
3880 if (did_set_swapcommand)
3881 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3882#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883#ifdef FEAT_BROWSE
3884 vim_free(browse_file);
3885#endif
3886 vim_free(free_fname);
3887 return retval;
3888}
3889
3890#ifdef FEAT_AUTOCMD
3891 static void
3892delbuf_msg(name)
3893 char_u *name;
3894{
3895 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3896 name == NULL ? (char_u *)"" : name);
3897 vim_free(name);
3898 au_new_curbuf = NULL;
3899}
3900#endif
3901
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003902static int append_indent = 0; /* autoindent for first line */
3903
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904/*
3905 * ":insert" and ":append", also used by ":change"
3906 */
3907 void
3908ex_append(eap)
3909 exarg_T *eap;
3910{
3911 char_u *theline;
3912 int did_undo = FALSE;
3913 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003914 int indent = 0;
3915 char_u *p;
3916 int vcol;
3917 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003919 /* the ! flag toggles autoindent */
3920 if (eap->forceit)
3921 curbuf->b_p_ai = !curbuf->b_p_ai;
3922
3923 /* First autoindent comes from the line we start on */
3924 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3925 append_indent = get_indent_lnum(lnum);
3926
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 if (eap->cmdidx != CMD_append)
3928 --lnum;
3929
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003930 /* when the buffer is empty append to line 0 and delete the dummy line */
3931 if (empty && lnum == 1)
3932 lnum = 0;
3933
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 State = INSERT; /* behave like in Insert mode */
3935 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3936 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003937
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003938 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 {
3940 msg_scroll = TRUE;
3941 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003942 if (curbuf->b_p_ai)
3943 {
3944 if (append_indent >= 0)
3945 {
3946 indent = append_indent;
3947 append_indent = -1;
3948 }
3949 else if (lnum > 0)
3950 indent = get_indent_lnum(lnum);
3951 }
3952 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003954 {
3955 /* No getline() function, use the lines that follow. This ends
3956 * when there is no more. */
3957 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3958 break;
3959 p = vim_strchr(eap->nextcmd, NL);
3960 if (p == NULL)
3961 p = eap->nextcmd + STRLEN(eap->nextcmd);
3962 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3963 if (*p != NUL)
3964 ++p;
3965 eap->nextcmd = p;
3966 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 else
3968 theline = eap->getline(
3969#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003970 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003972 NUL, eap->cookie, indent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003974 if (theline == NULL)
3975 break;
3976
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003977 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3978 if (ex_keep_indent)
3979 append_indent = indent;
3980
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003981 /* Look for the "." after automatic indent. */
3982 vcol = 0;
3983 for (p = theline; indent > vcol; ++p)
3984 {
3985 if (*p == ' ')
3986 ++vcol;
3987 else if (*p == TAB)
3988 vcol += 8 - vcol % 8;
3989 else
3990 break;
3991 }
3992 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003993 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3994 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 {
3996 vim_free(theline);
3997 break;
3998 }
3999
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004000 /* don't use autoindent if nothing was typed. */
4001 if (p[0] == NUL)
4002 theline[0] = NUL;
4003
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 did_undo = TRUE;
4005 ml_append(lnum, theline, (colnr_T)0, FALSE);
4006 appended_lines_mark(lnum, 1L);
4007
4008 vim_free(theline);
4009 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004010
4011 if (empty)
4012 {
4013 ml_delete(2L, FALSE);
4014 empty = FALSE;
4015 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 }
4017 State = NORMAL;
4018
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004019 if (eap->forceit)
4020 curbuf->b_p_ai = !curbuf->b_p_ai;
4021
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004023 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 * "end" is set to lnum when something has been appended, otherwise
4025 * it is the same than "start" -- Acevedo */
4026 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4027 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4028 if (eap->cmdidx != CMD_append)
4029 --curbuf->b_op_start.lnum;
4030 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4031 ? lnum : curbuf->b_op_start.lnum;
4032 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4033 curwin->w_cursor.lnum = lnum;
4034 check_cursor_lnum();
4035 beginline(BL_SOL | BL_FIX);
4036
4037 need_wait_return = FALSE; /* don't use wait_return() now */
4038 ex_no_reprint = TRUE;
4039}
4040
4041/*
4042 * ":change"
4043 */
4044 void
4045ex_change(eap)
4046 exarg_T *eap;
4047{
4048 linenr_T lnum;
4049
4050 if (eap->line2 >= eap->line1
4051 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4052 return;
4053
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004054 /* the ! flag toggles autoindent */
4055 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4056 append_indent = get_indent_lnum(eap->line1);
4057
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4059 {
4060 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4061 break;
4062 ml_delete(eap->line1, FALSE);
4063 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004064
4065 /* make sure the cursor is not beyond the end of the file now */
4066 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4068
4069 /* ":append" on the line above the deleted lines. */
4070 eap->line2 = eap->line1;
4071 ex_append(eap);
4072}
4073
4074 void
4075ex_z(eap)
4076 exarg_T *eap;
4077{
4078 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004079 int bigness;
4080 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 int minus = 0;
4082 linenr_T start, end, curs, i;
4083 int j;
4084 linenr_T lnum = eap->line2;
4085
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004086 /* Vi compatible: ":z!" uses display height, without a count uses
4087 * 'scroll' */
4088 if (eap->forceit)
4089 bigness = curwin->w_height;
4090 else if (firstwin == lastwin)
4091 bigness = curwin->w_p_scr * 2;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004092#ifdef FEAT_WINDOWS
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004093 else
4094 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004095#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 if (bigness < 1)
4097 bigness = 1;
4098
4099 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004100 kind = x;
4101 if (*kind == '-' || *kind == '+' || *kind == '='
4102 || *kind == '^' || *kind == '.')
4103 ++x;
4104 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 ++x;
4106
4107 if (*x != 0)
4108 {
4109 if (!VIM_ISDIGIT(*x))
4110 {
4111 EMSG(_("E144: non-numeric argument to :z"));
4112 return;
4113 }
4114 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004115 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004117 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004118 if (*kind == '=')
4119 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004120 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 }
4122
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004123 /* the number of '-' and '+' multiplies the distance */
4124 if (*kind == '-' || *kind == '+')
4125 for (x = kind + 1; *x == *kind; ++x)
4126 ;
4127
4128 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 {
4130 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004131 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4132 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004133 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 break;
4135
4136 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004137 start = lnum - (bigness + 1) / 2 + 1;
4138 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 curs = lnum;
4140 minus = 1;
4141 break;
4142
4143 case '^':
4144 start = lnum - bigness * 2;
4145 end = lnum - bigness;
4146 curs = lnum - bigness;
4147 break;
4148
4149 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004150 start = lnum - (bigness + 1) / 2 + 1;
4151 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 curs = end;
4153 break;
4154
4155 default: /* '+' */
4156 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004157 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004158 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004159 else if (eap->addr_count == 0)
4160 ++start;
4161 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 curs = end;
4163 break;
4164 }
4165
4166 if (start < 1)
4167 start = 1;
4168
4169 if (end > curbuf->b_ml.ml_line_count)
4170 end = curbuf->b_ml.ml_line_count;
4171
4172 if (curs > curbuf->b_ml.ml_line_count)
4173 curs = curbuf->b_ml.ml_line_count;
4174
4175 for (i = start; i <= end; i++)
4176 {
4177 if (minus && i == lnum)
4178 {
4179 msg_putchar('\n');
4180
4181 for (j = 1; j < Columns; j++)
4182 msg_putchar('-');
4183 }
4184
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004185 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186
4187 if (minus && i == lnum)
4188 {
4189 msg_putchar('\n');
4190
4191 for (j = 1; j < Columns; j++)
4192 msg_putchar('-');
4193 }
4194 }
4195
4196 curwin->w_cursor.lnum = curs;
4197 ex_no_reprint = TRUE;
4198}
4199
4200/*
4201 * Check if the restricted flag is set.
4202 * If so, give an error message and return TRUE.
4203 * Otherwise, return FALSE.
4204 */
4205 int
4206check_restricted()
4207{
4208 if (restricted)
4209 {
4210 EMSG(_("E145: Shell commands not allowed in rvim"));
4211 return TRUE;
4212 }
4213 return FALSE;
4214}
4215
4216/*
4217 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4218 * If so, give an error message and return TRUE.
4219 * Otherwise, return FALSE.
4220 */
4221 int
4222check_secure()
4223{
4224 if (secure)
4225 {
4226 secure = 2;
4227 EMSG(_(e_curdir));
4228 return TRUE;
4229 }
4230#ifdef HAVE_SANDBOX
4231 /*
4232 * In the sandbox more things are not allowed, including the things
4233 * disallowed in secure mode.
4234 */
4235 if (sandbox != 0)
4236 {
4237 EMSG(_(e_sandbox));
4238 return TRUE;
4239 }
4240#endif
4241 return FALSE;
4242}
4243
4244static char_u *old_sub = NULL; /* previous substitute pattern */
4245static int global_need_beginline; /* call beginline() after ":g" */
4246
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247/* do_sub()
4248 *
4249 * Perform a substitution from line eap->line1 to line eap->line2 using the
4250 * command pointed to by eap->arg which should be of the form:
4251 *
4252 * /pattern/substitution/{flags}
4253 *
4254 * The usual escapes are supported as described in the regexp docs.
4255 */
4256 void
4257do_sub(eap)
4258 exarg_T *eap;
4259{
4260 linenr_T lnum;
4261 long i = 0;
4262 regmmatch_T regmatch;
4263 static int do_all = FALSE; /* do multiple substitutions per line */
4264 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004265 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 static int do_error = TRUE; /* if false, ignore errors */
4267 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004268 static int do_list = FALSE; /* list last line with subs. */
4269 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 static int do_ic = 0; /* ignore case flag */
4271 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4272 int delimiter;
4273 int sublen;
4274 int got_quit = FALSE;
4275 int got_match = FALSE;
4276 int temp;
4277 int which_pat;
4278 char_u *cmd;
4279 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004280 linenr_T first_line = 0; /* first changed line */
4281 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 * change */
4283 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4284 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004285 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004286 char_u *sub_firstline; /* allocated copy of first sub line */
4287 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004288 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004289 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004290#ifdef FEAT_EVAL
4291 int save_ma = 0;
4292#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293
4294 cmd = eap->arg;
4295 if (!global_busy)
4296 {
4297 sub_nsubs = 0;
4298 sub_nlines = 0;
4299 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004300 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 if (eap->cmdidx == CMD_tilde)
4303 which_pat = RE_LAST; /* use last used regexp */
4304 else
4305 which_pat = RE_SUBST; /* use last substitute regexp */
4306
4307 /* new pattern and substitution */
4308 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4309 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4310 {
4311 /* don't accept alphanumeric for separator */
4312 if (isalpha(*cmd))
4313 {
4314 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4315 return;
4316 }
4317 /*
4318 * undocumented vi feature:
4319 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4320 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4321 */
4322 if (*cmd == '\\')
4323 {
4324 ++cmd;
4325 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4326 {
4327 EMSG(_(e_backslash));
4328 return;
4329 }
4330 if (*cmd != '&')
4331 which_pat = RE_SEARCH; /* use last '/' pattern */
4332 pat = (char_u *)""; /* empty search pattern */
4333 delimiter = *cmd++; /* remember delimiter character */
4334 }
4335 else /* find the end of the regexp */
4336 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004337#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4338 if (p_altkeymap && curwin->w_p_rl)
4339 lrF_sub(cmd);
4340#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 which_pat = RE_LAST; /* use last used regexp */
4342 delimiter = *cmd++; /* remember delimiter character */
4343 pat = cmd; /* remember start of search pat */
4344 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4345 if (cmd[0] == delimiter) /* end delimiter found */
4346 *cmd++ = NUL; /* replace it with a NUL */
4347 }
4348
4349 /*
4350 * Small incompatibility: vi sees '\n' as end of the command, but in
4351 * Vim we want to use '\n' to find/substitute a NUL.
4352 */
4353 sub = cmd; /* remember the start of the substitution */
4354
4355 while (cmd[0])
4356 {
4357 if (cmd[0] == delimiter) /* end delimiter found */
4358 {
4359 *cmd++ = NUL; /* replace it with a NUL */
4360 break;
4361 }
4362 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4363 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004364 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 }
4366
4367 if (!eap->skip)
4368 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004369 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4370 if (STRCMP(sub, "%") == 0
4371 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4372 {
4373 if (old_sub == NULL) /* there is no previous command */
4374 {
4375 EMSG(_(e_nopresub));
4376 return;
4377 }
4378 sub = old_sub;
4379 }
4380 else
4381 {
4382 vim_free(old_sub);
4383 old_sub = vim_strsave(sub);
4384 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 }
4386 }
4387 else if (!eap->skip) /* use previous pattern and substitution */
4388 {
4389 if (old_sub == NULL) /* there is no previous command */
4390 {
4391 EMSG(_(e_nopresub));
4392 return;
4393 }
4394 pat = NULL; /* search_regcomp() will use previous pattern */
4395 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004396
4397 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4398 * last column after using "$". */
4399 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 }
4401
4402 /*
4403 * Find trailing options. When '&' is used, keep old options.
4404 */
4405 if (*cmd == '&')
4406 ++cmd;
4407 else
4408 {
4409 if (!p_ed)
4410 {
4411 if (p_gd) /* default is global on */
4412 do_all = TRUE;
4413 else
4414 do_all = FALSE;
4415 do_ask = FALSE;
4416 }
4417 do_error = TRUE;
4418 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004419 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004420 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 do_ic = 0;
4422 }
4423 while (*cmd)
4424 {
4425 /*
4426 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4427 * 'r' is never inverted.
4428 */
4429 if (*cmd == 'g')
4430 do_all = !do_all;
4431 else if (*cmd == 'c')
4432 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004433 else if (*cmd == 'n')
4434 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 else if (*cmd == 'e')
4436 do_error = !do_error;
4437 else if (*cmd == 'r') /* use last used regexp */
4438 which_pat = RE_LAST;
4439 else if (*cmd == 'p')
4440 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004441 else if (*cmd == '#')
4442 {
4443 do_print = TRUE;
4444 do_number = TRUE;
4445 }
4446 else if (*cmd == 'l')
4447 {
4448 do_print = TRUE;
4449 do_list = TRUE;
4450 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 else if (*cmd == 'i') /* ignore case */
4452 do_ic = 'i';
4453 else if (*cmd == 'I') /* don't ignore case */
4454 do_ic = 'I';
4455 else
4456 break;
4457 ++cmd;
4458 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004459 if (do_count)
4460 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461
4462 /*
4463 * check for a trailing count
4464 */
4465 cmd = skipwhite(cmd);
4466 if (VIM_ISDIGIT(*cmd))
4467 {
4468 i = getdigits(&cmd);
4469 if (i <= 0 && !eap->skip && do_error)
4470 {
4471 EMSG(_(e_zerocount));
4472 return;
4473 }
4474 eap->line1 = eap->line2;
4475 eap->line2 += i - 1;
4476 if (eap->line2 > curbuf->b_ml.ml_line_count)
4477 eap->line2 = curbuf->b_ml.ml_line_count;
4478 }
4479
4480 /*
4481 * check for trailing command or garbage
4482 */
4483 cmd = skipwhite(cmd);
4484 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4485 {
4486 eap->nextcmd = check_nextcmd(cmd);
4487 if (eap->nextcmd == NULL)
4488 {
4489 EMSG(_(e_trailing));
4490 return;
4491 }
4492 }
4493
4494 if (eap->skip) /* not executing commands, only parsing */
4495 return;
4496
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004497 if (!do_count && !curbuf->b_p_ma)
4498 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004499 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004500 EMSG(_(e_modifiable));
4501 return;
4502 }
4503
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4505 {
4506 if (do_error)
4507 EMSG(_(e_invcmd));
4508 return;
4509 }
4510
4511 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4512 if (do_ic == 'i')
4513 regmatch.rmm_ic = TRUE;
4514 else if (do_ic == 'I')
4515 regmatch.rmm_ic = FALSE;
4516
4517 sub_firstline = NULL;
4518
4519 /*
4520 * ~ in the substitute pattern is replaced with the old pattern.
4521 * We do it here once to avoid it to be replaced over and over again.
4522 * But don't do it when it starts with "\=", then it's an expression.
4523 */
4524 if (!(sub[0] == '\\' && sub[1] == '='))
4525 sub = regtilde(sub, p_magic);
4526
4527 /*
4528 * Check for a match on each line.
4529 */
4530 line2 = eap->line2;
4531 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4532#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4533 || aborting()
4534#endif
4535 ); ++lnum)
4536 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004537 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4538 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 if (nmatch)
4540 {
4541 colnr_T copycol;
4542 colnr_T matchcol;
4543 colnr_T prev_matchcol = MAXCOL;
4544 char_u *new_end, *new_start = NULL;
4545 unsigned new_start_len = 0;
4546 char_u *p1;
4547 int did_sub = FALSE;
4548 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004549 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 long nmatch_tl = 0; /* nr of lines matched below lnum */
4551 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004552 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004553 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554
4555 /*
4556 * The new text is build up step by step, to avoid too much
4557 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004558 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 * copycol Column in the old text where we started
4560 * looking for a match; from here old text still
4561 * needs to be copied to the new text.
4562 * matchcol Column number of the old text where to look
4563 * for the next match. It's just after the
4564 * previous match or one further.
4565 * prev_matchcol Column just after the previous match (if any).
4566 * Mostly equal to matchcol, except for the first
4567 * match and after skipping an empty match.
4568 * regmatch.*pos Where the pattern matched in the old text.
4569 * new_start The new text, all that has been produced so
4570 * far.
4571 * new_end The new text, where to append new text.
4572 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004573 * lnum The line number where we found the start of
4574 * the match. Can be below the line we searched
4575 * when there is a \n before a \zs in the
4576 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 * sub_firstlnum The line number in the buffer where to look
4578 * for a match. Can be different from "lnum"
4579 * when the pattern or substitute string contains
4580 * line breaks.
4581 *
4582 * Special situations:
4583 * - When the substitute string contains a line break, the part up
4584 * to the line break is inserted in the text, but the copy of
4585 * the original line is kept. "sub_firstlnum" is adjusted for
4586 * the inserted lines.
4587 * - When the matched pattern contains a line break, the old line
4588 * is taken from the line at the end of the pattern. The lines
4589 * in the match are deleted later, "sub_firstlnum" is adjusted
4590 * accordingly.
4591 *
4592 * The new text is built up in new_start[]. It has some extra
4593 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004594 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 *
4596 * Make a copy of the old line, so it won't be taken away when
4597 * updating the screen or handling a multi-line match. The "old_"
4598 * pointers point into this copy.
4599 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004600 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 copycol = 0;
4602 matchcol = 0;
4603
4604 /* At first match, remember current cursor position. */
4605 if (!got_match)
4606 {
4607 setpcmark();
4608 got_match = TRUE;
4609 }
4610
4611 /*
4612 * Loop until nothing more to replace in this line.
4613 * 1. Handle match with empty string.
4614 * 2. If do_ask is set, ask for confirmation.
4615 * 3. substitute the string.
4616 * 4. if do_all is set, find next match
4617 * 5. break if there isn't another match in this line
4618 */
4619 for (;;)
4620 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004621 /* Advance "lnum" to the line where the match starts. The
4622 * match does not start in the first line when there is a line
4623 * break before \zs. */
4624 if (regmatch.startpos[0].lnum > 0)
4625 {
4626 lnum += regmatch.startpos[0].lnum;
4627 sub_firstlnum += regmatch.startpos[0].lnum;
4628 nmatch -= regmatch.startpos[0].lnum;
4629 vim_free(sub_firstline);
4630 sub_firstline = NULL;
4631 }
4632
4633 if (sub_firstline == NULL)
4634 {
4635 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4636 if (sub_firstline == NULL)
4637 {
4638 vim_free(new_start);
4639 goto outofmem;
4640 }
4641 }
4642
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 /* Save the line number of the last change for the final
4644 * cursor position (just like Vi). */
4645 curwin->w_cursor.lnum = lnum;
4646 do_again = FALSE;
4647
4648 /*
4649 * 1. Match empty string does not count, except for first
4650 * match. This reproduces the strange vi behaviour.
4651 * This also catches endless loops.
4652 */
4653 if (matchcol == prev_matchcol
4654 && regmatch.endpos[0].lnum == 0
4655 && matchcol == regmatch.endpos[0].col)
4656 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004657 if (sub_firstline[matchcol] == NUL)
4658 /* We already were at the end of the line. Don't look
4659 * for a match in this line again. */
4660 skip_match = TRUE;
4661 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004662 {
4663 /* search for a match at next column */
4664#ifdef FEAT_MBYTE
4665 if (has_mbyte)
4666 matchcol += mb_ptr2len(sub_firstline + matchcol);
4667 else
4668#endif
4669 ++matchcol;
4670 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 goto skip;
4672 }
4673
4674 /* Normally we continue searching for a match just after the
4675 * previous match. */
4676 matchcol = regmatch.endpos[0].col;
4677 prev_matchcol = matchcol;
4678
4679 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004680 * 2. If do_count is set only increase the counter.
4681 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004683 if (do_count)
4684 {
4685 /* For a multi-line match, put matchcol at the NUL at
4686 * the end of the line and set nmatch to one, so that
4687 * we continue looking for a match on the next line.
4688 * Avoids that ":s/\nB\@=//gc" get stuck. */
4689 if (nmatch > 1)
4690 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004691 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004692 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004693 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004694 }
4695 sub_nsubs++;
4696 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004697#ifdef FEAT_EVAL
4698 /* Skip the substitution, unless an expression is used,
4699 * then it is evaluated in the sandbox. */
4700 if (!(sub[0] == '\\' && sub[1] == '='))
4701#endif
4702 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004703 }
4704
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 if (do_ask)
4706 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004707 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004708
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 /* change State to CONFIRM, so that the mouse works
4710 * properly */
4711 save_State = State;
4712 State = CONFIRM;
4713#ifdef FEAT_MOUSE
4714 setmouse(); /* disable mouse in xterm */
4715#endif
4716 curwin->w_cursor.col = regmatch.startpos[0].col;
4717
4718 /* When 'cpoptions' contains "u" don't sync undo when
4719 * asking for confirmation. */
4720 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4721 ++no_u_sync;
4722
4723 /*
4724 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4725 */
4726 while (do_ask)
4727 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004728 if (exmode_active)
4729 {
4730 char_u *resp;
4731 colnr_T sc, ec;
4732
4733 print_line_no_prefix(lnum, FALSE, FALSE);
4734
4735 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4736 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4737 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4738 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004739 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004740 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004741 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004742 msg_putchar('^');
4743
4744 resp = getexmodeline('?', NULL, 0);
4745 if (resp != NULL)
4746 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004747 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004748 vim_free(resp);
4749 }
4750 }
4751 else
4752 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004753 char_u *orig_line = NULL;
4754 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004756 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004758 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004760 /* Invert the matched string.
4761 * Remove the inversion afterwards. */
4762 temp = RedrawingDisabled;
4763 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004765 if (new_start != NULL)
4766 {
4767 /* There already was a substitution, we would
4768 * like to show this to the user. We cannot
4769 * really update the line, it would change
4770 * what matches. Temporarily replace the line
4771 * and change it back afterwards. */
4772 orig_line = vim_strsave(ml_get(lnum));
4773 if (orig_line != NULL)
4774 {
4775 char_u *new_line = concat_str(new_start,
4776 sub_firstline + copycol);
4777
4778 if (new_line == NULL)
4779 {
4780 vim_free(orig_line);
4781 orig_line = NULL;
4782 }
4783 else
4784 {
4785 /* Position the cursor relative to the
4786 * end of the line, the previous
4787 * substitute may have inserted or
4788 * deleted characters before the
4789 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004790 len_change = (int)STRLEN(new_line)
4791 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004792 curwin->w_cursor.col += len_change;
4793 ml_replace(lnum, new_line, FALSE);
4794 }
4795 }
4796 }
4797
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004798 search_match_lines = regmatch.endpos[0].lnum
4799 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004800 search_match_endcol = regmatch.endpos[0].col
4801 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004802 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004804 update_topline();
4805 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004806 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004807 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004808 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809
4810#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004811 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004813 if (msg_row == Rows - 1)
4814 msg_didout = FALSE; /* avoid a scroll-up */
4815 msg_starthere();
4816 i = msg_scroll;
4817 msg_scroll = 0; /* truncate msg when
4818 needed */
4819 msg_no_more = TRUE;
4820 /* write message same highlighting as for
4821 * wait_return */
4822 smsg_attr(hl_attr(HLF_R),
4823 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4824 msg_no_more = FALSE;
4825 msg_scroll = i;
4826 showruler(TRUE);
4827 windgoto(msg_row, msg_col);
4828 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829
4830#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004831 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004833 ++no_mapping; /* don't map this key */
4834 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004835 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004836 --allow_keys;
4837 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004839 /* clear the question */
4840 msg_didout = FALSE; /* don't scroll up */
4841 msg_col = 0;
4842 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004843
4844 /* restore the line */
4845 if (orig_line != NULL)
4846 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004847 }
4848
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004850 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004852 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853#endif
4854 )
4855 {
4856 got_quit = TRUE;
4857 break;
4858 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004859 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004861 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004863 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 {
4865 /* last: replace and then stop */
4866 do_all = FALSE;
4867 line2 = lnum;
4868 break;
4869 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004870 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 {
4872 do_ask = FALSE;
4873 break;
4874 }
4875#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004876 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004878 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 scrolldown_clamp();
4880#endif
4881 }
4882 State = save_State;
4883#ifdef FEAT_MOUSE
4884 setmouse();
4885#endif
4886 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4887 --no_u_sync;
4888
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004889 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 {
4891 /* For a multi-line match, put matchcol at the NUL at
4892 * the end of the line and set nmatch to one, so that
4893 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004894 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4895 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 if (nmatch > 1)
4897 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004898 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004899 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 }
4901 goto skip;
4902 }
4903 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004904 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 }
4906
4907 /* Move the cursor to the start of the match, so that we can
4908 * use "\=col("."). */
4909 curwin->w_cursor.col = regmatch.startpos[0].col;
4910
4911 /*
4912 * 3. substitute the string.
4913 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004914#ifdef FEAT_EVAL
4915 if (do_count)
4916 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004917 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004918 save_ma = curbuf->b_p_ma;
4919 curbuf->b_p_ma = FALSE;
4920 sandbox++;
4921 }
4922#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004924 sublen = vim_regsub_multi(&regmatch,
4925 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004927#ifdef FEAT_EVAL
4928 if (do_count)
4929 {
4930 curbuf->b_p_ma = save_ma;
4931 sandbox--;
4932 goto skip;
4933 }
4934#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935
Bram Moolenaar4463f292005-09-25 22:20:24 +00004936 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004937 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004938 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4939 {
4940 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4941 skip_match = TRUE;
4942 }
4943
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 /* Need room for:
4945 * - result so far in new_start (not for first sub in line)
4946 * - original text up to match
4947 * - length of substituted part
4948 * - original text after match
4949 */
4950 if (nmatch == 1)
4951 p1 = sub_firstline;
4952 else
4953 {
4954 p1 = ml_get(sub_firstlnum + nmatch - 1);
4955 nmatch_tl += nmatch - 1;
4956 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004957 copy_len = regmatch.startpos[0].col - copycol;
4958 needed_len = copy_len + ((unsigned)STRLEN(p1)
4959 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 if (new_start == NULL)
4961 {
4962 /*
4963 * Get some space for a temporary buffer to do the
4964 * substitution into (and some extra space to avoid
4965 * too many calls to alloc()/free()).
4966 */
4967 new_start_len = needed_len + 50;
4968 if ((new_start = alloc_check(new_start_len)) == NULL)
4969 goto outofmem;
4970 *new_start = NUL;
4971 new_end = new_start;
4972 }
4973 else
4974 {
4975 /*
4976 * Check if the temporary buffer is long enough to do the
4977 * substitution into. If not, make it larger (with a bit
4978 * extra to avoid too many calls to alloc()/free()).
4979 */
4980 len = (unsigned)STRLEN(new_start);
4981 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004982 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 {
4984 new_start_len = needed_len + 50;
4985 if ((p1 = alloc_check(new_start_len)) == NULL)
4986 {
4987 vim_free(new_start);
4988 goto outofmem;
4989 }
4990 mch_memmove(p1, new_start, (size_t)(len + 1));
4991 vim_free(new_start);
4992 new_start = p1;
4993 }
4994 new_end = new_start + len;
4995 }
4996
4997 /*
4998 * copy the text up to the part that matched
4999 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005000 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
5001 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005003 (void)vim_regsub_multi(&regmatch,
5004 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 sub, new_end, TRUE, p_magic, TRUE);
5006 sub_nsubs++;
5007 did_sub = TRUE;
5008
5009 /* Move the cursor to the start of the line, to avoid that it
5010 * is beyond the end of the line after the substitution. */
5011 curwin->w_cursor.col = 0;
5012
5013 /* For a multi-line match, make a copy of the last matched
5014 * line and continue in that one. */
5015 if (nmatch > 1)
5016 {
5017 sub_firstlnum += nmatch - 1;
5018 vim_free(sub_firstline);
5019 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5020 /* When going beyond the last line, stop substituting. */
5021 if (sub_firstlnum <= line2)
5022 do_again = TRUE;
5023 else
5024 do_all = FALSE;
5025 }
5026
5027 /* Remember next character to be copied. */
5028 copycol = regmatch.endpos[0].col;
5029
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005030 if (skip_match)
5031 {
5032 /* Already hit end of the buffer, sub_firstlnum is one
5033 * less than what it ought to be. */
5034 vim_free(sub_firstline);
5035 sub_firstline = vim_strsave((char_u *)"");
5036 copycol = 0;
5037 }
5038
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 /*
5040 * Now the trick is to replace CTRL-M chars with a real line
5041 * break. This would make it impossible to insert a CTRL-M in
5042 * the text. The line break can be avoided by preceding the
5043 * CTRL-M with a backslash. To be able to insert a backslash,
5044 * they must be doubled in the string and are halved here.
5045 * That is Vi compatible.
5046 */
5047 for (p1 = new_end; *p1; ++p1)
5048 {
5049 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005050 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 else if (*p1 == CAR)
5052 {
5053 if (u_inssub(lnum) == OK) /* prepare for undo */
5054 {
5055 *p1 = NUL; /* truncate up to the CR */
5056 ml_append(lnum - 1, new_start,
5057 (colnr_T)(p1 - new_start + 1), FALSE);
5058 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
5059 if (do_ask)
5060 appended_lines(lnum - 1, 1L);
5061 else
5062 {
5063 if (first_line == 0)
5064 first_line = lnum;
5065 last_line = lnum + 1;
5066 }
5067 /* All line numbers increase. */
5068 ++sub_firstlnum;
5069 ++lnum;
5070 ++line2;
5071 /* move the cursor to the new line, like Vi */
5072 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005073 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005074 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 p1 = new_start - 1;
5076 }
5077 }
5078#ifdef FEAT_MBYTE
5079 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005080 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081#endif
5082 }
5083
5084 /*
5085 * 4. If do_all is set, find next match.
5086 * Prevent endless loop with patterns that match empty
5087 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5088 * But ":s/\n/#/" is OK.
5089 */
5090skip:
5091 /* We already know that we did the last subst when we are at
5092 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005093 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5094 * "line2" when there is a \zs in the pattern after a line
5095 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005096 lastone = (skip_match
5097 || got_int
5098 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005099 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005100 || !(do_all || do_again)
5101 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5102 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 nmatch = -1;
5104
5105 /*
5106 * Replace the line in the buffer when needed. This is
5107 * skipped when there are more matches.
5108 * The check for nmatch_tl is needed for when multi-line
5109 * matching must replace the lines before trying to do another
5110 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005111 * When the match starts below where we start searching also
5112 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 */
5114 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 || nmatch_tl > 0
5116 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005117 curbuf, sub_firstlnum,
5118 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005119 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 {
5121 if (new_start != NULL)
5122 {
5123 /*
5124 * Copy the rest of the line, that didn't match.
5125 * "matchcol" has to be adjusted, we use the end of
5126 * the line as reference, because the substitute may
5127 * have changed the number of characters. Same for
5128 * "prev_matchcol".
5129 */
5130 STRCAT(new_start, sub_firstline + copycol);
5131 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5132 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5133 - prev_matchcol;
5134
5135 if (u_savesub(lnum) != OK)
5136 break;
5137 ml_replace(lnum, new_start, TRUE);
5138
5139 if (nmatch_tl > 0)
5140 {
5141 /*
5142 * Matched lines have now been substituted and are
5143 * useless, delete them. The part after the match
5144 * has been appended to new_start, we don't need
5145 * it in the buffer.
5146 */
5147 ++lnum;
5148 if (u_savedel(lnum, nmatch_tl) != OK)
5149 break;
5150 for (i = 0; i < nmatch_tl; ++i)
5151 ml_delete(lnum, (int)FALSE);
5152 mark_adjust(lnum, lnum + nmatch_tl - 1,
5153 (long)MAXLNUM, -nmatch_tl);
5154 if (do_ask)
5155 deleted_lines(lnum, nmatch_tl);
5156 --lnum;
5157 line2 -= nmatch_tl; /* nr of lines decreases */
5158 nmatch_tl = 0;
5159 }
5160
5161 /* When asking, undo is saved each time, must also set
5162 * changed flag each time. */
5163 if (do_ask)
5164 changed_bytes(lnum, 0);
5165 else
5166 {
5167 if (first_line == 0)
5168 first_line = lnum;
5169 last_line = lnum + 1;
5170 }
5171
5172 sub_firstlnum = lnum;
5173 vim_free(sub_firstline); /* free the temp buffer */
5174 sub_firstline = new_start;
5175 new_start = NULL;
5176 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5177 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5178 - prev_matchcol;
5179 copycol = 0;
5180 }
5181 if (nmatch == -1 && !lastone)
5182 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005183 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184
5185 /*
5186 * 5. break if there isn't another match in this line
5187 */
5188 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005189 {
5190 /* If the match found didn't start where we were
5191 * searching, do the next search in the line where we
5192 * found the match. */
5193 if (nmatch == -1)
5194 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005196 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 }
5198
5199 line_breakcheck();
5200 }
5201
5202 if (did_sub)
5203 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005204 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 vim_free(sub_firstline); /* free the copy of the original line */
5206 sub_firstline = NULL;
5207 }
5208
5209 line_breakcheck();
5210 }
5211
5212 if (first_line != 0)
5213 {
5214 /* Need to subtract the number of added lines from "last_line" to get
5215 * the line number before the change (same as adding the number of
5216 * deleted lines). */
5217 i = curbuf->b_ml.ml_line_count - old_line_count;
5218 changed_lines(first_line, 0, last_line - i, i);
5219 }
5220
5221outofmem:
5222 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005223
5224 /* ":s/pat//n" doesn't move the cursor */
5225 if (do_count)
5226 curwin->w_cursor = old_cursor;
5227
Bram Moolenaar46475522010-03-23 17:36:29 +01005228 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 {
5230 /* Set the '[ and '] marks. */
5231 curbuf->b_op_start.lnum = eap->line1;
5232 curbuf->b_op_end.lnum = line2;
5233 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5234
5235 if (!global_busy)
5236 {
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005237 if (!do_ask) /* when interactive leave cursor on the match */
5238 {
5239 if (endcolumn)
5240 coladvance((colnr_T)MAXCOL);
5241 else
5242 beginline(BL_WHITE | BL_FIX);
5243 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005244 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 MSG("");
5246 }
5247 else
5248 global_need_beginline = TRUE;
5249 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005250 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 }
5252 else if (!global_busy)
5253 {
5254 if (got_int) /* interrupted */
5255 EMSG(_(e_interr));
5256 else if (got_match) /* did find something but nothing substituted */
5257 MSG("");
5258 else if (do_error) /* nothing found */
5259 EMSG2(_(e_patnotf2), get_search_pat());
5260 }
5261
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005262#ifdef FEAT_FOLDING
5263 if (do_ask && hasAnyFolding(curwin))
5264 /* Cursor position may require updating */
5265 changed_window_setting();
5266#endif
5267
Bram Moolenaar473de612013-06-08 18:19:48 +02005268 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269}
5270
5271/*
5272 * Give message for number of substitutions.
5273 * Can also be used after a ":global" command.
5274 * Return TRUE if a message was given.
5275 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005276 int
Bram Moolenaar05159a02005-02-26 23:04:13 +00005277do_sub_msg(count_only)
5278 int count_only; /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279{
5280 /*
5281 * Only report substitutions when:
5282 * - more than 'report' substitutions
5283 * - command was typed by user, or number of changed lines > 'report'
5284 * - giving messages is not disabled by 'lazyredraw'
5285 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005286 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5287 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 && messaging())
5289 {
5290 if (got_int)
5291 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005292 else
5293 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005295 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005296 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005298 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005299 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 sub_nsubs);
5301 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005302 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005303 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005305 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005306 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005309 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 return TRUE;
5311 }
5312 if (got_int)
5313 {
5314 EMSG(_(e_interr));
5315 return TRUE;
5316 }
5317 return FALSE;
5318}
5319
5320/*
5321 * Execute a global command of the form:
5322 *
5323 * g/pattern/X : execute X on all lines where pattern matches
5324 * v/pattern/X : execute X on all lines where pattern does not match
5325 *
5326 * where 'X' is an EX command
5327 *
5328 * The command character (as well as the trailing slash) is optional, and
5329 * is assumed to be 'p' if missing.
5330 *
5331 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005332 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 * for each line that has a mark. This is required because after deleting
5334 * lines we do not know where to search for the next match.
5335 */
5336 void
5337ex_global(eap)
5338 exarg_T *eap;
5339{
5340 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005341 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 int type; /* first char of cmd: 'v' or 'g' */
5343 char_u *cmd; /* command argument */
5344
5345 char_u delim; /* delimiter, normally '/' */
5346 char_u *pat;
5347 regmmatch_T regmatch;
5348 int match;
5349 int which_pat;
5350
5351 if (global_busy)
5352 {
5353 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5354 return;
5355 }
5356
5357 if (eap->forceit) /* ":global!" is like ":vglobal" */
5358 type = 'v';
5359 else
5360 type = *eap->cmd;
5361 cmd = eap->arg;
5362 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363
5364 /*
5365 * undocumented vi feature:
5366 * "\/" and "\?": use previous search pattern.
5367 * "\&": use previous substitute pattern.
5368 */
5369 if (*cmd == '\\')
5370 {
5371 ++cmd;
5372 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5373 {
5374 EMSG(_(e_backslash));
5375 return;
5376 }
5377 if (*cmd == '&')
5378 which_pat = RE_SUBST; /* use previous substitute pattern */
5379 else
5380 which_pat = RE_SEARCH; /* use previous search pattern */
5381 ++cmd;
5382 pat = (char_u *)"";
5383 }
5384 else if (*cmd == NUL)
5385 {
5386 EMSG(_("E148: Regular expression missing from global"));
5387 return;
5388 }
5389 else
5390 {
5391 delim = *cmd; /* get the delimiter */
5392 if (delim)
5393 ++cmd; /* skip delimiter if there is one */
5394 pat = cmd; /* remember start of pattern */
5395 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5396 if (cmd[0] == delim) /* end delimiter found */
5397 *cmd++ = NUL; /* replace it with a NUL */
5398 }
5399
5400#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5401 if (p_altkeymap && curwin->w_p_rl)
5402 lrFswap(pat,0);
5403#endif
5404
5405 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5406 {
5407 EMSG(_(e_invcmd));
5408 return;
5409 }
5410
5411 /*
5412 * pass 1: set marks for each (not) matching line
5413 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5415 {
5416 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005417 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5418 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 if ((type == 'g' && match) || (type == 'v' && !match))
5420 {
5421 ml_setmarked(lnum);
5422 ndone++;
5423 }
5424 line_breakcheck();
5425 }
5426
5427 /*
5428 * pass 2: execute the command for each line that has been marked
5429 */
5430 if (got_int)
5431 MSG(_(e_interr));
5432 else if (ndone == 0)
5433 {
5434 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005435 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01005437 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 }
5439 else
5440 global_exe(cmd);
5441
5442 ml_clearmarked(); /* clear rest of the marks */
Bram Moolenaar473de612013-06-08 18:19:48 +02005443 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444}
5445
5446/*
5447 * Execute "cmd" on lines marked with ml_setmarked().
5448 */
5449 void
5450global_exe(cmd)
5451 char_u *cmd;
5452{
Bram Moolenaarbb993222011-05-10 16:00:47 +02005453 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5454 buf_T *old_buf = curbuf; /* remember what buffer we started in */
5455 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456
5457 /*
5458 * Set current position only once for a global command.
5459 * If global_busy is set, setpcmark() will not do anything.
5460 * If there is an error, global_busy will be incremented.
5461 */
5462 setpcmark();
5463
5464 /* When the command writes a message, don't overwrite the command. */
5465 msg_didout = TRUE;
5466
Bram Moolenaard25bc232010-03-23 17:49:24 +01005467 sub_nsubs = 0;
5468 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 global_need_beginline = FALSE;
5470 global_busy = 1;
5471 old_lcount = curbuf->b_ml.ml_line_count;
5472 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5473 {
5474 curwin->w_cursor.lnum = lnum;
5475 curwin->w_cursor.col = 0;
5476 if (*cmd == NUL || *cmd == '\n')
5477 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5478 else
5479 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5480 ui_breakcheck();
5481 }
5482
5483 global_busy = 0;
5484 if (global_need_beginline)
5485 beginline(BL_WHITE | BL_FIX);
5486 else
5487 check_cursor(); /* cursor may be beyond the end of the line */
5488
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005489 /* the cursor may not have moved in the text but a change in a previous
5490 * line may move it on the screen */
5491 changed_line_abv_curs();
5492
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 /* If it looks like no message was written, allow overwriting the
5494 * command with the report for number of changes. */
5495 if (msg_col == 0 && msg_scrolled == 0)
5496 msg_didout = FALSE;
5497
Bram Moolenaar45667512007-05-10 19:24:43 +00005498 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02005499 * number of extra or deleted lines.
5500 * Don't report extra or deleted lines in the edge case where the buffer
5501 * we are in after execution is different from the buffer we started in. */
5502 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5504}
5505
5506#ifdef FEAT_VIMINFO
5507 int
5508read_viminfo_sub_string(virp, force)
5509 vir_T *virp;
5510 int force;
5511{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01005512 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 vim_free(old_sub);
5514 if (force || old_sub == NULL)
5515 old_sub = viminfo_readstring(virp, 1, TRUE);
5516 return viminfo_readline(virp);
5517}
5518
5519 void
5520write_viminfo_sub_string(fp)
5521 FILE *fp;
5522{
5523 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5524 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02005525 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 viminfo_writestring(fp, old_sub);
5527 }
5528}
5529#endif /* FEAT_VIMINFO */
5530
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005531#if defined(EXITFREE) || defined(PROTO)
5532 void
5533free_old_sub()
5534{
5535 vim_free(old_sub);
5536}
5537#endif
5538
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5540/*
5541 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005542 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005544 int
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005545prepare_tagpreview(undo_sync)
5546 int undo_sync; /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547{
5548 win_T *wp;
5549
5550# ifdef FEAT_GUI
5551 need_mouse_correct = TRUE;
5552# endif
5553
5554 /*
5555 * If there is already a preview window open, use that one.
5556 */
5557 if (!curwin->w_p_pvw)
5558 {
5559 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5560 if (wp->w_p_pvw)
5561 break;
5562 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005563 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 else
5565 {
5566 /*
5567 * There is no preview window open yet. Create one.
5568 */
5569 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5570 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005571 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 curwin->w_p_pvw = TRUE;
5573 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02005574 RESET_BINDING(curwin); /* don't take over 'scrollbind'
5575 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576# ifdef FEAT_DIFF
5577 curwin->w_p_diff = FALSE; /* no 'diff' */
5578# endif
5579# ifdef FEAT_FOLDING
5580 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5581# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005582 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 }
5584 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005585 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586}
5587
5588#endif
5589
5590
5591/*
5592 * ":help": open a read-only window on a help file
5593 */
5594 void
5595ex_help(eap)
5596 exarg_T *eap;
5597{
5598 char_u *arg;
5599 char_u *tag;
5600 FILE *helpfd; /* file descriptor of help file */
5601 int n;
5602 int i;
5603#ifdef FEAT_WINDOWS
5604 win_T *wp;
5605#endif
5606 int num_matches;
5607 char_u **matches;
5608 char_u *p;
5609 int empty_fnum = 0;
5610 int alt_fnum = 0;
5611 buf_T *buf;
5612#ifdef FEAT_MULTI_LANG
5613 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005614 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005616#ifdef FEAT_FOLDING
5617 int old_KeyTyped = KeyTyped;
5618#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619
5620 if (eap != NULL)
5621 {
5622 /*
5623 * A ":help" command ends at the first LF, or at a '|' that is
5624 * followed by some text. Set nextcmd to the following command.
5625 */
5626 for (arg = eap->arg; *arg; ++arg)
5627 {
5628 if (*arg == '\n' || *arg == '\r'
5629 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5630 {
5631 *arg++ = NUL;
5632 eap->nextcmd = arg;
5633 break;
5634 }
5635 }
5636 arg = eap->arg;
5637
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005638 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 {
5640 EMSG(_("E478: Don't panic!"));
5641 return;
5642 }
5643
5644 if (eap->skip) /* not executing commands */
5645 return;
5646 }
5647 else
5648 arg = (char_u *)"";
5649
5650 /* remove trailing blanks */
5651 p = arg + STRLEN(arg) - 1;
5652 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5653 *p-- = NUL;
5654
5655#ifdef FEAT_MULTI_LANG
5656 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005657 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658#endif
5659
5660 /* When no argument given go to the index. */
5661 if (*arg == NUL)
5662 arg = (char_u *)"help.txt";
5663
5664 /*
5665 * Check if there is a match for the argument.
5666 */
5667 n = find_help_tags(arg, &num_matches, &matches,
5668 eap != NULL && eap->forceit);
5669
5670 i = 0;
5671#ifdef FEAT_MULTI_LANG
5672 if (n != FAIL && lang != NULL)
5673 /* Find first item with the requested language. */
5674 for (i = 0; i < num_matches; ++i)
5675 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005676 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 if (len > 3 && matches[i][len - 3] == '@'
5678 && STRICMP(matches[i] + len - 2, lang) == 0)
5679 break;
5680 }
5681#endif
5682 if (i >= num_matches || n == FAIL)
5683 {
5684#ifdef FEAT_MULTI_LANG
5685 if (lang != NULL)
5686 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5687 else
5688#endif
5689 EMSG2(_("E149: Sorry, no help for %s"), arg);
5690 if (n != FAIL)
5691 FreeWild(num_matches, matches);
5692 return;
5693 }
5694
5695 /* The first match (in the requested language) is the best match. */
5696 tag = vim_strsave(matches[i]);
5697 FreeWild(num_matches, matches);
5698
5699#ifdef FEAT_GUI
5700 need_mouse_correct = TRUE;
5701#endif
5702
5703 /*
5704 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005705 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005707 if (!curwin->w_buffer->b_help
5708#ifdef FEAT_WINDOWS
5709 || cmdmod.tab != 0
5710#endif
5711 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 {
5713#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005714 if (cmdmod.tab != 0)
5715 wp = NULL;
5716 else
5717 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5718 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5719 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5721 win_enter(wp, TRUE);
5722 else
5723#endif
5724 {
5725 /*
5726 * There is no help window yet.
5727 * Try to open the file specified by the "helpfile" option.
5728 */
5729 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5730 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00005731 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 goto erret;
5733 }
5734 fclose(helpfd);
5735
5736#ifdef FEAT_WINDOWS
5737 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005738 * specified, the current window is vertically split and
5739 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 n = WSP_HELP;
5741# ifdef FEAT_VERTSPLIT
5742 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005743 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 n |= WSP_TOP;
5745# endif
5746 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005747 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748#else
5749 /* use current window */
5750 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005752#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753
5754#ifdef FEAT_WINDOWS
5755 if (curwin->w_height < p_hh)
5756 win_setheight((int)p_hh);
5757#endif
5758
5759 /*
5760 * Open help file (do_ecmd() will set b_help flag, readfile() will
5761 * set b_p_ro flag).
5762 * Set the alternate file to the previously edited file.
5763 */
5764 alt_fnum = curbuf->b_fnum;
5765 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005766 ECMD_HIDE + ECMD_SET_HELP,
5767#ifdef FEAT_WINDOWS
5768 NULL /* buffer is still open, don't store info */
5769#else
5770 curwin
5771#endif
5772 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005773 if (!cmdmod.keepalt)
5774 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 empty_fnum = curbuf->b_fnum;
5776 }
5777 }
5778
5779 if (!p_im)
5780 restart_edit = 0; /* don't want insert mode in help file */
5781
Bram Moolenaar8f535582011-09-30 17:30:31 +02005782#ifdef FEAT_FOLDING
5783 /* Restore KeyTyped, setting 'filetype=help' may reset it.
5784 * It is needed for do_tag top open folds under the cursor. */
5785 KeyTyped = old_KeyTyped;
5786#endif
5787
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 if (tag != NULL)
5789 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5790
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005791 /* Delete the empty buffer if we're not using it. Careful: autocommands
5792 * may have jumped to another window, check that the buffer is not in a
5793 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5795 {
5796 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005797 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 wipe_buffer(buf, TRUE);
5799 }
5800
5801 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005802 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 curwin->w_alt_fnum = alt_fnum;
5804
5805erret:
5806 vim_free(tag);
5807}
5808
5809
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005810#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5811/*
5812 * In an argument search for a language specifiers in the form "@xx".
5813 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5814 * Returns NULL if not found.
5815 */
5816 char_u *
5817check_help_lang(arg)
5818 char_u *arg;
5819{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005820 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005821
5822 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5823 && ASCII_ISALPHA(arg[len - 1]))
5824 {
5825 arg[len - 3] = NUL; /* remove the '@' */
5826 return arg + len - 2;
5827 }
5828 return NULL;
5829}
5830#endif
5831
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832/*
5833 * Return a heuristic indicating how well the given string matches. The
5834 * smaller the number, the better the match. This is the order of priorities,
5835 * from best match to worst match:
5836 * - Match with least alpha-numeric characters is better.
5837 * - Match with least total characters is better.
5838 * - Match towards the start is better.
5839 * - Match starting with "+" is worse (feature instead of command)
5840 * Assumption is made that the matched_string passed has already been found to
5841 * match some string for which help is requested. webb.
5842 */
5843 int
5844help_heuristic(matched_string, offset, wrong_case)
5845 char_u *matched_string;
5846 int offset; /* offset for match */
5847 int wrong_case; /* no matching case */
5848{
5849 int num_letters;
5850 char_u *p;
5851
5852 num_letters = 0;
5853 for (p = matched_string; *p; p++)
5854 if (ASCII_ISALNUM(*p))
5855 num_letters++;
5856
5857 /*
5858 * Multiply the number of letters by 100 to give it a much bigger
5859 * weighting than the number of characters.
5860 * If there only is a match while ignoring case, add 5000.
5861 * If the match starts in the middle of a word, add 10000 to put it
5862 * somewhere in the last half.
5863 * If the match is more than 2 chars from the start, multiply by 200 to
5864 * put it after matches at the start.
5865 */
5866 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5867 && ASCII_ISALNUM(matched_string[offset - 1]))
5868 offset += 10000;
5869 else if (offset > 2)
5870 offset *= 200;
5871 if (wrong_case)
5872 offset += 5000;
5873 /* Features are less interesting than the subjects themselves, but "+"
5874 * alone is not a feature. */
5875 if (matched_string[0] == '+' && matched_string[1] != NUL)
5876 offset += 100;
5877 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5878}
5879
5880/*
5881 * Compare functions for qsort() below, that checks the help heuristics number
5882 * that has been put after the tagname by find_tags().
5883 */
5884 static int
5885#ifdef __BORLANDC__
5886_RTLENTRYF
5887#endif
5888help_compare(s1, s2)
5889 const void *s1;
5890 const void *s2;
5891{
5892 char *p1;
5893 char *p2;
5894
5895 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5896 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5897 return strcmp(p1, p2);
5898}
5899
5900/*
5901 * Find all help tags matching "arg", sort them and return in matches[], with
5902 * the number of matches in num_matches.
5903 * The matches will be sorted with a "best" match algorithm.
5904 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5905 */
5906 int
5907find_help_tags(arg, num_matches, matches, keep_lang)
5908 char_u *arg;
5909 int *num_matches;
5910 char_u ***matches;
5911 int keep_lang;
5912{
5913 char_u *s, *d;
5914 int i;
5915 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005916 "/*", "/\\*", "\"*", "**",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005917 "cpo-*", "/\\(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005918 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005919 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 "[count]", "[quotex]", "[range]",
5921 "[pattern]", "\\|", "\\%$"};
5922 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005923 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005924 "cpo-star", "/\\\\(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005925 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005926 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 "\\[count]", "\\[quotex]", "\\[range]",
5928 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5929 int flags;
5930
5931 d = IObuff; /* assume IObuff is long enough! */
5932
5933 /*
5934 * Recognize a few exceptions to the rule. Some strings that contain '*'
5935 * with "star". Otherwise '*' is recognized as a wildcard.
5936 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005937 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 if (STRCMP(arg, mtable[i]) == 0)
5939 {
5940 STRCPY(d, rtable[i]);
5941 break;
5942 }
5943
5944 if (i < 0) /* no match in table */
5945 {
5946 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5947 * Also replace "\%^" and "\%(", they match every tag too.
5948 * Also "\zs", "\z1", etc.
5949 * Also "\@<", "\@=", "\@<=", etc.
5950 * And also "\_$" and "\_^". */
5951 if (arg[0] == '\\'
5952 && ((arg[1] != NUL && arg[2] == NUL)
5953 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5954 && arg[2] != NUL)))
5955 {
5956 STRCPY(d, "/\\\\");
5957 STRCPY(d + 3, arg + 1);
5958 /* Check for "/\\_$", should be "/\\_\$" */
5959 if (d[3] == '_' && d[4] == '$')
5960 STRCPY(d + 4, "\\$");
5961 }
5962 else
5963 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005964 /* Replace:
5965 * "[:...:]" with "\[:...:]"
5966 * "[++...]" with "\[++...]"
5967 * "\{" with "\\{"
5968 */
5969 if ((arg[0] == '[' && (arg[1] == ':'
5970 || (arg[1] == '+' && arg[2] == '+')))
5971 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 *d++ = '\\';
5973
5974 for (s = arg; *s; ++s)
5975 {
5976 /*
5977 * Replace "|" with "bar" and '"' with "quote" to match the name of
5978 * the tags for these commands.
5979 * Replace "*" with ".*" and "?" with "." to match command line
5980 * completion.
5981 * Insert a backslash before '~', '$' and '.' to avoid their
5982 * special meaning.
5983 */
5984 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5985 break;
5986 switch (*s)
5987 {
5988 case '|': STRCPY(d, "bar");
5989 d += 3;
5990 continue;
5991 case '"': STRCPY(d, "quote");
5992 d += 5;
5993 continue;
5994 case '*': *d++ = '.';
5995 break;
5996 case '?': *d++ = '.';
5997 continue;
5998 case '$':
5999 case '.':
6000 case '~': *d++ = '\\';
6001 break;
6002 }
6003
6004 /*
6005 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6006 * ":help i_^_CTRL-D" work.
6007 * Insert '-' before and after "CTRL-X" when applicable.
6008 */
6009 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6010 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6011 {
6012 if (d > IObuff && d[-1] != '_')
6013 *d++ = '_'; /* prepend a '_' */
6014 STRCPY(d, "CTRL-");
6015 d += 5;
6016 if (*s < ' ')
6017 {
6018#ifdef EBCDIC
6019 *d++ = CtrlChar(*s);
6020#else
6021 *d++ = *s + '@';
6022#endif
6023 if (d[-1] == '\\')
6024 *d++ = '\\'; /* double a backslash */
6025 }
6026 else
6027 *d++ = *++s;
6028 if (s[1] != NUL && s[1] != '_')
6029 *d++ = '_'; /* append a '_' */
6030 continue;
6031 }
6032 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6033 *d++ = '\\';
6034
6035 /*
6036 * Insert a backslash before a backslash after a slash, for search
6037 * pattern tags: "/\|" --> "/\\|".
6038 */
6039 else if (s[0] == '\\' && s[1] != '\\'
6040 && *arg == '/' && s == arg + 1)
6041 *d++ = '\\';
6042
6043 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6044 * "CTRL-\_CTRL-N" */
6045 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6046 {
6047 STRCPY(d, "CTRL-\\\\");
6048 d += 7;
6049 s += 6;
6050 }
6051
6052 *d++ = *s;
6053
6054 /*
6055 * If tag starts with ', toss everything after a second '. Fixes
6056 * CTRL-] on 'option'. (would include the trailing '.').
6057 */
6058 if (*s == '\'' && s > arg && *arg == '\'')
6059 break;
6060 }
6061 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006062
6063 if (*IObuff == '`')
6064 {
6065 if (d > IObuff + 2 && d[-1] == '`')
6066 {
6067 /* remove the backticks from `command` */
6068 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6069 d[-2] = NUL;
6070 }
6071 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6072 {
6073 /* remove the backticks and comma from `command`, */
6074 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6075 d[-3] = NUL;
6076 }
6077 else if (d > IObuff + 4 && d[-3] == '`'
6078 && d[-2] == '\\' && d[-1] == '.')
6079 {
6080 /* remove the backticks and dot from `command`\. */
6081 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6082 d[-4] = NUL;
6083 }
6084 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 }
6086 }
6087
6088 *matches = (char_u **)"";
6089 *num_matches = 0;
6090 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6091 if (keep_lang)
6092 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006093 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006095 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 /* Sort the matches found on the heuristic number that is after the
6097 * tag name. */
6098 qsort((void *)*matches, (size_t)*num_matches,
6099 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006100 /* Delete more than TAG_MANY to reduce the size of the listing. */
6101 while (*num_matches > TAG_MANY)
6102 vim_free((*matches)[--*num_matches]);
6103 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 return OK;
6105}
6106
6107/*
6108 * After reading a help file: May cleanup a help buffer when syntax
6109 * highlighting is not used.
6110 */
6111 void
6112fix_help_buffer()
6113{
6114 linenr_T lnum;
6115 char_u *line;
6116 int in_example = FALSE;
6117 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006118 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 char_u *p;
6120 char_u *rt;
6121 int mustfree;
6122
6123 /* set filetype to "help". */
6124 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6125
6126#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006127 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128#endif
6129 {
6130 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6131 {
6132 line = ml_get_buf(curbuf, lnum, FALSE);
6133 len = (int)STRLEN(line);
6134 if (in_example && len > 0 && !vim_iswhite(line[0]))
6135 {
6136 /* End of example: non-white or '<' in first column. */
6137 if (line[0] == '<')
6138 {
6139 /* blank-out a '<' in the first column */
6140 line = ml_get_buf(curbuf, lnum, TRUE);
6141 line[0] = ' ';
6142 }
6143 in_example = FALSE;
6144 }
6145 if (!in_example && len > 0)
6146 {
6147 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6148 {
6149 /* blank-out a '>' in the last column (start of example) */
6150 line = ml_get_buf(curbuf, lnum, TRUE);
6151 line[len - 1] = ' ';
6152 in_example = TRUE;
6153 }
6154 else if (line[len - 1] == '~')
6155 {
6156 /* blank-out a '~' at the end of line (header marker) */
6157 line = ml_get_buf(curbuf, lnum, TRUE);
6158 line[len - 1] = ' ';
6159 }
6160 }
6161 }
6162 }
6163
6164 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006165 * In the "help.txt" and "help.abx" file, add the locally added help
6166 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006168 fname = gettail(curbuf->b_fname);
6169 if (fnamecmp(fname, "help.txt") == 0
6170#ifdef FEAT_MULTI_LANG
6171 || (fnamencmp(fname, "help.", 5) == 0
6172 && ASCII_ISALPHA(fname[5])
6173 && ASCII_ISALPHA(fname[6])
6174 && TOLOWER_ASC(fname[7]) == 'x'
6175 && fname[8] == NUL)
6176#endif
6177 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 {
6179 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6180 {
6181 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006182 if (strstr((char *)line, "*local-additions*") == NULL)
6183 continue;
6184
6185 /* Go through all directories in 'runtimepath', skipping
6186 * $VIMRUNTIME. */
6187 p = p_rtp;
6188 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006190 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6191 mustfree = FALSE;
6192 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6193 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006195 int fcount;
6196 char_u **fnames;
6197 FILE *fd;
6198 char_u *s;
6199 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006201 vimconv_T vc;
6202 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203#endif
6204
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006205 /* Find all "doc/ *.txt" files in this directory. */
6206 add_pathsep(NameBuff);
6207#ifdef FEAT_MULTI_LANG
6208 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006210 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006212 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6213 &fnames, EW_FILE|EW_SILENT) == OK
6214 && fcount > 0)
6215 {
6216#ifdef FEAT_MULTI_LANG
6217 int i1;
6218 int i2;
6219 char_u *f1;
6220 char_u *f2;
6221 char_u *t1;
6222 char_u *e1;
6223 char_u *e2;
6224
6225 /* If foo.abx is found use it instead of foo.txt in
6226 * the same directory. */
6227 for (i1 = 0; i1 < fcount; ++i1)
6228 {
6229 for (i2 = 0; i2 < fcount; ++i2)
6230 {
6231 if (i1 == i2)
6232 continue;
6233 if (fnames[i1] == NULL || fnames[i2] == NULL)
6234 continue;
6235 f1 = fnames[i1];
6236 f2 = fnames[i2];
6237 t1 = gettail(f1);
6238 if (fnamencmp(f1, f2, t1 - f1) != 0)
6239 continue;
6240 e1 = vim_strrchr(t1, '.');
6241 e2 = vim_strrchr(gettail(f2), '.');
6242 if (e1 == NUL || e2 == NUL)
6243 continue;
6244 if (fnamecmp(e1, ".txt") != 0
6245 && fnamecmp(e1, fname + 4) != 0)
6246 {
6247 /* Not .txt and not .abx, remove it. */
6248 vim_free(fnames[i1]);
6249 fnames[i1] = NULL;
6250 continue;
6251 }
6252 if (fnamencmp(f1, f2, e1 - f1) != 0)
6253 continue;
6254 if (fnamecmp(e1, ".txt") == 0
6255 && fnamecmp(e2, fname + 4) == 0)
6256 {
6257 /* use .abx instead of .txt */
6258 vim_free(fnames[i1]);
6259 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 }
6261 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006263#endif
6264 for (fi = 0; fi < fcount; ++fi)
6265 {
6266 if (fnames[fi] == NULL)
6267 continue;
6268 fd = mch_fopen((char *)fnames[fi], "r");
6269 if (fd != NULL)
6270 {
6271 vim_fgets(IObuff, IOSIZE, fd);
6272 if (IObuff[0] == '*'
6273 && (s = vim_strchr(IObuff + 1, '*'))
6274 != NULL)
6275 {
6276#ifdef FEAT_MBYTE
6277 int this_utf = MAYBE;
6278#endif
6279 /* Change tag definition to a
6280 * reference and remove <CR>/<NL>. */
6281 IObuff[0] = '|';
6282 *s = '|';
6283 while (*s != NUL)
6284 {
6285 if (*s == '\r' || *s == '\n')
6286 *s = NUL;
6287#ifdef FEAT_MBYTE
6288 /* The text is utf-8 when a byte
6289 * above 127 is found and no
6290 * illegal byte sequence is found.
6291 */
6292 if (*s >= 0x80 && this_utf != FALSE)
6293 {
6294 int l;
6295
6296 this_utf = TRUE;
6297 l = utf_ptr2len(s);
6298 if (l == 1)
6299 this_utf = FALSE;
6300 s += l - 1;
6301 }
6302#endif
6303 ++s;
6304 }
6305#ifdef FEAT_MBYTE
6306 /* The help file is latin1 or utf-8;
6307 * conversion to the current
6308 * 'encoding' may be required. */
6309 vc.vc_type = CONV_NONE;
6310 convert_setup(&vc, (char_u *)(
6311 this_utf == TRUE ? "utf-8"
6312 : "latin1"), p_enc);
6313 if (vc.vc_type == CONV_NONE)
6314 /* No conversion needed. */
6315 cp = IObuff;
6316 else
6317 {
6318 /* Do the conversion. If it fails
6319 * use the unconverted text. */
6320 cp = string_convert(&vc, IObuff,
6321 NULL);
6322 if (cp == NULL)
6323 cp = IObuff;
6324 }
6325 convert_setup(&vc, NULL, NULL);
6326
6327 ml_append(lnum, cp, (colnr_T)0, FALSE);
6328 if (cp != IObuff)
6329 vim_free(cp);
6330#else
6331 ml_append(lnum, IObuff, (colnr_T)0,
6332 FALSE);
6333#endif
6334 ++lnum;
6335 }
6336 fclose(fd);
6337 }
6338 }
6339 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006342 if (mustfree)
6343 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006345 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 }
6347 }
6348}
6349
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006350/*
6351 * ":exusage"
6352 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006353 void
6354ex_exusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006355 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006356{
6357 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6358}
6359
6360/*
6361 * ":viusage"
6362 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006363 void
6364ex_viusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006365 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006366{
6367 do_cmdline_cmd((char_u *)"help normal-index");
6368}
6369
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370#if defined(FEAT_EX_EXTRA) || defined(PROTO)
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006371static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372
6373/*
6374 * ":helptags"
6375 */
6376 void
6377ex_helptags(eap)
6378 exarg_T *eap;
6379{
6380 garray_T ga;
6381 int i, j;
6382 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006383#ifdef FEAT_MULTI_LANG
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 char_u lang[2];
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006385#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006386 expand_T xpc;
6387 char_u *dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 char_u ext[5];
6389 char_u fname[8];
6390 int filecount;
6391 char_u **files;
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006392 int add_help_tags = FALSE;
6393
6394 /* Check for ":helptags ++t {dir}". */
6395 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6396 {
6397 add_help_tags = TRUE;
6398 eap->arg = skipwhite(eap->arg + 3);
6399 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400
Bram Moolenaar0e253142008-01-13 12:31:34 +00006401 ExpandInit(&xpc);
6402 xpc.xp_context = EXPAND_DIRECTORIES;
6403 dirname = ExpandOne(&xpc, eap->arg, NULL,
6404 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6405 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 {
6407 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6408 return;
6409 }
6410
6411#ifdef FEAT_MULTI_LANG
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006412 /* Get a list of all files in the help directory and in subdirectories. */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006413 STRCPY(NameBuff, dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 add_pathsep(NameBuff);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006415 STRCAT(NameBuff, "**");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6417 EW_FILE|EW_SILENT) == FAIL
6418 || filecount == 0)
6419 {
6420 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar0e253142008-01-13 12:31:34 +00006421 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 return;
6423 }
6424
6425 /* Go over all files in the directory to find out what languages are
6426 * present. */
6427 ga_init2(&ga, 1, 10);
6428 for (i = 0; i < filecount; ++i)
6429 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006430 len = (int)STRLEN(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 if (len > 4)
6432 {
6433 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6434 {
6435 /* ".txt" -> language "en" */
6436 lang[0] = 'e';
6437 lang[1] = 'n';
6438 }
6439 else if (files[i][len - 4] == '.'
6440 && ASCII_ISALPHA(files[i][len - 3])
6441 && ASCII_ISALPHA(files[i][len - 2])
6442 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6443 {
6444 /* ".abx" -> language "ab" */
6445 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6446 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6447 }
6448 else
6449 continue;
6450
6451 /* Did we find this language already? */
6452 for (j = 0; j < ga.ga_len; j += 2)
6453 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6454 break;
6455 if (j == ga.ga_len)
6456 {
6457 /* New language, add it. */
6458 if (ga_grow(&ga, 2) == FAIL)
6459 break;
6460 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6461 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 }
6463 }
6464 }
6465
6466 /*
6467 * Loop over the found languages to generate a tags file for each one.
6468 */
6469 for (j = 0; j < ga.ga_len; j += 2)
6470 {
6471 STRCPY(fname, "tags-xx");
6472 fname[5] = ((char_u *)ga.ga_data)[j];
6473 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6474 if (fname[5] == 'e' && fname[6] == 'n')
6475 {
6476 /* English is an exception: use ".txt" and "tags". */
6477 fname[4] = NUL;
6478 STRCPY(ext, ".txt");
6479 }
6480 else
6481 {
6482 /* Language "ab" uses ".abx" and "tags-ab". */
6483 STRCPY(ext, ".xxx");
6484 ext[1] = fname[5];
6485 ext[2] = fname[6];
6486 }
Bram Moolenaar0e253142008-01-13 12:31:34 +00006487 helptags_one(dirname, ext, fname, add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 }
6489
6490 ga_clear(&ga);
6491 FreeWild(filecount, files);
6492
6493#else
6494 /* No language support, just use "*.txt" and "tags". */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006495 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006497 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498}
6499
6500 static void
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006501helptags_one(dir, ext, tagfname, add_help_tags)
6502 char_u *dir; /* doc directory */
6503 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006504 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6505 int add_help_tags; /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506{
6507 FILE *fd_tags;
6508 FILE *fd;
6509 garray_T ga;
6510 int filecount;
6511 char_u **files;
6512 char_u *p1, *p2;
6513 int fi;
6514 char_u *s;
6515 int i;
6516 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006517 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518# ifdef FEAT_MBYTE
6519 int utf8 = MAYBE;
6520 int this_utf8;
6521 int firstline;
6522 int mix = FALSE; /* detected mixed encodings */
6523# endif
6524
6525 /*
6526 * Find all *.txt files.
6527 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01006528 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006530 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 STRCAT(NameBuff, ext);
6532 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6533 EW_FILE|EW_SILENT) == FAIL
6534 || filecount == 0)
6535 {
6536 if (!got_int)
6537 EMSG2("E151: No match: %s", NameBuff);
6538 return;
6539 }
6540
6541 /*
6542 * Open the tags file for writing.
6543 * Do this before scanning through all the files.
6544 */
6545 STRCPY(NameBuff, dir);
6546 add_pathsep(NameBuff);
6547 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006548 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 if (fd_tags == NULL)
6550 {
6551 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6552 FreeWild(filecount, files);
6553 return;
6554 }
6555
6556 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006557 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6558 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 */
6560 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006561 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6562 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 {
6564 if (ga_grow(&ga, 1) == FAIL)
6565 got_int = TRUE;
6566 else
6567 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006568 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 if (s == NULL)
6570 got_int = TRUE;
6571 else
6572 {
6573 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6574 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6575 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 }
6577 }
6578 }
6579
6580 /*
6581 * Go over all the files and extract the tags.
6582 */
6583 for (fi = 0; fi < filecount && !got_int; ++fi)
6584 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006585 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 if (fd == NULL)
6587 {
6588 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6589 continue;
6590 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006591 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592
6593# ifdef FEAT_MBYTE
6594 firstline = TRUE;
6595# endif
6596 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6597 {
6598# ifdef FEAT_MBYTE
6599 if (firstline)
6600 {
6601 /* Detect utf-8 file by a non-ASCII char in the first line. */
6602 this_utf8 = MAYBE;
6603 for (s = IObuff; *s != NUL; ++s)
6604 if (*s >= 0x80)
6605 {
6606 int l;
6607
6608 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006609 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 if (l == 1)
6611 {
6612 /* Illegal UTF-8 byte sequence. */
6613 this_utf8 = FALSE;
6614 break;
6615 }
6616 s += l - 1;
6617 }
6618 if (this_utf8 == MAYBE) /* only ASCII characters found */
6619 this_utf8 = FALSE;
6620 if (utf8 == MAYBE) /* first file */
6621 utf8 = this_utf8;
6622 else if (utf8 != this_utf8)
6623 {
6624 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6625 mix = !got_int;
6626 got_int = TRUE;
6627 }
6628 firstline = FALSE;
6629 }
6630# endif
6631 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6632 while (p1 != NULL)
6633 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02006634 /* Use vim_strbyte() instead of vim_strchr() so that when
6635 * 'encoding' is dbcs it still works, don't find '*' in the
6636 * second byte. */
6637 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6639 {
6640 for (s = p1 + 1; s < p2; ++s)
6641 if (*s == ' ' || *s == '\t' || *s == '|')
6642 break;
6643
6644 /*
6645 * Only accept a *tag* when it consists of valid
6646 * characters, there is white space before it and is
6647 * followed by a white character or end-of-line.
6648 */
6649 if (s == p2
6650 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6651 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6652 || s[1] == '\0'))
6653 {
6654 *p2 = '\0';
6655 ++p1;
6656 if (ga_grow(&ga, 1) == FAIL)
6657 {
6658 got_int = TRUE;
6659 break;
6660 }
6661 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6662 if (s == NULL)
6663 {
6664 got_int = TRUE;
6665 break;
6666 }
6667 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6668 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 sprintf((char *)s, "%s\t%s", p1, fname);
6670
6671 /* find next '*' */
6672 p2 = vim_strchr(p2 + 1, '*');
6673 }
6674 }
6675 p1 = p2;
6676 }
6677 line_breakcheck();
6678 }
6679
6680 fclose(fd);
6681 }
6682
6683 FreeWild(filecount, files);
6684
6685 if (!got_int)
6686 {
6687 /*
6688 * Sort the tags.
6689 */
6690 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6691
6692 /*
6693 * Check for duplicates.
6694 */
6695 for (i = 1; i < ga.ga_len; ++i)
6696 {
6697 p1 = ((char_u **)ga.ga_data)[i - 1];
6698 p2 = ((char_u **)ga.ga_data)[i];
6699 while (*p1 == *p2)
6700 {
6701 if (*p2 == '\t')
6702 {
6703 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006704 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6706 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6707 EMSG(NameBuff);
6708 *p2 = '\t';
6709 break;
6710 }
6711 ++p1;
6712 ++p2;
6713 }
6714 }
6715
6716# ifdef FEAT_MBYTE
6717 if (utf8 == TRUE)
6718 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6719# endif
6720
6721 /*
6722 * Write the tags into the file.
6723 */
6724 for (i = 0; i < ga.ga_len; ++i)
6725 {
6726 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006727 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006729 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 else
6731 {
6732 fprintf(fd_tags, "%s\t/*", s);
6733 for (p1 = s; *p1 != '\t'; ++p1)
6734 {
6735 /* insert backslash before '\\' and '/' */
6736 if (*p1 == '\\' || *p1 == '/')
6737 putc('\\', fd_tags);
6738 putc(*p1, fd_tags);
6739 }
6740 fprintf(fd_tags, "*\n");
6741 }
6742 }
6743 }
6744#ifdef FEAT_MBYTE
6745 if (mix)
6746 got_int = FALSE; /* continue with other languages */
6747#endif
6748
6749 for (i = 0; i < ga.ga_len; ++i)
6750 vim_free(((char_u **)ga.ga_data)[i]);
6751 ga_clear(&ga);
6752 fclose(fd_tags); /* there is no check for an error... */
6753}
6754#endif
6755
6756#if defined(FEAT_SIGNS) || defined(PROTO)
6757
6758/*
6759 * Struct to hold the sign properties.
6760 */
6761typedef struct sign sign_T;
6762
6763struct sign
6764{
6765 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02006766 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 char_u *sn_name; /* name of sign */
6768 char_u *sn_icon; /* name of pixmap */
6769#ifdef FEAT_SIGN_ICONS
6770 void *sn_image; /* icon image */
6771#endif
6772 char_u *sn_text; /* text used instead of pixmap */
6773 int sn_line_hl; /* highlight ID for line */
6774 int sn_text_hl; /* highlight ID for text */
6775};
6776
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006778static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779
Bram Moolenaar985cb442009-05-14 19:51:46 +00006780static int sign_cmd_idx __ARGS((char_u *begin_cmd, char_u *end_cmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781static void sign_list_defined __ARGS((sign_T *sp));
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006782static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006784static char *cmds[] = {
6785 "define",
6786#define SIGNCMD_DEFINE 0
6787 "undefine",
6788#define SIGNCMD_UNDEFINE 1
6789 "list",
6790#define SIGNCMD_LIST 2
6791 "place",
6792#define SIGNCMD_PLACE 3
6793 "unplace",
6794#define SIGNCMD_UNPLACE 4
6795 "jump",
6796#define SIGNCMD_JUMP 5
6797 NULL
6798#define SIGNCMD_LAST 6
6799};
6800
6801/*
6802 * Find index of a ":sign" subcmd from its name.
6803 * "*end_cmd" must be writable.
6804 */
6805 static int
6806sign_cmd_idx(begin_cmd, end_cmd)
Bram Moolenaar985cb442009-05-14 19:51:46 +00006807 char_u *begin_cmd; /* begin of sign subcmd */
6808 char_u *end_cmd; /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006809{
6810 int idx;
6811 char save = *end_cmd;
6812
6813 *end_cmd = NUL;
6814 for (idx = 0; ; ++idx)
6815 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6816 break;
6817 *end_cmd = save;
6818 return idx;
6819}
6820
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821/*
6822 * ":sign" command
6823 */
6824 void
6825ex_sign(eap)
6826 exarg_T *eap;
6827{
6828 char_u *arg = eap->arg;
6829 char_u *p;
6830 int idx;
6831 sign_T *sp;
6832 sign_T *sp_prev;
6833 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834
6835 /* Parse the subcommand. */
6836 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006837 idx = sign_cmd_idx(arg, p);
6838 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006840 EMSG2(_("E160: Unknown sign command: %s"), arg);
6841 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 }
6843 arg = skipwhite(p);
6844
6845 if (idx <= SIGNCMD_LIST)
6846 {
6847 /*
6848 * Define, undefine or list signs.
6849 */
6850 if (idx == SIGNCMD_LIST && *arg == NUL)
6851 {
6852 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01006853 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 sign_list_defined(sp);
6855 }
6856 else if (*arg == NUL)
6857 EMSG(_("E156: Missing sign name"));
6858 else
6859 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006860 /* Isolate the sign name. If it's a number skip leading zeroes,
6861 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 p = skiptowhite(arg);
6863 if (*p != NUL)
6864 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006865 while (arg[0] == '0' && arg[1] != NUL)
6866 ++arg;
6867
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 sp_prev = NULL;
6869 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6870 {
6871 if (STRCMP(sp->sn_name, arg) == 0)
6872 break;
6873 sp_prev = sp;
6874 }
6875 if (idx == SIGNCMD_DEFINE)
6876 {
6877 /* ":sign define {name} ...": define a sign */
6878 if (sp == NULL)
6879 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006880 sign_T *lp;
6881 int start = next_sign_typenr;
6882
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 /* Allocate a new sign. */
6884 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6885 if (sp == NULL)
6886 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006888 /* Check that next_sign_typenr is not already being used.
6889 * This only happens after wrapping around. Hopefully
6890 * another one got deleted and we can use its number. */
6891 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006893 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006895 ++next_sign_typenr;
6896 if (next_sign_typenr == MAX_TYPENR)
6897 next_sign_typenr = 1;
6898 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006900 vim_free(sp);
6901 EMSG(_("E612: Too many signs defined"));
6902 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006904 lp = first_sign; /* start all over */
6905 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006907 lp = lp->sn_next;
6908 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006910 sp->sn_typenr = next_sign_typenr;
6911 if (++next_sign_typenr == MAX_TYPENR)
6912 next_sign_typenr = 1; /* wrap around */
6913
6914 sp->sn_name = vim_strsave(arg);
6915 if (sp->sn_name == NULL) /* out of memory */
6916 {
6917 vim_free(sp);
6918 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02006920
6921 /* add the new sign to the list of signs */
6922 if (sp_prev == NULL)
6923 first_sign = sp;
6924 else
6925 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 }
6927
6928 /* set values for a defined sign. */
6929 for (;;)
6930 {
6931 arg = skipwhite(p);
6932 if (*arg == NUL)
6933 break;
6934 p = skiptowhite_esc(arg);
6935 if (STRNCMP(arg, "icon=", 5) == 0)
6936 {
6937 arg += 5;
6938 vim_free(sp->sn_icon);
6939 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6940 backslash_halve(sp->sn_icon);
6941#ifdef FEAT_SIGN_ICONS
6942 if (gui.in_use)
6943 {
6944 out_flush();
6945 if (sp->sn_image != NULL)
6946 gui_mch_destroy_sign(sp->sn_image);
6947 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6948 }
6949#endif
6950 }
6951 else if (STRNCMP(arg, "text=", 5) == 0)
6952 {
6953 char_u *s;
6954 int cells;
6955 int len;
6956
6957 arg += 5;
6958#ifdef FEAT_MBYTE
6959 /* Count cells and check for non-printable chars */
6960 if (has_mbyte)
6961 {
6962 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006963 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 {
6965 if (!vim_isprintc((*mb_ptr2char)(s)))
6966 break;
6967 cells += (*mb_ptr2cells)(s);
6968 }
6969 }
6970 else
6971#endif
6972 {
6973 for (s = arg; s < p; ++s)
6974 if (!vim_isprintc(*s))
6975 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006976 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 }
6978 /* Currently must be one or two display cells */
6979 if (s != p || cells < 1 || cells > 2)
6980 {
6981 *p = NUL;
6982 EMSG2(_("E239: Invalid sign text: %s"), arg);
6983 return;
6984 }
6985
6986 vim_free(sp->sn_text);
6987 /* Allocate one byte more if we need to pad up
6988 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006989 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 sp->sn_text = vim_strnsave(arg, len);
6991
6992 if (sp->sn_text != NULL && cells == 1)
6993 STRCPY(sp->sn_text + len - 1, " ");
6994 }
6995 else if (STRNCMP(arg, "linehl=", 7) == 0)
6996 {
6997 arg += 7;
6998 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6999 }
7000 else if (STRNCMP(arg, "texthl=", 7) == 0)
7001 {
7002 arg += 7;
7003 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7004 }
7005 else
7006 {
7007 EMSG2(_(e_invarg2), arg);
7008 return;
7009 }
7010 }
7011 }
7012 else if (sp == NULL)
7013 EMSG2(_("E155: Unknown sign: %s"), arg);
7014 else if (idx == SIGNCMD_LIST)
7015 /* ":sign list {name}" */
7016 sign_list_defined(sp);
7017 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007018 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007019 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 }
7021 }
7022 else
7023 {
7024 int id = -1;
7025 linenr_T lnum = -1;
7026 char_u *sign_name = NULL;
7027 char_u *arg1;
7028
7029 if (*arg == NUL)
7030 {
7031 if (idx == SIGNCMD_PLACE)
7032 {
7033 /* ":sign place": list placed signs in all buffers */
7034 sign_list_placed(NULL);
7035 }
7036 else if (idx == SIGNCMD_UNPLACE)
7037 {
7038 /* ":sign unplace": remove placed sign at cursor */
7039 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7040 if (id > 0)
7041 {
7042 buf_delsign(curwin->w_buffer, id);
7043 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7044 }
7045 else
7046 EMSG(_("E159: Missing sign number"));
7047 }
7048 else
7049 EMSG(_(e_argreq));
7050 return;
7051 }
7052
7053 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7054 {
7055 /* ":sign unplace *": remove all placed signs */
7056 buf_delete_all_signs();
7057 return;
7058 }
7059
7060 /* first arg could be placed sign id */
7061 arg1 = arg;
7062 if (VIM_ISDIGIT(*arg))
7063 {
7064 id = getdigits(&arg);
7065 if (!vim_iswhite(*arg) && *arg != NUL)
7066 {
7067 id = -1;
7068 arg = arg1;
7069 }
7070 else
7071 {
7072 arg = skipwhite(arg);
7073 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7074 {
7075 /* ":sign unplace {id}": remove placed sign by number */
7076 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
7077 if ((lnum = buf_delsign(buf, id)) != 0)
7078 update_debug_sign(buf, lnum);
7079 return;
7080 }
7081 }
7082 }
7083
7084 /*
7085 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7086 * Leave "arg" pointing to {fname}.
7087 */
7088 for (;;)
7089 {
7090 if (STRNCMP(arg, "line=", 5) == 0)
7091 {
7092 arg += 5;
7093 lnum = atoi((char *)arg);
7094 arg = skiptowhite(arg);
7095 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007096 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7097 {
7098 if (id != -1)
7099 {
7100 EMSG(_(e_invarg));
7101 return;
7102 }
7103 id = -2;
7104 arg = skiptowhite(arg + 1);
7105 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 else if (STRNCMP(arg, "name=", 5) == 0)
7107 {
7108 arg += 5;
7109 sign_name = arg;
7110 arg = skiptowhite(arg);
7111 if (*arg != NUL)
7112 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007113 while (sign_name[0] == '0' && sign_name[1] != NUL)
7114 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 }
7116 else if (STRNCMP(arg, "file=", 5) == 0)
7117 {
7118 arg += 5;
7119 buf = buflist_findname(arg);
7120 break;
7121 }
7122 else if (STRNCMP(arg, "buffer=", 7) == 0)
7123 {
7124 arg += 7;
7125 buf = buflist_findnr((int)getdigits(&arg));
7126 if (*skipwhite(arg) != NUL)
7127 EMSG(_(e_trailing));
7128 break;
7129 }
7130 else
7131 {
7132 EMSG(_(e_invarg));
7133 return;
7134 }
7135 arg = skipwhite(arg);
7136 }
7137
7138 if (buf == NULL)
7139 {
7140 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7141 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007142 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 {
7144 if (lnum >= 0 || sign_name != NULL)
7145 EMSG(_(e_invarg));
7146 else
7147 /* ":sign place file={fname}": list placed signs in one file */
7148 sign_list_placed(buf);
7149 }
7150 else if (idx == SIGNCMD_JUMP)
7151 {
7152 /* ":sign jump {id} file={fname}" */
7153 if (lnum >= 0 || sign_name != NULL)
7154 EMSG(_(e_invarg));
7155 else if ((lnum = buf_findsign(buf, id)) > 0)
7156 { /* goto a sign ... */
7157 if (buf_jump_open_win(buf) != NULL)
7158 { /* ... in a current window */
7159 curwin->w_cursor.lnum = lnum;
7160 check_cursor_lnum();
7161 beginline(BL_WHITE);
7162 }
7163 else
7164 { /* ... not currently in a window */
7165 char_u *cmd;
7166
7167 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7168 if (cmd == NULL)
7169 return;
7170 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7171 do_cmdline_cmd(cmd);
7172 vim_free(cmd);
7173 }
7174#ifdef FEAT_FOLDING
7175 foldOpenCursor();
7176#endif
7177 }
7178 else
7179 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7180 }
7181 else if (idx == SIGNCMD_UNPLACE)
7182 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 if (lnum >= 0 || sign_name != NULL)
7184 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007185 else if (id == -2)
7186 {
7187 /* ":sign unplace * file={fname}" */
7188 redraw_buf_later(buf, NOT_VALID);
7189 buf_delete_signs(buf);
7190 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 else
7192 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007193 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 lnum = buf_delsign(buf, id);
7195 update_debug_sign(buf, lnum);
7196 }
7197 }
7198 /* idx == SIGNCMD_PLACE */
7199 else if (sign_name != NULL)
7200 {
7201 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7202 if (STRCMP(sp->sn_name, sign_name) == 0)
7203 break;
7204 if (sp == NULL)
7205 {
7206 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7207 return;
7208 }
7209 if (lnum > 0)
7210 /* ":sign place {id} line={lnum} name={name} file={fname}":
7211 * place a sign */
7212 buf_addsign(buf, id, lnum, sp->sn_typenr);
7213 else
7214 /* ":sign place {id} file={fname}": change sign type */
7215 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
7216 update_debug_sign(buf, lnum);
7217 }
7218 else
7219 EMSG(_(e_invarg));
7220 }
7221}
7222
7223#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7224/*
7225 * Allocate the icons. Called when the GUI has started. Allows defining
7226 * signs before it starts.
7227 */
7228 void
7229sign_gui_started()
7230{
7231 sign_T *sp;
7232
7233 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7234 if (sp->sn_icon != NULL)
7235 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7236}
7237#endif
7238
7239/*
7240 * List one sign.
7241 */
7242 static void
7243sign_list_defined(sp)
7244 sign_T *sp;
7245{
7246 char_u *p;
7247
Bram Moolenaar555b2802005-05-19 21:08:39 +00007248 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 if (sp->sn_icon != NULL)
7250 {
7251 MSG_PUTS(" icon=");
7252 msg_outtrans(sp->sn_icon);
7253#ifdef FEAT_SIGN_ICONS
7254 if (sp->sn_image == NULL)
7255 MSG_PUTS(_(" (NOT FOUND)"));
7256#else
7257 MSG_PUTS(_(" (not supported)"));
7258#endif
7259 }
7260 if (sp->sn_text != NULL)
7261 {
7262 MSG_PUTS(" text=");
7263 msg_outtrans(sp->sn_text);
7264 }
7265 if (sp->sn_line_hl > 0)
7266 {
7267 MSG_PUTS(" linehl=");
7268 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7269 if (p == NULL)
7270 MSG_PUTS("NONE");
7271 else
7272 msg_puts(p);
7273 }
7274 if (sp->sn_text_hl > 0)
7275 {
7276 MSG_PUTS(" texthl=");
7277 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7278 if (p == NULL)
7279 MSG_PUTS("NONE");
7280 else
7281 msg_puts(p);
7282 }
7283}
7284
7285/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007286 * Undefine a sign and free its memory.
7287 */
7288 static void
7289sign_undefine(sp, sp_prev)
7290 sign_T *sp;
7291 sign_T *sp_prev;
7292{
7293 vim_free(sp->sn_name);
7294 vim_free(sp->sn_icon);
7295#ifdef FEAT_SIGN_ICONS
7296 if (sp->sn_image != NULL)
7297 {
7298 out_flush();
7299 gui_mch_destroy_sign(sp->sn_image);
7300 }
7301#endif
7302 vim_free(sp->sn_text);
7303 if (sp_prev == NULL)
7304 first_sign = sp->sn_next;
7305 else
7306 sp_prev->sn_next = sp->sn_next;
7307 vim_free(sp);
7308}
7309
7310/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 * Get highlighting attribute for sign "typenr".
7312 * If "line" is TRUE: line highl, if FALSE: text highl.
7313 */
7314 int
7315sign_get_attr(typenr, line)
7316 int typenr;
7317 int line;
7318{
7319 sign_T *sp;
7320
7321 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7322 if (sp->sn_typenr == typenr)
7323 {
7324 if (line)
7325 {
7326 if (sp->sn_line_hl > 0)
7327 return syn_id2attr(sp->sn_line_hl);
7328 }
7329 else
7330 {
7331 if (sp->sn_text_hl > 0)
7332 return syn_id2attr(sp->sn_text_hl);
7333 }
7334 break;
7335 }
7336 return 0;
7337}
7338
7339/*
7340 * Get text mark for sign "typenr".
7341 * Returns NULL if there isn't one.
7342 */
7343 char_u *
7344sign_get_text(typenr)
7345 int typenr;
7346{
7347 sign_T *sp;
7348
7349 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7350 if (sp->sn_typenr == typenr)
7351 return sp->sn_text;
7352 return NULL;
7353}
7354
7355#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7356 void *
7357sign_get_image(typenr)
7358 int typenr; /* the attribute which may have a sign */
7359{
7360 sign_T *sp;
7361
7362 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7363 if (sp->sn_typenr == typenr)
7364 return sp->sn_image;
7365 return NULL;
7366}
7367#endif
7368
7369/*
7370 * Get the name of a sign by its typenr.
7371 */
7372 char_u *
7373sign_typenr2name(typenr)
7374 int typenr;
7375{
7376 sign_T *sp;
7377
7378 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7379 if (sp->sn_typenr == typenr)
7380 return sp->sn_name;
7381 return (char_u *)_("[Deleted]");
7382}
7383
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007384#if defined(EXITFREE) || defined(PROTO)
7385/*
7386 * Undefine/free all signs.
7387 */
7388 void
7389free_signs()
7390{
7391 while (first_sign != NULL)
7392 sign_undefine(first_sign, NULL);
7393}
7394#endif
7395
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007396#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7397static enum
7398{
7399 EXP_SUBCMD, /* expand :sign sub-commands */
7400 EXP_DEFINE, /* expand :sign define {name} args */
7401 EXP_PLACE, /* expand :sign place {id} args */
7402 EXP_UNPLACE, /* expand :sign unplace" */
7403 EXP_SIGN_NAMES /* expand with name of placed signs */
7404} expand_what;
7405
7406/*
7407 * Function given to ExpandGeneric() to obtain the sign command
7408 * expansion.
7409 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007410 char_u *
7411get_sign_name(xp, idx)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00007412 expand_T *xp UNUSED;
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007413 int idx;
7414{
7415 sign_T *sp;
7416 int current_idx;
7417
7418 switch (expand_what)
7419 {
7420 case EXP_SUBCMD:
7421 return (char_u *)cmds[idx];
7422 case EXP_DEFINE:
7423 {
7424 char *define_arg[] =
7425 {
7426 "icon=", "linehl=", "text=", "texthl=", NULL
7427 };
7428 return (char_u *)define_arg[idx];
7429 }
7430 case EXP_PLACE:
7431 {
7432 char *place_arg[] =
7433 {
7434 "line=", "name=", "file=", "buffer=", NULL
7435 };
7436 return (char_u *)place_arg[idx];
7437 }
7438 case EXP_UNPLACE:
7439 {
7440 char *unplace_arg[] = { "file=", "buffer=", NULL };
7441 return (char_u *)unplace_arg[idx];
7442 }
7443 case EXP_SIGN_NAMES:
7444 /* Complete with name of signs already defined */
7445 current_idx = 0;
7446 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7447 if (current_idx++ == idx)
7448 return sp->sn_name;
7449 return NULL;
7450 default:
7451 return NULL;
7452 }
7453}
7454
7455/*
7456 * Handle command line completion for :sign command.
7457 */
7458 void
7459set_context_in_sign_cmd(xp, arg)
7460 expand_T *xp;
7461 char_u *arg;
7462{
7463 char_u *p;
7464 char_u *end_subcmd;
7465 char_u *last;
7466 int cmd_idx;
7467 char_u *begin_subcmd_args;
7468
7469 /* Default: expand subcommands. */
7470 xp->xp_context = EXPAND_SIGN;
7471 expand_what = EXP_SUBCMD;
7472 xp->xp_pattern = arg;
7473
7474 end_subcmd = skiptowhite(arg);
7475 if (*end_subcmd == NUL)
7476 /* expand subcmd name
7477 * :sign {subcmd}<CTRL-D>*/
7478 return;
7479
7480 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7481
7482 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007483 * |
7484 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007485 begin_subcmd_args = skipwhite(end_subcmd);
7486 p = skiptowhite(begin_subcmd_args);
7487 if (*p == NUL)
7488 {
7489 /*
7490 * Expand first argument of subcmd when possible.
7491 * For ":jump {id}" and ":unplace {id}", we could
7492 * possibly expand the ids of all signs already placed.
7493 */
7494 xp->xp_pattern = begin_subcmd_args;
7495 switch (cmd_idx)
7496 {
7497 case SIGNCMD_LIST:
7498 case SIGNCMD_UNDEFINE:
7499 /* :sign list <CTRL-D>
7500 * :sign undefine <CTRL-D> */
7501 expand_what = EXP_SIGN_NAMES;
7502 break;
7503 default:
7504 xp->xp_context = EXPAND_NOTHING;
7505 }
7506 return;
7507 }
7508
7509 /* expand last argument of subcmd */
7510
7511 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007512 * |
7513 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007514
7515 /* Loop until reaching last argument. */
7516 do
7517 {
7518 p = skipwhite(p);
7519 last = p;
7520 p = skiptowhite(p);
7521 } while (*p != NUL);
7522
7523 p = vim_strchr(last, '=');
7524
7525 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007526 * | |
7527 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007528 if (p == NUL)
7529 {
7530 /* Expand last argument name (before equal sign). */
7531 xp->xp_pattern = last;
7532 switch (cmd_idx)
7533 {
7534 case SIGNCMD_DEFINE:
7535 expand_what = EXP_DEFINE;
7536 break;
7537 case SIGNCMD_PLACE:
7538 expand_what = EXP_PLACE;
7539 break;
7540 case SIGNCMD_JUMP:
7541 case SIGNCMD_UNPLACE:
7542 expand_what = EXP_UNPLACE;
7543 break;
7544 default:
7545 xp->xp_context = EXPAND_NOTHING;
7546 }
7547 }
7548 else
7549 {
7550 /* Expand last argument value (after equal sign). */
7551 xp->xp_pattern = p + 1;
7552 switch (cmd_idx)
7553 {
7554 case SIGNCMD_DEFINE:
7555 if (STRNCMP(last, "texthl", p - last) == 0 ||
7556 STRNCMP(last, "linehl", p - last) == 0)
7557 xp->xp_context = EXPAND_HIGHLIGHT;
7558 else if (STRNCMP(last, "icon", p - last) == 0)
7559 xp->xp_context = EXPAND_FILES;
7560 else
7561 xp->xp_context = EXPAND_NOTHING;
7562 break;
7563 case SIGNCMD_PLACE:
7564 if (STRNCMP(last, "name", p - last) == 0)
7565 expand_what = EXP_SIGN_NAMES;
7566 else
7567 xp->xp_context = EXPAND_NOTHING;
7568 break;
7569 default:
7570 xp->xp_context = EXPAND_NOTHING;
7571 }
7572 }
7573}
7574#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575#endif
7576
7577#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7578/*
7579 * ":drop"
7580 * Opens the first argument in a window. When there are two or more arguments
7581 * the argument list is redefined.
7582 */
7583 void
7584ex_drop(eap)
7585 exarg_T *eap;
7586{
7587 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 win_T *wp;
7589 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007590# ifdef FEAT_WINDOWS
7591 tabpage_T *tp;
7592# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593
7594 /*
7595 * Check if the first argument is already being edited in a window. If
7596 * so, jump to that window.
7597 * We would actually need to check all arguments, but that's complicated
7598 * and mostly only one file is dropped.
7599 * This also ignores wildcards, since it is very unlikely the user is
7600 * editing a file name with a wildcard character.
7601 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007602 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007604 /*
7605 * Expanding wildcards may result in an empty argument list. E.g. when
7606 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7607 * already did an error message for this.
7608 */
7609 if (ARGCOUNT == 0)
7610 return;
7611
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007612# ifdef FEAT_WINDOWS
7613 if (cmdmod.tab)
7614 {
7615 /* ":tab drop file ...": open a tab for each argument that isn't
7616 * edited in a window yet. It's like ":tab all" but without closing
7617 * windows or tabs. */
7618 ex_all(eap);
7619 }
7620 else
7621# endif
7622 {
7623 /* ":drop file ...": Edit the first argument. Jump to an existing
7624 * window if possible, edit in current window if the current buffer
7625 * can be abandoned, otherwise open a new window. */
7626 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7627
7628 FOR_ALL_TAB_WINDOWS(tp, wp)
7629 {
7630 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007632# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007633 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007634# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 return;
7637 }
7638 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007640 /*
7641 * Check whether the current buffer is changed. If so, we will need
7642 * to split the current window or data could be lost.
7643 * Skip the check if the 'hidden' option is set, as in this case the
7644 * buffer won't be lost.
7645 */
7646 if (!P_HID(curbuf))
7647 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007649 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007651 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007653 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007655 if (split)
7656 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007658 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007660 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7661 if (split)
7662 {
7663 eap->cmdidx = CMD_sfirst;
7664 eap->cmd[0] = 's';
7665 }
7666 else
7667 eap->cmdidx = CMD_first;
7668 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670}
7671#endif