blob: cd6772ed521225c06f676abd3339dd45939d738b [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 Moolenaar67fe1a12005-05-22 22:12:58 +0000574 vim_free(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/*
1725 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1726 * that effectively a merge of current info and old info is done. This allows
1727 * multiple vims to run simultaneously, without losing any marks etc. If
1728 * forceit is TRUE, then the old file is not read in, and only internal info is
1729 * written to the file. -- webb
1730 */
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;
2050
2051 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2052 return;
2053 vir.vir_fd = fp_in;
2054#ifdef FEAT_MBYTE
2055 vir.vir_conv.vc_type = CONV_NONE;
2056#endif
2057
2058 if (fp_in != NULL)
2059 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002060 if (flags & VIF_WANT_INFO)
2061 eof = read_viminfo_up_to_marks(&vir,
2062 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 else
2064 /* Skip info, find start of marks */
2065 while (!(eof = viminfo_readline(&vir))
2066 && vir.vir_line[0] != '>')
2067 ;
2068 }
2069 if (fp_out != NULL)
2070 {
2071 /* Write the info: */
2072 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2073 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002074 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002076 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2078#endif
2079 write_viminfo_search_pattern(fp_out);
2080 write_viminfo_sub_string(fp_out);
2081#ifdef FEAT_CMDHIST
2082 write_viminfo_history(fp_out);
2083#endif
2084 write_viminfo_registers(fp_out);
2085#ifdef FEAT_EVAL
2086 write_viminfo_varlist(fp_out);
2087#endif
2088 write_viminfo_filemarks(fp_out);
2089 write_viminfo_bufferlist(fp_out);
2090 count = write_viminfo_marks(fp_out);
2091 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002092 if (fp_in != NULL
2093 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2094 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095
2096 vim_free(vir.vir_line);
2097#ifdef FEAT_MBYTE
2098 if (vir.vir_conv.vc_type != CONV_NONE)
2099 convert_setup(&vir.vir_conv, NULL, NULL);
2100#endif
2101}
2102
2103/*
2104 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2105 * first part of the viminfo file which contains everything but the marks that
2106 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2107 */
2108 static int
2109read_viminfo_up_to_marks(virp, forceit, writing)
2110 vir_T *virp;
2111 int forceit;
2112 int writing;
2113{
2114 int eof;
2115 buf_T *buf;
2116
2117#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002118 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119#endif
2120 eof = viminfo_readline(virp);
2121 while (!eof && virp->vir_line[0] != '>')
2122 {
2123 switch (virp->vir_line[0])
2124 {
2125 /* Characters reserved for future expansion, ignored now */
2126 case '+': /* "+40 /path/dir file", for running vim without args */
2127 case '|': /* to be defined */
2128 case '^': /* to be defined */
2129 case '<': /* long line - ignored */
2130 /* A comment or empty line. */
2131 case NUL:
2132 case '\r':
2133 case '\n':
2134 case '#':
2135 eof = viminfo_readline(virp);
2136 break;
2137 case '*': /* "*encoding=value" */
2138 eof = viminfo_encoding(virp);
2139 break;
2140 case '!': /* global variable */
2141#ifdef FEAT_EVAL
2142 eof = read_viminfo_varlist(virp, writing);
2143#else
2144 eof = viminfo_readline(virp);
2145#endif
2146 break;
2147 case '%': /* entry for buffer list */
2148 eof = read_viminfo_bufferlist(virp, writing);
2149 break;
2150 case '"':
2151 eof = read_viminfo_register(virp, forceit);
2152 break;
2153 case '/': /* Search string */
2154 case '&': /* Substitute search string */
2155 case '~': /* Last search string, followed by '/' or '&' */
2156 eof = read_viminfo_search_pattern(virp, forceit);
2157 break;
2158 case '$':
2159 eof = read_viminfo_sub_string(virp, forceit);
2160 break;
2161 case ':':
2162 case '?':
2163 case '=':
2164 case '@':
2165#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002166 eof = read_viminfo_history(virp, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167#else
2168 eof = viminfo_readline(virp);
2169#endif
2170 break;
2171 case '-':
2172 case '\'':
2173 eof = read_viminfo_filemark(virp, forceit);
2174 break;
2175 default:
2176 if (viminfo_error("E575: ", _("Illegal starting char"),
2177 virp->vir_line))
2178 eof = TRUE;
2179 else
2180 eof = viminfo_readline(virp);
2181 break;
2182 }
2183 }
2184
2185#ifdef FEAT_CMDHIST
2186 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002187 if (!writing)
2188 finish_viminfo_history();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189#endif
2190
2191 /* Change file names to buffer numbers for fmarks. */
2192 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2193 fmarks_check_names(buf);
2194
2195 return eof;
2196}
2197
2198/*
2199 * Compare the 'encoding' value in the viminfo file with the current value of
2200 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2201 * conversion of text with iconv() in viminfo_readstring().
2202 */
2203 static int
2204viminfo_encoding(virp)
2205 vir_T *virp;
2206{
2207#ifdef FEAT_MBYTE
2208 char_u *p;
2209 int i;
2210
2211 if (get_viminfo_parameter('c') != 0)
2212 {
2213 p = vim_strchr(virp->vir_line, '=');
2214 if (p != NULL)
2215 {
2216 /* remove trailing newline */
2217 ++p;
2218 for (i = 0; vim_isprintc(p[i]); ++i)
2219 ;
2220 p[i] = NUL;
2221
2222 convert_setup(&virp->vir_conv, p, p_enc);
2223 }
2224 }
2225#endif
2226 return viminfo_readline(virp);
2227}
2228
2229/*
2230 * Read a line from the viminfo file.
2231 * Returns TRUE for end-of-file;
2232 */
2233 int
2234viminfo_readline(virp)
2235 vir_T *virp;
2236{
2237 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2238}
2239
2240/*
2241 * check string read from viminfo file
2242 * remove '\n' at the end of the line
2243 * - replace CTRL-V CTRL-V with CTRL-V
2244 * - replace CTRL-V 'n' with '\n'
2245 *
2246 * Check for a long line as written by viminfo_writestring().
2247 *
2248 * Return the string in allocated memory (NULL when out of memory).
2249 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 char_u *
2251viminfo_readstring(virp, off, convert)
2252 vir_T *virp;
2253 int off; /* offset for virp->vir_line */
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00002254 int convert UNUSED; /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255{
2256 char_u *retval;
2257 char_u *s, *d;
2258 long len;
2259
2260 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2261 {
2262 len = atol((char *)virp->vir_line + off + 1);
2263 retval = lalloc(len, TRUE);
2264 if (retval == NULL)
2265 {
2266 /* Line too long? File messed up? Skip next line. */
2267 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2268 return NULL;
2269 }
2270 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2271 s = retval + 1; /* Skip the leading '<' */
2272 }
2273 else
2274 {
2275 retval = vim_strsave(virp->vir_line + off);
2276 if (retval == NULL)
2277 return NULL;
2278 s = retval;
2279 }
2280
2281 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2282 d = retval;
2283 while (*s != NUL && *s != '\n')
2284 {
2285 if (s[0] == Ctrl_V && s[1] != NUL)
2286 {
2287 if (s[1] == 'n')
2288 *d++ = '\n';
2289 else
2290 *d++ = Ctrl_V;
2291 s += 2;
2292 }
2293 else
2294 *d++ = *s++;
2295 }
2296 *d = NUL;
2297
2298#ifdef FEAT_MBYTE
2299 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2300 {
2301 d = string_convert(&virp->vir_conv, retval, NULL);
2302 if (d != NULL)
2303 {
2304 vim_free(retval);
2305 retval = d;
2306 }
2307 }
2308#endif
2309
2310 return retval;
2311}
2312
2313/*
2314 * write string to viminfo file
2315 * - replace CTRL-V with CTRL-V CTRL-V
2316 * - replace '\n' with CTRL-V 'n'
2317 * - add a '\n' at the end
2318 *
2319 * For a long line:
2320 * - write " CTRL-V <length> \n " in first line
2321 * - write " < <string> \n " in second line
2322 */
2323 void
2324viminfo_writestring(fd, p)
2325 FILE *fd;
2326 char_u *p;
2327{
2328 int c;
2329 char_u *s;
2330 int len = 0;
2331
2332 for (s = p; *s != NUL; ++s)
2333 {
2334 if (*s == Ctrl_V || *s == '\n')
2335 ++len;
2336 ++len;
2337 }
2338
2339 /* If the string will be too long, write its length and put it in the next
2340 * line. Take into account that some room is needed for what comes before
2341 * the string (e.g., variable name). Add something to the length for the
2342 * '<', NL and trailing NUL. */
2343 if (len > LSIZE / 2)
2344 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2345
2346 while ((c = *p++) != NUL)
2347 {
2348 if (c == Ctrl_V || c == '\n')
2349 {
2350 putc(Ctrl_V, fd);
2351 if (c == '\n')
2352 c = 'n';
2353 }
2354 putc(c, fd);
2355 }
2356 putc('\n', fd);
2357}
2358#endif /* FEAT_VIMINFO */
2359
2360/*
2361 * Implementation of ":fixdel", also used by get_stty().
2362 * <BS> resulting <Del>
2363 * ^? ^H
2364 * not ^? ^?
2365 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 void
2367do_fixdel(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00002368 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369{
2370 char_u *p;
2371
2372 p = find_termcode((char_u *)"kb");
2373 add_termcode((char_u *)"kD", p != NULL
2374 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2375}
2376
2377 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002378print_line_no_prefix(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 linenr_T lnum;
2380 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002381 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002383 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384
2385 if (curwin->w_p_nu || use_number)
2386 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002387 vim_snprintf((char *)numbuf, sizeof(numbuf),
2388 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2390 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002391 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392}
2393
2394/*
2395 * Print a text line. Also in silent mode ("ex -s").
2396 */
2397 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002398print_line(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 linenr_T lnum;
2400 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002401 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402{
2403 int save_silent = silent_mode;
2404
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002406 silent_mode = FALSE;
2407 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2408 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 if (save_silent)
2410 {
2411 msg_putchar('\n');
2412 cursor_on(); /* msg_start() switches it off */
2413 out_flush();
2414 silent_mode = save_silent;
2415 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002416 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417}
2418
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002419 int
2420rename_buffer(new_fname)
2421 char_u *new_fname;
2422{
2423 char_u *fname, *sfname, *xfname;
Bram Moolenaar7e283842013-05-30 11:43:15 +02002424 buf_T *buf;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002425
Bram Moolenaar7e283842013-05-30 11:43:15 +02002426#ifdef FEAT_AUTOCMD
2427 buf = curbuf;
2428 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002429 /* buffer changed, don't change name now */
2430 if (buf != curbuf)
2431 return FAIL;
2432# ifdef FEAT_EVAL
2433 if (aborting()) /* autocmds may abort script processing */
2434 return FAIL;
2435# endif
2436#endif
2437 /*
2438 * The name of the current buffer will be changed.
2439 * A new (unlisted) buffer entry needs to be made to hold the old file
2440 * name, which will become the alternate file name.
2441 * But don't set the alternate file name if the buffer didn't have a
2442 * name.
2443 */
Bram Moolenaar7e283842013-05-30 11:43:15 +02002444 fname = curbuf->b_ffname;
2445 sfname = curbuf->b_sfname;
2446 xfname = curbuf->b_fname;
2447 curbuf->b_ffname = NULL;
2448 curbuf->b_sfname = NULL;
2449 if (setfname(curbuf, new_fname, NULL, TRUE) == FAIL)
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002450 {
Bram Moolenaar7e283842013-05-30 11:43:15 +02002451 curbuf->b_ffname = fname;
2452 curbuf->b_sfname = sfname;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002453 return FAIL;
2454 }
Bram Moolenaar7e283842013-05-30 11:43:15 +02002455 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002456 if (xfname != NULL && *xfname != NUL)
2457 {
2458 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2459 if (buf != NULL && !cmdmod.keepalt)
2460 curwin->w_alt_fnum = buf->b_fnum;
2461 }
2462 vim_free(fname);
2463 vim_free(sfname);
2464#ifdef FEAT_AUTOCMD
Bram Moolenaar7e283842013-05-30 11:43:15 +02002465 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002466#endif
2467 /* Change directories when the 'acd' option is set. */
2468 DO_AUTOCHDIR
2469 return OK;
2470}
2471
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472/*
2473 * ":file[!] [fname]".
2474 */
2475 void
2476ex_file(eap)
2477 exarg_T *eap;
2478{
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002479 /* ":0file" removes the file name. Check for illegal uses ":3file",
2480 * "0file name", etc. */
2481 if (eap->addr_count > 0
2482 && (*eap->arg != NUL
2483 || eap->line2 > 0
2484 || eap->addr_count > 1))
2485 {
2486 EMSG(_(e_invarg));
2487 return;
2488 }
2489
2490 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 {
Bram Moolenaare9ba5162013-05-29 22:02:22 +02002492 if (rename_buffer(eap->arg) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 }
2495 /* print full file name if :cd used */
2496 fileinfo(FALSE, FALSE, eap->forceit);
2497}
2498
2499/*
2500 * ":update".
2501 */
2502 void
2503ex_update(eap)
2504 exarg_T *eap;
2505{
2506 if (curbufIsChanged())
2507 (void)do_write(eap);
2508}
2509
2510/*
2511 * ":write" and ":saveas".
2512 */
2513 void
2514ex_write(eap)
2515 exarg_T *eap;
2516{
2517 if (eap->usefilter) /* input lines to shell command */
2518 do_bang(1, eap, FALSE, TRUE, FALSE);
2519 else
2520 (void)do_write(eap);
2521}
2522
2523/*
2524 * write current buffer to file 'eap->arg'
2525 * if 'eap->append' is TRUE, append to the file
2526 *
2527 * if *eap->arg == NUL write to current file
2528 *
2529 * return FAIL for failure, OK otherwise
2530 */
2531 int
2532do_write(eap)
2533 exarg_T *eap;
2534{
2535 int other;
2536 char_u *fname = NULL; /* init to shut up gcc */
2537 char_u *ffname;
2538 int retval = FAIL;
2539 char_u *free_fname = NULL;
2540#ifdef FEAT_BROWSE
2541 char_u *browse_file = NULL;
2542#endif
2543 buf_T *alt_buf = NULL;
2544
2545 if (not_writing()) /* check 'write' option */
2546 return FAIL;
2547
2548 ffname = eap->arg;
2549#ifdef FEAT_BROWSE
2550 if (cmdmod.browse)
2551 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002552 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 NULL, NULL, NULL, curbuf);
2554 if (browse_file == NULL)
2555 goto theend;
2556 ffname = browse_file;
2557 }
2558#endif
2559 if (*ffname == NUL)
2560 {
2561 if (eap->cmdidx == CMD_saveas)
2562 {
2563 EMSG(_(e_argreq));
2564 goto theend;
2565 }
2566 other = FALSE;
2567 }
2568 else
2569 {
2570 fname = ffname;
2571 free_fname = fix_fname(ffname);
2572 /*
2573 * When out-of-memory, keep unexpanded file name, because we MUST be
2574 * able to write the file in this situation.
2575 */
2576 if (free_fname != NULL)
2577 ffname = free_fname;
2578 other = otherfile(ffname);
2579 }
2580
2581 /*
2582 * If we have a new file, put its name in the list of alternate file names.
2583 */
2584 if (other)
2585 {
2586 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2587 || eap->cmdidx == CMD_saveas)
2588 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2589 else
2590 alt_buf = buflist_findname(ffname);
2591 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2592 {
2593 /* Overwriting a file that is loaded in another buffer is not a
2594 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00002595 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 goto theend;
2597 }
2598 }
2599
2600 /*
2601 * Writing to the current file is not allowed in readonly mode
2602 * and a file name is required.
2603 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2604 */
2605 if (!other && (
2606#ifdef FEAT_QUICKFIX
2607 bt_dontwrite_msg(curbuf) ||
2608#endif
2609 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2610 goto theend;
2611
2612 if (!other)
2613 {
2614 ffname = curbuf->b_ffname;
2615 fname = curbuf->b_fname;
2616 /*
2617 * Not writing the whole file is only allowed with '!'.
2618 */
2619 if ( (eap->line1 != 1
2620 || eap->line2 != curbuf->b_ml.ml_line_count)
2621 && !eap->forceit
2622 && !eap->append
2623 && !p_wa)
2624 {
2625#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2626 if (p_confirm || cmdmod.confirm)
2627 {
2628 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2629 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2630 goto theend;
2631 eap->forceit = TRUE;
2632 }
2633 else
2634#endif
2635 {
2636 EMSG(_("E140: Use ! to write partial buffer"));
2637 goto theend;
2638 }
2639 }
2640 }
2641
2642 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2643 {
2644 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2645 {
2646#ifdef FEAT_AUTOCMD
2647 buf_T *was_curbuf = curbuf;
2648
2649 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002650 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651# ifdef FEAT_EVAL
2652 if (curbuf != was_curbuf || aborting())
2653# else
2654 if (curbuf != was_curbuf)
2655# endif
2656 {
2657 /* buffer changed, don't change name now */
2658 retval = FAIL;
2659 goto theend;
2660 }
2661#endif
2662 /* Exchange the file names for the current and the alternate
2663 * buffer. This makes it look like we are now editing the buffer
2664 * under the new name. Must be done before buf_write(), because
2665 * if there is no file name and 'cpo' contains 'F', it will set
2666 * the file name. */
2667 fname = alt_buf->b_fname;
2668 alt_buf->b_fname = curbuf->b_fname;
2669 curbuf->b_fname = fname;
2670 fname = alt_buf->b_ffname;
2671 alt_buf->b_ffname = curbuf->b_ffname;
2672 curbuf->b_ffname = fname;
2673 fname = alt_buf->b_sfname;
2674 alt_buf->b_sfname = curbuf->b_sfname;
2675 curbuf->b_sfname = fname;
2676 buf_name_changed(curbuf);
2677#ifdef FEAT_AUTOCMD
2678 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002679 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 if (!alt_buf->b_p_bl)
2681 {
2682 alt_buf->b_p_bl = TRUE;
2683 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2684 }
2685# ifdef FEAT_EVAL
2686 if (curbuf != was_curbuf || aborting())
2687# else
2688 if (curbuf != was_curbuf)
2689# endif
2690 {
2691 /* buffer changed, don't write the file */
2692 retval = FAIL;
2693 goto theend;
2694 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002695
2696 /* If 'filetype' was empty try detecting it now. */
2697 if (*curbuf->b_p_ft == NUL)
2698 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002699 if (au_has_group((char_u *)"filetypedetect"))
2700 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2701 TRUE);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002702 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002703 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002704
2705 /* Autocommands may have changed buffer names, esp. when
2706 * 'autochdir' is set. */
2707 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708#endif
2709 }
2710
2711 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2712 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002713
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002714 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002715 if (eap->cmdidx == CMD_saveas)
2716 {
2717 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002718 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002719 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002720#ifdef FEAT_WINDOWS
2721 redraw_tabline = TRUE;
2722#endif
2723 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002724 /* Change directories when the 'acd' option is set. */
2725 DO_AUTOCHDIR
2726 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 }
2728
2729theend:
2730#ifdef FEAT_BROWSE
2731 vim_free(browse_file);
2732#endif
2733 vim_free(free_fname);
2734 return retval;
2735}
2736
2737/*
2738 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2739 * BF_NEW or BF_READERR, check for overwriting current file.
2740 * May set eap->forceit if a dialog says it's OK to overwrite.
2741 * Return OK if it's OK, FAIL if it is not.
2742 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002743 int
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744check_overwrite(eap, buf, fname, ffname, other)
2745 exarg_T *eap;
2746 buf_T *buf;
2747 char_u *fname; /* file name to be used (can differ from
2748 buf->ffname) */
2749 char_u *ffname; /* full path version of fname */
2750 int other; /* writing under other name */
2751{
2752 /*
2753 * write to other file or b_flags set or not writing the whole file:
2754 * overwriting only allowed with '!'
2755 */
2756 if ( (other
2757 || (buf->b_flags & BF_NOTEDITED)
2758 || ((buf->b_flags & BF_NEW)
2759 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2760 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002762#ifdef FEAT_QUICKFIX
2763 && !bt_nofile(buf)
2764#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 && vim_fexists(ffname))
2766 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002767 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002769#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002770 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002771 if (mch_isdir(ffname))
2772 {
2773 EMSG2(_(e_isadir2), ffname);
2774 return FAIL;
2775 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776#endif
2777#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002778 if (p_confirm || cmdmod.confirm)
2779 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002780 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002782 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2783 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2784 return FAIL;
2785 eap->forceit = TRUE;
2786 }
2787 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002789 {
2790 EMSG(_(e_exists));
2791 return FAIL;
2792 }
2793 }
2794
2795 /* For ":w! filename" check that no swap file exists for "filename". */
2796 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002798 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002799 char_u *p;
2800 int r;
2801 char_u *swapname;
2802
2803 /* We only try the first entry in 'directory', without checking if
2804 * it's writable. If the "." directory is not writable the write
2805 * will probably fail anyway.
2806 * Use 'shortname' of the current buffer, since there is no buffer
2807 * for the written file. */
2808 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002809 {
2810 dir = alloc(5);
2811 if (dir == NULL)
2812 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002813 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002814 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002815 else
2816 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002817 dir = alloc(MAXPATHL);
2818 if (dir == NULL)
2819 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002820 p = p_dir;
2821 copy_option_part(&p, dir, MAXPATHL, ",");
2822 }
2823 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002824 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002825 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002826 if (r)
2827 {
2828#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2829 if (p_confirm || cmdmod.confirm)
2830 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002831 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002832
2833 dialog_msg(buff,
2834 _("Swap file \"%s\" exists, overwrite anyway?"),
2835 swapname);
2836 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2837 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002838 {
2839 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002840 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002841 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002842 eap->forceit = TRUE;
2843 }
2844 else
2845#endif
2846 {
2847 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2848 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002849 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002850 return FAIL;
2851 }
2852 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002853 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 }
2855 }
2856 return OK;
2857}
2858
2859/*
2860 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2861 */
2862 void
2863ex_wnext(eap)
2864 exarg_T *eap;
2865{
2866 int i;
2867
2868 if (eap->cmd[1] == 'n')
2869 i = curwin->w_arg_idx + (int)eap->line2;
2870 else
2871 i = curwin->w_arg_idx - (int)eap->line2;
2872 eap->line1 = 1;
2873 eap->line2 = curbuf->b_ml.ml_line_count;
2874 if (do_write(eap) != FAIL)
2875 do_argfile(eap, i);
2876}
2877
2878/*
2879 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2880 */
2881 void
2882do_wqall(eap)
2883 exarg_T *eap;
2884{
2885 buf_T *buf;
2886 int error = 0;
2887 int save_forceit = eap->forceit;
2888
2889 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2890 exiting = TRUE;
2891
2892 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2893 {
2894 if (bufIsChanged(buf))
2895 {
2896 /*
2897 * Check if there is a reason the buffer cannot be written:
2898 * 1. if the 'write' option is set
2899 * 2. if there is no file name (even after browsing)
2900 * 3. if the 'readonly' is set (even after a dialog)
2901 * 4. if overwriting is allowed (even after a dialog)
2902 */
2903 if (not_writing())
2904 {
2905 ++error;
2906 break;
2907 }
2908#ifdef FEAT_BROWSE
2909 /* ":browse wall": ask for file name if there isn't one */
2910 if (buf->b_ffname == NULL && cmdmod.browse)
2911 browse_save_fname(buf);
2912#endif
2913 if (buf->b_ffname == NULL)
2914 {
2915 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2916 ++error;
2917 }
2918 else if (check_readonly(&eap->forceit, buf)
2919 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2920 FALSE) == FAIL)
2921 {
2922 ++error;
2923 }
2924 else
2925 {
2926 if (buf_write_all(buf, eap->forceit) == FAIL)
2927 ++error;
2928#ifdef FEAT_AUTOCMD
2929 /* an autocommand may have deleted the buffer */
2930 if (!buf_valid(buf))
2931 buf = firstbuf;
2932#endif
2933 }
2934 eap->forceit = save_forceit; /* check_overwrite() may set it */
2935 }
2936 }
2937 if (exiting)
2938 {
2939 if (!error)
2940 getout(0); /* exit Vim */
2941 not_exiting();
2942 }
2943}
2944
2945/*
2946 * Check the 'write' option.
2947 * Return TRUE and give a message when it's not st.
2948 */
2949 int
2950not_writing()
2951{
2952 if (p_write)
2953 return FALSE;
2954 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2955 return TRUE;
2956}
2957
2958/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002959 * Check if a buffer is read-only (either 'readonly' option is set or file is
2960 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2961 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 */
2963 static int
2964check_readonly(forceit, buf)
2965 int *forceit;
2966 buf_T *buf;
2967{
Bram Moolenaar5386a122007-06-28 20:02:32 +00002968 struct stat st;
2969
2970 /* Handle a file being readonly when the 'readonly' option is set or when
2971 * the file exists and permissions are read-only.
2972 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2973 * important for device checks but not here. */
2974 if (!*forceit && (buf->b_p_ro
2975 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2976 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 {
2978#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2979 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2980 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002981 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982
Bram Moolenaar5386a122007-06-28 20:02:32 +00002983 if (buf->b_p_ro)
2984 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2985 buf->b_fname);
2986 else
2987 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 +00002988 buf->b_fname);
2989
2990 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2991 {
2992 /* Set forceit, to force the writing of a readonly file */
2993 *forceit = TRUE;
2994 return FALSE;
2995 }
2996 else
2997 return TRUE;
2998 }
2999 else
3000#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00003001 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00003003 else
3004 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
3005 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 return TRUE;
3007 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00003008
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 return FALSE;
3010}
3011
3012/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003013 * Try to abandon current file and edit a new or existing file.
3014 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003016 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003017 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3019 */
3020 int
3021getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3022 int fnum;
3023 char_u *ffname;
3024 char_u *sfname;
3025 int setpm;
3026 linenr_T lnum;
3027 int forceit;
3028{
3029 int other;
3030 int retval;
3031 char_u *free_me = NULL;
3032
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003033 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003035#ifdef FEAT_AUTOCMD
3036 if (curbuf_locked())
3037 return 1;
3038#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039
3040 if (fnum == 0)
3041 {
3042 /* make ffname full path, set sfname */
3043 fname_expand(curbuf, &ffname, &sfname);
3044 other = otherfile(ffname);
3045 free_me = ffname; /* has been allocated, free() later */
3046 }
3047 else
3048 other = (fnum != curbuf->b_fnum);
3049
3050 if (other)
3051 ++no_wait_return; /* don't wait for autowrite message */
3052 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3053 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3054 {
3055#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3056 if (p_confirm && p_write)
3057 dialog_changed(curbuf, FALSE);
3058 if (curbufIsChanged())
3059#endif
3060 {
3061 if (other)
3062 --no_wait_return;
3063 EMSG(_(e_nowrtmsg));
3064 retval = 2; /* file has been changed */
3065 goto theend;
3066 }
3067 }
3068 if (other)
3069 --no_wait_return;
3070 if (setpm)
3071 setpcmark();
3072 if (!other)
3073 {
3074 if (lnum != 0)
3075 curwin->w_cursor.lnum = lnum;
3076 check_cursor_lnum();
3077 beginline(BL_SOL | BL_FIX);
3078 retval = 0; /* it's in the same file */
3079 }
3080 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003081 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3082 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 retval = -1; /* opened another file */
3084 else
3085 retval = 1; /* error encountered */
3086
3087theend:
3088 vim_free(free_me);
3089 return retval;
3090}
3091
3092/*
3093 * start editing a new file
3094 *
3095 * fnum: file number; if zero use ffname/sfname
3096 * ffname: the file name
3097 * - full path if sfname used,
3098 * - any file name if sfname is NULL
3099 * - empty string to re-edit with the same file name (but may be
3100 * in a different directory)
3101 * - NULL to start an empty buffer
3102 * sfname: the short file name (or NULL)
3103 * eap: contains the command to be executed after loading the file and
3104 * forced 'ff' and 'fenc'
3105 * newlnum: if > 0: put cursor on this line number (if possible)
3106 * if ECMD_LASTL: use last position in loaded file
3107 * if ECMD_LAST: use last position in all files
3108 * if ECMD_ONE: use first line
3109 * flags:
3110 * ECMD_HIDE: if TRUE don't free the current buffer
3111 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3112 * ECMD_OLDBUF: use existing buffer if it exists
3113 * ECMD_FORCEIT: ! used for Ex command
3114 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003115 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003116 * window, NULL when splitting the window first. When not NULL info
3117 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 *
3119 * return FAIL for failure, OK otherwise
3120 */
3121 int
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003122do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 int fnum;
3124 char_u *ffname;
3125 char_u *sfname;
3126 exarg_T *eap; /* can be NULL! */
3127 linenr_T newlnum;
3128 int flags;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003129 win_T *oldwin;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130{
3131 int other_file; /* TRUE if editing another file */
3132 int oldbuf; /* TRUE if using existing buffer */
3133#ifdef FEAT_AUTOCMD
3134 int auto_buf = FALSE; /* TRUE if autocommands brought us
3135 into the buffer unexpectedly */
3136 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003137 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138#endif
3139 buf_T *buf;
3140#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3141 buf_T *old_curbuf = curbuf;
3142#endif
3143 char_u *free_fname = NULL;
3144#ifdef FEAT_BROWSE
3145 char_u *browse_file = NULL;
3146#endif
3147 int retval = FAIL;
3148 long n;
3149 linenr_T lnum;
3150 linenr_T topline = 0;
3151 int newcol = -1;
3152 int solcol = -1;
3153 pos_T *pos;
3154#ifdef FEAT_SUN_WORKSHOP
3155 char_u *cp;
3156#endif
3157 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003158#ifdef FEAT_SPELL
3159 int did_get_winopts = FALSE;
3160#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003161 int readfile_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162
3163 if (eap != NULL)
3164 command = eap->do_ecmd_cmd;
3165
3166 if (fnum != 0)
3167 {
3168 if (fnum == curbuf->b_fnum) /* file is already being edited */
3169 return OK; /* nothing to do */
3170 other_file = TRUE;
3171 }
3172 else
3173 {
3174#ifdef FEAT_BROWSE
3175 if (cmdmod.browse)
3176 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003177# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003178 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003179# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003180 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003181# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003182 au_has_group((char_u *)"FileExplorer"))
3183 {
3184 /* No browsing supported but we do have the file explorer:
3185 * Edit the directory. */
3186 if (ffname == NULL || !mch_isdir(ffname))
3187 ffname = (char_u *)".";
3188 }
3189 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003190# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003191 {
3192 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003194 if (browse_file == NULL)
3195 goto theend;
3196 ffname = browse_file;
3197 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 }
3199#endif
3200 /* if no short name given, use ffname for short name */
3201 if (sfname == NULL)
3202 sfname = ffname;
3203#ifdef USE_FNAME_CASE
3204# ifdef USE_LONG_FNAME
3205 if (USE_LONG_FNAME)
3206# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003207 if (sfname != NULL)
3208 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209#endif
3210
3211#ifdef FEAT_LISTCMDS
3212 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3213 goto theend;
3214#endif
3215
3216 if (ffname == NULL)
3217 other_file = TRUE;
3218 /* there is no file name */
3219 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3220 other_file = FALSE;
3221 else
3222 {
3223 if (*ffname == NUL) /* re-edit with same file name */
3224 {
3225 ffname = curbuf->b_ffname;
3226 sfname = curbuf->b_fname;
3227 }
3228 free_fname = fix_fname(ffname); /* may expand to full path name */
3229 if (free_fname != NULL)
3230 ffname = free_fname;
3231 other_file = otherfile(ffname);
3232#ifdef FEAT_SUN_WORKSHOP
3233 if (usingSunWorkShop && p_acd
3234 && (cp = vim_strrchr(sfname, '/')) != NULL)
3235 sfname = ++cp;
3236#endif
3237 }
3238 }
3239
3240 /*
3241 * if the file was changed we may not be allowed to abandon it
3242 * - if we are going to re-edit the same file
3243 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3244 */
3245 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3246 || (curbuf->b_nwindows == 1
3247 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3248 && check_changed(curbuf, p_awa, !other_file,
3249 (flags & ECMD_FORCEIT), FALSE))
3250 {
3251 if (fnum == 0 && other_file && ffname != NULL)
3252 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3253 goto theend;
3254 }
3255
3256#ifdef FEAT_VISUAL
3257 /*
3258 * End Visual mode before switching to another buffer, so the text can be
3259 * copied into the GUI selection buffer.
3260 */
3261 reset_VIsual();
3262#endif
3263
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003264#ifdef FEAT_AUTOCMD
3265 if ((command != NULL || newlnum > (linenr_T)0)
3266 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3267 {
3268 int len;
3269 char_u *p;
3270
3271 /* Set v:swapcommand for the SwapExists autocommands. */
3272 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003273 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003274 else
3275 len = 30;
3276 p = alloc((unsigned)len);
3277 if (p != NULL)
3278 {
3279 if (command != NULL)
3280 vim_snprintf((char *)p, len, ":%s\r", command);
3281 else
3282 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3283 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3284 did_set_swapcommand = TRUE;
3285 vim_free(p);
3286 }
3287 }
3288#endif
3289
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 /*
3291 * If we are starting to edit another file, open a (new) buffer.
3292 * Otherwise we re-use the current buffer.
3293 */
3294 if (other_file)
3295 {
3296#ifdef FEAT_LISTCMDS
3297 if (!(flags & ECMD_ADDBUF))
3298#endif
3299 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003300 if (!cmdmod.keepalt)
3301 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003302 if (oldwin != NULL)
3303 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 }
3305
3306 if (fnum)
3307 buf = buflist_findnr(fnum);
3308 else
3309 {
3310#ifdef FEAT_LISTCMDS
3311 if (flags & ECMD_ADDBUF)
3312 {
3313 linenr_T tlnum = 1L;
3314
3315 if (command != NULL)
3316 {
3317 tlnum = atol((char *)command);
3318 if (tlnum <= 0)
3319 tlnum = 1L;
3320 }
3321 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3322 goto theend;
3323 }
3324#endif
3325 buf = buflist_new(ffname, sfname, 0L,
3326 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3327 }
3328 if (buf == NULL)
3329 goto theend;
3330 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3331 {
3332 oldbuf = FALSE;
3333 buf->b_nwindows = 0;
3334 }
3335 else /* existing memfile */
3336 {
3337 oldbuf = TRUE;
3338 (void)buf_check_timestamp(buf, FALSE);
3339 /* Check if autocommands made buffer invalid or changed the current
3340 * buffer. */
3341 if (!buf_valid(buf)
3342#ifdef FEAT_AUTOCMD
3343 || curbuf != old_curbuf
3344#endif
3345 )
3346 goto theend;
3347#ifdef FEAT_EVAL
3348 if (aborting()) /* autocmds may abort script processing */
3349 goto theend;
3350#endif
3351 }
3352
3353 /* May jump to last used line number for a loaded buffer or when asked
3354 * for explicitly */
3355 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3356 {
3357 pos = buflist_findfpos(buf);
3358 newlnum = pos->lnum;
3359 solcol = pos->col;
3360 }
3361
3362 /*
3363 * Make the (new) buffer the one used by the current window.
3364 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3365 * If the current buffer was empty and has no file name, curbuf
3366 * is returned by buflist_new().
3367 */
3368 if (buf != curbuf)
3369 {
3370#ifdef FEAT_AUTOCMD
3371 /*
3372 * Be careful: The autocommands may delete any buffer and change
3373 * the current buffer.
3374 * - If the buffer we are going to edit is deleted, give up.
3375 * - If the current buffer is deleted, prefer to load the new
3376 * buffer when loading a buffer is required. This avoids
3377 * loading another buffer which then must be closed again.
3378 * - If we ended up in the new buffer already, need to skip a few
3379 * things, set auto_buf.
3380 */
3381 if (buf->b_fname != NULL)
3382 new_name = vim_strsave(buf->b_fname);
3383 au_new_curbuf = buf;
3384 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3385 if (!buf_valid(buf)) /* new buffer has been deleted */
3386 {
3387 delbuf_msg(new_name); /* frees new_name */
3388 goto theend;
3389 }
3390# ifdef FEAT_EVAL
3391 if (aborting()) /* autocmds may abort script processing */
3392 {
3393 vim_free(new_name);
3394 goto theend;
3395 }
3396# endif
3397 if (buf == curbuf) /* already in new buffer */
3398 auto_buf = TRUE;
3399 else
3400 {
3401 if (curbuf == old_curbuf)
3402#endif
3403 buf_copy_options(buf, BCO_ENTER);
3404
3405 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003406 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003407 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003408 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409
3410#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003411 /* Autocommands may open a new window and leave oldwin open
3412 * which leads to crashes since the above call sets
3413 * oldwin->w_buffer to NULL. */
3414 if (curwin != oldwin && oldwin != aucmd_win
3415 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3416 win_close(oldwin, FALSE);
3417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418# ifdef FEAT_EVAL
3419 if (aborting()) /* autocmds may abort script processing */
3420 {
3421 vim_free(new_name);
3422 goto theend;
3423 }
3424# endif
3425 /* Be careful again, like above. */
3426 if (!buf_valid(buf)) /* new buffer has been deleted */
3427 {
3428 delbuf_msg(new_name); /* frees new_name */
3429 goto theend;
3430 }
3431 if (buf == curbuf) /* already in new buffer */
3432 auto_buf = TRUE;
3433 else
3434#endif
3435 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003436#ifdef FEAT_SYN_HL
3437 /*
3438 * <VN> We could instead free the synblock
3439 * and re-attach to buffer, perhaps.
3440 */
3441 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003442 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003443#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 curwin->w_buffer = buf;
3445 curbuf = buf;
3446 ++curbuf->b_nwindows;
3447 /* set 'fileformat' */
3448 if (*p_ffs && !oldbuf)
3449 set_fileformat(default_fileformat(), OPT_LOCAL);
3450 }
3451
3452 /* May get the window options from the last time this buffer
3453 * was in this window (or another window). If not used
3454 * before, reset the local window options to the global
3455 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003456 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003457#ifdef FEAT_SPELL
3458 did_get_winopts = TRUE;
3459#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460
3461#ifdef FEAT_AUTOCMD
3462 }
3463 vim_free(new_name);
3464 au_new_curbuf = NULL;
3465#endif
3466 }
3467 else
3468 ++curbuf->b_nwindows;
3469
3470 curwin->w_pcmark.lnum = 1;
3471 curwin->w_pcmark.col = 0;
3472 }
3473 else /* !other_file */
3474 {
3475 if (
3476#ifdef FEAT_LISTCMDS
3477 (flags & ECMD_ADDBUF) ||
3478#endif
3479 check_fname() == FAIL)
3480 goto theend;
3481 oldbuf = (flags & ECMD_OLDBUF);
3482 }
3483
3484 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3485 {
3486 char_u *p;
3487
3488 curbuf->b_help = TRUE;
3489#ifdef FEAT_QUICKFIX
3490 set_string_option_direct((char_u *)"buftype", -1,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003491 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492#endif
3493
3494 /*
3495 * Always set these options after jumping to a help tag, because the
3496 * user may have an autocommand that gets in the way.
3497 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3498 * latin1 word characters (for translated help files).
3499 * Only set it when needed, buf_init_chartab() is some work.
3500 */
3501 p =
3502#ifdef EBCDIC
3503 (char_u *)"65-255,^*,^|,^\"";
3504#else
3505 (char_u *)"!-~,^*,^|,^\",192-255";
3506#endif
3507 if (STRCMP(curbuf->b_p_isk, p) != 0)
3508 {
3509 set_string_option_direct((char_u *)"isk", -1, p,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003510 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 check_buf_options(curbuf);
3512 (void)buf_init_chartab(curbuf, FALSE);
3513 }
3514
3515 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3516 curwin->w_p_list = FALSE; /* no list mode */
3517
3518 curbuf->b_p_ma = FALSE; /* not modifiable */
3519 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3520 curwin->w_p_nu = 0; /* no line numbers */
Bram Moolenaar64486672010-05-16 15:46:46 +02003521 curwin->w_p_rnu = 0; /* no relative line numbers */
Bram Moolenaar3368ea22010-09-21 16:56:35 +02003522 RESET_BINDING(curwin); /* no scroll or cursor binding */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523#ifdef FEAT_ARABIC
3524 curwin->w_p_arab = FALSE; /* no arabic mode */
3525#endif
3526#ifdef FEAT_RIGHTLEFT
3527 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3528#endif
3529#ifdef FEAT_FOLDING
3530 curwin->w_p_fen = FALSE; /* No folding in the help window */
3531#endif
3532#ifdef FEAT_DIFF
3533 curwin->w_p_diff = FALSE; /* No 'diff' */
3534#endif
Bram Moolenaara1956f62006-03-12 22:18:00 +00003535#ifdef FEAT_SPELL
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00003536 curwin->w_p_spell = FALSE; /* No spell checking */
3537#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538
3539#ifdef FEAT_AUTOCMD
3540 buf = curbuf;
3541#endif
3542 set_buflisted(FALSE);
3543 }
3544 else
3545 {
3546#ifdef FEAT_AUTOCMD
3547 buf = curbuf;
3548#endif
3549 /* Don't make a buffer listed if it's a help buffer. Useful when
3550 * using CTRL-O to go back to a help file. */
3551 if (!curbuf->b_help)
3552 set_buflisted(TRUE);
3553 }
3554
3555#ifdef FEAT_AUTOCMD
3556 /* If autocommands change buffers under our fingers, forget about
3557 * editing the file. */
3558 if (buf != curbuf)
3559 goto theend;
3560# ifdef FEAT_EVAL
3561 if (aborting()) /* autocmds may abort script processing */
3562 goto theend;
3563# endif
3564
3565 /* Since we are starting to edit a file, consider the filetype to be
3566 * unset. Helps for when an autocommand changes files and expects syntax
3567 * highlighting to work in the other file. */
3568 did_filetype = FALSE;
3569#endif
3570
3571/*
3572 * other_file oldbuf
3573 * FALSE FALSE re-edit same file, buffer is re-used
3574 * FALSE TRUE re-edit same file, nothing changes
3575 * TRUE FALSE start editing new file, new buffer
3576 * TRUE TRUE start editing in existing buffer (nothing to do)
3577 */
3578 if (!other_file && !oldbuf) /* re-use the buffer */
3579 {
3580 set_last_cursor(curwin); /* may set b_last_cursor */
3581 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3582 {
3583 newlnum = curwin->w_cursor.lnum;
3584 solcol = curwin->w_cursor.col;
3585 }
3586#ifdef FEAT_AUTOCMD
3587 buf = curbuf;
3588 if (buf->b_fname != NULL)
3589 new_name = vim_strsave(buf->b_fname);
3590 else
3591 new_name = NULL;
3592#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003593 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
3594 {
3595 /* Save all the text, so that the reload can be undone.
3596 * Sync first so that this is a separate undo-able action. */
3597 u_sync(FALSE);
3598 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
3599 == FAIL)
3600 goto theend;
3601 u_unchanged(curbuf);
3602 buf_freeall(curbuf, BFA_KEEP_UNDO);
3603
3604 /* tell readfile() not to clear or reload undo info */
3605 readfile_flags = READ_KEEP_UNDO;
3606 }
3607 else
3608 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609#ifdef FEAT_AUTOCMD
3610 /* If autocommands deleted the buffer we were going to re-edit, give
3611 * up and jump to the end. */
3612 if (!buf_valid(buf))
3613 {
3614 delbuf_msg(new_name); /* frees new_name */
3615 goto theend;
3616 }
3617 vim_free(new_name);
3618
3619 /* If autocommands change buffers under our fingers, forget about
3620 * re-editing the file. Should do the buf_clear_file(), but perhaps
3621 * the autocommands changed the buffer... */
3622 if (buf != curbuf)
3623 goto theend;
3624# ifdef FEAT_EVAL
3625 if (aborting()) /* autocmds may abort script processing */
3626 goto theend;
3627# endif
3628#endif
3629 buf_clear_file(curbuf);
3630 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3631 curbuf->b_op_end.lnum = 0;
3632 }
3633
3634/*
3635 * If we get here we are sure to start editing
3636 */
3637 /* don't redraw until the cursor is in the right line */
3638 ++RedrawingDisabled;
3639
3640 /* Assume success now */
3641 retval = OK;
3642
3643 /*
3644 * Reset cursor position, could be used by autocommands.
3645 */
3646 check_cursor();
3647
3648 /*
3649 * Check if we are editing the w_arg_idx file in the argument list.
3650 */
3651 check_arg_idx(curwin);
3652
3653#ifdef FEAT_AUTOCMD
3654 if (!auto_buf)
3655#endif
3656 {
3657 /*
3658 * Set cursor and init window before reading the file and executing
3659 * autocommands. This allows for the autocommands to position the
3660 * cursor.
3661 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003662 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663
3664#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003665 /* It's possible that all lines in the buffer changed. Need to update
3666 * automatic folding for all windows where it's used. */
3667# ifdef FEAT_WINDOWS
3668 {
3669 win_T *win;
3670 tabpage_T *tp;
3671
3672 FOR_ALL_TAB_WINDOWS(tp, win)
3673 if (win->w_buffer == curbuf)
3674 foldUpdateAll(win);
3675 }
3676# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003678# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679#endif
3680
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003681 /* Change directories when the 'acd' option is set. */
3682 DO_AUTOCHDIR
3683
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 /*
3685 * Careful: open_buffer() and apply_autocmds() may change the current
3686 * buffer and window.
3687 */
3688 lnum = curwin->w_cursor.lnum;
3689 topline = curwin->w_topline;
3690 if (!oldbuf) /* need to read the file */
3691 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003692#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 swap_exists_action = SEA_DIALOG;
3694#endif
3695 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3696
3697 /*
3698 * Open the buffer and read the file.
3699 */
3700#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003701 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 retval = FAIL;
3703#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003704 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705#endif
3706
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003707#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 if (swap_exists_action == SEA_QUIT)
3709 retval = FAIL;
3710 handle_swap_exists(old_curbuf);
3711#endif
3712 }
3713#ifdef FEAT_AUTOCMD
3714 else
3715 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003716 /* Read the modelines, but only to set window-local options. Any
3717 * buffer-local options have already been set and may have been
3718 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003719 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003720
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3722 &retval);
3723 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3724 &retval);
3725 }
3726 check_arg_idx(curwin);
3727#endif
3728
3729 /*
3730 * If autocommands change the cursor position or topline, we should
3731 * keep it.
3732 */
3733 if (curwin->w_cursor.lnum != lnum)
3734 {
3735 newlnum = curwin->w_cursor.lnum;
3736 newcol = curwin->w_cursor.col;
3737 }
3738 if (curwin->w_topline == topline)
3739 topline = 0;
3740
3741 /* Even when cursor didn't move we need to recompute topline. */
3742 changed_line_abv_curs();
3743
3744#ifdef FEAT_TITLE
3745 maketitle();
3746#endif
3747 }
3748
3749#ifdef FEAT_DIFF
3750 /* Tell the diff stuff that this buffer is new and/or needs updating.
3751 * Also needed when re-editing the same buffer, because unloading will
3752 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003753 if (curwin->w_p_diff)
3754 {
3755 diff_buf_add(curbuf);
3756 diff_invalidate(curbuf);
3757 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758#endif
3759
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003760#ifdef FEAT_SPELL
3761 /* If the window options were changed may need to set the spell language.
3762 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003763 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3764 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003765#endif
3766
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 if (command == NULL)
3768 {
3769 if (newcol >= 0) /* position set by autocommands */
3770 {
3771 curwin->w_cursor.lnum = newlnum;
3772 curwin->w_cursor.col = newcol;
3773 check_cursor();
3774 }
3775 else if (newlnum > 0) /* line number from caller or old position */
3776 {
3777 curwin->w_cursor.lnum = newlnum;
3778 check_cursor_lnum();
3779 if (solcol >= 0 && !p_sol)
3780 {
3781 /* 'sol' is off: Use last known column. */
3782 curwin->w_cursor.col = solcol;
3783 check_cursor_col();
3784#ifdef FEAT_VIRTUALEDIT
3785 curwin->w_cursor.coladd = 0;
3786#endif
3787 curwin->w_set_curswant = TRUE;
3788 }
3789 else
3790 beginline(BL_SOL | BL_FIX);
3791 }
3792 else /* no line number, go to last line in Ex mode */
3793 {
3794 if (exmode_active)
3795 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3796 beginline(BL_WHITE | BL_FIX);
3797 }
3798 }
3799
3800#ifdef FEAT_WINDOWS
3801 /* Check if cursors in other windows on the same buffer are still valid */
3802 check_lnums(FALSE);
3803#endif
3804
3805 /*
3806 * Did not read the file, need to show some info about the file.
3807 * Do this after setting the cursor.
3808 */
3809 if (oldbuf
3810#ifdef FEAT_AUTOCMD
3811 && !auto_buf
3812#endif
3813 )
3814 {
3815 int msg_scroll_save = msg_scroll;
3816
3817 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3818 * message. */
3819 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3820 msg_scroll = FALSE;
3821 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3822 check_for_delay(FALSE);
3823 msg_start();
3824 msg_scroll = msg_scroll_save;
3825 msg_scrolled_ign = TRUE;
3826
3827 fileinfo(FALSE, TRUE, FALSE);
3828
3829 msg_scrolled_ign = FALSE;
3830 }
3831
3832 if (command != NULL)
3833 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3834
3835#ifdef FEAT_KEYMAP
3836 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003837 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838#endif
3839
3840 --RedrawingDisabled;
3841 if (!skip_redraw)
3842 {
3843 n = p_so;
3844 if (topline == 0 && command == NULL)
3845 p_so = 999; /* force cursor halfway the window */
3846 update_topline();
3847#ifdef FEAT_SCROLLBIND
3848 curwin->w_scbind_pos = curwin->w_topline;
3849#endif
3850 p_so = n;
3851 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3852 }
3853
3854 if (p_im)
3855 need_start_insertmode = TRUE;
3856
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003857 /* Change directories when the 'acd' option is set. */
3858 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00003860#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003861 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 {
3863# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02003864 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3866# endif
3867# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003868 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003869 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870# endif
3871 }
3872#endif
3873
3874theend:
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003875#ifdef FEAT_AUTOCMD
3876 if (did_set_swapcommand)
3877 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3878#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879#ifdef FEAT_BROWSE
3880 vim_free(browse_file);
3881#endif
3882 vim_free(free_fname);
3883 return retval;
3884}
3885
3886#ifdef FEAT_AUTOCMD
3887 static void
3888delbuf_msg(name)
3889 char_u *name;
3890{
3891 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3892 name == NULL ? (char_u *)"" : name);
3893 vim_free(name);
3894 au_new_curbuf = NULL;
3895}
3896#endif
3897
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003898static int append_indent = 0; /* autoindent for first line */
3899
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900/*
3901 * ":insert" and ":append", also used by ":change"
3902 */
3903 void
3904ex_append(eap)
3905 exarg_T *eap;
3906{
3907 char_u *theline;
3908 int did_undo = FALSE;
3909 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003910 int indent = 0;
3911 char_u *p;
3912 int vcol;
3913 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003915 /* the ! flag toggles autoindent */
3916 if (eap->forceit)
3917 curbuf->b_p_ai = !curbuf->b_p_ai;
3918
3919 /* First autoindent comes from the line we start on */
3920 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3921 append_indent = get_indent_lnum(lnum);
3922
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 if (eap->cmdidx != CMD_append)
3924 --lnum;
3925
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003926 /* when the buffer is empty append to line 0 and delete the dummy line */
3927 if (empty && lnum == 1)
3928 lnum = 0;
3929
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 State = INSERT; /* behave like in Insert mode */
3931 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3932 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003933
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003934 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 {
3936 msg_scroll = TRUE;
3937 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003938 if (curbuf->b_p_ai)
3939 {
3940 if (append_indent >= 0)
3941 {
3942 indent = append_indent;
3943 append_indent = -1;
3944 }
3945 else if (lnum > 0)
3946 indent = get_indent_lnum(lnum);
3947 }
3948 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003950 {
3951 /* No getline() function, use the lines that follow. This ends
3952 * when there is no more. */
3953 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3954 break;
3955 p = vim_strchr(eap->nextcmd, NL);
3956 if (p == NULL)
3957 p = eap->nextcmd + STRLEN(eap->nextcmd);
3958 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3959 if (*p != NUL)
3960 ++p;
3961 eap->nextcmd = p;
3962 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 else
3964 theline = eap->getline(
3965#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003966 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003968 NUL, eap->cookie, indent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003970 if (theline == NULL)
3971 break;
3972
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003973 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3974 if (ex_keep_indent)
3975 append_indent = indent;
3976
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003977 /* Look for the "." after automatic indent. */
3978 vcol = 0;
3979 for (p = theline; indent > vcol; ++p)
3980 {
3981 if (*p == ' ')
3982 ++vcol;
3983 else if (*p == TAB)
3984 vcol += 8 - vcol % 8;
3985 else
3986 break;
3987 }
3988 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003989 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3990 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 {
3992 vim_free(theline);
3993 break;
3994 }
3995
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003996 /* don't use autoindent if nothing was typed. */
3997 if (p[0] == NUL)
3998 theline[0] = NUL;
3999
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 did_undo = TRUE;
4001 ml_append(lnum, theline, (colnr_T)0, FALSE);
4002 appended_lines_mark(lnum, 1L);
4003
4004 vim_free(theline);
4005 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004006
4007 if (empty)
4008 {
4009 ml_delete(2L, FALSE);
4010 empty = FALSE;
4011 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 }
4013 State = NORMAL;
4014
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004015 if (eap->forceit)
4016 curbuf->b_p_ai = !curbuf->b_p_ai;
4017
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004019 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 * "end" is set to lnum when something has been appended, otherwise
4021 * it is the same than "start" -- Acevedo */
4022 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4023 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4024 if (eap->cmdidx != CMD_append)
4025 --curbuf->b_op_start.lnum;
4026 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4027 ? lnum : curbuf->b_op_start.lnum;
4028 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4029 curwin->w_cursor.lnum = lnum;
4030 check_cursor_lnum();
4031 beginline(BL_SOL | BL_FIX);
4032
4033 need_wait_return = FALSE; /* don't use wait_return() now */
4034 ex_no_reprint = TRUE;
4035}
4036
4037/*
4038 * ":change"
4039 */
4040 void
4041ex_change(eap)
4042 exarg_T *eap;
4043{
4044 linenr_T lnum;
4045
4046 if (eap->line2 >= eap->line1
4047 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4048 return;
4049
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004050 /* the ! flag toggles autoindent */
4051 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4052 append_indent = get_indent_lnum(eap->line1);
4053
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4055 {
4056 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4057 break;
4058 ml_delete(eap->line1, FALSE);
4059 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004060
4061 /* make sure the cursor is not beyond the end of the file now */
4062 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4064
4065 /* ":append" on the line above the deleted lines. */
4066 eap->line2 = eap->line1;
4067 ex_append(eap);
4068}
4069
4070 void
4071ex_z(eap)
4072 exarg_T *eap;
4073{
4074 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004075 int bigness;
4076 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 int minus = 0;
4078 linenr_T start, end, curs, i;
4079 int j;
4080 linenr_T lnum = eap->line2;
4081
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004082 /* Vi compatible: ":z!" uses display height, without a count uses
4083 * 'scroll' */
4084 if (eap->forceit)
4085 bigness = curwin->w_height;
4086 else if (firstwin == lastwin)
4087 bigness = curwin->w_p_scr * 2;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004088#ifdef FEAT_WINDOWS
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004089 else
4090 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004091#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 if (bigness < 1)
4093 bigness = 1;
4094
4095 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004096 kind = x;
4097 if (*kind == '-' || *kind == '+' || *kind == '='
4098 || *kind == '^' || *kind == '.')
4099 ++x;
4100 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 ++x;
4102
4103 if (*x != 0)
4104 {
4105 if (!VIM_ISDIGIT(*x))
4106 {
4107 EMSG(_("E144: non-numeric argument to :z"));
4108 return;
4109 }
4110 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004111 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004113 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004114 if (*kind == '=')
4115 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004116 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 }
4118
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004119 /* the number of '-' and '+' multiplies the distance */
4120 if (*kind == '-' || *kind == '+')
4121 for (x = kind + 1; *x == *kind; ++x)
4122 ;
4123
4124 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 {
4126 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004127 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4128 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004129 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 break;
4131
4132 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004133 start = lnum - (bigness + 1) / 2 + 1;
4134 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 curs = lnum;
4136 minus = 1;
4137 break;
4138
4139 case '^':
4140 start = lnum - bigness * 2;
4141 end = lnum - bigness;
4142 curs = lnum - bigness;
4143 break;
4144
4145 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004146 start = lnum - (bigness + 1) / 2 + 1;
4147 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 curs = end;
4149 break;
4150
4151 default: /* '+' */
4152 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004153 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004154 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004155 else if (eap->addr_count == 0)
4156 ++start;
4157 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 curs = end;
4159 break;
4160 }
4161
4162 if (start < 1)
4163 start = 1;
4164
4165 if (end > curbuf->b_ml.ml_line_count)
4166 end = curbuf->b_ml.ml_line_count;
4167
4168 if (curs > curbuf->b_ml.ml_line_count)
4169 curs = curbuf->b_ml.ml_line_count;
4170
4171 for (i = start; i <= end; i++)
4172 {
4173 if (minus && i == lnum)
4174 {
4175 msg_putchar('\n');
4176
4177 for (j = 1; j < Columns; j++)
4178 msg_putchar('-');
4179 }
4180
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004181 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182
4183 if (minus && i == lnum)
4184 {
4185 msg_putchar('\n');
4186
4187 for (j = 1; j < Columns; j++)
4188 msg_putchar('-');
4189 }
4190 }
4191
4192 curwin->w_cursor.lnum = curs;
4193 ex_no_reprint = TRUE;
4194}
4195
4196/*
4197 * Check if the restricted flag is set.
4198 * If so, give an error message and return TRUE.
4199 * Otherwise, return FALSE.
4200 */
4201 int
4202check_restricted()
4203{
4204 if (restricted)
4205 {
4206 EMSG(_("E145: Shell commands not allowed in rvim"));
4207 return TRUE;
4208 }
4209 return FALSE;
4210}
4211
4212/*
4213 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4214 * If so, give an error message and return TRUE.
4215 * Otherwise, return FALSE.
4216 */
4217 int
4218check_secure()
4219{
4220 if (secure)
4221 {
4222 secure = 2;
4223 EMSG(_(e_curdir));
4224 return TRUE;
4225 }
4226#ifdef HAVE_SANDBOX
4227 /*
4228 * In the sandbox more things are not allowed, including the things
4229 * disallowed in secure mode.
4230 */
4231 if (sandbox != 0)
4232 {
4233 EMSG(_(e_sandbox));
4234 return TRUE;
4235 }
4236#endif
4237 return FALSE;
4238}
4239
4240static char_u *old_sub = NULL; /* previous substitute pattern */
4241static int global_need_beginline; /* call beginline() after ":g" */
4242
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243/* do_sub()
4244 *
4245 * Perform a substitution from line eap->line1 to line eap->line2 using the
4246 * command pointed to by eap->arg which should be of the form:
4247 *
4248 * /pattern/substitution/{flags}
4249 *
4250 * The usual escapes are supported as described in the regexp docs.
4251 */
4252 void
4253do_sub(eap)
4254 exarg_T *eap;
4255{
4256 linenr_T lnum;
4257 long i = 0;
4258 regmmatch_T regmatch;
4259 static int do_all = FALSE; /* do multiple substitutions per line */
4260 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004261 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 static int do_error = TRUE; /* if false, ignore errors */
4263 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004264 static int do_list = FALSE; /* list last line with subs. */
4265 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 static int do_ic = 0; /* ignore case flag */
4267 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4268 int delimiter;
4269 int sublen;
4270 int got_quit = FALSE;
4271 int got_match = FALSE;
4272 int temp;
4273 int which_pat;
4274 char_u *cmd;
4275 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004276 linenr_T first_line = 0; /* first changed line */
4277 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 * change */
4279 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4280 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004281 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004282 char_u *sub_firstline; /* allocated copy of first sub line */
4283 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004284 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004285 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004286#ifdef FEAT_EVAL
4287 int save_ma = 0;
4288#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289
4290 cmd = eap->arg;
4291 if (!global_busy)
4292 {
4293 sub_nsubs = 0;
4294 sub_nlines = 0;
4295 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004296 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 if (eap->cmdidx == CMD_tilde)
4299 which_pat = RE_LAST; /* use last used regexp */
4300 else
4301 which_pat = RE_SUBST; /* use last substitute regexp */
4302
4303 /* new pattern and substitution */
4304 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4305 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4306 {
4307 /* don't accept alphanumeric for separator */
4308 if (isalpha(*cmd))
4309 {
4310 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4311 return;
4312 }
4313 /*
4314 * undocumented vi feature:
4315 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4316 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4317 */
4318 if (*cmd == '\\')
4319 {
4320 ++cmd;
4321 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4322 {
4323 EMSG(_(e_backslash));
4324 return;
4325 }
4326 if (*cmd != '&')
4327 which_pat = RE_SEARCH; /* use last '/' pattern */
4328 pat = (char_u *)""; /* empty search pattern */
4329 delimiter = *cmd++; /* remember delimiter character */
4330 }
4331 else /* find the end of the regexp */
4332 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004333#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4334 if (p_altkeymap && curwin->w_p_rl)
4335 lrF_sub(cmd);
4336#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 which_pat = RE_LAST; /* use last used regexp */
4338 delimiter = *cmd++; /* remember delimiter character */
4339 pat = cmd; /* remember start of search pat */
4340 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4341 if (cmd[0] == delimiter) /* end delimiter found */
4342 *cmd++ = NUL; /* replace it with a NUL */
4343 }
4344
4345 /*
4346 * Small incompatibility: vi sees '\n' as end of the command, but in
4347 * Vim we want to use '\n' to find/substitute a NUL.
4348 */
4349 sub = cmd; /* remember the start of the substitution */
4350
4351 while (cmd[0])
4352 {
4353 if (cmd[0] == delimiter) /* end delimiter found */
4354 {
4355 *cmd++ = NUL; /* replace it with a NUL */
4356 break;
4357 }
4358 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4359 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004360 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 }
4362
4363 if (!eap->skip)
4364 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004365 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4366 if (STRCMP(sub, "%") == 0
4367 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4368 {
4369 if (old_sub == NULL) /* there is no previous command */
4370 {
4371 EMSG(_(e_nopresub));
4372 return;
4373 }
4374 sub = old_sub;
4375 }
4376 else
4377 {
4378 vim_free(old_sub);
4379 old_sub = vim_strsave(sub);
4380 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 }
4382 }
4383 else if (!eap->skip) /* use previous pattern and substitution */
4384 {
4385 if (old_sub == NULL) /* there is no previous command */
4386 {
4387 EMSG(_(e_nopresub));
4388 return;
4389 }
4390 pat = NULL; /* search_regcomp() will use previous pattern */
4391 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004392
4393 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4394 * last column after using "$". */
4395 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 }
4397
4398 /*
4399 * Find trailing options. When '&' is used, keep old options.
4400 */
4401 if (*cmd == '&')
4402 ++cmd;
4403 else
4404 {
4405 if (!p_ed)
4406 {
4407 if (p_gd) /* default is global on */
4408 do_all = TRUE;
4409 else
4410 do_all = FALSE;
4411 do_ask = FALSE;
4412 }
4413 do_error = TRUE;
4414 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004415 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004416 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 do_ic = 0;
4418 }
4419 while (*cmd)
4420 {
4421 /*
4422 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4423 * 'r' is never inverted.
4424 */
4425 if (*cmd == 'g')
4426 do_all = !do_all;
4427 else if (*cmd == 'c')
4428 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004429 else if (*cmd == 'n')
4430 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 else if (*cmd == 'e')
4432 do_error = !do_error;
4433 else if (*cmd == 'r') /* use last used regexp */
4434 which_pat = RE_LAST;
4435 else if (*cmd == 'p')
4436 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004437 else if (*cmd == '#')
4438 {
4439 do_print = TRUE;
4440 do_number = TRUE;
4441 }
4442 else if (*cmd == 'l')
4443 {
4444 do_print = TRUE;
4445 do_list = TRUE;
4446 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 else if (*cmd == 'i') /* ignore case */
4448 do_ic = 'i';
4449 else if (*cmd == 'I') /* don't ignore case */
4450 do_ic = 'I';
4451 else
4452 break;
4453 ++cmd;
4454 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004455 if (do_count)
4456 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457
4458 /*
4459 * check for a trailing count
4460 */
4461 cmd = skipwhite(cmd);
4462 if (VIM_ISDIGIT(*cmd))
4463 {
4464 i = getdigits(&cmd);
4465 if (i <= 0 && !eap->skip && do_error)
4466 {
4467 EMSG(_(e_zerocount));
4468 return;
4469 }
4470 eap->line1 = eap->line2;
4471 eap->line2 += i - 1;
4472 if (eap->line2 > curbuf->b_ml.ml_line_count)
4473 eap->line2 = curbuf->b_ml.ml_line_count;
4474 }
4475
4476 /*
4477 * check for trailing command or garbage
4478 */
4479 cmd = skipwhite(cmd);
4480 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4481 {
4482 eap->nextcmd = check_nextcmd(cmd);
4483 if (eap->nextcmd == NULL)
4484 {
4485 EMSG(_(e_trailing));
4486 return;
4487 }
4488 }
4489
4490 if (eap->skip) /* not executing commands, only parsing */
4491 return;
4492
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004493 if (!do_count && !curbuf->b_p_ma)
4494 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004495 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004496 EMSG(_(e_modifiable));
4497 return;
4498 }
4499
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4501 {
4502 if (do_error)
4503 EMSG(_(e_invcmd));
4504 return;
4505 }
4506
4507 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4508 if (do_ic == 'i')
4509 regmatch.rmm_ic = TRUE;
4510 else if (do_ic == 'I')
4511 regmatch.rmm_ic = FALSE;
4512
4513 sub_firstline = NULL;
4514
4515 /*
4516 * ~ in the substitute pattern is replaced with the old pattern.
4517 * We do it here once to avoid it to be replaced over and over again.
4518 * But don't do it when it starts with "\=", then it's an expression.
4519 */
4520 if (!(sub[0] == '\\' && sub[1] == '='))
4521 sub = regtilde(sub, p_magic);
4522
4523 /*
4524 * Check for a match on each line.
4525 */
4526 line2 = eap->line2;
4527 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4528#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4529 || aborting()
4530#endif
4531 ); ++lnum)
4532 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004533 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4534 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 if (nmatch)
4536 {
4537 colnr_T copycol;
4538 colnr_T matchcol;
4539 colnr_T prev_matchcol = MAXCOL;
4540 char_u *new_end, *new_start = NULL;
4541 unsigned new_start_len = 0;
4542 char_u *p1;
4543 int did_sub = FALSE;
4544 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004545 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 long nmatch_tl = 0; /* nr of lines matched below lnum */
4547 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004548 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004549 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550
4551 /*
4552 * The new text is build up step by step, to avoid too much
4553 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004554 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 * copycol Column in the old text where we started
4556 * looking for a match; from here old text still
4557 * needs to be copied to the new text.
4558 * matchcol Column number of the old text where to look
4559 * for the next match. It's just after the
4560 * previous match or one further.
4561 * prev_matchcol Column just after the previous match (if any).
4562 * Mostly equal to matchcol, except for the first
4563 * match and after skipping an empty match.
4564 * regmatch.*pos Where the pattern matched in the old text.
4565 * new_start The new text, all that has been produced so
4566 * far.
4567 * new_end The new text, where to append new text.
4568 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004569 * lnum The line number where we found the start of
4570 * the match. Can be below the line we searched
4571 * when there is a \n before a \zs in the
4572 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 * sub_firstlnum The line number in the buffer where to look
4574 * for a match. Can be different from "lnum"
4575 * when the pattern or substitute string contains
4576 * line breaks.
4577 *
4578 * Special situations:
4579 * - When the substitute string contains a line break, the part up
4580 * to the line break is inserted in the text, but the copy of
4581 * the original line is kept. "sub_firstlnum" is adjusted for
4582 * the inserted lines.
4583 * - When the matched pattern contains a line break, the old line
4584 * is taken from the line at the end of the pattern. The lines
4585 * in the match are deleted later, "sub_firstlnum" is adjusted
4586 * accordingly.
4587 *
4588 * The new text is built up in new_start[]. It has some extra
4589 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004590 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 *
4592 * Make a copy of the old line, so it won't be taken away when
4593 * updating the screen or handling a multi-line match. The "old_"
4594 * pointers point into this copy.
4595 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004596 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 copycol = 0;
4598 matchcol = 0;
4599
4600 /* At first match, remember current cursor position. */
4601 if (!got_match)
4602 {
4603 setpcmark();
4604 got_match = TRUE;
4605 }
4606
4607 /*
4608 * Loop until nothing more to replace in this line.
4609 * 1. Handle match with empty string.
4610 * 2. If do_ask is set, ask for confirmation.
4611 * 3. substitute the string.
4612 * 4. if do_all is set, find next match
4613 * 5. break if there isn't another match in this line
4614 */
4615 for (;;)
4616 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004617 /* Advance "lnum" to the line where the match starts. The
4618 * match does not start in the first line when there is a line
4619 * break before \zs. */
4620 if (regmatch.startpos[0].lnum > 0)
4621 {
4622 lnum += regmatch.startpos[0].lnum;
4623 sub_firstlnum += regmatch.startpos[0].lnum;
4624 nmatch -= regmatch.startpos[0].lnum;
4625 vim_free(sub_firstline);
4626 sub_firstline = NULL;
4627 }
4628
4629 if (sub_firstline == NULL)
4630 {
4631 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4632 if (sub_firstline == NULL)
4633 {
4634 vim_free(new_start);
4635 goto outofmem;
4636 }
4637 }
4638
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 /* Save the line number of the last change for the final
4640 * cursor position (just like Vi). */
4641 curwin->w_cursor.lnum = lnum;
4642 do_again = FALSE;
4643
4644 /*
4645 * 1. Match empty string does not count, except for first
4646 * match. This reproduces the strange vi behaviour.
4647 * This also catches endless loops.
4648 */
4649 if (matchcol == prev_matchcol
4650 && regmatch.endpos[0].lnum == 0
4651 && matchcol == regmatch.endpos[0].col)
4652 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004653 if (sub_firstline[matchcol] == NUL)
4654 /* We already were at the end of the line. Don't look
4655 * for a match in this line again. */
4656 skip_match = TRUE;
4657 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004658 {
4659 /* search for a match at next column */
4660#ifdef FEAT_MBYTE
4661 if (has_mbyte)
4662 matchcol += mb_ptr2len(sub_firstline + matchcol);
4663 else
4664#endif
4665 ++matchcol;
4666 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 goto skip;
4668 }
4669
4670 /* Normally we continue searching for a match just after the
4671 * previous match. */
4672 matchcol = regmatch.endpos[0].col;
4673 prev_matchcol = matchcol;
4674
4675 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004676 * 2. If do_count is set only increase the counter.
4677 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004679 if (do_count)
4680 {
4681 /* For a multi-line match, put matchcol at the NUL at
4682 * the end of the line and set nmatch to one, so that
4683 * we continue looking for a match on the next line.
4684 * Avoids that ":s/\nB\@=//gc" get stuck. */
4685 if (nmatch > 1)
4686 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004687 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004688 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004689 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004690 }
4691 sub_nsubs++;
4692 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004693#ifdef FEAT_EVAL
4694 /* Skip the substitution, unless an expression is used,
4695 * then it is evaluated in the sandbox. */
4696 if (!(sub[0] == '\\' && sub[1] == '='))
4697#endif
4698 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004699 }
4700
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 if (do_ask)
4702 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004703 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004704
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 /* change State to CONFIRM, so that the mouse works
4706 * properly */
4707 save_State = State;
4708 State = CONFIRM;
4709#ifdef FEAT_MOUSE
4710 setmouse(); /* disable mouse in xterm */
4711#endif
4712 curwin->w_cursor.col = regmatch.startpos[0].col;
4713
4714 /* When 'cpoptions' contains "u" don't sync undo when
4715 * asking for confirmation. */
4716 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4717 ++no_u_sync;
4718
4719 /*
4720 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4721 */
4722 while (do_ask)
4723 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004724 if (exmode_active)
4725 {
4726 char_u *resp;
4727 colnr_T sc, ec;
4728
4729 print_line_no_prefix(lnum, FALSE, FALSE);
4730
4731 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4732 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4733 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4734 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004735 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004736 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004737 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004738 msg_putchar('^');
4739
4740 resp = getexmodeline('?', NULL, 0);
4741 if (resp != NULL)
4742 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004743 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004744 vim_free(resp);
4745 }
4746 }
4747 else
4748 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004749 char_u *orig_line = NULL;
4750 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004752 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004754 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004756 /* Invert the matched string.
4757 * Remove the inversion afterwards. */
4758 temp = RedrawingDisabled;
4759 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004761 if (new_start != NULL)
4762 {
4763 /* There already was a substitution, we would
4764 * like to show this to the user. We cannot
4765 * really update the line, it would change
4766 * what matches. Temporarily replace the line
4767 * and change it back afterwards. */
4768 orig_line = vim_strsave(ml_get(lnum));
4769 if (orig_line != NULL)
4770 {
4771 char_u *new_line = concat_str(new_start,
4772 sub_firstline + copycol);
4773
4774 if (new_line == NULL)
4775 {
4776 vim_free(orig_line);
4777 orig_line = NULL;
4778 }
4779 else
4780 {
4781 /* Position the cursor relative to the
4782 * end of the line, the previous
4783 * substitute may have inserted or
4784 * deleted characters before the
4785 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004786 len_change = (int)STRLEN(new_line)
4787 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004788 curwin->w_cursor.col += len_change;
4789 ml_replace(lnum, new_line, FALSE);
4790 }
4791 }
4792 }
4793
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004794 search_match_lines = regmatch.endpos[0].lnum
4795 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004796 search_match_endcol = regmatch.endpos[0].col
4797 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004798 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004800 update_topline();
4801 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004802 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004803 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004804 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
4806#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004807 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004809 if (msg_row == Rows - 1)
4810 msg_didout = FALSE; /* avoid a scroll-up */
4811 msg_starthere();
4812 i = msg_scroll;
4813 msg_scroll = 0; /* truncate msg when
4814 needed */
4815 msg_no_more = TRUE;
4816 /* write message same highlighting as for
4817 * wait_return */
4818 smsg_attr(hl_attr(HLF_R),
4819 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4820 msg_no_more = FALSE;
4821 msg_scroll = i;
4822 showruler(TRUE);
4823 windgoto(msg_row, msg_col);
4824 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825
4826#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004827 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004829 ++no_mapping; /* don't map this key */
4830 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004831 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004832 --allow_keys;
4833 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004835 /* clear the question */
4836 msg_didout = FALSE; /* don't scroll up */
4837 msg_col = 0;
4838 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004839
4840 /* restore the line */
4841 if (orig_line != NULL)
4842 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004843 }
4844
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004846 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004848 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849#endif
4850 )
4851 {
4852 got_quit = TRUE;
4853 break;
4854 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004855 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004857 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004859 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 {
4861 /* last: replace and then stop */
4862 do_all = FALSE;
4863 line2 = lnum;
4864 break;
4865 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004866 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 {
4868 do_ask = FALSE;
4869 break;
4870 }
4871#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004872 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004874 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 scrolldown_clamp();
4876#endif
4877 }
4878 State = save_State;
4879#ifdef FEAT_MOUSE
4880 setmouse();
4881#endif
4882 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4883 --no_u_sync;
4884
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004885 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 {
4887 /* For a multi-line match, put matchcol at the NUL at
4888 * the end of the line and set nmatch to one, so that
4889 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004890 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4891 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 if (nmatch > 1)
4893 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004894 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004895 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 }
4897 goto skip;
4898 }
4899 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004900 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 }
4902
4903 /* Move the cursor to the start of the match, so that we can
4904 * use "\=col("."). */
4905 curwin->w_cursor.col = regmatch.startpos[0].col;
4906
4907 /*
4908 * 3. substitute the string.
4909 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004910#ifdef FEAT_EVAL
4911 if (do_count)
4912 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004913 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004914 save_ma = curbuf->b_p_ma;
4915 curbuf->b_p_ma = FALSE;
4916 sandbox++;
4917 }
4918#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004920 sublen = vim_regsub_multi(&regmatch,
4921 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004923#ifdef FEAT_EVAL
4924 if (do_count)
4925 {
4926 curbuf->b_p_ma = save_ma;
4927 sandbox--;
4928 goto skip;
4929 }
4930#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931
Bram Moolenaar4463f292005-09-25 22:20:24 +00004932 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004933 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004934 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4935 {
4936 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4937 skip_match = TRUE;
4938 }
4939
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 /* Need room for:
4941 * - result so far in new_start (not for first sub in line)
4942 * - original text up to match
4943 * - length of substituted part
4944 * - original text after match
4945 */
4946 if (nmatch == 1)
4947 p1 = sub_firstline;
4948 else
4949 {
4950 p1 = ml_get(sub_firstlnum + nmatch - 1);
4951 nmatch_tl += nmatch - 1;
4952 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004953 copy_len = regmatch.startpos[0].col - copycol;
4954 needed_len = copy_len + ((unsigned)STRLEN(p1)
4955 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 if (new_start == NULL)
4957 {
4958 /*
4959 * Get some space for a temporary buffer to do the
4960 * substitution into (and some extra space to avoid
4961 * too many calls to alloc()/free()).
4962 */
4963 new_start_len = needed_len + 50;
4964 if ((new_start = alloc_check(new_start_len)) == NULL)
4965 goto outofmem;
4966 *new_start = NUL;
4967 new_end = new_start;
4968 }
4969 else
4970 {
4971 /*
4972 * Check if the temporary buffer is long enough to do the
4973 * substitution into. If not, make it larger (with a bit
4974 * extra to avoid too many calls to alloc()/free()).
4975 */
4976 len = (unsigned)STRLEN(new_start);
4977 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004978 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 {
4980 new_start_len = needed_len + 50;
4981 if ((p1 = alloc_check(new_start_len)) == NULL)
4982 {
4983 vim_free(new_start);
4984 goto outofmem;
4985 }
4986 mch_memmove(p1, new_start, (size_t)(len + 1));
4987 vim_free(new_start);
4988 new_start = p1;
4989 }
4990 new_end = new_start + len;
4991 }
4992
4993 /*
4994 * copy the text up to the part that matched
4995 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004996 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4997 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004999 (void)vim_regsub_multi(&regmatch,
5000 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 sub, new_end, TRUE, p_magic, TRUE);
5002 sub_nsubs++;
5003 did_sub = TRUE;
5004
5005 /* Move the cursor to the start of the line, to avoid that it
5006 * is beyond the end of the line after the substitution. */
5007 curwin->w_cursor.col = 0;
5008
5009 /* For a multi-line match, make a copy of the last matched
5010 * line and continue in that one. */
5011 if (nmatch > 1)
5012 {
5013 sub_firstlnum += nmatch - 1;
5014 vim_free(sub_firstline);
5015 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5016 /* When going beyond the last line, stop substituting. */
5017 if (sub_firstlnum <= line2)
5018 do_again = TRUE;
5019 else
5020 do_all = FALSE;
5021 }
5022
5023 /* Remember next character to be copied. */
5024 copycol = regmatch.endpos[0].col;
5025
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005026 if (skip_match)
5027 {
5028 /* Already hit end of the buffer, sub_firstlnum is one
5029 * less than what it ought to be. */
5030 vim_free(sub_firstline);
5031 sub_firstline = vim_strsave((char_u *)"");
5032 copycol = 0;
5033 }
5034
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 /*
5036 * Now the trick is to replace CTRL-M chars with a real line
5037 * break. This would make it impossible to insert a CTRL-M in
5038 * the text. The line break can be avoided by preceding the
5039 * CTRL-M with a backslash. To be able to insert a backslash,
5040 * they must be doubled in the string and are halved here.
5041 * That is Vi compatible.
5042 */
5043 for (p1 = new_end; *p1; ++p1)
5044 {
5045 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005046 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 else if (*p1 == CAR)
5048 {
5049 if (u_inssub(lnum) == OK) /* prepare for undo */
5050 {
5051 *p1 = NUL; /* truncate up to the CR */
5052 ml_append(lnum - 1, new_start,
5053 (colnr_T)(p1 - new_start + 1), FALSE);
5054 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
5055 if (do_ask)
5056 appended_lines(lnum - 1, 1L);
5057 else
5058 {
5059 if (first_line == 0)
5060 first_line = lnum;
5061 last_line = lnum + 1;
5062 }
5063 /* All line numbers increase. */
5064 ++sub_firstlnum;
5065 ++lnum;
5066 ++line2;
5067 /* move the cursor to the new line, like Vi */
5068 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005069 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005070 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 p1 = new_start - 1;
5072 }
5073 }
5074#ifdef FEAT_MBYTE
5075 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005076 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077#endif
5078 }
5079
5080 /*
5081 * 4. If do_all is set, find next match.
5082 * Prevent endless loop with patterns that match empty
5083 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5084 * But ":s/\n/#/" is OK.
5085 */
5086skip:
5087 /* We already know that we did the last subst when we are at
5088 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005089 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5090 * "line2" when there is a \zs in the pattern after a line
5091 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005092 lastone = (skip_match
5093 || got_int
5094 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005095 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005096 || !(do_all || do_again)
5097 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5098 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 nmatch = -1;
5100
5101 /*
5102 * Replace the line in the buffer when needed. This is
5103 * skipped when there are more matches.
5104 * The check for nmatch_tl is needed for when multi-line
5105 * matching must replace the lines before trying to do another
5106 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005107 * When the match starts below where we start searching also
5108 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 */
5110 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 || nmatch_tl > 0
5112 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005113 curbuf, sub_firstlnum,
5114 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005115 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 {
5117 if (new_start != NULL)
5118 {
5119 /*
5120 * Copy the rest of the line, that didn't match.
5121 * "matchcol" has to be adjusted, we use the end of
5122 * the line as reference, because the substitute may
5123 * have changed the number of characters. Same for
5124 * "prev_matchcol".
5125 */
5126 STRCAT(new_start, sub_firstline + copycol);
5127 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5128 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5129 - prev_matchcol;
5130
5131 if (u_savesub(lnum) != OK)
5132 break;
5133 ml_replace(lnum, new_start, TRUE);
5134
5135 if (nmatch_tl > 0)
5136 {
5137 /*
5138 * Matched lines have now been substituted and are
5139 * useless, delete them. The part after the match
5140 * has been appended to new_start, we don't need
5141 * it in the buffer.
5142 */
5143 ++lnum;
5144 if (u_savedel(lnum, nmatch_tl) != OK)
5145 break;
5146 for (i = 0; i < nmatch_tl; ++i)
5147 ml_delete(lnum, (int)FALSE);
5148 mark_adjust(lnum, lnum + nmatch_tl - 1,
5149 (long)MAXLNUM, -nmatch_tl);
5150 if (do_ask)
5151 deleted_lines(lnum, nmatch_tl);
5152 --lnum;
5153 line2 -= nmatch_tl; /* nr of lines decreases */
5154 nmatch_tl = 0;
5155 }
5156
5157 /* When asking, undo is saved each time, must also set
5158 * changed flag each time. */
5159 if (do_ask)
5160 changed_bytes(lnum, 0);
5161 else
5162 {
5163 if (first_line == 0)
5164 first_line = lnum;
5165 last_line = lnum + 1;
5166 }
5167
5168 sub_firstlnum = lnum;
5169 vim_free(sub_firstline); /* free the temp buffer */
5170 sub_firstline = new_start;
5171 new_start = NULL;
5172 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5173 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5174 - prev_matchcol;
5175 copycol = 0;
5176 }
5177 if (nmatch == -1 && !lastone)
5178 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005179 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180
5181 /*
5182 * 5. break if there isn't another match in this line
5183 */
5184 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005185 {
5186 /* If the match found didn't start where we were
5187 * searching, do the next search in the line where we
5188 * found the match. */
5189 if (nmatch == -1)
5190 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005192 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 }
5194
5195 line_breakcheck();
5196 }
5197
5198 if (did_sub)
5199 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005200 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 vim_free(sub_firstline); /* free the copy of the original line */
5202 sub_firstline = NULL;
5203 }
5204
5205 line_breakcheck();
5206 }
5207
5208 if (first_line != 0)
5209 {
5210 /* Need to subtract the number of added lines from "last_line" to get
5211 * the line number before the change (same as adding the number of
5212 * deleted lines). */
5213 i = curbuf->b_ml.ml_line_count - old_line_count;
5214 changed_lines(first_line, 0, last_line - i, i);
5215 }
5216
5217outofmem:
5218 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005219
5220 /* ":s/pat//n" doesn't move the cursor */
5221 if (do_count)
5222 curwin->w_cursor = old_cursor;
5223
Bram Moolenaar46475522010-03-23 17:36:29 +01005224 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 {
5226 /* Set the '[ and '] marks. */
5227 curbuf->b_op_start.lnum = eap->line1;
5228 curbuf->b_op_end.lnum = line2;
5229 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5230
5231 if (!global_busy)
5232 {
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005233 if (!do_ask) /* when interactive leave cursor on the match */
5234 {
5235 if (endcolumn)
5236 coladvance((colnr_T)MAXCOL);
5237 else
5238 beginline(BL_WHITE | BL_FIX);
5239 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005240 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 MSG("");
5242 }
5243 else
5244 global_need_beginline = TRUE;
5245 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005246 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 }
5248 else if (!global_busy)
5249 {
5250 if (got_int) /* interrupted */
5251 EMSG(_(e_interr));
5252 else if (got_match) /* did find something but nothing substituted */
5253 MSG("");
5254 else if (do_error) /* nothing found */
5255 EMSG2(_(e_patnotf2), get_search_pat());
5256 }
5257
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005258#ifdef FEAT_FOLDING
5259 if (do_ask && hasAnyFolding(curwin))
5260 /* Cursor position may require updating */
5261 changed_window_setting();
5262#endif
5263
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 vim_free(regmatch.regprog);
5265}
5266
5267/*
5268 * Give message for number of substitutions.
5269 * Can also be used after a ":global" command.
5270 * Return TRUE if a message was given.
5271 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005272 int
Bram Moolenaar05159a02005-02-26 23:04:13 +00005273do_sub_msg(count_only)
5274 int count_only; /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275{
5276 /*
5277 * Only report substitutions when:
5278 * - more than 'report' substitutions
5279 * - command was typed by user, or number of changed lines > 'report'
5280 * - giving messages is not disabled by 'lazyredraw'
5281 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005282 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5283 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 && messaging())
5285 {
5286 if (got_int)
5287 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005288 else
5289 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005291 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005292 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005294 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005295 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 sub_nsubs);
5297 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005298 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005299 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005301 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005302 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005305 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 return TRUE;
5307 }
5308 if (got_int)
5309 {
5310 EMSG(_(e_interr));
5311 return TRUE;
5312 }
5313 return FALSE;
5314}
5315
5316/*
5317 * Execute a global command of the form:
5318 *
5319 * g/pattern/X : execute X on all lines where pattern matches
5320 * v/pattern/X : execute X on all lines where pattern does not match
5321 *
5322 * where 'X' is an EX command
5323 *
5324 * The command character (as well as the trailing slash) is optional, and
5325 * is assumed to be 'p' if missing.
5326 *
5327 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005328 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 * for each line that has a mark. This is required because after deleting
5330 * lines we do not know where to search for the next match.
5331 */
5332 void
5333ex_global(eap)
5334 exarg_T *eap;
5335{
5336 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005337 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 int type; /* first char of cmd: 'v' or 'g' */
5339 char_u *cmd; /* command argument */
5340
5341 char_u delim; /* delimiter, normally '/' */
5342 char_u *pat;
5343 regmmatch_T regmatch;
5344 int match;
5345 int which_pat;
5346
5347 if (global_busy)
5348 {
5349 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5350 return;
5351 }
5352
5353 if (eap->forceit) /* ":global!" is like ":vglobal" */
5354 type = 'v';
5355 else
5356 type = *eap->cmd;
5357 cmd = eap->arg;
5358 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359
5360 /*
5361 * undocumented vi feature:
5362 * "\/" and "\?": use previous search pattern.
5363 * "\&": use previous substitute pattern.
5364 */
5365 if (*cmd == '\\')
5366 {
5367 ++cmd;
5368 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5369 {
5370 EMSG(_(e_backslash));
5371 return;
5372 }
5373 if (*cmd == '&')
5374 which_pat = RE_SUBST; /* use previous substitute pattern */
5375 else
5376 which_pat = RE_SEARCH; /* use previous search pattern */
5377 ++cmd;
5378 pat = (char_u *)"";
5379 }
5380 else if (*cmd == NUL)
5381 {
5382 EMSG(_("E148: Regular expression missing from global"));
5383 return;
5384 }
5385 else
5386 {
5387 delim = *cmd; /* get the delimiter */
5388 if (delim)
5389 ++cmd; /* skip delimiter if there is one */
5390 pat = cmd; /* remember start of pattern */
5391 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5392 if (cmd[0] == delim) /* end delimiter found */
5393 *cmd++ = NUL; /* replace it with a NUL */
5394 }
5395
5396#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5397 if (p_altkeymap && curwin->w_p_rl)
5398 lrFswap(pat,0);
5399#endif
5400
5401 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5402 {
5403 EMSG(_(e_invcmd));
5404 return;
5405 }
5406
5407 /*
5408 * pass 1: set marks for each (not) matching line
5409 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5411 {
5412 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005413 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5414 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 if ((type == 'g' && match) || (type == 'v' && !match))
5416 {
5417 ml_setmarked(lnum);
5418 ndone++;
5419 }
5420 line_breakcheck();
5421 }
5422
5423 /*
5424 * pass 2: execute the command for each line that has been marked
5425 */
5426 if (got_int)
5427 MSG(_(e_interr));
5428 else if (ndone == 0)
5429 {
5430 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005431 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01005433 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 }
5435 else
5436 global_exe(cmd);
5437
5438 ml_clearmarked(); /* clear rest of the marks */
5439 vim_free(regmatch.regprog);
5440}
5441
5442/*
5443 * Execute "cmd" on lines marked with ml_setmarked().
5444 */
5445 void
5446global_exe(cmd)
5447 char_u *cmd;
5448{
Bram Moolenaarbb993222011-05-10 16:00:47 +02005449 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5450 buf_T *old_buf = curbuf; /* remember what buffer we started in */
5451 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
5453 /*
5454 * Set current position only once for a global command.
5455 * If global_busy is set, setpcmark() will not do anything.
5456 * If there is an error, global_busy will be incremented.
5457 */
5458 setpcmark();
5459
5460 /* When the command writes a message, don't overwrite the command. */
5461 msg_didout = TRUE;
5462
Bram Moolenaard25bc232010-03-23 17:49:24 +01005463 sub_nsubs = 0;
5464 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 global_need_beginline = FALSE;
5466 global_busy = 1;
5467 old_lcount = curbuf->b_ml.ml_line_count;
5468 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5469 {
5470 curwin->w_cursor.lnum = lnum;
5471 curwin->w_cursor.col = 0;
5472 if (*cmd == NUL || *cmd == '\n')
5473 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5474 else
5475 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5476 ui_breakcheck();
5477 }
5478
5479 global_busy = 0;
5480 if (global_need_beginline)
5481 beginline(BL_WHITE | BL_FIX);
5482 else
5483 check_cursor(); /* cursor may be beyond the end of the line */
5484
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005485 /* the cursor may not have moved in the text but a change in a previous
5486 * line may move it on the screen */
5487 changed_line_abv_curs();
5488
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 /* If it looks like no message was written, allow overwriting the
5490 * command with the report for number of changes. */
5491 if (msg_col == 0 && msg_scrolled == 0)
5492 msg_didout = FALSE;
5493
Bram Moolenaar45667512007-05-10 19:24:43 +00005494 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02005495 * number of extra or deleted lines.
5496 * Don't report extra or deleted lines in the edge case where the buffer
5497 * we are in after execution is different from the buffer we started in. */
5498 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5500}
5501
5502#ifdef FEAT_VIMINFO
5503 int
5504read_viminfo_sub_string(virp, force)
5505 vir_T *virp;
5506 int force;
5507{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01005508 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 vim_free(old_sub);
5510 if (force || old_sub == NULL)
5511 old_sub = viminfo_readstring(virp, 1, TRUE);
5512 return viminfo_readline(virp);
5513}
5514
5515 void
5516write_viminfo_sub_string(fp)
5517 FILE *fp;
5518{
5519 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5520 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02005521 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 viminfo_writestring(fp, old_sub);
5523 }
5524}
5525#endif /* FEAT_VIMINFO */
5526
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005527#if defined(EXITFREE) || defined(PROTO)
5528 void
5529free_old_sub()
5530{
5531 vim_free(old_sub);
5532}
5533#endif
5534
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5536/*
5537 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005538 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005540 int
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005541prepare_tagpreview(undo_sync)
5542 int undo_sync; /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543{
5544 win_T *wp;
5545
5546# ifdef FEAT_GUI
5547 need_mouse_correct = TRUE;
5548# endif
5549
5550 /*
5551 * If there is already a preview window open, use that one.
5552 */
5553 if (!curwin->w_p_pvw)
5554 {
5555 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5556 if (wp->w_p_pvw)
5557 break;
5558 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005559 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 else
5561 {
5562 /*
5563 * There is no preview window open yet. Create one.
5564 */
5565 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5566 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005567 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 curwin->w_p_pvw = TRUE;
5569 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02005570 RESET_BINDING(curwin); /* don't take over 'scrollbind'
5571 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572# ifdef FEAT_DIFF
5573 curwin->w_p_diff = FALSE; /* no 'diff' */
5574# endif
5575# ifdef FEAT_FOLDING
5576 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5577# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005578 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 }
5580 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005581 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582}
5583
5584#endif
5585
5586
5587/*
5588 * ":help": open a read-only window on a help file
5589 */
5590 void
5591ex_help(eap)
5592 exarg_T *eap;
5593{
5594 char_u *arg;
5595 char_u *tag;
5596 FILE *helpfd; /* file descriptor of help file */
5597 int n;
5598 int i;
5599#ifdef FEAT_WINDOWS
5600 win_T *wp;
5601#endif
5602 int num_matches;
5603 char_u **matches;
5604 char_u *p;
5605 int empty_fnum = 0;
5606 int alt_fnum = 0;
5607 buf_T *buf;
5608#ifdef FEAT_MULTI_LANG
5609 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005610 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005612#ifdef FEAT_FOLDING
5613 int old_KeyTyped = KeyTyped;
5614#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615
5616 if (eap != NULL)
5617 {
5618 /*
5619 * A ":help" command ends at the first LF, or at a '|' that is
5620 * followed by some text. Set nextcmd to the following command.
5621 */
5622 for (arg = eap->arg; *arg; ++arg)
5623 {
5624 if (*arg == '\n' || *arg == '\r'
5625 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5626 {
5627 *arg++ = NUL;
5628 eap->nextcmd = arg;
5629 break;
5630 }
5631 }
5632 arg = eap->arg;
5633
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005634 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 {
5636 EMSG(_("E478: Don't panic!"));
5637 return;
5638 }
5639
5640 if (eap->skip) /* not executing commands */
5641 return;
5642 }
5643 else
5644 arg = (char_u *)"";
5645
5646 /* remove trailing blanks */
5647 p = arg + STRLEN(arg) - 1;
5648 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5649 *p-- = NUL;
5650
5651#ifdef FEAT_MULTI_LANG
5652 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005653 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654#endif
5655
5656 /* When no argument given go to the index. */
5657 if (*arg == NUL)
5658 arg = (char_u *)"help.txt";
5659
5660 /*
5661 * Check if there is a match for the argument.
5662 */
5663 n = find_help_tags(arg, &num_matches, &matches,
5664 eap != NULL && eap->forceit);
5665
5666 i = 0;
5667#ifdef FEAT_MULTI_LANG
5668 if (n != FAIL && lang != NULL)
5669 /* Find first item with the requested language. */
5670 for (i = 0; i < num_matches; ++i)
5671 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005672 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 if (len > 3 && matches[i][len - 3] == '@'
5674 && STRICMP(matches[i] + len - 2, lang) == 0)
5675 break;
5676 }
5677#endif
5678 if (i >= num_matches || n == FAIL)
5679 {
5680#ifdef FEAT_MULTI_LANG
5681 if (lang != NULL)
5682 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5683 else
5684#endif
5685 EMSG2(_("E149: Sorry, no help for %s"), arg);
5686 if (n != FAIL)
5687 FreeWild(num_matches, matches);
5688 return;
5689 }
5690
5691 /* The first match (in the requested language) is the best match. */
5692 tag = vim_strsave(matches[i]);
5693 FreeWild(num_matches, matches);
5694
5695#ifdef FEAT_GUI
5696 need_mouse_correct = TRUE;
5697#endif
5698
5699 /*
5700 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005701 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005703 if (!curwin->w_buffer->b_help
5704#ifdef FEAT_WINDOWS
5705 || cmdmod.tab != 0
5706#endif
5707 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 {
5709#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005710 if (cmdmod.tab != 0)
5711 wp = NULL;
5712 else
5713 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5714 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5715 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5717 win_enter(wp, TRUE);
5718 else
5719#endif
5720 {
5721 /*
5722 * There is no help window yet.
5723 * Try to open the file specified by the "helpfile" option.
5724 */
5725 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5726 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00005727 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 goto erret;
5729 }
5730 fclose(helpfd);
5731
5732#ifdef FEAT_WINDOWS
5733 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005734 * specified, the current window is vertically split and
5735 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 n = WSP_HELP;
5737# ifdef FEAT_VERTSPLIT
5738 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005739 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 n |= WSP_TOP;
5741# endif
5742 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005743 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744#else
5745 /* use current window */
5746 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005748#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749
5750#ifdef FEAT_WINDOWS
5751 if (curwin->w_height < p_hh)
5752 win_setheight((int)p_hh);
5753#endif
5754
5755 /*
5756 * Open help file (do_ecmd() will set b_help flag, readfile() will
5757 * set b_p_ro flag).
5758 * Set the alternate file to the previously edited file.
5759 */
5760 alt_fnum = curbuf->b_fnum;
5761 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005762 ECMD_HIDE + ECMD_SET_HELP,
5763#ifdef FEAT_WINDOWS
5764 NULL /* buffer is still open, don't store info */
5765#else
5766 curwin
5767#endif
5768 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005769 if (!cmdmod.keepalt)
5770 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 empty_fnum = curbuf->b_fnum;
5772 }
5773 }
5774
5775 if (!p_im)
5776 restart_edit = 0; /* don't want insert mode in help file */
5777
Bram Moolenaar8f535582011-09-30 17:30:31 +02005778#ifdef FEAT_FOLDING
5779 /* Restore KeyTyped, setting 'filetype=help' may reset it.
5780 * It is needed for do_tag top open folds under the cursor. */
5781 KeyTyped = old_KeyTyped;
5782#endif
5783
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 if (tag != NULL)
5785 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5786
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005787 /* Delete the empty buffer if we're not using it. Careful: autocommands
5788 * may have jumped to another window, check that the buffer is not in a
5789 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5791 {
5792 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005793 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 wipe_buffer(buf, TRUE);
5795 }
5796
5797 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005798 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799 curwin->w_alt_fnum = alt_fnum;
5800
5801erret:
5802 vim_free(tag);
5803}
5804
5805
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005806#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5807/*
5808 * In an argument search for a language specifiers in the form "@xx".
5809 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5810 * Returns NULL if not found.
5811 */
5812 char_u *
5813check_help_lang(arg)
5814 char_u *arg;
5815{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005816 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005817
5818 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5819 && ASCII_ISALPHA(arg[len - 1]))
5820 {
5821 arg[len - 3] = NUL; /* remove the '@' */
5822 return arg + len - 2;
5823 }
5824 return NULL;
5825}
5826#endif
5827
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828/*
5829 * Return a heuristic indicating how well the given string matches. The
5830 * smaller the number, the better the match. This is the order of priorities,
5831 * from best match to worst match:
5832 * - Match with least alpha-numeric characters is better.
5833 * - Match with least total characters is better.
5834 * - Match towards the start is better.
5835 * - Match starting with "+" is worse (feature instead of command)
5836 * Assumption is made that the matched_string passed has already been found to
5837 * match some string for which help is requested. webb.
5838 */
5839 int
5840help_heuristic(matched_string, offset, wrong_case)
5841 char_u *matched_string;
5842 int offset; /* offset for match */
5843 int wrong_case; /* no matching case */
5844{
5845 int num_letters;
5846 char_u *p;
5847
5848 num_letters = 0;
5849 for (p = matched_string; *p; p++)
5850 if (ASCII_ISALNUM(*p))
5851 num_letters++;
5852
5853 /*
5854 * Multiply the number of letters by 100 to give it a much bigger
5855 * weighting than the number of characters.
5856 * If there only is a match while ignoring case, add 5000.
5857 * If the match starts in the middle of a word, add 10000 to put it
5858 * somewhere in the last half.
5859 * If the match is more than 2 chars from the start, multiply by 200 to
5860 * put it after matches at the start.
5861 */
5862 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5863 && ASCII_ISALNUM(matched_string[offset - 1]))
5864 offset += 10000;
5865 else if (offset > 2)
5866 offset *= 200;
5867 if (wrong_case)
5868 offset += 5000;
5869 /* Features are less interesting than the subjects themselves, but "+"
5870 * alone is not a feature. */
5871 if (matched_string[0] == '+' && matched_string[1] != NUL)
5872 offset += 100;
5873 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5874}
5875
5876/*
5877 * Compare functions for qsort() below, that checks the help heuristics number
5878 * that has been put after the tagname by find_tags().
5879 */
5880 static int
5881#ifdef __BORLANDC__
5882_RTLENTRYF
5883#endif
5884help_compare(s1, s2)
5885 const void *s1;
5886 const void *s2;
5887{
5888 char *p1;
5889 char *p2;
5890
5891 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5892 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5893 return strcmp(p1, p2);
5894}
5895
5896/*
5897 * Find all help tags matching "arg", sort them and return in matches[], with
5898 * the number of matches in num_matches.
5899 * The matches will be sorted with a "best" match algorithm.
5900 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5901 */
5902 int
5903find_help_tags(arg, num_matches, matches, keep_lang)
5904 char_u *arg;
5905 int *num_matches;
5906 char_u ***matches;
5907 int keep_lang;
5908{
5909 char_u *s, *d;
5910 int i;
5911 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005912 "/*", "/\\*", "\"*", "**",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005913 "cpo-*", "/\\(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005914 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005915 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 "[count]", "[quotex]", "[range]",
5917 "[pattern]", "\\|", "\\%$"};
5918 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005919 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005920 "cpo-star", "/\\\\(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005921 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005922 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 "\\[count]", "\\[quotex]", "\\[range]",
5924 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5925 int flags;
5926
5927 d = IObuff; /* assume IObuff is long enough! */
5928
5929 /*
5930 * Recognize a few exceptions to the rule. Some strings that contain '*'
5931 * with "star". Otherwise '*' is recognized as a wildcard.
5932 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005933 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 if (STRCMP(arg, mtable[i]) == 0)
5935 {
5936 STRCPY(d, rtable[i]);
5937 break;
5938 }
5939
5940 if (i < 0) /* no match in table */
5941 {
5942 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5943 * Also replace "\%^" and "\%(", they match every tag too.
5944 * Also "\zs", "\z1", etc.
5945 * Also "\@<", "\@=", "\@<=", etc.
5946 * And also "\_$" and "\_^". */
5947 if (arg[0] == '\\'
5948 && ((arg[1] != NUL && arg[2] == NUL)
5949 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5950 && arg[2] != NUL)))
5951 {
5952 STRCPY(d, "/\\\\");
5953 STRCPY(d + 3, arg + 1);
5954 /* Check for "/\\_$", should be "/\\_\$" */
5955 if (d[3] == '_' && d[4] == '$')
5956 STRCPY(d + 4, "\\$");
5957 }
5958 else
5959 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005960 /* Replace:
5961 * "[:...:]" with "\[:...:]"
5962 * "[++...]" with "\[++...]"
5963 * "\{" with "\\{"
5964 */
5965 if ((arg[0] == '[' && (arg[1] == ':'
5966 || (arg[1] == '+' && arg[2] == '+')))
5967 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 *d++ = '\\';
5969
5970 for (s = arg; *s; ++s)
5971 {
5972 /*
5973 * Replace "|" with "bar" and '"' with "quote" to match the name of
5974 * the tags for these commands.
5975 * Replace "*" with ".*" and "?" with "." to match command line
5976 * completion.
5977 * Insert a backslash before '~', '$' and '.' to avoid their
5978 * special meaning.
5979 */
5980 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5981 break;
5982 switch (*s)
5983 {
5984 case '|': STRCPY(d, "bar");
5985 d += 3;
5986 continue;
5987 case '"': STRCPY(d, "quote");
5988 d += 5;
5989 continue;
5990 case '*': *d++ = '.';
5991 break;
5992 case '?': *d++ = '.';
5993 continue;
5994 case '$':
5995 case '.':
5996 case '~': *d++ = '\\';
5997 break;
5998 }
5999
6000 /*
6001 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
6002 * ":help i_^_CTRL-D" work.
6003 * Insert '-' before and after "CTRL-X" when applicable.
6004 */
6005 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
6006 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
6007 {
6008 if (d > IObuff && d[-1] != '_')
6009 *d++ = '_'; /* prepend a '_' */
6010 STRCPY(d, "CTRL-");
6011 d += 5;
6012 if (*s < ' ')
6013 {
6014#ifdef EBCDIC
6015 *d++ = CtrlChar(*s);
6016#else
6017 *d++ = *s + '@';
6018#endif
6019 if (d[-1] == '\\')
6020 *d++ = '\\'; /* double a backslash */
6021 }
6022 else
6023 *d++ = *++s;
6024 if (s[1] != NUL && s[1] != '_')
6025 *d++ = '_'; /* append a '_' */
6026 continue;
6027 }
6028 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6029 *d++ = '\\';
6030
6031 /*
6032 * Insert a backslash before a backslash after a slash, for search
6033 * pattern tags: "/\|" --> "/\\|".
6034 */
6035 else if (s[0] == '\\' && s[1] != '\\'
6036 && *arg == '/' && s == arg + 1)
6037 *d++ = '\\';
6038
6039 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6040 * "CTRL-\_CTRL-N" */
6041 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6042 {
6043 STRCPY(d, "CTRL-\\\\");
6044 d += 7;
6045 s += 6;
6046 }
6047
6048 *d++ = *s;
6049
6050 /*
6051 * If tag starts with ', toss everything after a second '. Fixes
6052 * CTRL-] on 'option'. (would include the trailing '.').
6053 */
6054 if (*s == '\'' && s > arg && *arg == '\'')
6055 break;
6056 }
6057 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006058
6059 if (*IObuff == '`')
6060 {
6061 if (d > IObuff + 2 && d[-1] == '`')
6062 {
6063 /* remove the backticks from `command` */
6064 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6065 d[-2] = NUL;
6066 }
6067 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6068 {
6069 /* remove the backticks and comma from `command`, */
6070 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6071 d[-3] = NUL;
6072 }
6073 else if (d > IObuff + 4 && d[-3] == '`'
6074 && d[-2] == '\\' && d[-1] == '.')
6075 {
6076 /* remove the backticks and dot from `command`\. */
6077 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6078 d[-4] = NUL;
6079 }
6080 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 }
6082 }
6083
6084 *matches = (char_u **)"";
6085 *num_matches = 0;
6086 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6087 if (keep_lang)
6088 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006089 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006091 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 /* Sort the matches found on the heuristic number that is after the
6093 * tag name. */
6094 qsort((void *)*matches, (size_t)*num_matches,
6095 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006096 /* Delete more than TAG_MANY to reduce the size of the listing. */
6097 while (*num_matches > TAG_MANY)
6098 vim_free((*matches)[--*num_matches]);
6099 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 return OK;
6101}
6102
6103/*
6104 * After reading a help file: May cleanup a help buffer when syntax
6105 * highlighting is not used.
6106 */
6107 void
6108fix_help_buffer()
6109{
6110 linenr_T lnum;
6111 char_u *line;
6112 int in_example = FALSE;
6113 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006114 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 char_u *p;
6116 char_u *rt;
6117 int mustfree;
6118
6119 /* set filetype to "help". */
6120 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6121
6122#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006123 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124#endif
6125 {
6126 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6127 {
6128 line = ml_get_buf(curbuf, lnum, FALSE);
6129 len = (int)STRLEN(line);
6130 if (in_example && len > 0 && !vim_iswhite(line[0]))
6131 {
6132 /* End of example: non-white or '<' in first column. */
6133 if (line[0] == '<')
6134 {
6135 /* blank-out a '<' in the first column */
6136 line = ml_get_buf(curbuf, lnum, TRUE);
6137 line[0] = ' ';
6138 }
6139 in_example = FALSE;
6140 }
6141 if (!in_example && len > 0)
6142 {
6143 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6144 {
6145 /* blank-out a '>' in the last column (start of example) */
6146 line = ml_get_buf(curbuf, lnum, TRUE);
6147 line[len - 1] = ' ';
6148 in_example = TRUE;
6149 }
6150 else if (line[len - 1] == '~')
6151 {
6152 /* blank-out a '~' at the end of line (header marker) */
6153 line = ml_get_buf(curbuf, lnum, TRUE);
6154 line[len - 1] = ' ';
6155 }
6156 }
6157 }
6158 }
6159
6160 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006161 * In the "help.txt" and "help.abx" file, add the locally added help
6162 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006164 fname = gettail(curbuf->b_fname);
6165 if (fnamecmp(fname, "help.txt") == 0
6166#ifdef FEAT_MULTI_LANG
6167 || (fnamencmp(fname, "help.", 5) == 0
6168 && ASCII_ISALPHA(fname[5])
6169 && ASCII_ISALPHA(fname[6])
6170 && TOLOWER_ASC(fname[7]) == 'x'
6171 && fname[8] == NUL)
6172#endif
6173 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 {
6175 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6176 {
6177 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006178 if (strstr((char *)line, "*local-additions*") == NULL)
6179 continue;
6180
6181 /* Go through all directories in 'runtimepath', skipping
6182 * $VIMRUNTIME. */
6183 p = p_rtp;
6184 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006186 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6187 mustfree = FALSE;
6188 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6189 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006191 int fcount;
6192 char_u **fnames;
6193 FILE *fd;
6194 char_u *s;
6195 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006197 vimconv_T vc;
6198 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199#endif
6200
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006201 /* Find all "doc/ *.txt" files in this directory. */
6202 add_pathsep(NameBuff);
6203#ifdef FEAT_MULTI_LANG
6204 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006206 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006208 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6209 &fnames, EW_FILE|EW_SILENT) == OK
6210 && fcount > 0)
6211 {
6212#ifdef FEAT_MULTI_LANG
6213 int i1;
6214 int i2;
6215 char_u *f1;
6216 char_u *f2;
6217 char_u *t1;
6218 char_u *e1;
6219 char_u *e2;
6220
6221 /* If foo.abx is found use it instead of foo.txt in
6222 * the same directory. */
6223 for (i1 = 0; i1 < fcount; ++i1)
6224 {
6225 for (i2 = 0; i2 < fcount; ++i2)
6226 {
6227 if (i1 == i2)
6228 continue;
6229 if (fnames[i1] == NULL || fnames[i2] == NULL)
6230 continue;
6231 f1 = fnames[i1];
6232 f2 = fnames[i2];
6233 t1 = gettail(f1);
6234 if (fnamencmp(f1, f2, t1 - f1) != 0)
6235 continue;
6236 e1 = vim_strrchr(t1, '.');
6237 e2 = vim_strrchr(gettail(f2), '.');
6238 if (e1 == NUL || e2 == NUL)
6239 continue;
6240 if (fnamecmp(e1, ".txt") != 0
6241 && fnamecmp(e1, fname + 4) != 0)
6242 {
6243 /* Not .txt and not .abx, remove it. */
6244 vim_free(fnames[i1]);
6245 fnames[i1] = NULL;
6246 continue;
6247 }
6248 if (fnamencmp(f1, f2, e1 - f1) != 0)
6249 continue;
6250 if (fnamecmp(e1, ".txt") == 0
6251 && fnamecmp(e2, fname + 4) == 0)
6252 {
6253 /* use .abx instead of .txt */
6254 vim_free(fnames[i1]);
6255 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 }
6257 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006259#endif
6260 for (fi = 0; fi < fcount; ++fi)
6261 {
6262 if (fnames[fi] == NULL)
6263 continue;
6264 fd = mch_fopen((char *)fnames[fi], "r");
6265 if (fd != NULL)
6266 {
6267 vim_fgets(IObuff, IOSIZE, fd);
6268 if (IObuff[0] == '*'
6269 && (s = vim_strchr(IObuff + 1, '*'))
6270 != NULL)
6271 {
6272#ifdef FEAT_MBYTE
6273 int this_utf = MAYBE;
6274#endif
6275 /* Change tag definition to a
6276 * reference and remove <CR>/<NL>. */
6277 IObuff[0] = '|';
6278 *s = '|';
6279 while (*s != NUL)
6280 {
6281 if (*s == '\r' || *s == '\n')
6282 *s = NUL;
6283#ifdef FEAT_MBYTE
6284 /* The text is utf-8 when a byte
6285 * above 127 is found and no
6286 * illegal byte sequence is found.
6287 */
6288 if (*s >= 0x80 && this_utf != FALSE)
6289 {
6290 int l;
6291
6292 this_utf = TRUE;
6293 l = utf_ptr2len(s);
6294 if (l == 1)
6295 this_utf = FALSE;
6296 s += l - 1;
6297 }
6298#endif
6299 ++s;
6300 }
6301#ifdef FEAT_MBYTE
6302 /* The help file is latin1 or utf-8;
6303 * conversion to the current
6304 * 'encoding' may be required. */
6305 vc.vc_type = CONV_NONE;
6306 convert_setup(&vc, (char_u *)(
6307 this_utf == TRUE ? "utf-8"
6308 : "latin1"), p_enc);
6309 if (vc.vc_type == CONV_NONE)
6310 /* No conversion needed. */
6311 cp = IObuff;
6312 else
6313 {
6314 /* Do the conversion. If it fails
6315 * use the unconverted text. */
6316 cp = string_convert(&vc, IObuff,
6317 NULL);
6318 if (cp == NULL)
6319 cp = IObuff;
6320 }
6321 convert_setup(&vc, NULL, NULL);
6322
6323 ml_append(lnum, cp, (colnr_T)0, FALSE);
6324 if (cp != IObuff)
6325 vim_free(cp);
6326#else
6327 ml_append(lnum, IObuff, (colnr_T)0,
6328 FALSE);
6329#endif
6330 ++lnum;
6331 }
6332 fclose(fd);
6333 }
6334 }
6335 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006338 if (mustfree)
6339 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006341 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 }
6343 }
6344}
6345
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006346/*
6347 * ":exusage"
6348 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006349 void
6350ex_exusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006351 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006352{
6353 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6354}
6355
6356/*
6357 * ":viusage"
6358 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006359 void
6360ex_viusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006361 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006362{
6363 do_cmdline_cmd((char_u *)"help normal-index");
6364}
6365
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366#if defined(FEAT_EX_EXTRA) || defined(PROTO)
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006367static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368
6369/*
6370 * ":helptags"
6371 */
6372 void
6373ex_helptags(eap)
6374 exarg_T *eap;
6375{
6376 garray_T ga;
6377 int i, j;
6378 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006379#ifdef FEAT_MULTI_LANG
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 char_u lang[2];
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006381#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006382 expand_T xpc;
6383 char_u *dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 char_u ext[5];
6385 char_u fname[8];
6386 int filecount;
6387 char_u **files;
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006388 int add_help_tags = FALSE;
6389
6390 /* Check for ":helptags ++t {dir}". */
6391 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6392 {
6393 add_help_tags = TRUE;
6394 eap->arg = skipwhite(eap->arg + 3);
6395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396
Bram Moolenaar0e253142008-01-13 12:31:34 +00006397 ExpandInit(&xpc);
6398 xpc.xp_context = EXPAND_DIRECTORIES;
6399 dirname = ExpandOne(&xpc, eap->arg, NULL,
6400 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6401 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 {
6403 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6404 return;
6405 }
6406
6407#ifdef FEAT_MULTI_LANG
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006408 /* Get a list of all files in the help directory and in subdirectories. */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006409 STRCPY(NameBuff, dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 add_pathsep(NameBuff);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006411 STRCAT(NameBuff, "**");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6413 EW_FILE|EW_SILENT) == FAIL
6414 || filecount == 0)
6415 {
6416 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar0e253142008-01-13 12:31:34 +00006417 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 return;
6419 }
6420
6421 /* Go over all files in the directory to find out what languages are
6422 * present. */
6423 ga_init2(&ga, 1, 10);
6424 for (i = 0; i < filecount; ++i)
6425 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006426 len = (int)STRLEN(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 if (len > 4)
6428 {
6429 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6430 {
6431 /* ".txt" -> language "en" */
6432 lang[0] = 'e';
6433 lang[1] = 'n';
6434 }
6435 else if (files[i][len - 4] == '.'
6436 && ASCII_ISALPHA(files[i][len - 3])
6437 && ASCII_ISALPHA(files[i][len - 2])
6438 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6439 {
6440 /* ".abx" -> language "ab" */
6441 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6442 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6443 }
6444 else
6445 continue;
6446
6447 /* Did we find this language already? */
6448 for (j = 0; j < ga.ga_len; j += 2)
6449 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6450 break;
6451 if (j == ga.ga_len)
6452 {
6453 /* New language, add it. */
6454 if (ga_grow(&ga, 2) == FAIL)
6455 break;
6456 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6457 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 }
6459 }
6460 }
6461
6462 /*
6463 * Loop over the found languages to generate a tags file for each one.
6464 */
6465 for (j = 0; j < ga.ga_len; j += 2)
6466 {
6467 STRCPY(fname, "tags-xx");
6468 fname[5] = ((char_u *)ga.ga_data)[j];
6469 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6470 if (fname[5] == 'e' && fname[6] == 'n')
6471 {
6472 /* English is an exception: use ".txt" and "tags". */
6473 fname[4] = NUL;
6474 STRCPY(ext, ".txt");
6475 }
6476 else
6477 {
6478 /* Language "ab" uses ".abx" and "tags-ab". */
6479 STRCPY(ext, ".xxx");
6480 ext[1] = fname[5];
6481 ext[2] = fname[6];
6482 }
Bram Moolenaar0e253142008-01-13 12:31:34 +00006483 helptags_one(dirname, ext, fname, add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 }
6485
6486 ga_clear(&ga);
6487 FreeWild(filecount, files);
6488
6489#else
6490 /* No language support, just use "*.txt" and "tags". */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006491 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006493 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494}
6495
6496 static void
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006497helptags_one(dir, ext, tagfname, add_help_tags)
6498 char_u *dir; /* doc directory */
6499 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006500 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6501 int add_help_tags; /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502{
6503 FILE *fd_tags;
6504 FILE *fd;
6505 garray_T ga;
6506 int filecount;
6507 char_u **files;
6508 char_u *p1, *p2;
6509 int fi;
6510 char_u *s;
6511 int i;
6512 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006513 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514# ifdef FEAT_MBYTE
6515 int utf8 = MAYBE;
6516 int this_utf8;
6517 int firstline;
6518 int mix = FALSE; /* detected mixed encodings */
6519# endif
6520
6521 /*
6522 * Find all *.txt files.
6523 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01006524 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006526 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 STRCAT(NameBuff, ext);
6528 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6529 EW_FILE|EW_SILENT) == FAIL
6530 || filecount == 0)
6531 {
6532 if (!got_int)
6533 EMSG2("E151: No match: %s", NameBuff);
6534 return;
6535 }
6536
6537 /*
6538 * Open the tags file for writing.
6539 * Do this before scanning through all the files.
6540 */
6541 STRCPY(NameBuff, dir);
6542 add_pathsep(NameBuff);
6543 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006544 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 if (fd_tags == NULL)
6546 {
6547 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6548 FreeWild(filecount, files);
6549 return;
6550 }
6551
6552 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006553 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6554 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 */
6556 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006557 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6558 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 {
6560 if (ga_grow(&ga, 1) == FAIL)
6561 got_int = TRUE;
6562 else
6563 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006564 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 if (s == NULL)
6566 got_int = TRUE;
6567 else
6568 {
6569 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6570 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6571 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 }
6573 }
6574 }
6575
6576 /*
6577 * Go over all the files and extract the tags.
6578 */
6579 for (fi = 0; fi < filecount && !got_int; ++fi)
6580 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006581 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 if (fd == NULL)
6583 {
6584 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6585 continue;
6586 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006587 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588
6589# ifdef FEAT_MBYTE
6590 firstline = TRUE;
6591# endif
6592 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6593 {
6594# ifdef FEAT_MBYTE
6595 if (firstline)
6596 {
6597 /* Detect utf-8 file by a non-ASCII char in the first line. */
6598 this_utf8 = MAYBE;
6599 for (s = IObuff; *s != NUL; ++s)
6600 if (*s >= 0x80)
6601 {
6602 int l;
6603
6604 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006605 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 if (l == 1)
6607 {
6608 /* Illegal UTF-8 byte sequence. */
6609 this_utf8 = FALSE;
6610 break;
6611 }
6612 s += l - 1;
6613 }
6614 if (this_utf8 == MAYBE) /* only ASCII characters found */
6615 this_utf8 = FALSE;
6616 if (utf8 == MAYBE) /* first file */
6617 utf8 = this_utf8;
6618 else if (utf8 != this_utf8)
6619 {
6620 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6621 mix = !got_int;
6622 got_int = TRUE;
6623 }
6624 firstline = FALSE;
6625 }
6626# endif
6627 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6628 while (p1 != NULL)
6629 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02006630 /* Use vim_strbyte() instead of vim_strchr() so that when
6631 * 'encoding' is dbcs it still works, don't find '*' in the
6632 * second byte. */
6633 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6635 {
6636 for (s = p1 + 1; s < p2; ++s)
6637 if (*s == ' ' || *s == '\t' || *s == '|')
6638 break;
6639
6640 /*
6641 * Only accept a *tag* when it consists of valid
6642 * characters, there is white space before it and is
6643 * followed by a white character or end-of-line.
6644 */
6645 if (s == p2
6646 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6647 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6648 || s[1] == '\0'))
6649 {
6650 *p2 = '\0';
6651 ++p1;
6652 if (ga_grow(&ga, 1) == FAIL)
6653 {
6654 got_int = TRUE;
6655 break;
6656 }
6657 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6658 if (s == NULL)
6659 {
6660 got_int = TRUE;
6661 break;
6662 }
6663 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6664 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 sprintf((char *)s, "%s\t%s", p1, fname);
6666
6667 /* find next '*' */
6668 p2 = vim_strchr(p2 + 1, '*');
6669 }
6670 }
6671 p1 = p2;
6672 }
6673 line_breakcheck();
6674 }
6675
6676 fclose(fd);
6677 }
6678
6679 FreeWild(filecount, files);
6680
6681 if (!got_int)
6682 {
6683 /*
6684 * Sort the tags.
6685 */
6686 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6687
6688 /*
6689 * Check for duplicates.
6690 */
6691 for (i = 1; i < ga.ga_len; ++i)
6692 {
6693 p1 = ((char_u **)ga.ga_data)[i - 1];
6694 p2 = ((char_u **)ga.ga_data)[i];
6695 while (*p1 == *p2)
6696 {
6697 if (*p2 == '\t')
6698 {
6699 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006700 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6702 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6703 EMSG(NameBuff);
6704 *p2 = '\t';
6705 break;
6706 }
6707 ++p1;
6708 ++p2;
6709 }
6710 }
6711
6712# ifdef FEAT_MBYTE
6713 if (utf8 == TRUE)
6714 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6715# endif
6716
6717 /*
6718 * Write the tags into the file.
6719 */
6720 for (i = 0; i < ga.ga_len; ++i)
6721 {
6722 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006723 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006725 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 else
6727 {
6728 fprintf(fd_tags, "%s\t/*", s);
6729 for (p1 = s; *p1 != '\t'; ++p1)
6730 {
6731 /* insert backslash before '\\' and '/' */
6732 if (*p1 == '\\' || *p1 == '/')
6733 putc('\\', fd_tags);
6734 putc(*p1, fd_tags);
6735 }
6736 fprintf(fd_tags, "*\n");
6737 }
6738 }
6739 }
6740#ifdef FEAT_MBYTE
6741 if (mix)
6742 got_int = FALSE; /* continue with other languages */
6743#endif
6744
6745 for (i = 0; i < ga.ga_len; ++i)
6746 vim_free(((char_u **)ga.ga_data)[i]);
6747 ga_clear(&ga);
6748 fclose(fd_tags); /* there is no check for an error... */
6749}
6750#endif
6751
6752#if defined(FEAT_SIGNS) || defined(PROTO)
6753
6754/*
6755 * Struct to hold the sign properties.
6756 */
6757typedef struct sign sign_T;
6758
6759struct sign
6760{
6761 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02006762 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 char_u *sn_name; /* name of sign */
6764 char_u *sn_icon; /* name of pixmap */
6765#ifdef FEAT_SIGN_ICONS
6766 void *sn_image; /* icon image */
6767#endif
6768 char_u *sn_text; /* text used instead of pixmap */
6769 int sn_line_hl; /* highlight ID for line */
6770 int sn_text_hl; /* highlight ID for text */
6771};
6772
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006774static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775
Bram Moolenaar985cb442009-05-14 19:51:46 +00006776static int sign_cmd_idx __ARGS((char_u *begin_cmd, char_u *end_cmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777static void sign_list_defined __ARGS((sign_T *sp));
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006778static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006780static char *cmds[] = {
6781 "define",
6782#define SIGNCMD_DEFINE 0
6783 "undefine",
6784#define SIGNCMD_UNDEFINE 1
6785 "list",
6786#define SIGNCMD_LIST 2
6787 "place",
6788#define SIGNCMD_PLACE 3
6789 "unplace",
6790#define SIGNCMD_UNPLACE 4
6791 "jump",
6792#define SIGNCMD_JUMP 5
6793 NULL
6794#define SIGNCMD_LAST 6
6795};
6796
6797/*
6798 * Find index of a ":sign" subcmd from its name.
6799 * "*end_cmd" must be writable.
6800 */
6801 static int
6802sign_cmd_idx(begin_cmd, end_cmd)
Bram Moolenaar985cb442009-05-14 19:51:46 +00006803 char_u *begin_cmd; /* begin of sign subcmd */
6804 char_u *end_cmd; /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006805{
6806 int idx;
6807 char save = *end_cmd;
6808
6809 *end_cmd = NUL;
6810 for (idx = 0; ; ++idx)
6811 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6812 break;
6813 *end_cmd = save;
6814 return idx;
6815}
6816
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817/*
6818 * ":sign" command
6819 */
6820 void
6821ex_sign(eap)
6822 exarg_T *eap;
6823{
6824 char_u *arg = eap->arg;
6825 char_u *p;
6826 int idx;
6827 sign_T *sp;
6828 sign_T *sp_prev;
6829 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830
6831 /* Parse the subcommand. */
6832 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006833 idx = sign_cmd_idx(arg, p);
6834 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006836 EMSG2(_("E160: Unknown sign command: %s"), arg);
6837 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 }
6839 arg = skipwhite(p);
6840
6841 if (idx <= SIGNCMD_LIST)
6842 {
6843 /*
6844 * Define, undefine or list signs.
6845 */
6846 if (idx == SIGNCMD_LIST && *arg == NUL)
6847 {
6848 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01006849 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 sign_list_defined(sp);
6851 }
6852 else if (*arg == NUL)
6853 EMSG(_("E156: Missing sign name"));
6854 else
6855 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006856 /* Isolate the sign name. If it's a number skip leading zeroes,
6857 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 p = skiptowhite(arg);
6859 if (*p != NUL)
6860 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006861 while (arg[0] == '0' && arg[1] != NUL)
6862 ++arg;
6863
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 sp_prev = NULL;
6865 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6866 {
6867 if (STRCMP(sp->sn_name, arg) == 0)
6868 break;
6869 sp_prev = sp;
6870 }
6871 if (idx == SIGNCMD_DEFINE)
6872 {
6873 /* ":sign define {name} ...": define a sign */
6874 if (sp == NULL)
6875 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006876 sign_T *lp;
6877 int start = next_sign_typenr;
6878
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 /* Allocate a new sign. */
6880 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6881 if (sp == NULL)
6882 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006884 /* Check that next_sign_typenr is not already being used.
6885 * This only happens after wrapping around. Hopefully
6886 * another one got deleted and we can use its number. */
6887 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006889 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006891 ++next_sign_typenr;
6892 if (next_sign_typenr == MAX_TYPENR)
6893 next_sign_typenr = 1;
6894 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006896 vim_free(sp);
6897 EMSG(_("E612: Too many signs defined"));
6898 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006900 lp = first_sign; /* start all over */
6901 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006903 lp = lp->sn_next;
6904 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006906 sp->sn_typenr = next_sign_typenr;
6907 if (++next_sign_typenr == MAX_TYPENR)
6908 next_sign_typenr = 1; /* wrap around */
6909
6910 sp->sn_name = vim_strsave(arg);
6911 if (sp->sn_name == NULL) /* out of memory */
6912 {
6913 vim_free(sp);
6914 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02006916
6917 /* add the new sign to the list of signs */
6918 if (sp_prev == NULL)
6919 first_sign = sp;
6920 else
6921 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 }
6923
6924 /* set values for a defined sign. */
6925 for (;;)
6926 {
6927 arg = skipwhite(p);
6928 if (*arg == NUL)
6929 break;
6930 p = skiptowhite_esc(arg);
6931 if (STRNCMP(arg, "icon=", 5) == 0)
6932 {
6933 arg += 5;
6934 vim_free(sp->sn_icon);
6935 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6936 backslash_halve(sp->sn_icon);
6937#ifdef FEAT_SIGN_ICONS
6938 if (gui.in_use)
6939 {
6940 out_flush();
6941 if (sp->sn_image != NULL)
6942 gui_mch_destroy_sign(sp->sn_image);
6943 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6944 }
6945#endif
6946 }
6947 else if (STRNCMP(arg, "text=", 5) == 0)
6948 {
6949 char_u *s;
6950 int cells;
6951 int len;
6952
6953 arg += 5;
6954#ifdef FEAT_MBYTE
6955 /* Count cells and check for non-printable chars */
6956 if (has_mbyte)
6957 {
6958 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006959 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 {
6961 if (!vim_isprintc((*mb_ptr2char)(s)))
6962 break;
6963 cells += (*mb_ptr2cells)(s);
6964 }
6965 }
6966 else
6967#endif
6968 {
6969 for (s = arg; s < p; ++s)
6970 if (!vim_isprintc(*s))
6971 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006972 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 }
6974 /* Currently must be one or two display cells */
6975 if (s != p || cells < 1 || cells > 2)
6976 {
6977 *p = NUL;
6978 EMSG2(_("E239: Invalid sign text: %s"), arg);
6979 return;
6980 }
6981
6982 vim_free(sp->sn_text);
6983 /* Allocate one byte more if we need to pad up
6984 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006985 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 sp->sn_text = vim_strnsave(arg, len);
6987
6988 if (sp->sn_text != NULL && cells == 1)
6989 STRCPY(sp->sn_text + len - 1, " ");
6990 }
6991 else if (STRNCMP(arg, "linehl=", 7) == 0)
6992 {
6993 arg += 7;
6994 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6995 }
6996 else if (STRNCMP(arg, "texthl=", 7) == 0)
6997 {
6998 arg += 7;
6999 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
7000 }
7001 else
7002 {
7003 EMSG2(_(e_invarg2), arg);
7004 return;
7005 }
7006 }
7007 }
7008 else if (sp == NULL)
7009 EMSG2(_("E155: Unknown sign: %s"), arg);
7010 else if (idx == SIGNCMD_LIST)
7011 /* ":sign list {name}" */
7012 sign_list_defined(sp);
7013 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007015 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 }
7017 }
7018 else
7019 {
7020 int id = -1;
7021 linenr_T lnum = -1;
7022 char_u *sign_name = NULL;
7023 char_u *arg1;
7024
7025 if (*arg == NUL)
7026 {
7027 if (idx == SIGNCMD_PLACE)
7028 {
7029 /* ":sign place": list placed signs in all buffers */
7030 sign_list_placed(NULL);
7031 }
7032 else if (idx == SIGNCMD_UNPLACE)
7033 {
7034 /* ":sign unplace": remove placed sign at cursor */
7035 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7036 if (id > 0)
7037 {
7038 buf_delsign(curwin->w_buffer, id);
7039 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7040 }
7041 else
7042 EMSG(_("E159: Missing sign number"));
7043 }
7044 else
7045 EMSG(_(e_argreq));
7046 return;
7047 }
7048
7049 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7050 {
7051 /* ":sign unplace *": remove all placed signs */
7052 buf_delete_all_signs();
7053 return;
7054 }
7055
7056 /* first arg could be placed sign id */
7057 arg1 = arg;
7058 if (VIM_ISDIGIT(*arg))
7059 {
7060 id = getdigits(&arg);
7061 if (!vim_iswhite(*arg) && *arg != NUL)
7062 {
7063 id = -1;
7064 arg = arg1;
7065 }
7066 else
7067 {
7068 arg = skipwhite(arg);
7069 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7070 {
7071 /* ":sign unplace {id}": remove placed sign by number */
7072 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
7073 if ((lnum = buf_delsign(buf, id)) != 0)
7074 update_debug_sign(buf, lnum);
7075 return;
7076 }
7077 }
7078 }
7079
7080 /*
7081 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7082 * Leave "arg" pointing to {fname}.
7083 */
7084 for (;;)
7085 {
7086 if (STRNCMP(arg, "line=", 5) == 0)
7087 {
7088 arg += 5;
7089 lnum = atoi((char *)arg);
7090 arg = skiptowhite(arg);
7091 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007092 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7093 {
7094 if (id != -1)
7095 {
7096 EMSG(_(e_invarg));
7097 return;
7098 }
7099 id = -2;
7100 arg = skiptowhite(arg + 1);
7101 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 else if (STRNCMP(arg, "name=", 5) == 0)
7103 {
7104 arg += 5;
7105 sign_name = arg;
7106 arg = skiptowhite(arg);
7107 if (*arg != NUL)
7108 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007109 while (sign_name[0] == '0' && sign_name[1] != NUL)
7110 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 }
7112 else if (STRNCMP(arg, "file=", 5) == 0)
7113 {
7114 arg += 5;
7115 buf = buflist_findname(arg);
7116 break;
7117 }
7118 else if (STRNCMP(arg, "buffer=", 7) == 0)
7119 {
7120 arg += 7;
7121 buf = buflist_findnr((int)getdigits(&arg));
7122 if (*skipwhite(arg) != NUL)
7123 EMSG(_(e_trailing));
7124 break;
7125 }
7126 else
7127 {
7128 EMSG(_(e_invarg));
7129 return;
7130 }
7131 arg = skipwhite(arg);
7132 }
7133
7134 if (buf == NULL)
7135 {
7136 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7137 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007138 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 {
7140 if (lnum >= 0 || sign_name != NULL)
7141 EMSG(_(e_invarg));
7142 else
7143 /* ":sign place file={fname}": list placed signs in one file */
7144 sign_list_placed(buf);
7145 }
7146 else if (idx == SIGNCMD_JUMP)
7147 {
7148 /* ":sign jump {id} file={fname}" */
7149 if (lnum >= 0 || sign_name != NULL)
7150 EMSG(_(e_invarg));
7151 else if ((lnum = buf_findsign(buf, id)) > 0)
7152 { /* goto a sign ... */
7153 if (buf_jump_open_win(buf) != NULL)
7154 { /* ... in a current window */
7155 curwin->w_cursor.lnum = lnum;
7156 check_cursor_lnum();
7157 beginline(BL_WHITE);
7158 }
7159 else
7160 { /* ... not currently in a window */
7161 char_u *cmd;
7162
7163 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7164 if (cmd == NULL)
7165 return;
7166 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7167 do_cmdline_cmd(cmd);
7168 vim_free(cmd);
7169 }
7170#ifdef FEAT_FOLDING
7171 foldOpenCursor();
7172#endif
7173 }
7174 else
7175 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7176 }
7177 else if (idx == SIGNCMD_UNPLACE)
7178 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 if (lnum >= 0 || sign_name != NULL)
7180 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007181 else if (id == -2)
7182 {
7183 /* ":sign unplace * file={fname}" */
7184 redraw_buf_later(buf, NOT_VALID);
7185 buf_delete_signs(buf);
7186 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 else
7188 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007189 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 lnum = buf_delsign(buf, id);
7191 update_debug_sign(buf, lnum);
7192 }
7193 }
7194 /* idx == SIGNCMD_PLACE */
7195 else if (sign_name != NULL)
7196 {
7197 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7198 if (STRCMP(sp->sn_name, sign_name) == 0)
7199 break;
7200 if (sp == NULL)
7201 {
7202 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7203 return;
7204 }
7205 if (lnum > 0)
7206 /* ":sign place {id} line={lnum} name={name} file={fname}":
7207 * place a sign */
7208 buf_addsign(buf, id, lnum, sp->sn_typenr);
7209 else
7210 /* ":sign place {id} file={fname}": change sign type */
7211 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
7212 update_debug_sign(buf, lnum);
7213 }
7214 else
7215 EMSG(_(e_invarg));
7216 }
7217}
7218
7219#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7220/*
7221 * Allocate the icons. Called when the GUI has started. Allows defining
7222 * signs before it starts.
7223 */
7224 void
7225sign_gui_started()
7226{
7227 sign_T *sp;
7228
7229 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7230 if (sp->sn_icon != NULL)
7231 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7232}
7233#endif
7234
7235/*
7236 * List one sign.
7237 */
7238 static void
7239sign_list_defined(sp)
7240 sign_T *sp;
7241{
7242 char_u *p;
7243
Bram Moolenaar555b2802005-05-19 21:08:39 +00007244 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 if (sp->sn_icon != NULL)
7246 {
7247 MSG_PUTS(" icon=");
7248 msg_outtrans(sp->sn_icon);
7249#ifdef FEAT_SIGN_ICONS
7250 if (sp->sn_image == NULL)
7251 MSG_PUTS(_(" (NOT FOUND)"));
7252#else
7253 MSG_PUTS(_(" (not supported)"));
7254#endif
7255 }
7256 if (sp->sn_text != NULL)
7257 {
7258 MSG_PUTS(" text=");
7259 msg_outtrans(sp->sn_text);
7260 }
7261 if (sp->sn_line_hl > 0)
7262 {
7263 MSG_PUTS(" linehl=");
7264 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7265 if (p == NULL)
7266 MSG_PUTS("NONE");
7267 else
7268 msg_puts(p);
7269 }
7270 if (sp->sn_text_hl > 0)
7271 {
7272 MSG_PUTS(" texthl=");
7273 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7274 if (p == NULL)
7275 MSG_PUTS("NONE");
7276 else
7277 msg_puts(p);
7278 }
7279}
7280
7281/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007282 * Undefine a sign and free its memory.
7283 */
7284 static void
7285sign_undefine(sp, sp_prev)
7286 sign_T *sp;
7287 sign_T *sp_prev;
7288{
7289 vim_free(sp->sn_name);
7290 vim_free(sp->sn_icon);
7291#ifdef FEAT_SIGN_ICONS
7292 if (sp->sn_image != NULL)
7293 {
7294 out_flush();
7295 gui_mch_destroy_sign(sp->sn_image);
7296 }
7297#endif
7298 vim_free(sp->sn_text);
7299 if (sp_prev == NULL)
7300 first_sign = sp->sn_next;
7301 else
7302 sp_prev->sn_next = sp->sn_next;
7303 vim_free(sp);
7304}
7305
7306/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 * Get highlighting attribute for sign "typenr".
7308 * If "line" is TRUE: line highl, if FALSE: text highl.
7309 */
7310 int
7311sign_get_attr(typenr, line)
7312 int typenr;
7313 int line;
7314{
7315 sign_T *sp;
7316
7317 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7318 if (sp->sn_typenr == typenr)
7319 {
7320 if (line)
7321 {
7322 if (sp->sn_line_hl > 0)
7323 return syn_id2attr(sp->sn_line_hl);
7324 }
7325 else
7326 {
7327 if (sp->sn_text_hl > 0)
7328 return syn_id2attr(sp->sn_text_hl);
7329 }
7330 break;
7331 }
7332 return 0;
7333}
7334
7335/*
7336 * Get text mark for sign "typenr".
7337 * Returns NULL if there isn't one.
7338 */
7339 char_u *
7340sign_get_text(typenr)
7341 int typenr;
7342{
7343 sign_T *sp;
7344
7345 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7346 if (sp->sn_typenr == typenr)
7347 return sp->sn_text;
7348 return NULL;
7349}
7350
7351#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7352 void *
7353sign_get_image(typenr)
7354 int typenr; /* the attribute which may have a sign */
7355{
7356 sign_T *sp;
7357
7358 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7359 if (sp->sn_typenr == typenr)
7360 return sp->sn_image;
7361 return NULL;
7362}
7363#endif
7364
7365/*
7366 * Get the name of a sign by its typenr.
7367 */
7368 char_u *
7369sign_typenr2name(typenr)
7370 int typenr;
7371{
7372 sign_T *sp;
7373
7374 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7375 if (sp->sn_typenr == typenr)
7376 return sp->sn_name;
7377 return (char_u *)_("[Deleted]");
7378}
7379
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007380#if defined(EXITFREE) || defined(PROTO)
7381/*
7382 * Undefine/free all signs.
7383 */
7384 void
7385free_signs()
7386{
7387 while (first_sign != NULL)
7388 sign_undefine(first_sign, NULL);
7389}
7390#endif
7391
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007392#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7393static enum
7394{
7395 EXP_SUBCMD, /* expand :sign sub-commands */
7396 EXP_DEFINE, /* expand :sign define {name} args */
7397 EXP_PLACE, /* expand :sign place {id} args */
7398 EXP_UNPLACE, /* expand :sign unplace" */
7399 EXP_SIGN_NAMES /* expand with name of placed signs */
7400} expand_what;
7401
7402/*
7403 * Function given to ExpandGeneric() to obtain the sign command
7404 * expansion.
7405 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007406 char_u *
7407get_sign_name(xp, idx)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00007408 expand_T *xp UNUSED;
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007409 int idx;
7410{
7411 sign_T *sp;
7412 int current_idx;
7413
7414 switch (expand_what)
7415 {
7416 case EXP_SUBCMD:
7417 return (char_u *)cmds[idx];
7418 case EXP_DEFINE:
7419 {
7420 char *define_arg[] =
7421 {
7422 "icon=", "linehl=", "text=", "texthl=", NULL
7423 };
7424 return (char_u *)define_arg[idx];
7425 }
7426 case EXP_PLACE:
7427 {
7428 char *place_arg[] =
7429 {
7430 "line=", "name=", "file=", "buffer=", NULL
7431 };
7432 return (char_u *)place_arg[idx];
7433 }
7434 case EXP_UNPLACE:
7435 {
7436 char *unplace_arg[] = { "file=", "buffer=", NULL };
7437 return (char_u *)unplace_arg[idx];
7438 }
7439 case EXP_SIGN_NAMES:
7440 /* Complete with name of signs already defined */
7441 current_idx = 0;
7442 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7443 if (current_idx++ == idx)
7444 return sp->sn_name;
7445 return NULL;
7446 default:
7447 return NULL;
7448 }
7449}
7450
7451/*
7452 * Handle command line completion for :sign command.
7453 */
7454 void
7455set_context_in_sign_cmd(xp, arg)
7456 expand_T *xp;
7457 char_u *arg;
7458{
7459 char_u *p;
7460 char_u *end_subcmd;
7461 char_u *last;
7462 int cmd_idx;
7463 char_u *begin_subcmd_args;
7464
7465 /* Default: expand subcommands. */
7466 xp->xp_context = EXPAND_SIGN;
7467 expand_what = EXP_SUBCMD;
7468 xp->xp_pattern = arg;
7469
7470 end_subcmd = skiptowhite(arg);
7471 if (*end_subcmd == NUL)
7472 /* expand subcmd name
7473 * :sign {subcmd}<CTRL-D>*/
7474 return;
7475
7476 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7477
7478 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007479 * |
7480 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007481 begin_subcmd_args = skipwhite(end_subcmd);
7482 p = skiptowhite(begin_subcmd_args);
7483 if (*p == NUL)
7484 {
7485 /*
7486 * Expand first argument of subcmd when possible.
7487 * For ":jump {id}" and ":unplace {id}", we could
7488 * possibly expand the ids of all signs already placed.
7489 */
7490 xp->xp_pattern = begin_subcmd_args;
7491 switch (cmd_idx)
7492 {
7493 case SIGNCMD_LIST:
7494 case SIGNCMD_UNDEFINE:
7495 /* :sign list <CTRL-D>
7496 * :sign undefine <CTRL-D> */
7497 expand_what = EXP_SIGN_NAMES;
7498 break;
7499 default:
7500 xp->xp_context = EXPAND_NOTHING;
7501 }
7502 return;
7503 }
7504
7505 /* expand last argument of subcmd */
7506
7507 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007508 * |
7509 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007510
7511 /* Loop until reaching last argument. */
7512 do
7513 {
7514 p = skipwhite(p);
7515 last = p;
7516 p = skiptowhite(p);
7517 } while (*p != NUL);
7518
7519 p = vim_strchr(last, '=');
7520
7521 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007522 * | |
7523 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007524 if (p == NUL)
7525 {
7526 /* Expand last argument name (before equal sign). */
7527 xp->xp_pattern = last;
7528 switch (cmd_idx)
7529 {
7530 case SIGNCMD_DEFINE:
7531 expand_what = EXP_DEFINE;
7532 break;
7533 case SIGNCMD_PLACE:
7534 expand_what = EXP_PLACE;
7535 break;
7536 case SIGNCMD_JUMP:
7537 case SIGNCMD_UNPLACE:
7538 expand_what = EXP_UNPLACE;
7539 break;
7540 default:
7541 xp->xp_context = EXPAND_NOTHING;
7542 }
7543 }
7544 else
7545 {
7546 /* Expand last argument value (after equal sign). */
7547 xp->xp_pattern = p + 1;
7548 switch (cmd_idx)
7549 {
7550 case SIGNCMD_DEFINE:
7551 if (STRNCMP(last, "texthl", p - last) == 0 ||
7552 STRNCMP(last, "linehl", p - last) == 0)
7553 xp->xp_context = EXPAND_HIGHLIGHT;
7554 else if (STRNCMP(last, "icon", p - last) == 0)
7555 xp->xp_context = EXPAND_FILES;
7556 else
7557 xp->xp_context = EXPAND_NOTHING;
7558 break;
7559 case SIGNCMD_PLACE:
7560 if (STRNCMP(last, "name", p - last) == 0)
7561 expand_what = EXP_SIGN_NAMES;
7562 else
7563 xp->xp_context = EXPAND_NOTHING;
7564 break;
7565 default:
7566 xp->xp_context = EXPAND_NOTHING;
7567 }
7568 }
7569}
7570#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571#endif
7572
7573#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7574/*
7575 * ":drop"
7576 * Opens the first argument in a window. When there are two or more arguments
7577 * the argument list is redefined.
7578 */
7579 void
7580ex_drop(eap)
7581 exarg_T *eap;
7582{
7583 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 win_T *wp;
7585 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007586# ifdef FEAT_WINDOWS
7587 tabpage_T *tp;
7588# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589
7590 /*
7591 * Check if the first argument is already being edited in a window. If
7592 * so, jump to that window.
7593 * We would actually need to check all arguments, but that's complicated
7594 * and mostly only one file is dropped.
7595 * This also ignores wildcards, since it is very unlikely the user is
7596 * editing a file name with a wildcard character.
7597 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007598 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007600 /*
7601 * Expanding wildcards may result in an empty argument list. E.g. when
7602 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7603 * already did an error message for this.
7604 */
7605 if (ARGCOUNT == 0)
7606 return;
7607
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007608# ifdef FEAT_WINDOWS
7609 if (cmdmod.tab)
7610 {
7611 /* ":tab drop file ...": open a tab for each argument that isn't
7612 * edited in a window yet. It's like ":tab all" but without closing
7613 * windows or tabs. */
7614 ex_all(eap);
7615 }
7616 else
7617# endif
7618 {
7619 /* ":drop file ...": Edit the first argument. Jump to an existing
7620 * window if possible, edit in current window if the current buffer
7621 * can be abandoned, otherwise open a new window. */
7622 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7623
7624 FOR_ALL_TAB_WINDOWS(tp, wp)
7625 {
7626 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007628# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007629 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007630# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 return;
7633 }
7634 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007636 /*
7637 * Check whether the current buffer is changed. If so, we will need
7638 * to split the current window or data could be lost.
7639 * Skip the check if the 'hidden' option is set, as in this case the
7640 * buffer won't be lost.
7641 */
7642 if (!P_HID(curbuf))
7643 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007645 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007647 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
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# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007651 if (split)
7652 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007654 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007656 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7657 if (split)
7658 {
7659 eap->cmdidx = CMD_sfirst;
7660 eap->cmd[0] = 's';
7661 }
7662 else
7663 eap->cmdidx = CMD_first;
7664 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666}
7667#endif