blob: bc2fcb70701c97f4ee451287242eab6936c259d7 [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);
787 if (dest >= line2)
788 {
789 mark_adjust(line2 + 1, dest, -num_lines, 0L);
790 curbuf->b_op_start.lnum = dest - num_lines + 1;
791 curbuf->b_op_end.lnum = dest;
792 }
793 else
794 {
795 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
796 curbuf->b_op_start.lnum = dest + 1;
797 curbuf->b_op_end.lnum = dest + num_lines;
798 }
799 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
800 mark_adjust(last_line - num_lines + 1, last_line,
801 -(last_line - dest - extra), 0L);
802
803 /*
804 * Now we delete the original text -- webb
805 */
806 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
807 return FAIL;
808
809 for (l = line1; l <= line2; l++)
810 ml_delete(line1 + extra, TRUE);
811
812 if (!global_busy && num_lines > p_report)
813 {
814 if (num_lines == 1)
815 MSG(_("1 line moved"));
816 else
817 smsg((char_u *)_("%ld lines moved"), num_lines);
818 }
819
820 /*
821 * Leave the cursor on the last of the moved lines.
822 */
823 if (dest >= line1)
824 curwin->w_cursor.lnum = dest;
825 else
826 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
827
828 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100829 {
830 dest += num_lines + 1;
831 last_line = curbuf->b_ml.ml_line_count;
832 if (dest > last_line + 1)
833 dest = last_line + 1;
834 changed_lines(line1, 0, dest, 0L);
835 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 else
837 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
838
839 return OK;
840}
841
842/*
843 * ":copy"
844 */
845 void
846ex_copy(line1, line2, n)
847 linenr_T line1;
848 linenr_T line2;
849 linenr_T n;
850{
851 linenr_T count;
852 char_u *p;
853
854 count = line2 - line1 + 1;
855 curbuf->b_op_start.lnum = n + 1;
856 curbuf->b_op_end.lnum = n + count;
857 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
858
859 /*
860 * there are three situations:
861 * 1. destination is above line1
862 * 2. destination is between line1 and line2
863 * 3. destination is below line2
864 *
865 * n = destination (when starting)
866 * curwin->w_cursor.lnum = destination (while copying)
867 * line1 = start of source (while copying)
868 * line2 = end of source (while copying)
869 */
870 if (u_save(n, n + 1) == FAIL)
871 return;
872
873 curwin->w_cursor.lnum = n;
874 while (line1 <= line2)
875 {
876 /* need to use vim_strsave() because the line will be unlocked within
877 * ml_append() */
878 p = vim_strsave(ml_get(line1));
879 if (p != NULL)
880 {
881 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
882 vim_free(p);
883 }
884 /* situation 2: skip already copied lines */
885 if (line1 == n)
886 line1 = curwin->w_cursor.lnum;
887 ++line1;
888 if (curwin->w_cursor.lnum < line1)
889 ++line1;
890 if (curwin->w_cursor.lnum < line2)
891 ++line2;
892 ++curwin->w_cursor.lnum;
893 }
894
895 appended_lines_mark(n, count);
896
897 msgmore((long)count);
898}
899
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000900static char_u *prevcmd = NULL; /* the previous command */
901
902#if defined(EXITFREE) || defined(PROTO)
903 void
904free_prev_shellcmd()
905{
906 vim_free(prevcmd);
907}
908#endif
909
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910/*
911 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
912 * Bangs in the argument are replaced with the previously entered command.
913 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 */
915 void
916do_bang(addr_count, eap, forceit, do_in, do_out)
917 int addr_count;
918 exarg_T *eap;
919 int forceit;
920 int do_in, do_out;
921{
922 char_u *arg = eap->arg; /* command */
923 linenr_T line1 = eap->line1; /* start of range */
924 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 char_u *newcmd = NULL; /* the new command */
926 int free_newcmd = FALSE; /* need to free() newcmd */
927 int ins_prevcmd;
928 char_u *t;
929 char_u *p;
930 char_u *trailarg;
931 int len;
932 int scroll_save = msg_scroll;
933
934 /*
935 * Disallow shell commands for "rvim".
936 * Disallow shell commands from .exrc and .vimrc in current directory for
937 * security reasons.
938 */
939 if (check_restricted() || check_secure())
940 return;
941
942 if (addr_count == 0) /* :! */
943 {
944 msg_scroll = FALSE; /* don't scroll here */
945 autowrite_all();
946 msg_scroll = scroll_save;
947 }
948
949 /*
950 * Try to find an embedded bang, like in :!<cmd> ! [args]
951 * (:!! is indicated by the 'forceit' variable)
952 */
953 ins_prevcmd = forceit;
954 trailarg = arg;
955 do
956 {
957 len = (int)STRLEN(trailarg) + 1;
958 if (newcmd != NULL)
959 len += (int)STRLEN(newcmd);
960 if (ins_prevcmd)
961 {
962 if (prevcmd == NULL)
963 {
964 EMSG(_(e_noprev));
965 vim_free(newcmd);
966 return;
967 }
968 len += (int)STRLEN(prevcmd);
969 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000970 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 {
972 vim_free(newcmd);
973 return;
974 }
975 *t = NUL;
976 if (newcmd != NULL)
977 STRCAT(t, newcmd);
978 if (ins_prevcmd)
979 STRCAT(t, prevcmd);
980 p = t + STRLEN(t);
981 STRCAT(t, trailarg);
982 vim_free(newcmd);
983 newcmd = t;
984
985 /*
986 * Scan the rest of the argument for '!', which is replaced by the
987 * previous command. "\!" is replaced by "!" (this is vi compatible).
988 */
989 trailarg = NULL;
990 while (*p)
991 {
Bram Moolenaare60acc12011-05-10 16:41:25 +0200992 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 {
994 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000995 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 else
997 {
998 trailarg = p;
999 *trailarg++ = NUL;
1000 ins_prevcmd = TRUE;
1001 break;
1002 }
1003 }
1004 ++p;
1005 }
1006 } while (trailarg != NULL);
1007
1008 vim_free(prevcmd);
1009 prevcmd = newcmd;
1010
1011 if (bangredo) /* put cmd in redo buffer for ! command */
1012 {
Bram Moolenaarebefac62005-12-28 22:39:57 +00001013 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 AppendToRedobuff((char_u *)"\n");
1015 bangredo = FALSE;
1016 }
1017 /*
1018 * Add quotes around the command, for shells that need them.
1019 */
1020 if (*p_shq != NUL)
1021 {
1022 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1023 if (newcmd == NULL)
1024 return;
1025 STRCPY(newcmd, p_shq);
1026 STRCAT(newcmd, prevcmd);
1027 STRCAT(newcmd, p_shq);
1028 free_newcmd = TRUE;
1029 }
1030 if (addr_count == 0) /* :! */
1031 {
1032 /* echo the command */
1033 msg_start();
1034 msg_putchar(':');
1035 msg_putchar('!');
1036 msg_outtrans(newcmd);
1037 msg_clr_eos();
1038 windgoto(msg_row, msg_col);
1039
1040 do_shell(newcmd, 0);
1041 }
1042 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001043 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 /* Careful: This may recursively call do_bang() again! (because of
1045 * autocommands) */
1046 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001047#ifdef FEAT_AUTOCMD
1048 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1049#endif
1050 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 if (free_newcmd)
1052 vim_free(newcmd);
1053}
1054
1055/*
1056 * do_filter: filter lines through a command given by the user
1057 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001058 * We mostly use temp files and the call_shell() routine here. This would
1059 * normally be done using pipes on a UNIX machine, but this is more portable
1060 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 * to deal with redirection somehow, and should handle things like looking
1062 * at the PATH env. variable, and adding reasonable extensions to the
1063 * command name given by the user. All reasonable versions of call_shell()
1064 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001065 * Alternatively, if on Unix and redirecting input or output, but not both,
1066 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 * We use input redirection if do_in is TRUE.
1068 * We use output redirection if do_out is TRUE.
1069 */
1070 static void
1071do_filter(line1, line2, eap, cmd, do_in, do_out)
1072 linenr_T line1, line2;
1073 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1074 char_u *cmd;
1075 int do_in, do_out;
1076{
1077 char_u *itmp = NULL;
1078 char_u *otmp = NULL;
1079 linenr_T linecount;
1080 linenr_T read_linecount;
1081 pos_T cursor_save;
1082 char_u *cmd_buf;
1083#ifdef FEAT_AUTOCMD
1084 buf_T *old_curbuf = curbuf;
1085#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001086 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087
1088 if (*cmd == NUL) /* no filter command */
1089 return;
1090
1091#ifdef WIN3264
1092 /*
1093 * Check if external commands are allowed now.
1094 */
1095 if (can_end_termcap_mode(TRUE) == FALSE)
1096 return;
1097#endif
1098
1099 cursor_save = curwin->w_cursor;
1100 linecount = line2 - line1 + 1;
1101 curwin->w_cursor.lnum = line1;
1102 curwin->w_cursor.col = 0;
1103 changed_line_abv_curs();
1104 invalidate_botline();
1105
1106 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001107 * When using temp files:
1108 * 1. * Form temp file names
1109 * 2. * Write the lines to a temp file
1110 * 3. Run the filter command on the temp file
1111 * 4. * Read the output of the command into the buffer
1112 * 5. * Delete the original lines to be filtered
1113 * 6. * Remove the temp files
1114 *
1115 * When writing the input with a pipe or when catching the output with a
1116 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 */
1118
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001119 if (do_out)
1120 shell_flags |= SHELL_DOOUT;
1121
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001122#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001123 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001125 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1126 shell_flags |= SHELL_READ;
1127 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001129 else if (do_in && !do_out && !p_stmp)
1130 {
1131 /* Use a pipe to write stdin of the command, do not use a temp file. */
1132 shell_flags |= SHELL_WRITE;
1133 curbuf->b_op_start.lnum = line1;
1134 curbuf->b_op_end.lnum = line2;
1135 }
1136 else if (do_in && do_out && !p_stmp)
1137 {
1138 /* Use a pipe to write stdin and fetch stdout of the command, do not
1139 * use a temp file. */
1140 shell_flags |= SHELL_READ|SHELL_WRITE;
1141 curbuf->b_op_start.lnum = line1;
1142 curbuf->b_op_end.lnum = line2;
1143 curwin->w_cursor.lnum = line2;
1144 }
1145 else
1146#endif
1147 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1148 || (do_out && (otmp = vim_tempname('o')) == NULL))
1149 {
1150 EMSG(_(e_notmp));
1151 goto filterend;
1152 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153
1154/*
1155 * The writing and reading of temp files will not be shown.
1156 * Vi also doesn't do this and the messages are not very informative.
1157 */
1158 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001159 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160 FALSE, FALSE, FALSE, TRUE) == FAIL)
1161 {
1162 msg_putchar('\n'); /* keep message from buf_write() */
1163 --no_wait_return;
1164#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1165 if (!aborting())
1166#endif
1167 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1168 goto filterend;
1169 }
1170#ifdef FEAT_AUTOCMD
1171 if (curbuf != old_curbuf)
1172 goto filterend;
1173#endif
1174
1175 if (!do_out)
1176 msg_putchar('\n');
1177
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001178 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1180 if (cmd_buf == NULL)
1181 goto filterend;
1182
1183 windgoto((int)Rows - 1, 0);
1184 cursor_on();
1185
1186 /*
1187 * When not redirecting the output the command can write anything to the
1188 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1189 * stderr output of external command. Clear the screen later.
1190 * If do_in is FALSE, this could be something like ":r !cat", which may
1191 * also mess up the screen, clear it later.
1192 */
1193 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1194 redraw_later_clear();
1195
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001196 if (do_out)
1197 {
1198 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001199 {
1200 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001201 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001202 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001203 redraw_curbuf_later(VALID);
1204 }
1205 read_linecount = curbuf->b_ml.ml_line_count;
1206
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 /*
1208 * When call_shell() fails wait_return() is called to give the user a
1209 * chance to read the error messages. Otherwise errors are ignored, so you
1210 * can see the error messages from the command that appear on stdout; use
1211 * 'u' to fix the text
1212 * Switch to cooked mode when not redirecting stdin, avoids that something
1213 * like ":r !cat" hangs.
1214 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1215 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001216 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 {
1218 redraw_later_clear();
1219 wait_return(FALSE);
1220 }
1221 vim_free(cmd_buf);
1222
1223 did_check_timestamps = FALSE;
1224 need_check_timestamps = TRUE;
1225
1226 /* When interrupting the shell command, it may still have produced some
1227 * useful output. Reset got_int here, so that readfile() won't cancel
1228 * reading. */
1229 ui_breakcheck();
1230 got_int = FALSE;
1231
1232 if (do_out)
1233 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001234 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1237 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001239#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1240 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001242 {
1243 msg_putchar('\n');
1244 EMSG2(_(e_notread), otmp);
1245 }
1246 goto error;
1247 }
1248#ifdef FEAT_AUTOCMD
1249 if (curbuf != old_curbuf)
1250 goto filterend;
1251#endif
1252 }
1253
1254 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1255
1256 if (shell_flags & SHELL_READ)
1257 {
1258 curbuf->b_op_start.lnum = line2 + 1;
1259 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1260 appended_lines_mark(line2, read_linecount);
1261 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262
1263 if (do_in)
1264 {
1265 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1266 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 if (read_linecount >= linecount)
1268 /* move all marks from old lines to new lines */
1269 mark_adjust(line1, line2, linecount, 0L);
1270 else
1271 {
1272 /* move marks from old lines to new lines, delete marks
1273 * that are in deleted lines */
1274 mark_adjust(line1, line1 + read_linecount - 1,
1275 linecount, 0L);
1276 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1277 }
1278 }
1279
1280 /*
1281 * Put cursor on first filtered line for ":range!cmd".
1282 * Adjust '[ and '] (set by buf_write()).
1283 */
1284 curwin->w_cursor.lnum = line1;
1285 del_lines(linecount, TRUE);
1286 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1287 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1288 write_lnum_adjust(-linecount); /* adjust last line
1289 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001290#ifdef FEAT_FOLDING
1291 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1292#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 }
1294 else
1295 {
1296 /*
1297 * Put cursor on last new line for ":r !cmd".
1298 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001300 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001302
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1304 --no_wait_return;
1305
1306 if (linecount > p_report)
1307 {
1308 if (do_in)
1309 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001310 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1311 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001314 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 }
1316 else
1317 msgmore((long)linecount);
1318 }
1319 }
1320 else
1321 {
1322error:
1323 /* put cursor back in same position for ":w !cmd" */
1324 curwin->w_cursor = cursor_save;
1325 --no_wait_return;
1326 wait_return(FALSE);
1327 }
1328
1329filterend:
1330
1331#ifdef FEAT_AUTOCMD
1332 if (curbuf != old_curbuf)
1333 {
1334 --no_wait_return;
1335 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1336 }
1337#endif
1338 if (itmp != NULL)
1339 mch_remove(itmp);
1340 if (otmp != NULL)
1341 mch_remove(otmp);
1342 vim_free(itmp);
1343 vim_free(otmp);
1344}
1345
1346/*
1347 * Call a shell to execute a command.
1348 * When "cmd" is NULL start an interactive shell.
1349 */
1350 void
1351do_shell(cmd, flags)
1352 char_u *cmd;
1353 int flags; /* may be SHELL_DOOUT when output is redirected */
1354{
1355 buf_T *buf;
1356#ifndef FEAT_GUI_MSWIN
1357 int save_nwr;
1358#endif
1359#ifdef MSWIN
1360 int winstart = FALSE;
1361#endif
1362
1363 /*
1364 * Disallow shell commands for "rvim".
1365 * Disallow shell commands from .exrc and .vimrc in current directory for
1366 * security reasons.
1367 */
1368 if (check_restricted() || check_secure())
1369 {
1370 msg_end();
1371 return;
1372 }
1373
1374#ifdef MSWIN
1375 /*
1376 * Check if external commands are allowed now.
1377 */
1378 if (can_end_termcap_mode(TRUE) == FALSE)
1379 return;
1380
1381 /*
1382 * Check if ":!start" is used.
1383 */
1384 if (cmd != NULL)
1385 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1386#endif
1387
1388 /*
1389 * For autocommands we want to get the output on the current screen, to
1390 * avoid having to type return below.
1391 */
1392 msg_putchar('\r'); /* put cursor at start of line */
1393#ifdef FEAT_AUTOCMD
1394 if (!autocmd_busy)
1395#endif
1396 {
1397#ifdef MSWIN
1398 if (!winstart)
1399#endif
1400 stoptermcap();
1401 }
1402#ifdef MSWIN
1403 if (!winstart)
1404#endif
1405 msg_putchar('\n'); /* may shift screen one line up */
1406
1407 /* warning message before calling the shell */
1408 if (p_warn
1409#ifdef FEAT_AUTOCMD
1410 && !autocmd_busy
1411#endif
1412 && msg_silent == 0)
1413 for (buf = firstbuf; buf; buf = buf->b_next)
1414 if (bufIsChanged(buf))
1415 {
1416#ifdef FEAT_GUI_MSWIN
1417 if (!winstart)
1418 starttermcap(); /* don't want a message box here */
1419#endif
1420 MSG_PUTS(_("[No write since last change]\n"));
1421#ifdef FEAT_GUI_MSWIN
1422 if (!winstart)
1423 stoptermcap();
1424#endif
1425 break;
1426 }
1427
1428 /* This windgoto is required for when the '\n' resulted in a "delete line
1429 * 1" command to the terminal. */
1430 if (!swapping_screen())
1431 windgoto(msg_row, msg_col);
1432 cursor_on();
1433 (void)call_shell(cmd, SHELL_COOKED | flags);
1434 did_check_timestamps = FALSE;
1435 need_check_timestamps = TRUE;
1436
1437 /*
1438 * put the message cursor at the end of the screen, avoids wait_return()
1439 * to overwrite the text that the external command showed
1440 */
1441 if (!swapping_screen())
1442 {
1443 msg_row = Rows - 1;
1444 msg_col = 0;
1445 }
1446
1447#ifdef FEAT_AUTOCMD
1448 if (autocmd_busy)
1449 {
1450 if (msg_silent == 0)
1451 redraw_later_clear();
1452 }
1453 else
1454#endif
1455 {
1456 /*
1457 * For ":sh" there is no need to call wait_return(), just redraw.
1458 * Also for the Win32 GUI (the output is in a console window).
1459 * Otherwise there is probably text on the screen that the user wants
1460 * to read before redrawing, so call wait_return().
1461 */
1462#ifndef FEAT_GUI_MSWIN
1463 if (cmd == NULL
1464# ifdef WIN3264
1465 || (winstart && !need_wait_return)
1466# endif
1467 )
1468 {
1469 if (msg_silent == 0)
1470 redraw_later_clear();
1471 need_wait_return = FALSE;
1472 }
1473 else
1474 {
1475 /*
1476 * If we switch screens when starttermcap() is called, we really
1477 * want to wait for "hit return to continue".
1478 */
1479 save_nwr = no_wait_return;
1480 if (swapping_screen())
1481 no_wait_return = FALSE;
1482# ifdef AMIGA
1483 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1484# else
1485 wait_return(msg_silent == 0);
1486# endif
1487 no_wait_return = save_nwr;
1488 }
1489#endif /* FEAT_GUI_W32 */
1490
1491#ifdef MSWIN
1492 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1493#endif
1494 starttermcap(); /* start termcap if not done by wait_return() */
1495
1496 /*
1497 * In an Amiga window redrawing is caused by asking the window size.
1498 * If we got an interrupt this will not work. The chance that the
1499 * window size is wrong is very small, but we need to redraw the
1500 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1501 * but it saves an extra redraw.
1502 */
1503#ifdef AMIGA
1504 if (skip_redraw) /* ':' hit in wait_return() */
1505 {
1506 if (msg_silent == 0)
1507 redraw_later_clear();
1508 }
1509 else if (term_console)
1510 {
1511 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1512 if (got_int && msg_silent == 0)
1513 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1514 else
1515 must_redraw = 0; /* no extra redraw needed */
1516 }
1517#endif
1518 }
1519
1520 /* display any error messages now */
1521 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001522
1523#ifdef FEAT_AUTOCMD
1524 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1525#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526}
1527
1528/*
1529 * Create a shell command from a command string, input redirection file and
1530 * output redirection file.
1531 * Returns an allocated string with the shell command, or NULL for failure.
1532 */
1533 char_u *
1534make_filter_cmd(cmd, itmp, otmp)
1535 char_u *cmd; /* command */
1536 char_u *itmp; /* NULL or name of input file */
1537 char_u *otmp; /* NULL or name of output file */
1538{
1539 char_u *buf;
1540 long_u len;
1541
1542 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1543 if (itmp != NULL)
1544 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1545 if (otmp != NULL)
1546 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1547 buf = lalloc(len, TRUE);
1548 if (buf == NULL)
1549 return NULL;
1550
1551#if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1552 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001553 * Put braces around the command (for concatenated commands) when
1554 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001556 if (itmp != NULL || otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001557 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001558 else
1559 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 if (itmp != NULL)
1561 {
1562 STRCAT(buf, " < ");
1563 STRCAT(buf, itmp);
1564 }
1565#else
1566 /*
1567 * for shells that don't understand braces around commands, at least allow
1568 * the use of commands in a pipe.
1569 */
1570 STRCPY(buf, cmd);
1571 if (itmp != NULL)
1572 {
1573 char_u *p;
1574
1575 /*
1576 * If there is a pipe, we have to put the '<' in front of it.
1577 * Don't do this when 'shellquote' is not empty, otherwise the
1578 * redirection would be inside the quotes.
1579 */
1580 if (*p_shq == NUL)
1581 {
1582 p = vim_strchr(buf, '|');
1583 if (p != NULL)
1584 *p = NUL;
1585 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1587 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 if (*p_shq == NUL)
1589 {
1590 p = vim_strchr(cmd, '|');
1591 if (p != NULL)
1592 {
1593 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1594 STRCAT(buf, p);
1595 }
1596 }
1597 }
1598#endif
1599 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001600 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601
1602 return buf;
1603}
1604
1605/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001606 * Append output redirection for file "fname" to the end of string buffer
1607 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 * Works with the 'shellredir' and 'shellpipe' options.
1609 * The caller should make sure that there is enough room:
1610 * STRLEN(opt) + STRLEN(fname) + 3
1611 */
1612 void
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001613append_redir(buf, buflen, opt, fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 char_u *buf;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001615 int buflen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 char_u *opt;
1617 char_u *fname;
1618{
1619 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001620 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001622 end = buf + STRLEN(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 /* find "%s", skipping "%%" */
1624 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1625 if (p[1] == 's')
1626 break;
1627 if (p != NULL)
1628 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001629 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1630 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1631 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 }
1633 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001634 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 " %s %s",
1637#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639#endif
1640 (char *)opt, (char *)fname);
1641}
1642
1643#ifdef FEAT_VIMINFO
1644
1645static int no_viminfo __ARGS((void));
1646static int viminfo_errcnt;
1647
1648 static int
1649no_viminfo()
1650{
1651 /* "vim -i NONE" does not read or write a viminfo file */
1652 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1653}
1654
1655/*
1656 * Report an error for reading a viminfo file.
1657 * Count the number of errors. When there are more than 10, return TRUE.
1658 */
1659 int
1660viminfo_error(errnum, message, line)
1661 char *errnum;
1662 char *message;
1663 char_u *line;
1664{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001665 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1666 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001667 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001668 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1669 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 emsg(IObuff);
1671 if (++viminfo_errcnt >= 10)
1672 {
1673 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1674 return TRUE;
1675 }
1676 return FALSE;
1677}
1678
1679/*
1680 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001681 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 */
1683 int
Bram Moolenaard812df62008-11-09 12:46:09 +00001684read_viminfo(file, flags)
1685 char_u *file; /* file name or NULL to use default name */
1686 int flags; /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687{
1688 FILE *fp;
1689 char_u *fname;
1690
1691 if (no_viminfo())
1692 return FAIL;
1693
Bram Moolenaard812df62008-11-09 12:46:09 +00001694 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 if (fname == NULL)
1696 return FAIL;
1697 fp = mch_fopen((char *)fname, READBIN);
1698
1699 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001700 {
1701 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001702 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1703 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001704 (flags & VIF_WANT_INFO) ? _(" info") : "",
1705 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1706 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001707 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001708 verbose_leave();
1709 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710
1711 vim_free(fname);
1712 if (fp == NULL)
1713 return FAIL;
1714
1715 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001716 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
1718 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 return OK;
1720}
1721
1722/*
1723 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1724 * that effectively a merge of current info and old info is done. This allows
1725 * multiple vims to run simultaneously, without losing any marks etc. If
1726 * forceit is TRUE, then the old file is not read in, and only internal info is
1727 * written to the file. -- webb
1728 */
1729 void
1730write_viminfo(file, forceit)
1731 char_u *file;
1732 int forceit;
1733{
1734 char_u *fname;
1735 FILE *fp_in = NULL; /* input viminfo file, if any */
1736 FILE *fp_out = NULL; /* output viminfo file */
1737 char_u *tempname = NULL; /* name of temp viminfo file */
1738 struct stat st_new; /* mch_stat() of potential new file */
1739 char_u *wp;
1740#if defined(UNIX) || defined(VMS)
1741 mode_t umask_save;
1742#endif
1743#ifdef UNIX
1744 int shortname = FALSE; /* use 8.3 file name */
1745 struct stat st_old; /* mch_stat() of existing viminfo file */
1746#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001747#ifdef WIN3264
1748 long perm = -1;
1749#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750
1751 if (no_viminfo())
1752 return;
1753
1754 fname = viminfo_filename(file); /* may set to default if NULL */
1755 if (fname == NULL)
1756 return;
1757
1758 fp_in = mch_fopen((char *)fname, READBIN);
1759 if (fp_in == NULL)
1760 {
1761 /* if it does exist, but we can't read it, don't try writing */
1762 if (mch_stat((char *)fname, &st_new) == 0)
1763 goto end;
1764#if defined(UNIX) || defined(VMS)
1765 /*
1766 * For Unix we create the .viminfo non-accessible for others,
1767 * because it may contain text from non-accessible documents.
1768 */
1769 umask_save = umask(077);
1770#endif
1771 fp_out = mch_fopen((char *)fname, WRITEBIN);
1772#if defined(UNIX) || defined(VMS)
1773 (void)umask(umask_save);
1774#endif
1775 }
1776 else
1777 {
1778 /*
1779 * There is an existing viminfo file. Create a temporary file to
1780 * write the new viminfo into, in the same directory as the
1781 * existing viminfo file, which will be renamed later.
1782 */
1783#ifdef UNIX
1784 /*
1785 * For Unix we check the owner of the file. It's not very nice to
1786 * overwrite a user's viminfo file after a "su root", with a
1787 * viminfo file that the user can't read.
1788 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001789 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001790 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001792 if (mch_stat((char *)fname, &st_old) == 0
1793 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001794 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 ? (st_old.st_mode & 0200)
1796 : (st_old.st_gid == getgid()
1797 ? (st_old.st_mode & 0020)
1798 : (st_old.st_mode & 0002))))
1799 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001800 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801
1802 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1804 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001805 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 goto end;
1807 }
1808#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001809#ifdef WIN3264
1810 /* Get the file attributes of the existing viminfo file. */
1811 perm = mch_getperm(fname);
1812#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813
1814 /*
1815 * Make tempname.
1816 * May try twice: Once normal and once with shortname set, just in
1817 * case somebody puts his viminfo file in an 8.3 filesystem.
1818 */
1819 for (;;)
1820 {
1821 tempname = buf_modname(
1822#ifdef UNIX
1823 shortname,
1824#else
1825# ifdef SHORT_FNAME
1826 TRUE,
1827# else
1828# ifdef FEAT_GUI_W32
1829 gui_is_win32s(),
1830# else
1831 FALSE,
1832# endif
1833# endif
1834#endif
1835 fname,
1836#ifdef VMS
1837 (char_u *)"-tmp",
1838#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840#endif
1841 FALSE);
1842 if (tempname == NULL) /* out of memory */
1843 break;
1844
1845 /*
1846 * Check if tempfile already exists. Never overwrite an
1847 * existing file!
1848 */
1849 if (mch_stat((char *)tempname, &st_new) == 0)
1850 {
1851#ifdef UNIX
1852 /*
1853 * Check if tempfile is same as original file. May happen
1854 * when modname() gave the same file back. E.g. silly
1855 * link, or file name-length reached. Try again with
1856 * shortname set.
1857 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001858 if (!shortname && st_new.st_dev == st_old.st_dev
1859 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 {
1861 vim_free(tempname);
1862 tempname = NULL;
1863 shortname = TRUE;
1864 continue;
1865 }
1866#endif
1867 /*
1868 * Try another name. Change one character, just before
1869 * the extension. This should also work for an 8.3
1870 * file name, when after adding the extension it still is
1871 * the same file as the original.
1872 */
1873 wp = tempname + STRLEN(tempname) - 5;
1874 if (wp < gettail(tempname)) /* empty file name? */
1875 wp = gettail(tempname);
1876 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1877 --*wp)
1878 {
1879 /*
1880 * They all exist? Must be something wrong! Don't
1881 * write the viminfo file then.
1882 */
1883 if (*wp == 'a')
1884 {
1885 vim_free(tempname);
1886 tempname = NULL;
1887 break;
1888 }
1889 }
1890 }
1891 break;
1892 }
1893
1894 if (tempname != NULL)
1895 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001896#ifdef VMS
1897 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001898 umask_save = umask(077);
1899 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1900 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001901#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001902 int fd;
1903
1904 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001905 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001906 * Unix: same as original file, but strip s-bit. Reset umask to
1907 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001908 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001909# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001910 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001911 fd = mch_open((char *)tempname,
1912 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001913 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001914 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001915# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001916 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001917 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001918# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00001919 if (fd < 0)
1920 fp_out = NULL;
1921 else
1922 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001923#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924
1925 /*
1926 * If we can't create in the same directory, try creating a
1927 * "normal" temp file.
1928 */
1929 if (fp_out == NULL)
1930 {
1931 vim_free(tempname);
1932 if ((tempname = vim_tempname('o')) != NULL)
1933 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1934 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00001935
1936#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001938 * Make sure the owner can read/write it. This only works for
1939 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 */
1941 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001942 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943#endif
1944 }
1945 }
1946
1947 /*
1948 * Check if the new viminfo file can be written to.
1949 */
1950 if (fp_out == NULL)
1951 {
1952 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00001953 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 if (fp_in != NULL)
1955 fclose(fp_in);
1956 goto end;
1957 }
1958
1959 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001960 {
1961 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001962 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001963 verbose_leave();
1964 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965
1966 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001967 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968
1969 fclose(fp_out); /* errors are ignored !? */
1970 if (fp_in != NULL)
1971 {
1972 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001973
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 /*
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001975 * In case of an error keep the original viminfo file.
1976 * Otherwise rename the newly written file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 */
1978 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1979 mch_remove(tempname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001980
1981#ifdef WIN3264
1982 /* If the viminfo file was hidden then also hide the new file. */
1983 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1984 mch_hide(fname);
1985#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001987
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988end:
1989 vim_free(fname);
1990 vim_free(tempname);
1991}
1992
1993/*
1994 * Get the viminfo file name to use.
1995 * If "file" is given and not empty, use it (has already been expanded by
1996 * cmdline functions).
1997 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1998 * expand environment variables.
1999 * Returns an allocated string. NULL when out of memory.
2000 */
2001 static char_u *
2002viminfo_filename(file)
2003 char_u *file;
2004{
2005 if (file == NULL || *file == NUL)
2006 {
2007 if (use_viminfo != NULL)
2008 file = use_viminfo;
2009 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2010 {
2011#ifdef VIMINFO_FILE2
2012 /* don't use $HOME when not defined (turned into "c:/"!). */
2013# ifdef VMS
2014 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2015# else
2016 if (mch_getenv((char_u *)"HOME") == NULL)
2017# endif
2018 {
2019 /* don't use $VIM when not available. */
2020 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2021 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2022 file = (char_u *)VIMINFO_FILE2;
2023 else
2024 file = (char_u *)VIMINFO_FILE;
2025 }
2026 else
2027#endif
2028 file = (char_u *)VIMINFO_FILE;
2029 }
2030 expand_env(file, NameBuff, MAXPATHL);
2031 file = NameBuff;
2032 }
2033 return vim_strsave(file);
2034}
2035
2036/*
2037 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2038 */
2039 static void
Bram Moolenaard812df62008-11-09 12:46:09 +00002040do_viminfo(fp_in, fp_out, flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 FILE *fp_in;
2042 FILE *fp_out;
Bram Moolenaard812df62008-11-09 12:46:09 +00002043 int flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044{
2045 int count = 0;
2046 int eof = FALSE;
2047 vir_T vir;
2048
2049 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2050 return;
2051 vir.vir_fd = fp_in;
2052#ifdef FEAT_MBYTE
2053 vir.vir_conv.vc_type = CONV_NONE;
2054#endif
2055
2056 if (fp_in != NULL)
2057 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002058 if (flags & VIF_WANT_INFO)
2059 eof = read_viminfo_up_to_marks(&vir,
2060 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 else
2062 /* Skip info, find start of marks */
2063 while (!(eof = viminfo_readline(&vir))
2064 && vir.vir_line[0] != '>')
2065 ;
2066 }
2067 if (fp_out != NULL)
2068 {
2069 /* Write the info: */
2070 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2071 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002072 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002074 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2076#endif
2077 write_viminfo_search_pattern(fp_out);
2078 write_viminfo_sub_string(fp_out);
2079#ifdef FEAT_CMDHIST
2080 write_viminfo_history(fp_out);
2081#endif
2082 write_viminfo_registers(fp_out);
2083#ifdef FEAT_EVAL
2084 write_viminfo_varlist(fp_out);
2085#endif
2086 write_viminfo_filemarks(fp_out);
2087 write_viminfo_bufferlist(fp_out);
2088 count = write_viminfo_marks(fp_out);
2089 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002090 if (fp_in != NULL
2091 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2092 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093
2094 vim_free(vir.vir_line);
2095#ifdef FEAT_MBYTE
2096 if (vir.vir_conv.vc_type != CONV_NONE)
2097 convert_setup(&vir.vir_conv, NULL, NULL);
2098#endif
2099}
2100
2101/*
2102 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2103 * first part of the viminfo file which contains everything but the marks that
2104 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2105 */
2106 static int
2107read_viminfo_up_to_marks(virp, forceit, writing)
2108 vir_T *virp;
2109 int forceit;
2110 int writing;
2111{
2112 int eof;
2113 buf_T *buf;
2114
2115#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002116 prepare_viminfo_history(forceit ? 9999 : 0, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117#endif
2118 eof = viminfo_readline(virp);
2119 while (!eof && virp->vir_line[0] != '>')
2120 {
2121 switch (virp->vir_line[0])
2122 {
2123 /* Characters reserved for future expansion, ignored now */
2124 case '+': /* "+40 /path/dir file", for running vim without args */
2125 case '|': /* to be defined */
2126 case '^': /* to be defined */
2127 case '<': /* long line - ignored */
2128 /* A comment or empty line. */
2129 case NUL:
2130 case '\r':
2131 case '\n':
2132 case '#':
2133 eof = viminfo_readline(virp);
2134 break;
2135 case '*': /* "*encoding=value" */
2136 eof = viminfo_encoding(virp);
2137 break;
2138 case '!': /* global variable */
2139#ifdef FEAT_EVAL
2140 eof = read_viminfo_varlist(virp, writing);
2141#else
2142 eof = viminfo_readline(virp);
2143#endif
2144 break;
2145 case '%': /* entry for buffer list */
2146 eof = read_viminfo_bufferlist(virp, writing);
2147 break;
2148 case '"':
2149 eof = read_viminfo_register(virp, forceit);
2150 break;
2151 case '/': /* Search string */
2152 case '&': /* Substitute search string */
2153 case '~': /* Last search string, followed by '/' or '&' */
2154 eof = read_viminfo_search_pattern(virp, forceit);
2155 break;
2156 case '$':
2157 eof = read_viminfo_sub_string(virp, forceit);
2158 break;
2159 case ':':
2160 case '?':
2161 case '=':
2162 case '@':
2163#ifdef FEAT_CMDHIST
Bram Moolenaar07219f92013-04-14 23:19:36 +02002164 eof = read_viminfo_history(virp, writing);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165#else
2166 eof = viminfo_readline(virp);
2167#endif
2168 break;
2169 case '-':
2170 case '\'':
2171 eof = read_viminfo_filemark(virp, forceit);
2172 break;
2173 default:
2174 if (viminfo_error("E575: ", _("Illegal starting char"),
2175 virp->vir_line))
2176 eof = TRUE;
2177 else
2178 eof = viminfo_readline(virp);
2179 break;
2180 }
2181 }
2182
2183#ifdef FEAT_CMDHIST
2184 /* Finish reading history items. */
Bram Moolenaar07219f92013-04-14 23:19:36 +02002185 if (!writing)
2186 finish_viminfo_history();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187#endif
2188
2189 /* Change file names to buffer numbers for fmarks. */
2190 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2191 fmarks_check_names(buf);
2192
2193 return eof;
2194}
2195
2196/*
2197 * Compare the 'encoding' value in the viminfo file with the current value of
2198 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2199 * conversion of text with iconv() in viminfo_readstring().
2200 */
2201 static int
2202viminfo_encoding(virp)
2203 vir_T *virp;
2204{
2205#ifdef FEAT_MBYTE
2206 char_u *p;
2207 int i;
2208
2209 if (get_viminfo_parameter('c') != 0)
2210 {
2211 p = vim_strchr(virp->vir_line, '=');
2212 if (p != NULL)
2213 {
2214 /* remove trailing newline */
2215 ++p;
2216 for (i = 0; vim_isprintc(p[i]); ++i)
2217 ;
2218 p[i] = NUL;
2219
2220 convert_setup(&virp->vir_conv, p, p_enc);
2221 }
2222 }
2223#endif
2224 return viminfo_readline(virp);
2225}
2226
2227/*
2228 * Read a line from the viminfo file.
2229 * Returns TRUE for end-of-file;
2230 */
2231 int
2232viminfo_readline(virp)
2233 vir_T *virp;
2234{
2235 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2236}
2237
2238/*
2239 * check string read from viminfo file
2240 * remove '\n' at the end of the line
2241 * - replace CTRL-V CTRL-V with CTRL-V
2242 * - replace CTRL-V 'n' with '\n'
2243 *
2244 * Check for a long line as written by viminfo_writestring().
2245 *
2246 * Return the string in allocated memory (NULL when out of memory).
2247 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 char_u *
2249viminfo_readstring(virp, off, convert)
2250 vir_T *virp;
2251 int off; /* offset for virp->vir_line */
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00002252 int convert UNUSED; /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253{
2254 char_u *retval;
2255 char_u *s, *d;
2256 long len;
2257
2258 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2259 {
2260 len = atol((char *)virp->vir_line + off + 1);
2261 retval = lalloc(len, TRUE);
2262 if (retval == NULL)
2263 {
2264 /* Line too long? File messed up? Skip next line. */
2265 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2266 return NULL;
2267 }
2268 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2269 s = retval + 1; /* Skip the leading '<' */
2270 }
2271 else
2272 {
2273 retval = vim_strsave(virp->vir_line + off);
2274 if (retval == NULL)
2275 return NULL;
2276 s = retval;
2277 }
2278
2279 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2280 d = retval;
2281 while (*s != NUL && *s != '\n')
2282 {
2283 if (s[0] == Ctrl_V && s[1] != NUL)
2284 {
2285 if (s[1] == 'n')
2286 *d++ = '\n';
2287 else
2288 *d++ = Ctrl_V;
2289 s += 2;
2290 }
2291 else
2292 *d++ = *s++;
2293 }
2294 *d = NUL;
2295
2296#ifdef FEAT_MBYTE
2297 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2298 {
2299 d = string_convert(&virp->vir_conv, retval, NULL);
2300 if (d != NULL)
2301 {
2302 vim_free(retval);
2303 retval = d;
2304 }
2305 }
2306#endif
2307
2308 return retval;
2309}
2310
2311/*
2312 * write string to viminfo file
2313 * - replace CTRL-V with CTRL-V CTRL-V
2314 * - replace '\n' with CTRL-V 'n'
2315 * - add a '\n' at the end
2316 *
2317 * For a long line:
2318 * - write " CTRL-V <length> \n " in first line
2319 * - write " < <string> \n " in second line
2320 */
2321 void
2322viminfo_writestring(fd, p)
2323 FILE *fd;
2324 char_u *p;
2325{
2326 int c;
2327 char_u *s;
2328 int len = 0;
2329
2330 for (s = p; *s != NUL; ++s)
2331 {
2332 if (*s == Ctrl_V || *s == '\n')
2333 ++len;
2334 ++len;
2335 }
2336
2337 /* If the string will be too long, write its length and put it in the next
2338 * line. Take into account that some room is needed for what comes before
2339 * the string (e.g., variable name). Add something to the length for the
2340 * '<', NL and trailing NUL. */
2341 if (len > LSIZE / 2)
2342 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2343
2344 while ((c = *p++) != NUL)
2345 {
2346 if (c == Ctrl_V || c == '\n')
2347 {
2348 putc(Ctrl_V, fd);
2349 if (c == '\n')
2350 c = 'n';
2351 }
2352 putc(c, fd);
2353 }
2354 putc('\n', fd);
2355}
2356#endif /* FEAT_VIMINFO */
2357
2358/*
2359 * Implementation of ":fixdel", also used by get_stty().
2360 * <BS> resulting <Del>
2361 * ^? ^H
2362 * not ^? ^?
2363 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 void
2365do_fixdel(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00002366 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367{
2368 char_u *p;
2369
2370 p = find_termcode((char_u *)"kb");
2371 add_termcode((char_u *)"kD", p != NULL
2372 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2373}
2374
2375 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002376print_line_no_prefix(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 linenr_T lnum;
2378 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002379 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002381 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382
2383 if (curwin->w_p_nu || use_number)
2384 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002385 vim_snprintf((char *)numbuf, sizeof(numbuf),
2386 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2388 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002389 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390}
2391
2392/*
2393 * Print a text line. Also in silent mode ("ex -s").
2394 */
2395 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002396print_line(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 linenr_T lnum;
2398 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002399 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400{
2401 int save_silent = silent_mode;
2402
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002404 silent_mode = FALSE;
2405 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2406 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 if (save_silent)
2408 {
2409 msg_putchar('\n');
2410 cursor_on(); /* msg_start() switches it off */
2411 out_flush();
2412 silent_mode = save_silent;
2413 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002414 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415}
2416
2417/*
2418 * ":file[!] [fname]".
2419 */
2420 void
2421ex_file(eap)
2422 exarg_T *eap;
2423{
2424 char_u *fname, *sfname, *xfname;
2425 buf_T *buf;
2426
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002427 /* ":0file" removes the file name. Check for illegal uses ":3file",
2428 * "0file name", etc. */
2429 if (eap->addr_count > 0
2430 && (*eap->arg != NUL
2431 || eap->line2 > 0
2432 || eap->addr_count > 1))
2433 {
2434 EMSG(_(e_invarg));
2435 return;
2436 }
2437
2438 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 {
2440#ifdef FEAT_AUTOCMD
2441 buf = curbuf;
2442 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2443 /* buffer changed, don't change name now */
2444 if (buf != curbuf)
2445 return;
2446# ifdef FEAT_EVAL
2447 if (aborting()) /* autocmds may abort script processing */
2448 return;
2449# endif
2450#endif
2451 /*
2452 * The name of the current buffer will be changed.
2453 * A new (unlisted) buffer entry needs to be made to hold the old file
2454 * name, which will become the alternate file name.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002455 * But don't set the alternate file name if the buffer didn't have a
2456 * name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 */
2458 fname = curbuf->b_ffname;
2459 sfname = curbuf->b_sfname;
2460 xfname = curbuf->b_fname;
2461 curbuf->b_ffname = NULL;
2462 curbuf->b_sfname = NULL;
2463 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2464 {
2465 curbuf->b_ffname = fname;
2466 curbuf->b_sfname = sfname;
2467 return;
2468 }
2469 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002470 if (xfname != NULL && *xfname != NUL)
2471 {
2472 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2473 if (buf != NULL && !cmdmod.keepalt)
2474 curwin->w_alt_fnum = buf->b_fnum;
2475 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 vim_free(fname);
2477 vim_free(sfname);
2478#ifdef FEAT_AUTOCMD
2479 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2480#endif
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002481 /* Change directories when the 'acd' option is set. */
2482 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 }
2484 /* print full file name if :cd used */
2485 fileinfo(FALSE, FALSE, eap->forceit);
2486}
2487
2488/*
2489 * ":update".
2490 */
2491 void
2492ex_update(eap)
2493 exarg_T *eap;
2494{
2495 if (curbufIsChanged())
2496 (void)do_write(eap);
2497}
2498
2499/*
2500 * ":write" and ":saveas".
2501 */
2502 void
2503ex_write(eap)
2504 exarg_T *eap;
2505{
2506 if (eap->usefilter) /* input lines to shell command */
2507 do_bang(1, eap, FALSE, TRUE, FALSE);
2508 else
2509 (void)do_write(eap);
2510}
2511
2512/*
2513 * write current buffer to file 'eap->arg'
2514 * if 'eap->append' is TRUE, append to the file
2515 *
2516 * if *eap->arg == NUL write to current file
2517 *
2518 * return FAIL for failure, OK otherwise
2519 */
2520 int
2521do_write(eap)
2522 exarg_T *eap;
2523{
2524 int other;
2525 char_u *fname = NULL; /* init to shut up gcc */
2526 char_u *ffname;
2527 int retval = FAIL;
2528 char_u *free_fname = NULL;
2529#ifdef FEAT_BROWSE
2530 char_u *browse_file = NULL;
2531#endif
2532 buf_T *alt_buf = NULL;
2533
2534 if (not_writing()) /* check 'write' option */
2535 return FAIL;
2536
2537 ffname = eap->arg;
2538#ifdef FEAT_BROWSE
2539 if (cmdmod.browse)
2540 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002541 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 NULL, NULL, NULL, curbuf);
2543 if (browse_file == NULL)
2544 goto theend;
2545 ffname = browse_file;
2546 }
2547#endif
2548 if (*ffname == NUL)
2549 {
2550 if (eap->cmdidx == CMD_saveas)
2551 {
2552 EMSG(_(e_argreq));
2553 goto theend;
2554 }
2555 other = FALSE;
2556 }
2557 else
2558 {
2559 fname = ffname;
2560 free_fname = fix_fname(ffname);
2561 /*
2562 * When out-of-memory, keep unexpanded file name, because we MUST be
2563 * able to write the file in this situation.
2564 */
2565 if (free_fname != NULL)
2566 ffname = free_fname;
2567 other = otherfile(ffname);
2568 }
2569
2570 /*
2571 * If we have a new file, put its name in the list of alternate file names.
2572 */
2573 if (other)
2574 {
2575 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2576 || eap->cmdidx == CMD_saveas)
2577 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2578 else
2579 alt_buf = buflist_findname(ffname);
2580 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2581 {
2582 /* Overwriting a file that is loaded in another buffer is not a
2583 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00002584 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 goto theend;
2586 }
2587 }
2588
2589 /*
2590 * Writing to the current file is not allowed in readonly mode
2591 * and a file name is required.
2592 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2593 */
2594 if (!other && (
2595#ifdef FEAT_QUICKFIX
2596 bt_dontwrite_msg(curbuf) ||
2597#endif
2598 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2599 goto theend;
2600
2601 if (!other)
2602 {
2603 ffname = curbuf->b_ffname;
2604 fname = curbuf->b_fname;
2605 /*
2606 * Not writing the whole file is only allowed with '!'.
2607 */
2608 if ( (eap->line1 != 1
2609 || eap->line2 != curbuf->b_ml.ml_line_count)
2610 && !eap->forceit
2611 && !eap->append
2612 && !p_wa)
2613 {
2614#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2615 if (p_confirm || cmdmod.confirm)
2616 {
2617 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2618 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2619 goto theend;
2620 eap->forceit = TRUE;
2621 }
2622 else
2623#endif
2624 {
2625 EMSG(_("E140: Use ! to write partial buffer"));
2626 goto theend;
2627 }
2628 }
2629 }
2630
2631 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2632 {
2633 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2634 {
2635#ifdef FEAT_AUTOCMD
2636 buf_T *was_curbuf = curbuf;
2637
2638 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002639 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640# ifdef FEAT_EVAL
2641 if (curbuf != was_curbuf || aborting())
2642# else
2643 if (curbuf != was_curbuf)
2644# endif
2645 {
2646 /* buffer changed, don't change name now */
2647 retval = FAIL;
2648 goto theend;
2649 }
2650#endif
2651 /* Exchange the file names for the current and the alternate
2652 * buffer. This makes it look like we are now editing the buffer
2653 * under the new name. Must be done before buf_write(), because
2654 * if there is no file name and 'cpo' contains 'F', it will set
2655 * the file name. */
2656 fname = alt_buf->b_fname;
2657 alt_buf->b_fname = curbuf->b_fname;
2658 curbuf->b_fname = fname;
2659 fname = alt_buf->b_ffname;
2660 alt_buf->b_ffname = curbuf->b_ffname;
2661 curbuf->b_ffname = fname;
2662 fname = alt_buf->b_sfname;
2663 alt_buf->b_sfname = curbuf->b_sfname;
2664 curbuf->b_sfname = fname;
2665 buf_name_changed(curbuf);
2666#ifdef FEAT_AUTOCMD
2667 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002668 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 if (!alt_buf->b_p_bl)
2670 {
2671 alt_buf->b_p_bl = TRUE;
2672 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2673 }
2674# ifdef FEAT_EVAL
2675 if (curbuf != was_curbuf || aborting())
2676# else
2677 if (curbuf != was_curbuf)
2678# endif
2679 {
2680 /* buffer changed, don't write the file */
2681 retval = FAIL;
2682 goto theend;
2683 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002684
2685 /* If 'filetype' was empty try detecting it now. */
2686 if (*curbuf->b_p_ft == NUL)
2687 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002688 if (au_has_group((char_u *)"filetypedetect"))
2689 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2690 TRUE);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002691 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002692 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002693
2694 /* Autocommands may have changed buffer names, esp. when
2695 * 'autochdir' is set. */
2696 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697#endif
2698 }
2699
2700 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2701 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002702
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002703 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002704 if (eap->cmdidx == CMD_saveas)
2705 {
2706 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002707 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002708 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002709#ifdef FEAT_WINDOWS
2710 redraw_tabline = TRUE;
2711#endif
2712 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002713 /* Change directories when the 'acd' option is set. */
2714 DO_AUTOCHDIR
2715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 }
2717
2718theend:
2719#ifdef FEAT_BROWSE
2720 vim_free(browse_file);
2721#endif
2722 vim_free(free_fname);
2723 return retval;
2724}
2725
2726/*
2727 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2728 * BF_NEW or BF_READERR, check for overwriting current file.
2729 * May set eap->forceit if a dialog says it's OK to overwrite.
2730 * Return OK if it's OK, FAIL if it is not.
2731 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002732 int
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733check_overwrite(eap, buf, fname, ffname, other)
2734 exarg_T *eap;
2735 buf_T *buf;
2736 char_u *fname; /* file name to be used (can differ from
2737 buf->ffname) */
2738 char_u *ffname; /* full path version of fname */
2739 int other; /* writing under other name */
2740{
2741 /*
2742 * write to other file or b_flags set or not writing the whole file:
2743 * overwriting only allowed with '!'
2744 */
2745 if ( (other
2746 || (buf->b_flags & BF_NOTEDITED)
2747 || ((buf->b_flags & BF_NEW)
2748 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2749 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002751#ifdef FEAT_QUICKFIX
2752 && !bt_nofile(buf)
2753#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 && vim_fexists(ffname))
2755 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002756 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002758#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002759 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002760 if (mch_isdir(ffname))
2761 {
2762 EMSG2(_(e_isadir2), ffname);
2763 return FAIL;
2764 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765#endif
2766#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002767 if (p_confirm || cmdmod.confirm)
2768 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002769 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002771 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2772 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2773 return FAIL;
2774 eap->forceit = TRUE;
2775 }
2776 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002778 {
2779 EMSG(_(e_exists));
2780 return FAIL;
2781 }
2782 }
2783
2784 /* For ":w! filename" check that no swap file exists for "filename". */
2785 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002787 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002788 char_u *p;
2789 int r;
2790 char_u *swapname;
2791
2792 /* We only try the first entry in 'directory', without checking if
2793 * it's writable. If the "." directory is not writable the write
2794 * will probably fail anyway.
2795 * Use 'shortname' of the current buffer, since there is no buffer
2796 * for the written file. */
2797 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002798 {
2799 dir = alloc(5);
2800 if (dir == NULL)
2801 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002802 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002803 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002804 else
2805 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002806 dir = alloc(MAXPATHL);
2807 if (dir == NULL)
2808 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002809 p = p_dir;
2810 copy_option_part(&p, dir, MAXPATHL, ",");
2811 }
2812 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002813 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002814 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002815 if (r)
2816 {
2817#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2818 if (p_confirm || cmdmod.confirm)
2819 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002820 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002821
2822 dialog_msg(buff,
2823 _("Swap file \"%s\" exists, overwrite anyway?"),
2824 swapname);
2825 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2826 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002827 {
2828 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002829 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002830 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002831 eap->forceit = TRUE;
2832 }
2833 else
2834#endif
2835 {
2836 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2837 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002838 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002839 return FAIL;
2840 }
2841 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002842 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 }
2844 }
2845 return OK;
2846}
2847
2848/*
2849 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2850 */
2851 void
2852ex_wnext(eap)
2853 exarg_T *eap;
2854{
2855 int i;
2856
2857 if (eap->cmd[1] == 'n')
2858 i = curwin->w_arg_idx + (int)eap->line2;
2859 else
2860 i = curwin->w_arg_idx - (int)eap->line2;
2861 eap->line1 = 1;
2862 eap->line2 = curbuf->b_ml.ml_line_count;
2863 if (do_write(eap) != FAIL)
2864 do_argfile(eap, i);
2865}
2866
2867/*
2868 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2869 */
2870 void
2871do_wqall(eap)
2872 exarg_T *eap;
2873{
2874 buf_T *buf;
2875 int error = 0;
2876 int save_forceit = eap->forceit;
2877
2878 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2879 exiting = TRUE;
2880
2881 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2882 {
2883 if (bufIsChanged(buf))
2884 {
2885 /*
2886 * Check if there is a reason the buffer cannot be written:
2887 * 1. if the 'write' option is set
2888 * 2. if there is no file name (even after browsing)
2889 * 3. if the 'readonly' is set (even after a dialog)
2890 * 4. if overwriting is allowed (even after a dialog)
2891 */
2892 if (not_writing())
2893 {
2894 ++error;
2895 break;
2896 }
2897#ifdef FEAT_BROWSE
2898 /* ":browse wall": ask for file name if there isn't one */
2899 if (buf->b_ffname == NULL && cmdmod.browse)
2900 browse_save_fname(buf);
2901#endif
2902 if (buf->b_ffname == NULL)
2903 {
2904 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2905 ++error;
2906 }
2907 else if (check_readonly(&eap->forceit, buf)
2908 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2909 FALSE) == FAIL)
2910 {
2911 ++error;
2912 }
2913 else
2914 {
2915 if (buf_write_all(buf, eap->forceit) == FAIL)
2916 ++error;
2917#ifdef FEAT_AUTOCMD
2918 /* an autocommand may have deleted the buffer */
2919 if (!buf_valid(buf))
2920 buf = firstbuf;
2921#endif
2922 }
2923 eap->forceit = save_forceit; /* check_overwrite() may set it */
2924 }
2925 }
2926 if (exiting)
2927 {
2928 if (!error)
2929 getout(0); /* exit Vim */
2930 not_exiting();
2931 }
2932}
2933
2934/*
2935 * Check the 'write' option.
2936 * Return TRUE and give a message when it's not st.
2937 */
2938 int
2939not_writing()
2940{
2941 if (p_write)
2942 return FALSE;
2943 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2944 return TRUE;
2945}
2946
2947/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002948 * Check if a buffer is read-only (either 'readonly' option is set or file is
2949 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2950 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 */
2952 static int
2953check_readonly(forceit, buf)
2954 int *forceit;
2955 buf_T *buf;
2956{
Bram Moolenaar5386a122007-06-28 20:02:32 +00002957 struct stat st;
2958
2959 /* Handle a file being readonly when the 'readonly' option is set or when
2960 * the file exists and permissions are read-only.
2961 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2962 * important for device checks but not here. */
2963 if (!*forceit && (buf->b_p_ro
2964 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2965 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 {
2967#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2968 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2969 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002970 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971
Bram Moolenaar5386a122007-06-28 20:02:32 +00002972 if (buf->b_p_ro)
2973 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2974 buf->b_fname);
2975 else
2976 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 +00002977 buf->b_fname);
2978
2979 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2980 {
2981 /* Set forceit, to force the writing of a readonly file */
2982 *forceit = TRUE;
2983 return FALSE;
2984 }
2985 else
2986 return TRUE;
2987 }
2988 else
2989#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002990 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002992 else
2993 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2994 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 return TRUE;
2996 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002997
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 return FALSE;
2999}
3000
3001/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003002 * Try to abandon current file and edit a new or existing file.
3003 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003005 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003006 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3008 */
3009 int
3010getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3011 int fnum;
3012 char_u *ffname;
3013 char_u *sfname;
3014 int setpm;
3015 linenr_T lnum;
3016 int forceit;
3017{
3018 int other;
3019 int retval;
3020 char_u *free_me = NULL;
3021
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003022 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003024#ifdef FEAT_AUTOCMD
3025 if (curbuf_locked())
3026 return 1;
3027#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028
3029 if (fnum == 0)
3030 {
3031 /* make ffname full path, set sfname */
3032 fname_expand(curbuf, &ffname, &sfname);
3033 other = otherfile(ffname);
3034 free_me = ffname; /* has been allocated, free() later */
3035 }
3036 else
3037 other = (fnum != curbuf->b_fnum);
3038
3039 if (other)
3040 ++no_wait_return; /* don't wait for autowrite message */
3041 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3042 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3043 {
3044#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3045 if (p_confirm && p_write)
3046 dialog_changed(curbuf, FALSE);
3047 if (curbufIsChanged())
3048#endif
3049 {
3050 if (other)
3051 --no_wait_return;
3052 EMSG(_(e_nowrtmsg));
3053 retval = 2; /* file has been changed */
3054 goto theend;
3055 }
3056 }
3057 if (other)
3058 --no_wait_return;
3059 if (setpm)
3060 setpcmark();
3061 if (!other)
3062 {
3063 if (lnum != 0)
3064 curwin->w_cursor.lnum = lnum;
3065 check_cursor_lnum();
3066 beginline(BL_SOL | BL_FIX);
3067 retval = 0; /* it's in the same file */
3068 }
3069 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003070 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3071 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 retval = -1; /* opened another file */
3073 else
3074 retval = 1; /* error encountered */
3075
3076theend:
3077 vim_free(free_me);
3078 return retval;
3079}
3080
3081/*
3082 * start editing a new file
3083 *
3084 * fnum: file number; if zero use ffname/sfname
3085 * ffname: the file name
3086 * - full path if sfname used,
3087 * - any file name if sfname is NULL
3088 * - empty string to re-edit with the same file name (but may be
3089 * in a different directory)
3090 * - NULL to start an empty buffer
3091 * sfname: the short file name (or NULL)
3092 * eap: contains the command to be executed after loading the file and
3093 * forced 'ff' and 'fenc'
3094 * newlnum: if > 0: put cursor on this line number (if possible)
3095 * if ECMD_LASTL: use last position in loaded file
3096 * if ECMD_LAST: use last position in all files
3097 * if ECMD_ONE: use first line
3098 * flags:
3099 * ECMD_HIDE: if TRUE don't free the current buffer
3100 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3101 * ECMD_OLDBUF: use existing buffer if it exists
3102 * ECMD_FORCEIT: ! used for Ex command
3103 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003104 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003105 * window, NULL when splitting the window first. When not NULL info
3106 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 *
3108 * return FAIL for failure, OK otherwise
3109 */
3110 int
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003111do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 int fnum;
3113 char_u *ffname;
3114 char_u *sfname;
3115 exarg_T *eap; /* can be NULL! */
3116 linenr_T newlnum;
3117 int flags;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003118 win_T *oldwin;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119{
3120 int other_file; /* TRUE if editing another file */
3121 int oldbuf; /* TRUE if using existing buffer */
3122#ifdef FEAT_AUTOCMD
3123 int auto_buf = FALSE; /* TRUE if autocommands brought us
3124 into the buffer unexpectedly */
3125 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003126 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127#endif
3128 buf_T *buf;
3129#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3130 buf_T *old_curbuf = curbuf;
3131#endif
3132 char_u *free_fname = NULL;
3133#ifdef FEAT_BROWSE
3134 char_u *browse_file = NULL;
3135#endif
3136 int retval = FAIL;
3137 long n;
3138 linenr_T lnum;
3139 linenr_T topline = 0;
3140 int newcol = -1;
3141 int solcol = -1;
3142 pos_T *pos;
3143#ifdef FEAT_SUN_WORKSHOP
3144 char_u *cp;
3145#endif
3146 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003147#ifdef FEAT_SPELL
3148 int did_get_winopts = FALSE;
3149#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003150 int readfile_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151
3152 if (eap != NULL)
3153 command = eap->do_ecmd_cmd;
3154
3155 if (fnum != 0)
3156 {
3157 if (fnum == curbuf->b_fnum) /* file is already being edited */
3158 return OK; /* nothing to do */
3159 other_file = TRUE;
3160 }
3161 else
3162 {
3163#ifdef FEAT_BROWSE
3164 if (cmdmod.browse)
3165 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003166# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003167 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003168# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003169 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003170# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003171 au_has_group((char_u *)"FileExplorer"))
3172 {
3173 /* No browsing supported but we do have the file explorer:
3174 * Edit the directory. */
3175 if (ffname == NULL || !mch_isdir(ffname))
3176 ffname = (char_u *)".";
3177 }
3178 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003179# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003180 {
3181 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003183 if (browse_file == NULL)
3184 goto theend;
3185 ffname = browse_file;
3186 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 }
3188#endif
3189 /* if no short name given, use ffname for short name */
3190 if (sfname == NULL)
3191 sfname = ffname;
3192#ifdef USE_FNAME_CASE
3193# ifdef USE_LONG_FNAME
3194 if (USE_LONG_FNAME)
3195# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003196 if (sfname != NULL)
3197 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198#endif
3199
3200#ifdef FEAT_LISTCMDS
3201 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3202 goto theend;
3203#endif
3204
3205 if (ffname == NULL)
3206 other_file = TRUE;
3207 /* there is no file name */
3208 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3209 other_file = FALSE;
3210 else
3211 {
3212 if (*ffname == NUL) /* re-edit with same file name */
3213 {
3214 ffname = curbuf->b_ffname;
3215 sfname = curbuf->b_fname;
3216 }
3217 free_fname = fix_fname(ffname); /* may expand to full path name */
3218 if (free_fname != NULL)
3219 ffname = free_fname;
3220 other_file = otherfile(ffname);
3221#ifdef FEAT_SUN_WORKSHOP
3222 if (usingSunWorkShop && p_acd
3223 && (cp = vim_strrchr(sfname, '/')) != NULL)
3224 sfname = ++cp;
3225#endif
3226 }
3227 }
3228
3229 /*
3230 * if the file was changed we may not be allowed to abandon it
3231 * - if we are going to re-edit the same file
3232 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3233 */
3234 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3235 || (curbuf->b_nwindows == 1
3236 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3237 && check_changed(curbuf, p_awa, !other_file,
3238 (flags & ECMD_FORCEIT), FALSE))
3239 {
3240 if (fnum == 0 && other_file && ffname != NULL)
3241 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3242 goto theend;
3243 }
3244
3245#ifdef FEAT_VISUAL
3246 /*
3247 * End Visual mode before switching to another buffer, so the text can be
3248 * copied into the GUI selection buffer.
3249 */
3250 reset_VIsual();
3251#endif
3252
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003253#ifdef FEAT_AUTOCMD
3254 if ((command != NULL || newlnum > (linenr_T)0)
3255 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3256 {
3257 int len;
3258 char_u *p;
3259
3260 /* Set v:swapcommand for the SwapExists autocommands. */
3261 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003262 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003263 else
3264 len = 30;
3265 p = alloc((unsigned)len);
3266 if (p != NULL)
3267 {
3268 if (command != NULL)
3269 vim_snprintf((char *)p, len, ":%s\r", command);
3270 else
3271 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3272 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3273 did_set_swapcommand = TRUE;
3274 vim_free(p);
3275 }
3276 }
3277#endif
3278
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 /*
3280 * If we are starting to edit another file, open a (new) buffer.
3281 * Otherwise we re-use the current buffer.
3282 */
3283 if (other_file)
3284 {
3285#ifdef FEAT_LISTCMDS
3286 if (!(flags & ECMD_ADDBUF))
3287#endif
3288 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003289 if (!cmdmod.keepalt)
3290 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003291 if (oldwin != NULL)
3292 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 }
3294
3295 if (fnum)
3296 buf = buflist_findnr(fnum);
3297 else
3298 {
3299#ifdef FEAT_LISTCMDS
3300 if (flags & ECMD_ADDBUF)
3301 {
3302 linenr_T tlnum = 1L;
3303
3304 if (command != NULL)
3305 {
3306 tlnum = atol((char *)command);
3307 if (tlnum <= 0)
3308 tlnum = 1L;
3309 }
3310 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3311 goto theend;
3312 }
3313#endif
3314 buf = buflist_new(ffname, sfname, 0L,
3315 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3316 }
3317 if (buf == NULL)
3318 goto theend;
3319 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3320 {
3321 oldbuf = FALSE;
3322 buf->b_nwindows = 0;
3323 }
3324 else /* existing memfile */
3325 {
3326 oldbuf = TRUE;
3327 (void)buf_check_timestamp(buf, FALSE);
3328 /* Check if autocommands made buffer invalid or changed the current
3329 * buffer. */
3330 if (!buf_valid(buf)
3331#ifdef FEAT_AUTOCMD
3332 || curbuf != old_curbuf
3333#endif
3334 )
3335 goto theend;
3336#ifdef FEAT_EVAL
3337 if (aborting()) /* autocmds may abort script processing */
3338 goto theend;
3339#endif
3340 }
3341
3342 /* May jump to last used line number for a loaded buffer or when asked
3343 * for explicitly */
3344 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3345 {
3346 pos = buflist_findfpos(buf);
3347 newlnum = pos->lnum;
3348 solcol = pos->col;
3349 }
3350
3351 /*
3352 * Make the (new) buffer the one used by the current window.
3353 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3354 * If the current buffer was empty and has no file name, curbuf
3355 * is returned by buflist_new().
3356 */
3357 if (buf != curbuf)
3358 {
3359#ifdef FEAT_AUTOCMD
3360 /*
3361 * Be careful: The autocommands may delete any buffer and change
3362 * the current buffer.
3363 * - If the buffer we are going to edit is deleted, give up.
3364 * - If the current buffer is deleted, prefer to load the new
3365 * buffer when loading a buffer is required. This avoids
3366 * loading another buffer which then must be closed again.
3367 * - If we ended up in the new buffer already, need to skip a few
3368 * things, set auto_buf.
3369 */
3370 if (buf->b_fname != NULL)
3371 new_name = vim_strsave(buf->b_fname);
3372 au_new_curbuf = buf;
3373 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3374 if (!buf_valid(buf)) /* new buffer has been deleted */
3375 {
3376 delbuf_msg(new_name); /* frees new_name */
3377 goto theend;
3378 }
3379# ifdef FEAT_EVAL
3380 if (aborting()) /* autocmds may abort script processing */
3381 {
3382 vim_free(new_name);
3383 goto theend;
3384 }
3385# endif
3386 if (buf == curbuf) /* already in new buffer */
3387 auto_buf = TRUE;
3388 else
3389 {
3390 if (curbuf == old_curbuf)
3391#endif
3392 buf_copy_options(buf, BCO_ENTER);
3393
3394 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003395 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003396 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003397 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398
3399#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003400 /* Autocommands may open a new window and leave oldwin open
3401 * which leads to crashes since the above call sets
3402 * oldwin->w_buffer to NULL. */
3403 if (curwin != oldwin && oldwin != aucmd_win
3404 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3405 win_close(oldwin, FALSE);
3406
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407# ifdef FEAT_EVAL
3408 if (aborting()) /* autocmds may abort script processing */
3409 {
3410 vim_free(new_name);
3411 goto theend;
3412 }
3413# endif
3414 /* Be careful again, like above. */
3415 if (!buf_valid(buf)) /* new buffer has been deleted */
3416 {
3417 delbuf_msg(new_name); /* frees new_name */
3418 goto theend;
3419 }
3420 if (buf == curbuf) /* already in new buffer */
3421 auto_buf = TRUE;
3422 else
3423#endif
3424 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003425#ifdef FEAT_SYN_HL
3426 /*
3427 * <VN> We could instead free the synblock
3428 * and re-attach to buffer, perhaps.
3429 */
3430 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003431 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003432#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 curwin->w_buffer = buf;
3434 curbuf = buf;
3435 ++curbuf->b_nwindows;
3436 /* set 'fileformat' */
3437 if (*p_ffs && !oldbuf)
3438 set_fileformat(default_fileformat(), OPT_LOCAL);
3439 }
3440
3441 /* May get the window options from the last time this buffer
3442 * was in this window (or another window). If not used
3443 * before, reset the local window options to the global
3444 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003445 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003446#ifdef FEAT_SPELL
3447 did_get_winopts = TRUE;
3448#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449
3450#ifdef FEAT_AUTOCMD
3451 }
3452 vim_free(new_name);
3453 au_new_curbuf = NULL;
3454#endif
3455 }
3456 else
3457 ++curbuf->b_nwindows;
3458
3459 curwin->w_pcmark.lnum = 1;
3460 curwin->w_pcmark.col = 0;
3461 }
3462 else /* !other_file */
3463 {
3464 if (
3465#ifdef FEAT_LISTCMDS
3466 (flags & ECMD_ADDBUF) ||
3467#endif
3468 check_fname() == FAIL)
3469 goto theend;
3470 oldbuf = (flags & ECMD_OLDBUF);
3471 }
3472
3473 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3474 {
3475 char_u *p;
3476
3477 curbuf->b_help = TRUE;
3478#ifdef FEAT_QUICKFIX
3479 set_string_option_direct((char_u *)"buftype", -1,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003480 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481#endif
3482
3483 /*
3484 * Always set these options after jumping to a help tag, because the
3485 * user may have an autocommand that gets in the way.
3486 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3487 * latin1 word characters (for translated help files).
3488 * Only set it when needed, buf_init_chartab() is some work.
3489 */
3490 p =
3491#ifdef EBCDIC
3492 (char_u *)"65-255,^*,^|,^\"";
3493#else
3494 (char_u *)"!-~,^*,^|,^\",192-255";
3495#endif
3496 if (STRCMP(curbuf->b_p_isk, p) != 0)
3497 {
3498 set_string_option_direct((char_u *)"isk", -1, p,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003499 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 check_buf_options(curbuf);
3501 (void)buf_init_chartab(curbuf, FALSE);
3502 }
3503
3504 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3505 curwin->w_p_list = FALSE; /* no list mode */
3506
3507 curbuf->b_p_ma = FALSE; /* not modifiable */
3508 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3509 curwin->w_p_nu = 0; /* no line numbers */
Bram Moolenaar64486672010-05-16 15:46:46 +02003510 curwin->w_p_rnu = 0; /* no relative line numbers */
Bram Moolenaar3368ea22010-09-21 16:56:35 +02003511 RESET_BINDING(curwin); /* no scroll or cursor binding */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512#ifdef FEAT_ARABIC
3513 curwin->w_p_arab = FALSE; /* no arabic mode */
3514#endif
3515#ifdef FEAT_RIGHTLEFT
3516 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3517#endif
3518#ifdef FEAT_FOLDING
3519 curwin->w_p_fen = FALSE; /* No folding in the help window */
3520#endif
3521#ifdef FEAT_DIFF
3522 curwin->w_p_diff = FALSE; /* No 'diff' */
3523#endif
Bram Moolenaara1956f62006-03-12 22:18:00 +00003524#ifdef FEAT_SPELL
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00003525 curwin->w_p_spell = FALSE; /* No spell checking */
3526#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527
3528#ifdef FEAT_AUTOCMD
3529 buf = curbuf;
3530#endif
3531 set_buflisted(FALSE);
3532 }
3533 else
3534 {
3535#ifdef FEAT_AUTOCMD
3536 buf = curbuf;
3537#endif
3538 /* Don't make a buffer listed if it's a help buffer. Useful when
3539 * using CTRL-O to go back to a help file. */
3540 if (!curbuf->b_help)
3541 set_buflisted(TRUE);
3542 }
3543
3544#ifdef FEAT_AUTOCMD
3545 /* If autocommands change buffers under our fingers, forget about
3546 * editing the file. */
3547 if (buf != curbuf)
3548 goto theend;
3549# ifdef FEAT_EVAL
3550 if (aborting()) /* autocmds may abort script processing */
3551 goto theend;
3552# endif
3553
3554 /* Since we are starting to edit a file, consider the filetype to be
3555 * unset. Helps for when an autocommand changes files and expects syntax
3556 * highlighting to work in the other file. */
3557 did_filetype = FALSE;
3558#endif
3559
3560/*
3561 * other_file oldbuf
3562 * FALSE FALSE re-edit same file, buffer is re-used
3563 * FALSE TRUE re-edit same file, nothing changes
3564 * TRUE FALSE start editing new file, new buffer
3565 * TRUE TRUE start editing in existing buffer (nothing to do)
3566 */
3567 if (!other_file && !oldbuf) /* re-use the buffer */
3568 {
3569 set_last_cursor(curwin); /* may set b_last_cursor */
3570 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3571 {
3572 newlnum = curwin->w_cursor.lnum;
3573 solcol = curwin->w_cursor.col;
3574 }
3575#ifdef FEAT_AUTOCMD
3576 buf = curbuf;
3577 if (buf->b_fname != NULL)
3578 new_name = vim_strsave(buf->b_fname);
3579 else
3580 new_name = NULL;
3581#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003582 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
3583 {
3584 /* Save all the text, so that the reload can be undone.
3585 * Sync first so that this is a separate undo-able action. */
3586 u_sync(FALSE);
3587 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
3588 == FAIL)
3589 goto theend;
3590 u_unchanged(curbuf);
3591 buf_freeall(curbuf, BFA_KEEP_UNDO);
3592
3593 /* tell readfile() not to clear or reload undo info */
3594 readfile_flags = READ_KEEP_UNDO;
3595 }
3596 else
3597 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598#ifdef FEAT_AUTOCMD
3599 /* If autocommands deleted the buffer we were going to re-edit, give
3600 * up and jump to the end. */
3601 if (!buf_valid(buf))
3602 {
3603 delbuf_msg(new_name); /* frees new_name */
3604 goto theend;
3605 }
3606 vim_free(new_name);
3607
3608 /* If autocommands change buffers under our fingers, forget about
3609 * re-editing the file. Should do the buf_clear_file(), but perhaps
3610 * the autocommands changed the buffer... */
3611 if (buf != curbuf)
3612 goto theend;
3613# ifdef FEAT_EVAL
3614 if (aborting()) /* autocmds may abort script processing */
3615 goto theend;
3616# endif
3617#endif
3618 buf_clear_file(curbuf);
3619 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3620 curbuf->b_op_end.lnum = 0;
3621 }
3622
3623/*
3624 * If we get here we are sure to start editing
3625 */
3626 /* don't redraw until the cursor is in the right line */
3627 ++RedrawingDisabled;
3628
3629 /* Assume success now */
3630 retval = OK;
3631
3632 /*
3633 * Reset cursor position, could be used by autocommands.
3634 */
3635 check_cursor();
3636
3637 /*
3638 * Check if we are editing the w_arg_idx file in the argument list.
3639 */
3640 check_arg_idx(curwin);
3641
3642#ifdef FEAT_AUTOCMD
3643 if (!auto_buf)
3644#endif
3645 {
3646 /*
3647 * Set cursor and init window before reading the file and executing
3648 * autocommands. This allows for the autocommands to position the
3649 * cursor.
3650 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003651 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652
3653#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003654 /* It's possible that all lines in the buffer changed. Need to update
3655 * automatic folding for all windows where it's used. */
3656# ifdef FEAT_WINDOWS
3657 {
3658 win_T *win;
3659 tabpage_T *tp;
3660
3661 FOR_ALL_TAB_WINDOWS(tp, win)
3662 if (win->w_buffer == curbuf)
3663 foldUpdateAll(win);
3664 }
3665# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003667# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668#endif
3669
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003670 /* Change directories when the 'acd' option is set. */
3671 DO_AUTOCHDIR
3672
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 /*
3674 * Careful: open_buffer() and apply_autocmds() may change the current
3675 * buffer and window.
3676 */
3677 lnum = curwin->w_cursor.lnum;
3678 topline = curwin->w_topline;
3679 if (!oldbuf) /* need to read the file */
3680 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003681#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 swap_exists_action = SEA_DIALOG;
3683#endif
3684 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3685
3686 /*
3687 * Open the buffer and read the file.
3688 */
3689#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003690 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 retval = FAIL;
3692#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003693 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694#endif
3695
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003696#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 if (swap_exists_action == SEA_QUIT)
3698 retval = FAIL;
3699 handle_swap_exists(old_curbuf);
3700#endif
3701 }
3702#ifdef FEAT_AUTOCMD
3703 else
3704 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003705 /* Read the modelines, but only to set window-local options. Any
3706 * buffer-local options have already been set and may have been
3707 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003708 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003709
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3711 &retval);
3712 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3713 &retval);
3714 }
3715 check_arg_idx(curwin);
3716#endif
3717
3718 /*
3719 * If autocommands change the cursor position or topline, we should
3720 * keep it.
3721 */
3722 if (curwin->w_cursor.lnum != lnum)
3723 {
3724 newlnum = curwin->w_cursor.lnum;
3725 newcol = curwin->w_cursor.col;
3726 }
3727 if (curwin->w_topline == topline)
3728 topline = 0;
3729
3730 /* Even when cursor didn't move we need to recompute topline. */
3731 changed_line_abv_curs();
3732
3733#ifdef FEAT_TITLE
3734 maketitle();
3735#endif
3736 }
3737
3738#ifdef FEAT_DIFF
3739 /* Tell the diff stuff that this buffer is new and/or needs updating.
3740 * Also needed when re-editing the same buffer, because unloading will
3741 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003742 if (curwin->w_p_diff)
3743 {
3744 diff_buf_add(curbuf);
3745 diff_invalidate(curbuf);
3746 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747#endif
3748
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003749#ifdef FEAT_SPELL
3750 /* If the window options were changed may need to set the spell language.
3751 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003752 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3753 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003754#endif
3755
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 if (command == NULL)
3757 {
3758 if (newcol >= 0) /* position set by autocommands */
3759 {
3760 curwin->w_cursor.lnum = newlnum;
3761 curwin->w_cursor.col = newcol;
3762 check_cursor();
3763 }
3764 else if (newlnum > 0) /* line number from caller or old position */
3765 {
3766 curwin->w_cursor.lnum = newlnum;
3767 check_cursor_lnum();
3768 if (solcol >= 0 && !p_sol)
3769 {
3770 /* 'sol' is off: Use last known column. */
3771 curwin->w_cursor.col = solcol;
3772 check_cursor_col();
3773#ifdef FEAT_VIRTUALEDIT
3774 curwin->w_cursor.coladd = 0;
3775#endif
3776 curwin->w_set_curswant = TRUE;
3777 }
3778 else
3779 beginline(BL_SOL | BL_FIX);
3780 }
3781 else /* no line number, go to last line in Ex mode */
3782 {
3783 if (exmode_active)
3784 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3785 beginline(BL_WHITE | BL_FIX);
3786 }
3787 }
3788
3789#ifdef FEAT_WINDOWS
3790 /* Check if cursors in other windows on the same buffer are still valid */
3791 check_lnums(FALSE);
3792#endif
3793
3794 /*
3795 * Did not read the file, need to show some info about the file.
3796 * Do this after setting the cursor.
3797 */
3798 if (oldbuf
3799#ifdef FEAT_AUTOCMD
3800 && !auto_buf
3801#endif
3802 )
3803 {
3804 int msg_scroll_save = msg_scroll;
3805
3806 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3807 * message. */
3808 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3809 msg_scroll = FALSE;
3810 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3811 check_for_delay(FALSE);
3812 msg_start();
3813 msg_scroll = msg_scroll_save;
3814 msg_scrolled_ign = TRUE;
3815
3816 fileinfo(FALSE, TRUE, FALSE);
3817
3818 msg_scrolled_ign = FALSE;
3819 }
3820
3821 if (command != NULL)
3822 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3823
3824#ifdef FEAT_KEYMAP
3825 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003826 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827#endif
3828
3829 --RedrawingDisabled;
3830 if (!skip_redraw)
3831 {
3832 n = p_so;
3833 if (topline == 0 && command == NULL)
3834 p_so = 999; /* force cursor halfway the window */
3835 update_topline();
3836#ifdef FEAT_SCROLLBIND
3837 curwin->w_scbind_pos = curwin->w_topline;
3838#endif
3839 p_so = n;
3840 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3841 }
3842
3843 if (p_im)
3844 need_start_insertmode = TRUE;
3845
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003846 /* Change directories when the 'acd' option is set. */
3847 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00003849#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003850 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 {
3852# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02003853 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3855# endif
3856# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003857 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003858 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859# endif
3860 }
3861#endif
3862
3863theend:
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003864#ifdef FEAT_AUTOCMD
3865 if (did_set_swapcommand)
3866 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3867#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868#ifdef FEAT_BROWSE
3869 vim_free(browse_file);
3870#endif
3871 vim_free(free_fname);
3872 return retval;
3873}
3874
3875#ifdef FEAT_AUTOCMD
3876 static void
3877delbuf_msg(name)
3878 char_u *name;
3879{
3880 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3881 name == NULL ? (char_u *)"" : name);
3882 vim_free(name);
3883 au_new_curbuf = NULL;
3884}
3885#endif
3886
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003887static int append_indent = 0; /* autoindent for first line */
3888
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889/*
3890 * ":insert" and ":append", also used by ":change"
3891 */
3892 void
3893ex_append(eap)
3894 exarg_T *eap;
3895{
3896 char_u *theline;
3897 int did_undo = FALSE;
3898 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003899 int indent = 0;
3900 char_u *p;
3901 int vcol;
3902 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003904 /* the ! flag toggles autoindent */
3905 if (eap->forceit)
3906 curbuf->b_p_ai = !curbuf->b_p_ai;
3907
3908 /* First autoindent comes from the line we start on */
3909 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3910 append_indent = get_indent_lnum(lnum);
3911
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 if (eap->cmdidx != CMD_append)
3913 --lnum;
3914
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003915 /* when the buffer is empty append to line 0 and delete the dummy line */
3916 if (empty && lnum == 1)
3917 lnum = 0;
3918
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 State = INSERT; /* behave like in Insert mode */
3920 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3921 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003922
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003923 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 {
3925 msg_scroll = TRUE;
3926 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003927 if (curbuf->b_p_ai)
3928 {
3929 if (append_indent >= 0)
3930 {
3931 indent = append_indent;
3932 append_indent = -1;
3933 }
3934 else if (lnum > 0)
3935 indent = get_indent_lnum(lnum);
3936 }
3937 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003939 {
3940 /* No getline() function, use the lines that follow. This ends
3941 * when there is no more. */
3942 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3943 break;
3944 p = vim_strchr(eap->nextcmd, NL);
3945 if (p == NULL)
3946 p = eap->nextcmd + STRLEN(eap->nextcmd);
3947 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3948 if (*p != NUL)
3949 ++p;
3950 eap->nextcmd = p;
3951 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 else
3953 theline = eap->getline(
3954#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003955 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003957 NUL, eap->cookie, indent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003959 if (theline == NULL)
3960 break;
3961
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003962 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3963 if (ex_keep_indent)
3964 append_indent = indent;
3965
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003966 /* Look for the "." after automatic indent. */
3967 vcol = 0;
3968 for (p = theline; indent > vcol; ++p)
3969 {
3970 if (*p == ' ')
3971 ++vcol;
3972 else if (*p == TAB)
3973 vcol += 8 - vcol % 8;
3974 else
3975 break;
3976 }
3977 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003978 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3979 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 {
3981 vim_free(theline);
3982 break;
3983 }
3984
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003985 /* don't use autoindent if nothing was typed. */
3986 if (p[0] == NUL)
3987 theline[0] = NUL;
3988
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 did_undo = TRUE;
3990 ml_append(lnum, theline, (colnr_T)0, FALSE);
3991 appended_lines_mark(lnum, 1L);
3992
3993 vim_free(theline);
3994 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003995
3996 if (empty)
3997 {
3998 ml_delete(2L, FALSE);
3999 empty = FALSE;
4000 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 }
4002 State = NORMAL;
4003
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004004 if (eap->forceit)
4005 curbuf->b_p_ai = !curbuf->b_p_ai;
4006
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004008 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 * "end" is set to lnum when something has been appended, otherwise
4010 * it is the same than "start" -- Acevedo */
4011 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4012 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4013 if (eap->cmdidx != CMD_append)
4014 --curbuf->b_op_start.lnum;
4015 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4016 ? lnum : curbuf->b_op_start.lnum;
4017 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4018 curwin->w_cursor.lnum = lnum;
4019 check_cursor_lnum();
4020 beginline(BL_SOL | BL_FIX);
4021
4022 need_wait_return = FALSE; /* don't use wait_return() now */
4023 ex_no_reprint = TRUE;
4024}
4025
4026/*
4027 * ":change"
4028 */
4029 void
4030ex_change(eap)
4031 exarg_T *eap;
4032{
4033 linenr_T lnum;
4034
4035 if (eap->line2 >= eap->line1
4036 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4037 return;
4038
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004039 /* the ! flag toggles autoindent */
4040 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4041 append_indent = get_indent_lnum(eap->line1);
4042
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4044 {
4045 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4046 break;
4047 ml_delete(eap->line1, FALSE);
4048 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004049
4050 /* make sure the cursor is not beyond the end of the file now */
4051 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4053
4054 /* ":append" on the line above the deleted lines. */
4055 eap->line2 = eap->line1;
4056 ex_append(eap);
4057}
4058
4059 void
4060ex_z(eap)
4061 exarg_T *eap;
4062{
4063 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004064 int bigness;
4065 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 int minus = 0;
4067 linenr_T start, end, curs, i;
4068 int j;
4069 linenr_T lnum = eap->line2;
4070
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004071 /* Vi compatible: ":z!" uses display height, without a count uses
4072 * 'scroll' */
4073 if (eap->forceit)
4074 bigness = curwin->w_height;
4075 else if (firstwin == lastwin)
4076 bigness = curwin->w_p_scr * 2;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004077#ifdef FEAT_WINDOWS
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004078 else
4079 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004080#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 if (bigness < 1)
4082 bigness = 1;
4083
4084 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004085 kind = x;
4086 if (*kind == '-' || *kind == '+' || *kind == '='
4087 || *kind == '^' || *kind == '.')
4088 ++x;
4089 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 ++x;
4091
4092 if (*x != 0)
4093 {
4094 if (!VIM_ISDIGIT(*x))
4095 {
4096 EMSG(_("E144: non-numeric argument to :z"));
4097 return;
4098 }
4099 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004100 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004102 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004103 if (*kind == '=')
4104 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004105 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 }
4107
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004108 /* the number of '-' and '+' multiplies the distance */
4109 if (*kind == '-' || *kind == '+')
4110 for (x = kind + 1; *x == *kind; ++x)
4111 ;
4112
4113 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 {
4115 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004116 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4117 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004118 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 break;
4120
4121 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004122 start = lnum - (bigness + 1) / 2 + 1;
4123 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 curs = lnum;
4125 minus = 1;
4126 break;
4127
4128 case '^':
4129 start = lnum - bigness * 2;
4130 end = lnum - bigness;
4131 curs = lnum - bigness;
4132 break;
4133
4134 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004135 start = lnum - (bigness + 1) / 2 + 1;
4136 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 curs = end;
4138 break;
4139
4140 default: /* '+' */
4141 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004142 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004143 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004144 else if (eap->addr_count == 0)
4145 ++start;
4146 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 curs = end;
4148 break;
4149 }
4150
4151 if (start < 1)
4152 start = 1;
4153
4154 if (end > curbuf->b_ml.ml_line_count)
4155 end = curbuf->b_ml.ml_line_count;
4156
4157 if (curs > curbuf->b_ml.ml_line_count)
4158 curs = curbuf->b_ml.ml_line_count;
4159
4160 for (i = start; i <= end; i++)
4161 {
4162 if (minus && i == lnum)
4163 {
4164 msg_putchar('\n');
4165
4166 for (j = 1; j < Columns; j++)
4167 msg_putchar('-');
4168 }
4169
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004170 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171
4172 if (minus && i == lnum)
4173 {
4174 msg_putchar('\n');
4175
4176 for (j = 1; j < Columns; j++)
4177 msg_putchar('-');
4178 }
4179 }
4180
4181 curwin->w_cursor.lnum = curs;
4182 ex_no_reprint = TRUE;
4183}
4184
4185/*
4186 * Check if the restricted flag is set.
4187 * If so, give an error message and return TRUE.
4188 * Otherwise, return FALSE.
4189 */
4190 int
4191check_restricted()
4192{
4193 if (restricted)
4194 {
4195 EMSG(_("E145: Shell commands not allowed in rvim"));
4196 return TRUE;
4197 }
4198 return FALSE;
4199}
4200
4201/*
4202 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4203 * If so, give an error message and return TRUE.
4204 * Otherwise, return FALSE.
4205 */
4206 int
4207check_secure()
4208{
4209 if (secure)
4210 {
4211 secure = 2;
4212 EMSG(_(e_curdir));
4213 return TRUE;
4214 }
4215#ifdef HAVE_SANDBOX
4216 /*
4217 * In the sandbox more things are not allowed, including the things
4218 * disallowed in secure mode.
4219 */
4220 if (sandbox != 0)
4221 {
4222 EMSG(_(e_sandbox));
4223 return TRUE;
4224 }
4225#endif
4226 return FALSE;
4227}
4228
4229static char_u *old_sub = NULL; /* previous substitute pattern */
4230static int global_need_beginline; /* call beginline() after ":g" */
4231
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232/* do_sub()
4233 *
4234 * Perform a substitution from line eap->line1 to line eap->line2 using the
4235 * command pointed to by eap->arg which should be of the form:
4236 *
4237 * /pattern/substitution/{flags}
4238 *
4239 * The usual escapes are supported as described in the regexp docs.
4240 */
4241 void
4242do_sub(eap)
4243 exarg_T *eap;
4244{
4245 linenr_T lnum;
4246 long i = 0;
4247 regmmatch_T regmatch;
4248 static int do_all = FALSE; /* do multiple substitutions per line */
4249 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004250 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 static int do_error = TRUE; /* if false, ignore errors */
4252 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004253 static int do_list = FALSE; /* list last line with subs. */
4254 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 static int do_ic = 0; /* ignore case flag */
4256 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4257 int delimiter;
4258 int sublen;
4259 int got_quit = FALSE;
4260 int got_match = FALSE;
4261 int temp;
4262 int which_pat;
4263 char_u *cmd;
4264 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004265 linenr_T first_line = 0; /* first changed line */
4266 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 * change */
4268 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4269 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004270 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004271 char_u *sub_firstline; /* allocated copy of first sub line */
4272 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004273 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004274 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004275#ifdef FEAT_EVAL
4276 int save_ma = 0;
4277#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278
4279 cmd = eap->arg;
4280 if (!global_busy)
4281 {
4282 sub_nsubs = 0;
4283 sub_nlines = 0;
4284 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004285 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 if (eap->cmdidx == CMD_tilde)
4288 which_pat = RE_LAST; /* use last used regexp */
4289 else
4290 which_pat = RE_SUBST; /* use last substitute regexp */
4291
4292 /* new pattern and substitution */
4293 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4294 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4295 {
4296 /* don't accept alphanumeric for separator */
4297 if (isalpha(*cmd))
4298 {
4299 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4300 return;
4301 }
4302 /*
4303 * undocumented vi feature:
4304 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4305 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4306 */
4307 if (*cmd == '\\')
4308 {
4309 ++cmd;
4310 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4311 {
4312 EMSG(_(e_backslash));
4313 return;
4314 }
4315 if (*cmd != '&')
4316 which_pat = RE_SEARCH; /* use last '/' pattern */
4317 pat = (char_u *)""; /* empty search pattern */
4318 delimiter = *cmd++; /* remember delimiter character */
4319 }
4320 else /* find the end of the regexp */
4321 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004322#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4323 if (p_altkeymap && curwin->w_p_rl)
4324 lrF_sub(cmd);
4325#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 which_pat = RE_LAST; /* use last used regexp */
4327 delimiter = *cmd++; /* remember delimiter character */
4328 pat = cmd; /* remember start of search pat */
4329 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4330 if (cmd[0] == delimiter) /* end delimiter found */
4331 *cmd++ = NUL; /* replace it with a NUL */
4332 }
4333
4334 /*
4335 * Small incompatibility: vi sees '\n' as end of the command, but in
4336 * Vim we want to use '\n' to find/substitute a NUL.
4337 */
4338 sub = cmd; /* remember the start of the substitution */
4339
4340 while (cmd[0])
4341 {
4342 if (cmd[0] == delimiter) /* end delimiter found */
4343 {
4344 *cmd++ = NUL; /* replace it with a NUL */
4345 break;
4346 }
4347 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4348 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004349 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 }
4351
4352 if (!eap->skip)
4353 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004354 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4355 if (STRCMP(sub, "%") == 0
4356 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4357 {
4358 if (old_sub == NULL) /* there is no previous command */
4359 {
4360 EMSG(_(e_nopresub));
4361 return;
4362 }
4363 sub = old_sub;
4364 }
4365 else
4366 {
4367 vim_free(old_sub);
4368 old_sub = vim_strsave(sub);
4369 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 }
4371 }
4372 else if (!eap->skip) /* use previous pattern and substitution */
4373 {
4374 if (old_sub == NULL) /* there is no previous command */
4375 {
4376 EMSG(_(e_nopresub));
4377 return;
4378 }
4379 pat = NULL; /* search_regcomp() will use previous pattern */
4380 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004381
4382 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4383 * last column after using "$". */
4384 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 }
4386
4387 /*
4388 * Find trailing options. When '&' is used, keep old options.
4389 */
4390 if (*cmd == '&')
4391 ++cmd;
4392 else
4393 {
4394 if (!p_ed)
4395 {
4396 if (p_gd) /* default is global on */
4397 do_all = TRUE;
4398 else
4399 do_all = FALSE;
4400 do_ask = FALSE;
4401 }
4402 do_error = TRUE;
4403 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004404 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004405 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 do_ic = 0;
4407 }
4408 while (*cmd)
4409 {
4410 /*
4411 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4412 * 'r' is never inverted.
4413 */
4414 if (*cmd == 'g')
4415 do_all = !do_all;
4416 else if (*cmd == 'c')
4417 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004418 else if (*cmd == 'n')
4419 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 else if (*cmd == 'e')
4421 do_error = !do_error;
4422 else if (*cmd == 'r') /* use last used regexp */
4423 which_pat = RE_LAST;
4424 else if (*cmd == 'p')
4425 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004426 else if (*cmd == '#')
4427 {
4428 do_print = TRUE;
4429 do_number = TRUE;
4430 }
4431 else if (*cmd == 'l')
4432 {
4433 do_print = TRUE;
4434 do_list = TRUE;
4435 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 else if (*cmd == 'i') /* ignore case */
4437 do_ic = 'i';
4438 else if (*cmd == 'I') /* don't ignore case */
4439 do_ic = 'I';
4440 else
4441 break;
4442 ++cmd;
4443 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004444 if (do_count)
4445 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446
4447 /*
4448 * check for a trailing count
4449 */
4450 cmd = skipwhite(cmd);
4451 if (VIM_ISDIGIT(*cmd))
4452 {
4453 i = getdigits(&cmd);
4454 if (i <= 0 && !eap->skip && do_error)
4455 {
4456 EMSG(_(e_zerocount));
4457 return;
4458 }
4459 eap->line1 = eap->line2;
4460 eap->line2 += i - 1;
4461 if (eap->line2 > curbuf->b_ml.ml_line_count)
4462 eap->line2 = curbuf->b_ml.ml_line_count;
4463 }
4464
4465 /*
4466 * check for trailing command or garbage
4467 */
4468 cmd = skipwhite(cmd);
4469 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4470 {
4471 eap->nextcmd = check_nextcmd(cmd);
4472 if (eap->nextcmd == NULL)
4473 {
4474 EMSG(_(e_trailing));
4475 return;
4476 }
4477 }
4478
4479 if (eap->skip) /* not executing commands, only parsing */
4480 return;
4481
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004482 if (!do_count && !curbuf->b_p_ma)
4483 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004484 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004485 EMSG(_(e_modifiable));
4486 return;
4487 }
4488
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4490 {
4491 if (do_error)
4492 EMSG(_(e_invcmd));
4493 return;
4494 }
4495
4496 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4497 if (do_ic == 'i')
4498 regmatch.rmm_ic = TRUE;
4499 else if (do_ic == 'I')
4500 regmatch.rmm_ic = FALSE;
4501
4502 sub_firstline = NULL;
4503
4504 /*
4505 * ~ in the substitute pattern is replaced with the old pattern.
4506 * We do it here once to avoid it to be replaced over and over again.
4507 * But don't do it when it starts with "\=", then it's an expression.
4508 */
4509 if (!(sub[0] == '\\' && sub[1] == '='))
4510 sub = regtilde(sub, p_magic);
4511
4512 /*
4513 * Check for a match on each line.
4514 */
4515 line2 = eap->line2;
4516 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4517#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4518 || aborting()
4519#endif
4520 ); ++lnum)
4521 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004522 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4523 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 if (nmatch)
4525 {
4526 colnr_T copycol;
4527 colnr_T matchcol;
4528 colnr_T prev_matchcol = MAXCOL;
4529 char_u *new_end, *new_start = NULL;
4530 unsigned new_start_len = 0;
4531 char_u *p1;
4532 int did_sub = FALSE;
4533 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004534 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 long nmatch_tl = 0; /* nr of lines matched below lnum */
4536 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004537 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004538 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539
4540 /*
4541 * The new text is build up step by step, to avoid too much
4542 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004543 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 * copycol Column in the old text where we started
4545 * looking for a match; from here old text still
4546 * needs to be copied to the new text.
4547 * matchcol Column number of the old text where to look
4548 * for the next match. It's just after the
4549 * previous match or one further.
4550 * prev_matchcol Column just after the previous match (if any).
4551 * Mostly equal to matchcol, except for the first
4552 * match and after skipping an empty match.
4553 * regmatch.*pos Where the pattern matched in the old text.
4554 * new_start The new text, all that has been produced so
4555 * far.
4556 * new_end The new text, where to append new text.
4557 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004558 * lnum The line number where we found the start of
4559 * the match. Can be below the line we searched
4560 * when there is a \n before a \zs in the
4561 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 * sub_firstlnum The line number in the buffer where to look
4563 * for a match. Can be different from "lnum"
4564 * when the pattern or substitute string contains
4565 * line breaks.
4566 *
4567 * Special situations:
4568 * - When the substitute string contains a line break, the part up
4569 * to the line break is inserted in the text, but the copy of
4570 * the original line is kept. "sub_firstlnum" is adjusted for
4571 * the inserted lines.
4572 * - When the matched pattern contains a line break, the old line
4573 * is taken from the line at the end of the pattern. The lines
4574 * in the match are deleted later, "sub_firstlnum" is adjusted
4575 * accordingly.
4576 *
4577 * The new text is built up in new_start[]. It has some extra
4578 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004579 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 *
4581 * Make a copy of the old line, so it won't be taken away when
4582 * updating the screen or handling a multi-line match. The "old_"
4583 * pointers point into this copy.
4584 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004585 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 copycol = 0;
4587 matchcol = 0;
4588
4589 /* At first match, remember current cursor position. */
4590 if (!got_match)
4591 {
4592 setpcmark();
4593 got_match = TRUE;
4594 }
4595
4596 /*
4597 * Loop until nothing more to replace in this line.
4598 * 1. Handle match with empty string.
4599 * 2. If do_ask is set, ask for confirmation.
4600 * 3. substitute the string.
4601 * 4. if do_all is set, find next match
4602 * 5. break if there isn't another match in this line
4603 */
4604 for (;;)
4605 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004606 /* Advance "lnum" to the line where the match starts. The
4607 * match does not start in the first line when there is a line
4608 * break before \zs. */
4609 if (regmatch.startpos[0].lnum > 0)
4610 {
4611 lnum += regmatch.startpos[0].lnum;
4612 sub_firstlnum += regmatch.startpos[0].lnum;
4613 nmatch -= regmatch.startpos[0].lnum;
4614 vim_free(sub_firstline);
4615 sub_firstline = NULL;
4616 }
4617
4618 if (sub_firstline == NULL)
4619 {
4620 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4621 if (sub_firstline == NULL)
4622 {
4623 vim_free(new_start);
4624 goto outofmem;
4625 }
4626 }
4627
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 /* Save the line number of the last change for the final
4629 * cursor position (just like Vi). */
4630 curwin->w_cursor.lnum = lnum;
4631 do_again = FALSE;
4632
4633 /*
4634 * 1. Match empty string does not count, except for first
4635 * match. This reproduces the strange vi behaviour.
4636 * This also catches endless loops.
4637 */
4638 if (matchcol == prev_matchcol
4639 && regmatch.endpos[0].lnum == 0
4640 && matchcol == regmatch.endpos[0].col)
4641 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004642 if (sub_firstline[matchcol] == NUL)
4643 /* We already were at the end of the line. Don't look
4644 * for a match in this line again. */
4645 skip_match = TRUE;
4646 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004647 {
4648 /* search for a match at next column */
4649#ifdef FEAT_MBYTE
4650 if (has_mbyte)
4651 matchcol += mb_ptr2len(sub_firstline + matchcol);
4652 else
4653#endif
4654 ++matchcol;
4655 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 goto skip;
4657 }
4658
4659 /* Normally we continue searching for a match just after the
4660 * previous match. */
4661 matchcol = regmatch.endpos[0].col;
4662 prev_matchcol = matchcol;
4663
4664 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004665 * 2. If do_count is set only increase the counter.
4666 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004668 if (do_count)
4669 {
4670 /* For a multi-line match, put matchcol at the NUL at
4671 * the end of the line and set nmatch to one, so that
4672 * we continue looking for a match on the next line.
4673 * Avoids that ":s/\nB\@=//gc" get stuck. */
4674 if (nmatch > 1)
4675 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004676 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004677 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004678 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004679 }
4680 sub_nsubs++;
4681 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004682#ifdef FEAT_EVAL
4683 /* Skip the substitution, unless an expression is used,
4684 * then it is evaluated in the sandbox. */
4685 if (!(sub[0] == '\\' && sub[1] == '='))
4686#endif
4687 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004688 }
4689
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 if (do_ask)
4691 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004692 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004693
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 /* change State to CONFIRM, so that the mouse works
4695 * properly */
4696 save_State = State;
4697 State = CONFIRM;
4698#ifdef FEAT_MOUSE
4699 setmouse(); /* disable mouse in xterm */
4700#endif
4701 curwin->w_cursor.col = regmatch.startpos[0].col;
4702
4703 /* When 'cpoptions' contains "u" don't sync undo when
4704 * asking for confirmation. */
4705 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4706 ++no_u_sync;
4707
4708 /*
4709 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4710 */
4711 while (do_ask)
4712 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004713 if (exmode_active)
4714 {
4715 char_u *resp;
4716 colnr_T sc, ec;
4717
4718 print_line_no_prefix(lnum, FALSE, FALSE);
4719
4720 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4721 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4722 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4723 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004724 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004725 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004726 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004727 msg_putchar('^');
4728
4729 resp = getexmodeline('?', NULL, 0);
4730 if (resp != NULL)
4731 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004732 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004733 vim_free(resp);
4734 }
4735 }
4736 else
4737 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004738 char_u *orig_line = NULL;
4739 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004741 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004743 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004745 /* Invert the matched string.
4746 * Remove the inversion afterwards. */
4747 temp = RedrawingDisabled;
4748 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004750 if (new_start != NULL)
4751 {
4752 /* There already was a substitution, we would
4753 * like to show this to the user. We cannot
4754 * really update the line, it would change
4755 * what matches. Temporarily replace the line
4756 * and change it back afterwards. */
4757 orig_line = vim_strsave(ml_get(lnum));
4758 if (orig_line != NULL)
4759 {
4760 char_u *new_line = concat_str(new_start,
4761 sub_firstline + copycol);
4762
4763 if (new_line == NULL)
4764 {
4765 vim_free(orig_line);
4766 orig_line = NULL;
4767 }
4768 else
4769 {
4770 /* Position the cursor relative to the
4771 * end of the line, the previous
4772 * substitute may have inserted or
4773 * deleted characters before the
4774 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004775 len_change = (int)STRLEN(new_line)
4776 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004777 curwin->w_cursor.col += len_change;
4778 ml_replace(lnum, new_line, FALSE);
4779 }
4780 }
4781 }
4782
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004783 search_match_lines = regmatch.endpos[0].lnum
4784 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004785 search_match_endcol = regmatch.endpos[0].col
4786 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004787 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004789 update_topline();
4790 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004791 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004792 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004793 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794
4795#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004796 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004798 if (msg_row == Rows - 1)
4799 msg_didout = FALSE; /* avoid a scroll-up */
4800 msg_starthere();
4801 i = msg_scroll;
4802 msg_scroll = 0; /* truncate msg when
4803 needed */
4804 msg_no_more = TRUE;
4805 /* write message same highlighting as for
4806 * wait_return */
4807 smsg_attr(hl_attr(HLF_R),
4808 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4809 msg_no_more = FALSE;
4810 msg_scroll = i;
4811 showruler(TRUE);
4812 windgoto(msg_row, msg_col);
4813 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814
4815#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004816 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004818 ++no_mapping; /* don't map this key */
4819 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004820 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004821 --allow_keys;
4822 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004824 /* clear the question */
4825 msg_didout = FALSE; /* don't scroll up */
4826 msg_col = 0;
4827 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004828
4829 /* restore the line */
4830 if (orig_line != NULL)
4831 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004832 }
4833
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004835 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004837 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838#endif
4839 )
4840 {
4841 got_quit = TRUE;
4842 break;
4843 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004844 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004846 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004848 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 {
4850 /* last: replace and then stop */
4851 do_all = FALSE;
4852 line2 = lnum;
4853 break;
4854 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004855 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 {
4857 do_ask = FALSE;
4858 break;
4859 }
4860#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004861 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004863 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 scrolldown_clamp();
4865#endif
4866 }
4867 State = save_State;
4868#ifdef FEAT_MOUSE
4869 setmouse();
4870#endif
4871 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4872 --no_u_sync;
4873
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004874 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 {
4876 /* For a multi-line match, put matchcol at the NUL at
4877 * the end of the line and set nmatch to one, so that
4878 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004879 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4880 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 if (nmatch > 1)
4882 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004883 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004884 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 }
4886 goto skip;
4887 }
4888 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004889 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 }
4891
4892 /* Move the cursor to the start of the match, so that we can
4893 * use "\=col("."). */
4894 curwin->w_cursor.col = regmatch.startpos[0].col;
4895
4896 /*
4897 * 3. substitute the string.
4898 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004899#ifdef FEAT_EVAL
4900 if (do_count)
4901 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004902 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004903 save_ma = curbuf->b_p_ma;
4904 curbuf->b_p_ma = FALSE;
4905 sandbox++;
4906 }
4907#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004909 sublen = vim_regsub_multi(&regmatch,
4910 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004912#ifdef FEAT_EVAL
4913 if (do_count)
4914 {
4915 curbuf->b_p_ma = save_ma;
4916 sandbox--;
4917 goto skip;
4918 }
4919#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920
Bram Moolenaar4463f292005-09-25 22:20:24 +00004921 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004922 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004923 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4924 {
4925 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4926 skip_match = TRUE;
4927 }
4928
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 /* Need room for:
4930 * - result so far in new_start (not for first sub in line)
4931 * - original text up to match
4932 * - length of substituted part
4933 * - original text after match
4934 */
4935 if (nmatch == 1)
4936 p1 = sub_firstline;
4937 else
4938 {
4939 p1 = ml_get(sub_firstlnum + nmatch - 1);
4940 nmatch_tl += nmatch - 1;
4941 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004942 copy_len = regmatch.startpos[0].col - copycol;
4943 needed_len = copy_len + ((unsigned)STRLEN(p1)
4944 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 if (new_start == NULL)
4946 {
4947 /*
4948 * Get some space for a temporary buffer to do the
4949 * substitution into (and some extra space to avoid
4950 * too many calls to alloc()/free()).
4951 */
4952 new_start_len = needed_len + 50;
4953 if ((new_start = alloc_check(new_start_len)) == NULL)
4954 goto outofmem;
4955 *new_start = NUL;
4956 new_end = new_start;
4957 }
4958 else
4959 {
4960 /*
4961 * Check if the temporary buffer is long enough to do the
4962 * substitution into. If not, make it larger (with a bit
4963 * extra to avoid too many calls to alloc()/free()).
4964 */
4965 len = (unsigned)STRLEN(new_start);
4966 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004967 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 {
4969 new_start_len = needed_len + 50;
4970 if ((p1 = alloc_check(new_start_len)) == NULL)
4971 {
4972 vim_free(new_start);
4973 goto outofmem;
4974 }
4975 mch_memmove(p1, new_start, (size_t)(len + 1));
4976 vim_free(new_start);
4977 new_start = p1;
4978 }
4979 new_end = new_start + len;
4980 }
4981
4982 /*
4983 * copy the text up to the part that matched
4984 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004985 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4986 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004988 (void)vim_regsub_multi(&regmatch,
4989 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 sub, new_end, TRUE, p_magic, TRUE);
4991 sub_nsubs++;
4992 did_sub = TRUE;
4993
4994 /* Move the cursor to the start of the line, to avoid that it
4995 * is beyond the end of the line after the substitution. */
4996 curwin->w_cursor.col = 0;
4997
4998 /* For a multi-line match, make a copy of the last matched
4999 * line and continue in that one. */
5000 if (nmatch > 1)
5001 {
5002 sub_firstlnum += nmatch - 1;
5003 vim_free(sub_firstline);
5004 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
5005 /* When going beyond the last line, stop substituting. */
5006 if (sub_firstlnum <= line2)
5007 do_again = TRUE;
5008 else
5009 do_all = FALSE;
5010 }
5011
5012 /* Remember next character to be copied. */
5013 copycol = regmatch.endpos[0].col;
5014
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005015 if (skip_match)
5016 {
5017 /* Already hit end of the buffer, sub_firstlnum is one
5018 * less than what it ought to be. */
5019 vim_free(sub_firstline);
5020 sub_firstline = vim_strsave((char_u *)"");
5021 copycol = 0;
5022 }
5023
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 /*
5025 * Now the trick is to replace CTRL-M chars with a real line
5026 * break. This would make it impossible to insert a CTRL-M in
5027 * the text. The line break can be avoided by preceding the
5028 * CTRL-M with a backslash. To be able to insert a backslash,
5029 * they must be doubled in the string and are halved here.
5030 * That is Vi compatible.
5031 */
5032 for (p1 = new_end; *p1; ++p1)
5033 {
5034 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005035 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 else if (*p1 == CAR)
5037 {
5038 if (u_inssub(lnum) == OK) /* prepare for undo */
5039 {
5040 *p1 = NUL; /* truncate up to the CR */
5041 ml_append(lnum - 1, new_start,
5042 (colnr_T)(p1 - new_start + 1), FALSE);
5043 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
5044 if (do_ask)
5045 appended_lines(lnum - 1, 1L);
5046 else
5047 {
5048 if (first_line == 0)
5049 first_line = lnum;
5050 last_line = lnum + 1;
5051 }
5052 /* All line numbers increase. */
5053 ++sub_firstlnum;
5054 ++lnum;
5055 ++line2;
5056 /* move the cursor to the new line, like Vi */
5057 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005058 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005059 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 p1 = new_start - 1;
5061 }
5062 }
5063#ifdef FEAT_MBYTE
5064 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005065 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066#endif
5067 }
5068
5069 /*
5070 * 4. If do_all is set, find next match.
5071 * Prevent endless loop with patterns that match empty
5072 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5073 * But ":s/\n/#/" is OK.
5074 */
5075skip:
5076 /* We already know that we did the last subst when we are at
5077 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005078 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5079 * "line2" when there is a \zs in the pattern after a line
5080 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005081 lastone = (skip_match
5082 || got_int
5083 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005084 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005085 || !(do_all || do_again)
5086 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5087 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 nmatch = -1;
5089
5090 /*
5091 * Replace the line in the buffer when needed. This is
5092 * skipped when there are more matches.
5093 * The check for nmatch_tl is needed for when multi-line
5094 * matching must replace the lines before trying to do another
5095 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005096 * When the match starts below where we start searching also
5097 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 */
5099 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 || nmatch_tl > 0
5101 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005102 curbuf, sub_firstlnum,
5103 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005104 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 {
5106 if (new_start != NULL)
5107 {
5108 /*
5109 * Copy the rest of the line, that didn't match.
5110 * "matchcol" has to be adjusted, we use the end of
5111 * the line as reference, because the substitute may
5112 * have changed the number of characters. Same for
5113 * "prev_matchcol".
5114 */
5115 STRCAT(new_start, sub_firstline + copycol);
5116 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5117 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5118 - prev_matchcol;
5119
5120 if (u_savesub(lnum) != OK)
5121 break;
5122 ml_replace(lnum, new_start, TRUE);
5123
5124 if (nmatch_tl > 0)
5125 {
5126 /*
5127 * Matched lines have now been substituted and are
5128 * useless, delete them. The part after the match
5129 * has been appended to new_start, we don't need
5130 * it in the buffer.
5131 */
5132 ++lnum;
5133 if (u_savedel(lnum, nmatch_tl) != OK)
5134 break;
5135 for (i = 0; i < nmatch_tl; ++i)
5136 ml_delete(lnum, (int)FALSE);
5137 mark_adjust(lnum, lnum + nmatch_tl - 1,
5138 (long)MAXLNUM, -nmatch_tl);
5139 if (do_ask)
5140 deleted_lines(lnum, nmatch_tl);
5141 --lnum;
5142 line2 -= nmatch_tl; /* nr of lines decreases */
5143 nmatch_tl = 0;
5144 }
5145
5146 /* When asking, undo is saved each time, must also set
5147 * changed flag each time. */
5148 if (do_ask)
5149 changed_bytes(lnum, 0);
5150 else
5151 {
5152 if (first_line == 0)
5153 first_line = lnum;
5154 last_line = lnum + 1;
5155 }
5156
5157 sub_firstlnum = lnum;
5158 vim_free(sub_firstline); /* free the temp buffer */
5159 sub_firstline = new_start;
5160 new_start = NULL;
5161 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5162 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5163 - prev_matchcol;
5164 copycol = 0;
5165 }
5166 if (nmatch == -1 && !lastone)
5167 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005168 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169
5170 /*
5171 * 5. break if there isn't another match in this line
5172 */
5173 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005174 {
5175 /* If the match found didn't start where we were
5176 * searching, do the next search in the line where we
5177 * found the match. */
5178 if (nmatch == -1)
5179 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005181 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 }
5183
5184 line_breakcheck();
5185 }
5186
5187 if (did_sub)
5188 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005189 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 vim_free(sub_firstline); /* free the copy of the original line */
5191 sub_firstline = NULL;
5192 }
5193
5194 line_breakcheck();
5195 }
5196
5197 if (first_line != 0)
5198 {
5199 /* Need to subtract the number of added lines from "last_line" to get
5200 * the line number before the change (same as adding the number of
5201 * deleted lines). */
5202 i = curbuf->b_ml.ml_line_count - old_line_count;
5203 changed_lines(first_line, 0, last_line - i, i);
5204 }
5205
5206outofmem:
5207 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005208
5209 /* ":s/pat//n" doesn't move the cursor */
5210 if (do_count)
5211 curwin->w_cursor = old_cursor;
5212
Bram Moolenaar46475522010-03-23 17:36:29 +01005213 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 {
5215 /* Set the '[ and '] marks. */
5216 curbuf->b_op_start.lnum = eap->line1;
5217 curbuf->b_op_end.lnum = line2;
5218 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5219
5220 if (!global_busy)
5221 {
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005222 if (!do_ask) /* when interactive leave cursor on the match */
5223 {
5224 if (endcolumn)
5225 coladvance((colnr_T)MAXCOL);
5226 else
5227 beginline(BL_WHITE | BL_FIX);
5228 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005229 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 MSG("");
5231 }
5232 else
5233 global_need_beginline = TRUE;
5234 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005235 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 }
5237 else if (!global_busy)
5238 {
5239 if (got_int) /* interrupted */
5240 EMSG(_(e_interr));
5241 else if (got_match) /* did find something but nothing substituted */
5242 MSG("");
5243 else if (do_error) /* nothing found */
5244 EMSG2(_(e_patnotf2), get_search_pat());
5245 }
5246
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005247#ifdef FEAT_FOLDING
5248 if (do_ask && hasAnyFolding(curwin))
5249 /* Cursor position may require updating */
5250 changed_window_setting();
5251#endif
5252
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 vim_free(regmatch.regprog);
5254}
5255
5256/*
5257 * Give message for number of substitutions.
5258 * Can also be used after a ":global" command.
5259 * Return TRUE if a message was given.
5260 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005261 int
Bram Moolenaar05159a02005-02-26 23:04:13 +00005262do_sub_msg(count_only)
5263 int count_only; /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264{
5265 /*
5266 * Only report substitutions when:
5267 * - more than 'report' substitutions
5268 * - command was typed by user, or number of changed lines > 'report'
5269 * - giving messages is not disabled by 'lazyredraw'
5270 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005271 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5272 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 && messaging())
5274 {
5275 if (got_int)
5276 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005277 else
5278 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005280 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005281 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005283 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005284 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 sub_nsubs);
5286 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005287 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005288 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005290 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005291 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005294 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 return TRUE;
5296 }
5297 if (got_int)
5298 {
5299 EMSG(_(e_interr));
5300 return TRUE;
5301 }
5302 return FALSE;
5303}
5304
5305/*
5306 * Execute a global command of the form:
5307 *
5308 * g/pattern/X : execute X on all lines where pattern matches
5309 * v/pattern/X : execute X on all lines where pattern does not match
5310 *
5311 * where 'X' is an EX command
5312 *
5313 * The command character (as well as the trailing slash) is optional, and
5314 * is assumed to be 'p' if missing.
5315 *
5316 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005317 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 * for each line that has a mark. This is required because after deleting
5319 * lines we do not know where to search for the next match.
5320 */
5321 void
5322ex_global(eap)
5323 exarg_T *eap;
5324{
5325 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005326 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 int type; /* first char of cmd: 'v' or 'g' */
5328 char_u *cmd; /* command argument */
5329
5330 char_u delim; /* delimiter, normally '/' */
5331 char_u *pat;
5332 regmmatch_T regmatch;
5333 int match;
5334 int which_pat;
5335
5336 if (global_busy)
5337 {
5338 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5339 return;
5340 }
5341
5342 if (eap->forceit) /* ":global!" is like ":vglobal" */
5343 type = 'v';
5344 else
5345 type = *eap->cmd;
5346 cmd = eap->arg;
5347 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348
5349 /*
5350 * undocumented vi feature:
5351 * "\/" and "\?": use previous search pattern.
5352 * "\&": use previous substitute pattern.
5353 */
5354 if (*cmd == '\\')
5355 {
5356 ++cmd;
5357 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5358 {
5359 EMSG(_(e_backslash));
5360 return;
5361 }
5362 if (*cmd == '&')
5363 which_pat = RE_SUBST; /* use previous substitute pattern */
5364 else
5365 which_pat = RE_SEARCH; /* use previous search pattern */
5366 ++cmd;
5367 pat = (char_u *)"";
5368 }
5369 else if (*cmd == NUL)
5370 {
5371 EMSG(_("E148: Regular expression missing from global"));
5372 return;
5373 }
5374 else
5375 {
5376 delim = *cmd; /* get the delimiter */
5377 if (delim)
5378 ++cmd; /* skip delimiter if there is one */
5379 pat = cmd; /* remember start of pattern */
5380 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5381 if (cmd[0] == delim) /* end delimiter found */
5382 *cmd++ = NUL; /* replace it with a NUL */
5383 }
5384
5385#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5386 if (p_altkeymap && curwin->w_p_rl)
5387 lrFswap(pat,0);
5388#endif
5389
5390 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5391 {
5392 EMSG(_(e_invcmd));
5393 return;
5394 }
5395
5396 /*
5397 * pass 1: set marks for each (not) matching line
5398 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5400 {
5401 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005402 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5403 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 if ((type == 'g' && match) || (type == 'v' && !match))
5405 {
5406 ml_setmarked(lnum);
5407 ndone++;
5408 }
5409 line_breakcheck();
5410 }
5411
5412 /*
5413 * pass 2: execute the command for each line that has been marked
5414 */
5415 if (got_int)
5416 MSG(_(e_interr));
5417 else if (ndone == 0)
5418 {
5419 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005420 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 else
Bram Moolenaarc389fd32013-03-07 16:08:35 +01005422 smsg((char_u *)_("Pattern not found: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 }
5424 else
5425 global_exe(cmd);
5426
5427 ml_clearmarked(); /* clear rest of the marks */
5428 vim_free(regmatch.regprog);
5429}
5430
5431/*
5432 * Execute "cmd" on lines marked with ml_setmarked().
5433 */
5434 void
5435global_exe(cmd)
5436 char_u *cmd;
5437{
Bram Moolenaarbb993222011-05-10 16:00:47 +02005438 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5439 buf_T *old_buf = curbuf; /* remember what buffer we started in */
5440 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441
5442 /*
5443 * Set current position only once for a global command.
5444 * If global_busy is set, setpcmark() will not do anything.
5445 * If there is an error, global_busy will be incremented.
5446 */
5447 setpcmark();
5448
5449 /* When the command writes a message, don't overwrite the command. */
5450 msg_didout = TRUE;
5451
Bram Moolenaard25bc232010-03-23 17:49:24 +01005452 sub_nsubs = 0;
5453 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 global_need_beginline = FALSE;
5455 global_busy = 1;
5456 old_lcount = curbuf->b_ml.ml_line_count;
5457 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5458 {
5459 curwin->w_cursor.lnum = lnum;
5460 curwin->w_cursor.col = 0;
5461 if (*cmd == NUL || *cmd == '\n')
5462 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5463 else
5464 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5465 ui_breakcheck();
5466 }
5467
5468 global_busy = 0;
5469 if (global_need_beginline)
5470 beginline(BL_WHITE | BL_FIX);
5471 else
5472 check_cursor(); /* cursor may be beyond the end of the line */
5473
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005474 /* the cursor may not have moved in the text but a change in a previous
5475 * line may move it on the screen */
5476 changed_line_abv_curs();
5477
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 /* If it looks like no message was written, allow overwriting the
5479 * command with the report for number of changes. */
5480 if (msg_col == 0 && msg_scrolled == 0)
5481 msg_didout = FALSE;
5482
Bram Moolenaar45667512007-05-10 19:24:43 +00005483 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02005484 * number of extra or deleted lines.
5485 * Don't report extra or deleted lines in the edge case where the buffer
5486 * we are in after execution is different from the buffer we started in. */
5487 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5489}
5490
5491#ifdef FEAT_VIMINFO
5492 int
5493read_viminfo_sub_string(virp, force)
5494 vir_T *virp;
5495 int force;
5496{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01005497 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 vim_free(old_sub);
5499 if (force || old_sub == NULL)
5500 old_sub = viminfo_readstring(virp, 1, TRUE);
5501 return viminfo_readline(virp);
5502}
5503
5504 void
5505write_viminfo_sub_string(fp)
5506 FILE *fp;
5507{
5508 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5509 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02005510 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 viminfo_writestring(fp, old_sub);
5512 }
5513}
5514#endif /* FEAT_VIMINFO */
5515
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005516#if defined(EXITFREE) || defined(PROTO)
5517 void
5518free_old_sub()
5519{
5520 vim_free(old_sub);
5521}
5522#endif
5523
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5525/*
5526 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005527 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005529 int
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005530prepare_tagpreview(undo_sync)
5531 int undo_sync; /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532{
5533 win_T *wp;
5534
5535# ifdef FEAT_GUI
5536 need_mouse_correct = TRUE;
5537# endif
5538
5539 /*
5540 * If there is already a preview window open, use that one.
5541 */
5542 if (!curwin->w_p_pvw)
5543 {
5544 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5545 if (wp->w_p_pvw)
5546 break;
5547 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005548 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 else
5550 {
5551 /*
5552 * There is no preview window open yet. Create one.
5553 */
5554 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5555 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005556 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 curwin->w_p_pvw = TRUE;
5558 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02005559 RESET_BINDING(curwin); /* don't take over 'scrollbind'
5560 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561# ifdef FEAT_DIFF
5562 curwin->w_p_diff = FALSE; /* no 'diff' */
5563# endif
5564# ifdef FEAT_FOLDING
5565 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5566# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005567 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 }
5569 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005570 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571}
5572
5573#endif
5574
5575
5576/*
5577 * ":help": open a read-only window on a help file
5578 */
5579 void
5580ex_help(eap)
5581 exarg_T *eap;
5582{
5583 char_u *arg;
5584 char_u *tag;
5585 FILE *helpfd; /* file descriptor of help file */
5586 int n;
5587 int i;
5588#ifdef FEAT_WINDOWS
5589 win_T *wp;
5590#endif
5591 int num_matches;
5592 char_u **matches;
5593 char_u *p;
5594 int empty_fnum = 0;
5595 int alt_fnum = 0;
5596 buf_T *buf;
5597#ifdef FEAT_MULTI_LANG
5598 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005599 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005601#ifdef FEAT_FOLDING
5602 int old_KeyTyped = KeyTyped;
5603#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604
5605 if (eap != NULL)
5606 {
5607 /*
5608 * A ":help" command ends at the first LF, or at a '|' that is
5609 * followed by some text. Set nextcmd to the following command.
5610 */
5611 for (arg = eap->arg; *arg; ++arg)
5612 {
5613 if (*arg == '\n' || *arg == '\r'
5614 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5615 {
5616 *arg++ = NUL;
5617 eap->nextcmd = arg;
5618 break;
5619 }
5620 }
5621 arg = eap->arg;
5622
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005623 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 {
5625 EMSG(_("E478: Don't panic!"));
5626 return;
5627 }
5628
5629 if (eap->skip) /* not executing commands */
5630 return;
5631 }
5632 else
5633 arg = (char_u *)"";
5634
5635 /* remove trailing blanks */
5636 p = arg + STRLEN(arg) - 1;
5637 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5638 *p-- = NUL;
5639
5640#ifdef FEAT_MULTI_LANG
5641 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005642 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643#endif
5644
5645 /* When no argument given go to the index. */
5646 if (*arg == NUL)
5647 arg = (char_u *)"help.txt";
5648
5649 /*
5650 * Check if there is a match for the argument.
5651 */
5652 n = find_help_tags(arg, &num_matches, &matches,
5653 eap != NULL && eap->forceit);
5654
5655 i = 0;
5656#ifdef FEAT_MULTI_LANG
5657 if (n != FAIL && lang != NULL)
5658 /* Find first item with the requested language. */
5659 for (i = 0; i < num_matches; ++i)
5660 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005661 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 if (len > 3 && matches[i][len - 3] == '@'
5663 && STRICMP(matches[i] + len - 2, lang) == 0)
5664 break;
5665 }
5666#endif
5667 if (i >= num_matches || n == FAIL)
5668 {
5669#ifdef FEAT_MULTI_LANG
5670 if (lang != NULL)
5671 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5672 else
5673#endif
5674 EMSG2(_("E149: Sorry, no help for %s"), arg);
5675 if (n != FAIL)
5676 FreeWild(num_matches, matches);
5677 return;
5678 }
5679
5680 /* The first match (in the requested language) is the best match. */
5681 tag = vim_strsave(matches[i]);
5682 FreeWild(num_matches, matches);
5683
5684#ifdef FEAT_GUI
5685 need_mouse_correct = TRUE;
5686#endif
5687
5688 /*
5689 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005690 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005692 if (!curwin->w_buffer->b_help
5693#ifdef FEAT_WINDOWS
5694 || cmdmod.tab != 0
5695#endif
5696 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 {
5698#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005699 if (cmdmod.tab != 0)
5700 wp = NULL;
5701 else
5702 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5703 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5704 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5706 win_enter(wp, TRUE);
5707 else
5708#endif
5709 {
5710 /*
5711 * There is no help window yet.
5712 * Try to open the file specified by the "helpfile" option.
5713 */
5714 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5715 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00005716 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 goto erret;
5718 }
5719 fclose(helpfd);
5720
5721#ifdef FEAT_WINDOWS
5722 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005723 * specified, the current window is vertically split and
5724 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 n = WSP_HELP;
5726# ifdef FEAT_VERTSPLIT
5727 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005728 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 n |= WSP_TOP;
5730# endif
5731 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005732 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733#else
5734 /* use current window */
5735 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005737#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738
5739#ifdef FEAT_WINDOWS
5740 if (curwin->w_height < p_hh)
5741 win_setheight((int)p_hh);
5742#endif
5743
5744 /*
5745 * Open help file (do_ecmd() will set b_help flag, readfile() will
5746 * set b_p_ro flag).
5747 * Set the alternate file to the previously edited file.
5748 */
5749 alt_fnum = curbuf->b_fnum;
5750 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005751 ECMD_HIDE + ECMD_SET_HELP,
5752#ifdef FEAT_WINDOWS
5753 NULL /* buffer is still open, don't store info */
5754#else
5755 curwin
5756#endif
5757 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005758 if (!cmdmod.keepalt)
5759 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 empty_fnum = curbuf->b_fnum;
5761 }
5762 }
5763
5764 if (!p_im)
5765 restart_edit = 0; /* don't want insert mode in help file */
5766
Bram Moolenaar8f535582011-09-30 17:30:31 +02005767#ifdef FEAT_FOLDING
5768 /* Restore KeyTyped, setting 'filetype=help' may reset it.
5769 * It is needed for do_tag top open folds under the cursor. */
5770 KeyTyped = old_KeyTyped;
5771#endif
5772
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 if (tag != NULL)
5774 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5775
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005776 /* Delete the empty buffer if we're not using it. Careful: autocommands
5777 * may have jumped to another window, check that the buffer is not in a
5778 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5780 {
5781 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005782 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 wipe_buffer(buf, TRUE);
5784 }
5785
5786 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005787 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 curwin->w_alt_fnum = alt_fnum;
5789
5790erret:
5791 vim_free(tag);
5792}
5793
5794
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005795#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5796/*
5797 * In an argument search for a language specifiers in the form "@xx".
5798 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5799 * Returns NULL if not found.
5800 */
5801 char_u *
5802check_help_lang(arg)
5803 char_u *arg;
5804{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005805 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005806
5807 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5808 && ASCII_ISALPHA(arg[len - 1]))
5809 {
5810 arg[len - 3] = NUL; /* remove the '@' */
5811 return arg + len - 2;
5812 }
5813 return NULL;
5814}
5815#endif
5816
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817/*
5818 * Return a heuristic indicating how well the given string matches. The
5819 * smaller the number, the better the match. This is the order of priorities,
5820 * from best match to worst match:
5821 * - Match with least alpha-numeric characters is better.
5822 * - Match with least total characters is better.
5823 * - Match towards the start is better.
5824 * - Match starting with "+" is worse (feature instead of command)
5825 * Assumption is made that the matched_string passed has already been found to
5826 * match some string for which help is requested. webb.
5827 */
5828 int
5829help_heuristic(matched_string, offset, wrong_case)
5830 char_u *matched_string;
5831 int offset; /* offset for match */
5832 int wrong_case; /* no matching case */
5833{
5834 int num_letters;
5835 char_u *p;
5836
5837 num_letters = 0;
5838 for (p = matched_string; *p; p++)
5839 if (ASCII_ISALNUM(*p))
5840 num_letters++;
5841
5842 /*
5843 * Multiply the number of letters by 100 to give it a much bigger
5844 * weighting than the number of characters.
5845 * If there only is a match while ignoring case, add 5000.
5846 * If the match starts in the middle of a word, add 10000 to put it
5847 * somewhere in the last half.
5848 * If the match is more than 2 chars from the start, multiply by 200 to
5849 * put it after matches at the start.
5850 */
5851 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5852 && ASCII_ISALNUM(matched_string[offset - 1]))
5853 offset += 10000;
5854 else if (offset > 2)
5855 offset *= 200;
5856 if (wrong_case)
5857 offset += 5000;
5858 /* Features are less interesting than the subjects themselves, but "+"
5859 * alone is not a feature. */
5860 if (matched_string[0] == '+' && matched_string[1] != NUL)
5861 offset += 100;
5862 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5863}
5864
5865/*
5866 * Compare functions for qsort() below, that checks the help heuristics number
5867 * that has been put after the tagname by find_tags().
5868 */
5869 static int
5870#ifdef __BORLANDC__
5871_RTLENTRYF
5872#endif
5873help_compare(s1, s2)
5874 const void *s1;
5875 const void *s2;
5876{
5877 char *p1;
5878 char *p2;
5879
5880 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5881 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5882 return strcmp(p1, p2);
5883}
5884
5885/*
5886 * Find all help tags matching "arg", sort them and return in matches[], with
5887 * the number of matches in num_matches.
5888 * The matches will be sorted with a "best" match algorithm.
5889 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5890 */
5891 int
5892find_help_tags(arg, num_matches, matches, keep_lang)
5893 char_u *arg;
5894 int *num_matches;
5895 char_u ***matches;
5896 int keep_lang;
5897{
5898 char_u *s, *d;
5899 int i;
5900 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005901 "/*", "/\\*", "\"*", "**",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005902 "cpo-*", "/\\(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005903 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005904 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 "[count]", "[quotex]", "[range]",
5906 "[pattern]", "\\|", "\\%$"};
5907 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005908 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005909 "cpo-star", "/\\\\(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005910 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005911 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 "\\[count]", "\\[quotex]", "\\[range]",
5913 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5914 int flags;
5915
5916 d = IObuff; /* assume IObuff is long enough! */
5917
5918 /*
5919 * Recognize a few exceptions to the rule. Some strings that contain '*'
5920 * with "star". Otherwise '*' is recognized as a wildcard.
5921 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005922 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 if (STRCMP(arg, mtable[i]) == 0)
5924 {
5925 STRCPY(d, rtable[i]);
5926 break;
5927 }
5928
5929 if (i < 0) /* no match in table */
5930 {
5931 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5932 * Also replace "\%^" and "\%(", they match every tag too.
5933 * Also "\zs", "\z1", etc.
5934 * Also "\@<", "\@=", "\@<=", etc.
5935 * And also "\_$" and "\_^". */
5936 if (arg[0] == '\\'
5937 && ((arg[1] != NUL && arg[2] == NUL)
5938 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5939 && arg[2] != NUL)))
5940 {
5941 STRCPY(d, "/\\\\");
5942 STRCPY(d + 3, arg + 1);
5943 /* Check for "/\\_$", should be "/\\_\$" */
5944 if (d[3] == '_' && d[4] == '$')
5945 STRCPY(d + 4, "\\$");
5946 }
5947 else
5948 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005949 /* Replace:
5950 * "[:...:]" with "\[:...:]"
5951 * "[++...]" with "\[++...]"
5952 * "\{" with "\\{"
5953 */
5954 if ((arg[0] == '[' && (arg[1] == ':'
5955 || (arg[1] == '+' && arg[2] == '+')))
5956 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 *d++ = '\\';
5958
5959 for (s = arg; *s; ++s)
5960 {
5961 /*
5962 * Replace "|" with "bar" and '"' with "quote" to match the name of
5963 * the tags for these commands.
5964 * Replace "*" with ".*" and "?" with "." to match command line
5965 * completion.
5966 * Insert a backslash before '~', '$' and '.' to avoid their
5967 * special meaning.
5968 */
5969 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5970 break;
5971 switch (*s)
5972 {
5973 case '|': STRCPY(d, "bar");
5974 d += 3;
5975 continue;
5976 case '"': STRCPY(d, "quote");
5977 d += 5;
5978 continue;
5979 case '*': *d++ = '.';
5980 break;
5981 case '?': *d++ = '.';
5982 continue;
5983 case '$':
5984 case '.':
5985 case '~': *d++ = '\\';
5986 break;
5987 }
5988
5989 /*
5990 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5991 * ":help i_^_CTRL-D" work.
5992 * Insert '-' before and after "CTRL-X" when applicable.
5993 */
5994 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5995 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5996 {
5997 if (d > IObuff && d[-1] != '_')
5998 *d++ = '_'; /* prepend a '_' */
5999 STRCPY(d, "CTRL-");
6000 d += 5;
6001 if (*s < ' ')
6002 {
6003#ifdef EBCDIC
6004 *d++ = CtrlChar(*s);
6005#else
6006 *d++ = *s + '@';
6007#endif
6008 if (d[-1] == '\\')
6009 *d++ = '\\'; /* double a backslash */
6010 }
6011 else
6012 *d++ = *++s;
6013 if (s[1] != NUL && s[1] != '_')
6014 *d++ = '_'; /* append a '_' */
6015 continue;
6016 }
6017 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6018 *d++ = '\\';
6019
6020 /*
6021 * Insert a backslash before a backslash after a slash, for search
6022 * pattern tags: "/\|" --> "/\\|".
6023 */
6024 else if (s[0] == '\\' && s[1] != '\\'
6025 && *arg == '/' && s == arg + 1)
6026 *d++ = '\\';
6027
6028 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6029 * "CTRL-\_CTRL-N" */
6030 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6031 {
6032 STRCPY(d, "CTRL-\\\\");
6033 d += 7;
6034 s += 6;
6035 }
6036
6037 *d++ = *s;
6038
6039 /*
6040 * If tag starts with ', toss everything after a second '. Fixes
6041 * CTRL-] on 'option'. (would include the trailing '.').
6042 */
6043 if (*s == '\'' && s > arg && *arg == '\'')
6044 break;
6045 }
6046 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006047
6048 if (*IObuff == '`')
6049 {
6050 if (d > IObuff + 2 && d[-1] == '`')
6051 {
6052 /* remove the backticks from `command` */
6053 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6054 d[-2] = NUL;
6055 }
6056 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6057 {
6058 /* remove the backticks and comma from `command`, */
6059 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6060 d[-3] = NUL;
6061 }
6062 else if (d > IObuff + 4 && d[-3] == '`'
6063 && d[-2] == '\\' && d[-1] == '.')
6064 {
6065 /* remove the backticks and dot from `command`\. */
6066 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6067 d[-4] = NUL;
6068 }
6069 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 }
6071 }
6072
6073 *matches = (char_u **)"";
6074 *num_matches = 0;
6075 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6076 if (keep_lang)
6077 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006078 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006080 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 /* Sort the matches found on the heuristic number that is after the
6082 * tag name. */
6083 qsort((void *)*matches, (size_t)*num_matches,
6084 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006085 /* Delete more than TAG_MANY to reduce the size of the listing. */
6086 while (*num_matches > TAG_MANY)
6087 vim_free((*matches)[--*num_matches]);
6088 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 return OK;
6090}
6091
6092/*
6093 * After reading a help file: May cleanup a help buffer when syntax
6094 * highlighting is not used.
6095 */
6096 void
6097fix_help_buffer()
6098{
6099 linenr_T lnum;
6100 char_u *line;
6101 int in_example = FALSE;
6102 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006103 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 char_u *p;
6105 char_u *rt;
6106 int mustfree;
6107
6108 /* set filetype to "help". */
6109 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6110
6111#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006112 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006113#endif
6114 {
6115 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6116 {
6117 line = ml_get_buf(curbuf, lnum, FALSE);
6118 len = (int)STRLEN(line);
6119 if (in_example && len > 0 && !vim_iswhite(line[0]))
6120 {
6121 /* End of example: non-white or '<' in first column. */
6122 if (line[0] == '<')
6123 {
6124 /* blank-out a '<' in the first column */
6125 line = ml_get_buf(curbuf, lnum, TRUE);
6126 line[0] = ' ';
6127 }
6128 in_example = FALSE;
6129 }
6130 if (!in_example && len > 0)
6131 {
6132 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6133 {
6134 /* blank-out a '>' in the last column (start of example) */
6135 line = ml_get_buf(curbuf, lnum, TRUE);
6136 line[len - 1] = ' ';
6137 in_example = TRUE;
6138 }
6139 else if (line[len - 1] == '~')
6140 {
6141 /* blank-out a '~' at the end of line (header marker) */
6142 line = ml_get_buf(curbuf, lnum, TRUE);
6143 line[len - 1] = ' ';
6144 }
6145 }
6146 }
6147 }
6148
6149 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006150 * In the "help.txt" and "help.abx" file, add the locally added help
6151 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006153 fname = gettail(curbuf->b_fname);
6154 if (fnamecmp(fname, "help.txt") == 0
6155#ifdef FEAT_MULTI_LANG
6156 || (fnamencmp(fname, "help.", 5) == 0
6157 && ASCII_ISALPHA(fname[5])
6158 && ASCII_ISALPHA(fname[6])
6159 && TOLOWER_ASC(fname[7]) == 'x'
6160 && fname[8] == NUL)
6161#endif
6162 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 {
6164 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6165 {
6166 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006167 if (strstr((char *)line, "*local-additions*") == NULL)
6168 continue;
6169
6170 /* Go through all directories in 'runtimepath', skipping
6171 * $VIMRUNTIME. */
6172 p = p_rtp;
6173 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006175 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6176 mustfree = FALSE;
6177 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6178 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006180 int fcount;
6181 char_u **fnames;
6182 FILE *fd;
6183 char_u *s;
6184 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006186 vimconv_T vc;
6187 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188#endif
6189
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006190 /* Find all "doc/ *.txt" files in this directory. */
6191 add_pathsep(NameBuff);
6192#ifdef FEAT_MULTI_LANG
6193 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006195 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006197 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6198 &fnames, EW_FILE|EW_SILENT) == OK
6199 && fcount > 0)
6200 {
6201#ifdef FEAT_MULTI_LANG
6202 int i1;
6203 int i2;
6204 char_u *f1;
6205 char_u *f2;
6206 char_u *t1;
6207 char_u *e1;
6208 char_u *e2;
6209
6210 /* If foo.abx is found use it instead of foo.txt in
6211 * the same directory. */
6212 for (i1 = 0; i1 < fcount; ++i1)
6213 {
6214 for (i2 = 0; i2 < fcount; ++i2)
6215 {
6216 if (i1 == i2)
6217 continue;
6218 if (fnames[i1] == NULL || fnames[i2] == NULL)
6219 continue;
6220 f1 = fnames[i1];
6221 f2 = fnames[i2];
6222 t1 = gettail(f1);
6223 if (fnamencmp(f1, f2, t1 - f1) != 0)
6224 continue;
6225 e1 = vim_strrchr(t1, '.');
6226 e2 = vim_strrchr(gettail(f2), '.');
6227 if (e1 == NUL || e2 == NUL)
6228 continue;
6229 if (fnamecmp(e1, ".txt") != 0
6230 && fnamecmp(e1, fname + 4) != 0)
6231 {
6232 /* Not .txt and not .abx, remove it. */
6233 vim_free(fnames[i1]);
6234 fnames[i1] = NULL;
6235 continue;
6236 }
6237 if (fnamencmp(f1, f2, e1 - f1) != 0)
6238 continue;
6239 if (fnamecmp(e1, ".txt") == 0
6240 && fnamecmp(e2, fname + 4) == 0)
6241 {
6242 /* use .abx instead of .txt */
6243 vim_free(fnames[i1]);
6244 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 }
6246 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006248#endif
6249 for (fi = 0; fi < fcount; ++fi)
6250 {
6251 if (fnames[fi] == NULL)
6252 continue;
6253 fd = mch_fopen((char *)fnames[fi], "r");
6254 if (fd != NULL)
6255 {
6256 vim_fgets(IObuff, IOSIZE, fd);
6257 if (IObuff[0] == '*'
6258 && (s = vim_strchr(IObuff + 1, '*'))
6259 != NULL)
6260 {
6261#ifdef FEAT_MBYTE
6262 int this_utf = MAYBE;
6263#endif
6264 /* Change tag definition to a
6265 * reference and remove <CR>/<NL>. */
6266 IObuff[0] = '|';
6267 *s = '|';
6268 while (*s != NUL)
6269 {
6270 if (*s == '\r' || *s == '\n')
6271 *s = NUL;
6272#ifdef FEAT_MBYTE
6273 /* The text is utf-8 when a byte
6274 * above 127 is found and no
6275 * illegal byte sequence is found.
6276 */
6277 if (*s >= 0x80 && this_utf != FALSE)
6278 {
6279 int l;
6280
6281 this_utf = TRUE;
6282 l = utf_ptr2len(s);
6283 if (l == 1)
6284 this_utf = FALSE;
6285 s += l - 1;
6286 }
6287#endif
6288 ++s;
6289 }
6290#ifdef FEAT_MBYTE
6291 /* The help file is latin1 or utf-8;
6292 * conversion to the current
6293 * 'encoding' may be required. */
6294 vc.vc_type = CONV_NONE;
6295 convert_setup(&vc, (char_u *)(
6296 this_utf == TRUE ? "utf-8"
6297 : "latin1"), p_enc);
6298 if (vc.vc_type == CONV_NONE)
6299 /* No conversion needed. */
6300 cp = IObuff;
6301 else
6302 {
6303 /* Do the conversion. If it fails
6304 * use the unconverted text. */
6305 cp = string_convert(&vc, IObuff,
6306 NULL);
6307 if (cp == NULL)
6308 cp = IObuff;
6309 }
6310 convert_setup(&vc, NULL, NULL);
6311
6312 ml_append(lnum, cp, (colnr_T)0, FALSE);
6313 if (cp != IObuff)
6314 vim_free(cp);
6315#else
6316 ml_append(lnum, IObuff, (colnr_T)0,
6317 FALSE);
6318#endif
6319 ++lnum;
6320 }
6321 fclose(fd);
6322 }
6323 }
6324 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006327 if (mustfree)
6328 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006330 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 }
6332 }
6333}
6334
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006335/*
6336 * ":exusage"
6337 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006338 void
6339ex_exusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006340 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006341{
6342 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6343}
6344
6345/*
6346 * ":viusage"
6347 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006348 void
6349ex_viusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006350 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006351{
6352 do_cmdline_cmd((char_u *)"help normal-index");
6353}
6354
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355#if defined(FEAT_EX_EXTRA) || defined(PROTO)
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006356static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357
6358/*
6359 * ":helptags"
6360 */
6361 void
6362ex_helptags(eap)
6363 exarg_T *eap;
6364{
6365 garray_T ga;
6366 int i, j;
6367 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006368#ifdef FEAT_MULTI_LANG
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 char_u lang[2];
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006370#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006371 expand_T xpc;
6372 char_u *dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 char_u ext[5];
6374 char_u fname[8];
6375 int filecount;
6376 char_u **files;
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006377 int add_help_tags = FALSE;
6378
6379 /* Check for ":helptags ++t {dir}". */
6380 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6381 {
6382 add_help_tags = TRUE;
6383 eap->arg = skipwhite(eap->arg + 3);
6384 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385
Bram Moolenaar0e253142008-01-13 12:31:34 +00006386 ExpandInit(&xpc);
6387 xpc.xp_context = EXPAND_DIRECTORIES;
6388 dirname = ExpandOne(&xpc, eap->arg, NULL,
6389 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6390 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 {
6392 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6393 return;
6394 }
6395
6396#ifdef FEAT_MULTI_LANG
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006397 /* Get a list of all files in the help directory and in subdirectories. */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006398 STRCPY(NameBuff, dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 add_pathsep(NameBuff);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006400 STRCAT(NameBuff, "**");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6402 EW_FILE|EW_SILENT) == FAIL
6403 || filecount == 0)
6404 {
6405 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar0e253142008-01-13 12:31:34 +00006406 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 return;
6408 }
6409
6410 /* Go over all files in the directory to find out what languages are
6411 * present. */
6412 ga_init2(&ga, 1, 10);
6413 for (i = 0; i < filecount; ++i)
6414 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006415 len = (int)STRLEN(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 if (len > 4)
6417 {
6418 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6419 {
6420 /* ".txt" -> language "en" */
6421 lang[0] = 'e';
6422 lang[1] = 'n';
6423 }
6424 else if (files[i][len - 4] == '.'
6425 && ASCII_ISALPHA(files[i][len - 3])
6426 && ASCII_ISALPHA(files[i][len - 2])
6427 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6428 {
6429 /* ".abx" -> language "ab" */
6430 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6431 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6432 }
6433 else
6434 continue;
6435
6436 /* Did we find this language already? */
6437 for (j = 0; j < ga.ga_len; j += 2)
6438 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6439 break;
6440 if (j == ga.ga_len)
6441 {
6442 /* New language, add it. */
6443 if (ga_grow(&ga, 2) == FAIL)
6444 break;
6445 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6446 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 }
6448 }
6449 }
6450
6451 /*
6452 * Loop over the found languages to generate a tags file for each one.
6453 */
6454 for (j = 0; j < ga.ga_len; j += 2)
6455 {
6456 STRCPY(fname, "tags-xx");
6457 fname[5] = ((char_u *)ga.ga_data)[j];
6458 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6459 if (fname[5] == 'e' && fname[6] == 'n')
6460 {
6461 /* English is an exception: use ".txt" and "tags". */
6462 fname[4] = NUL;
6463 STRCPY(ext, ".txt");
6464 }
6465 else
6466 {
6467 /* Language "ab" uses ".abx" and "tags-ab". */
6468 STRCPY(ext, ".xxx");
6469 ext[1] = fname[5];
6470 ext[2] = fname[6];
6471 }
Bram Moolenaar0e253142008-01-13 12:31:34 +00006472 helptags_one(dirname, ext, fname, add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 }
6474
6475 ga_clear(&ga);
6476 FreeWild(filecount, files);
6477
6478#else
6479 /* No language support, just use "*.txt" and "tags". */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006480 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006482 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483}
6484
6485 static void
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006486helptags_one(dir, ext, tagfname, add_help_tags)
6487 char_u *dir; /* doc directory */
6488 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006489 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6490 int add_help_tags; /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491{
6492 FILE *fd_tags;
6493 FILE *fd;
6494 garray_T ga;
6495 int filecount;
6496 char_u **files;
6497 char_u *p1, *p2;
6498 int fi;
6499 char_u *s;
6500 int i;
6501 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006502 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503# ifdef FEAT_MBYTE
6504 int utf8 = MAYBE;
6505 int this_utf8;
6506 int firstline;
6507 int mix = FALSE; /* detected mixed encodings */
6508# endif
6509
6510 /*
6511 * Find all *.txt files.
6512 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01006513 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006515 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 STRCAT(NameBuff, ext);
6517 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6518 EW_FILE|EW_SILENT) == FAIL
6519 || filecount == 0)
6520 {
6521 if (!got_int)
6522 EMSG2("E151: No match: %s", NameBuff);
6523 return;
6524 }
6525
6526 /*
6527 * Open the tags file for writing.
6528 * Do this before scanning through all the files.
6529 */
6530 STRCPY(NameBuff, dir);
6531 add_pathsep(NameBuff);
6532 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006533 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 if (fd_tags == NULL)
6535 {
6536 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6537 FreeWild(filecount, files);
6538 return;
6539 }
6540
6541 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006542 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6543 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 */
6545 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006546 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6547 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 {
6549 if (ga_grow(&ga, 1) == FAIL)
6550 got_int = TRUE;
6551 else
6552 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006553 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 if (s == NULL)
6555 got_int = TRUE;
6556 else
6557 {
6558 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6559 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6560 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 }
6562 }
6563 }
6564
6565 /*
6566 * Go over all the files and extract the tags.
6567 */
6568 for (fi = 0; fi < filecount && !got_int; ++fi)
6569 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006570 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 if (fd == NULL)
6572 {
6573 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6574 continue;
6575 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006576 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577
6578# ifdef FEAT_MBYTE
6579 firstline = TRUE;
6580# endif
6581 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6582 {
6583# ifdef FEAT_MBYTE
6584 if (firstline)
6585 {
6586 /* Detect utf-8 file by a non-ASCII char in the first line. */
6587 this_utf8 = MAYBE;
6588 for (s = IObuff; *s != NUL; ++s)
6589 if (*s >= 0x80)
6590 {
6591 int l;
6592
6593 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006594 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 if (l == 1)
6596 {
6597 /* Illegal UTF-8 byte sequence. */
6598 this_utf8 = FALSE;
6599 break;
6600 }
6601 s += l - 1;
6602 }
6603 if (this_utf8 == MAYBE) /* only ASCII characters found */
6604 this_utf8 = FALSE;
6605 if (utf8 == MAYBE) /* first file */
6606 utf8 = this_utf8;
6607 else if (utf8 != this_utf8)
6608 {
6609 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6610 mix = !got_int;
6611 got_int = TRUE;
6612 }
6613 firstline = FALSE;
6614 }
6615# endif
6616 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6617 while (p1 != NULL)
6618 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02006619 /* Use vim_strbyte() instead of vim_strchr() so that when
6620 * 'encoding' is dbcs it still works, don't find '*' in the
6621 * second byte. */
6622 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6624 {
6625 for (s = p1 + 1; s < p2; ++s)
6626 if (*s == ' ' || *s == '\t' || *s == '|')
6627 break;
6628
6629 /*
6630 * Only accept a *tag* when it consists of valid
6631 * characters, there is white space before it and is
6632 * followed by a white character or end-of-line.
6633 */
6634 if (s == p2
6635 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6636 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6637 || s[1] == '\0'))
6638 {
6639 *p2 = '\0';
6640 ++p1;
6641 if (ga_grow(&ga, 1) == FAIL)
6642 {
6643 got_int = TRUE;
6644 break;
6645 }
6646 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6647 if (s == NULL)
6648 {
6649 got_int = TRUE;
6650 break;
6651 }
6652 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6653 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 sprintf((char *)s, "%s\t%s", p1, fname);
6655
6656 /* find next '*' */
6657 p2 = vim_strchr(p2 + 1, '*');
6658 }
6659 }
6660 p1 = p2;
6661 }
6662 line_breakcheck();
6663 }
6664
6665 fclose(fd);
6666 }
6667
6668 FreeWild(filecount, files);
6669
6670 if (!got_int)
6671 {
6672 /*
6673 * Sort the tags.
6674 */
6675 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6676
6677 /*
6678 * Check for duplicates.
6679 */
6680 for (i = 1; i < ga.ga_len; ++i)
6681 {
6682 p1 = ((char_u **)ga.ga_data)[i - 1];
6683 p2 = ((char_u **)ga.ga_data)[i];
6684 while (*p1 == *p2)
6685 {
6686 if (*p2 == '\t')
6687 {
6688 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006689 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6691 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6692 EMSG(NameBuff);
6693 *p2 = '\t';
6694 break;
6695 }
6696 ++p1;
6697 ++p2;
6698 }
6699 }
6700
6701# ifdef FEAT_MBYTE
6702 if (utf8 == TRUE)
6703 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6704# endif
6705
6706 /*
6707 * Write the tags into the file.
6708 */
6709 for (i = 0; i < ga.ga_len; ++i)
6710 {
6711 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006712 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006714 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 else
6716 {
6717 fprintf(fd_tags, "%s\t/*", s);
6718 for (p1 = s; *p1 != '\t'; ++p1)
6719 {
6720 /* insert backslash before '\\' and '/' */
6721 if (*p1 == '\\' || *p1 == '/')
6722 putc('\\', fd_tags);
6723 putc(*p1, fd_tags);
6724 }
6725 fprintf(fd_tags, "*\n");
6726 }
6727 }
6728 }
6729#ifdef FEAT_MBYTE
6730 if (mix)
6731 got_int = FALSE; /* continue with other languages */
6732#endif
6733
6734 for (i = 0; i < ga.ga_len; ++i)
6735 vim_free(((char_u **)ga.ga_data)[i]);
6736 ga_clear(&ga);
6737 fclose(fd_tags); /* there is no check for an error... */
6738}
6739#endif
6740
6741#if defined(FEAT_SIGNS) || defined(PROTO)
6742
6743/*
6744 * Struct to hold the sign properties.
6745 */
6746typedef struct sign sign_T;
6747
6748struct sign
6749{
6750 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02006751 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 char_u *sn_name; /* name of sign */
6753 char_u *sn_icon; /* name of pixmap */
6754#ifdef FEAT_SIGN_ICONS
6755 void *sn_image; /* icon image */
6756#endif
6757 char_u *sn_text; /* text used instead of pixmap */
6758 int sn_line_hl; /* highlight ID for line */
6759 int sn_text_hl; /* highlight ID for text */
6760};
6761
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006763static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764
Bram Moolenaar985cb442009-05-14 19:51:46 +00006765static int sign_cmd_idx __ARGS((char_u *begin_cmd, char_u *end_cmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766static void sign_list_defined __ARGS((sign_T *sp));
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006767static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006769static char *cmds[] = {
6770 "define",
6771#define SIGNCMD_DEFINE 0
6772 "undefine",
6773#define SIGNCMD_UNDEFINE 1
6774 "list",
6775#define SIGNCMD_LIST 2
6776 "place",
6777#define SIGNCMD_PLACE 3
6778 "unplace",
6779#define SIGNCMD_UNPLACE 4
6780 "jump",
6781#define SIGNCMD_JUMP 5
6782 NULL
6783#define SIGNCMD_LAST 6
6784};
6785
6786/*
6787 * Find index of a ":sign" subcmd from its name.
6788 * "*end_cmd" must be writable.
6789 */
6790 static int
6791sign_cmd_idx(begin_cmd, end_cmd)
Bram Moolenaar985cb442009-05-14 19:51:46 +00006792 char_u *begin_cmd; /* begin of sign subcmd */
6793 char_u *end_cmd; /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006794{
6795 int idx;
6796 char save = *end_cmd;
6797
6798 *end_cmd = NUL;
6799 for (idx = 0; ; ++idx)
6800 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6801 break;
6802 *end_cmd = save;
6803 return idx;
6804}
6805
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806/*
6807 * ":sign" command
6808 */
6809 void
6810ex_sign(eap)
6811 exarg_T *eap;
6812{
6813 char_u *arg = eap->arg;
6814 char_u *p;
6815 int idx;
6816 sign_T *sp;
6817 sign_T *sp_prev;
6818 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819
6820 /* Parse the subcommand. */
6821 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006822 idx = sign_cmd_idx(arg, p);
6823 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006825 EMSG2(_("E160: Unknown sign command: %s"), arg);
6826 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 }
6828 arg = skipwhite(p);
6829
6830 if (idx <= SIGNCMD_LIST)
6831 {
6832 /*
6833 * Define, undefine or list signs.
6834 */
6835 if (idx == SIGNCMD_LIST && *arg == NUL)
6836 {
6837 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01006838 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 sign_list_defined(sp);
6840 }
6841 else if (*arg == NUL)
6842 EMSG(_("E156: Missing sign name"));
6843 else
6844 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006845 /* Isolate the sign name. If it's a number skip leading zeroes,
6846 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 p = skiptowhite(arg);
6848 if (*p != NUL)
6849 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006850 while (arg[0] == '0' && arg[1] != NUL)
6851 ++arg;
6852
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 sp_prev = NULL;
6854 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6855 {
6856 if (STRCMP(sp->sn_name, arg) == 0)
6857 break;
6858 sp_prev = sp;
6859 }
6860 if (idx == SIGNCMD_DEFINE)
6861 {
6862 /* ":sign define {name} ...": define a sign */
6863 if (sp == NULL)
6864 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006865 sign_T *lp;
6866 int start = next_sign_typenr;
6867
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 /* Allocate a new sign. */
6869 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6870 if (sp == NULL)
6871 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006873 /* Check that next_sign_typenr is not already being used.
6874 * This only happens after wrapping around. Hopefully
6875 * another one got deleted and we can use its number. */
6876 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006878 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006880 ++next_sign_typenr;
6881 if (next_sign_typenr == MAX_TYPENR)
6882 next_sign_typenr = 1;
6883 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006885 vim_free(sp);
6886 EMSG(_("E612: Too many signs defined"));
6887 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006889 lp = first_sign; /* start all over */
6890 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006892 lp = lp->sn_next;
6893 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006895 sp->sn_typenr = next_sign_typenr;
6896 if (++next_sign_typenr == MAX_TYPENR)
6897 next_sign_typenr = 1; /* wrap around */
6898
6899 sp->sn_name = vim_strsave(arg);
6900 if (sp->sn_name == NULL) /* out of memory */
6901 {
6902 vim_free(sp);
6903 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02006905
6906 /* add the new sign to the list of signs */
6907 if (sp_prev == NULL)
6908 first_sign = sp;
6909 else
6910 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 }
6912
6913 /* set values for a defined sign. */
6914 for (;;)
6915 {
6916 arg = skipwhite(p);
6917 if (*arg == NUL)
6918 break;
6919 p = skiptowhite_esc(arg);
6920 if (STRNCMP(arg, "icon=", 5) == 0)
6921 {
6922 arg += 5;
6923 vim_free(sp->sn_icon);
6924 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6925 backslash_halve(sp->sn_icon);
6926#ifdef FEAT_SIGN_ICONS
6927 if (gui.in_use)
6928 {
6929 out_flush();
6930 if (sp->sn_image != NULL)
6931 gui_mch_destroy_sign(sp->sn_image);
6932 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6933 }
6934#endif
6935 }
6936 else if (STRNCMP(arg, "text=", 5) == 0)
6937 {
6938 char_u *s;
6939 int cells;
6940 int len;
6941
6942 arg += 5;
6943#ifdef FEAT_MBYTE
6944 /* Count cells and check for non-printable chars */
6945 if (has_mbyte)
6946 {
6947 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006948 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 {
6950 if (!vim_isprintc((*mb_ptr2char)(s)))
6951 break;
6952 cells += (*mb_ptr2cells)(s);
6953 }
6954 }
6955 else
6956#endif
6957 {
6958 for (s = arg; s < p; ++s)
6959 if (!vim_isprintc(*s))
6960 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006961 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 }
6963 /* Currently must be one or two display cells */
6964 if (s != p || cells < 1 || cells > 2)
6965 {
6966 *p = NUL;
6967 EMSG2(_("E239: Invalid sign text: %s"), arg);
6968 return;
6969 }
6970
6971 vim_free(sp->sn_text);
6972 /* Allocate one byte more if we need to pad up
6973 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006974 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 sp->sn_text = vim_strnsave(arg, len);
6976
6977 if (sp->sn_text != NULL && cells == 1)
6978 STRCPY(sp->sn_text + len - 1, " ");
6979 }
6980 else if (STRNCMP(arg, "linehl=", 7) == 0)
6981 {
6982 arg += 7;
6983 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6984 }
6985 else if (STRNCMP(arg, "texthl=", 7) == 0)
6986 {
6987 arg += 7;
6988 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6989 }
6990 else
6991 {
6992 EMSG2(_(e_invarg2), arg);
6993 return;
6994 }
6995 }
6996 }
6997 else if (sp == NULL)
6998 EMSG2(_("E155: Unknown sign: %s"), arg);
6999 else if (idx == SIGNCMD_LIST)
7000 /* ":sign list {name}" */
7001 sign_list_defined(sp);
7002 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007004 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 }
7006 }
7007 else
7008 {
7009 int id = -1;
7010 linenr_T lnum = -1;
7011 char_u *sign_name = NULL;
7012 char_u *arg1;
7013
7014 if (*arg == NUL)
7015 {
7016 if (idx == SIGNCMD_PLACE)
7017 {
7018 /* ":sign place": list placed signs in all buffers */
7019 sign_list_placed(NULL);
7020 }
7021 else if (idx == SIGNCMD_UNPLACE)
7022 {
7023 /* ":sign unplace": remove placed sign at cursor */
7024 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7025 if (id > 0)
7026 {
7027 buf_delsign(curwin->w_buffer, id);
7028 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7029 }
7030 else
7031 EMSG(_("E159: Missing sign number"));
7032 }
7033 else
7034 EMSG(_(e_argreq));
7035 return;
7036 }
7037
7038 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7039 {
7040 /* ":sign unplace *": remove all placed signs */
7041 buf_delete_all_signs();
7042 return;
7043 }
7044
7045 /* first arg could be placed sign id */
7046 arg1 = arg;
7047 if (VIM_ISDIGIT(*arg))
7048 {
7049 id = getdigits(&arg);
7050 if (!vim_iswhite(*arg) && *arg != NUL)
7051 {
7052 id = -1;
7053 arg = arg1;
7054 }
7055 else
7056 {
7057 arg = skipwhite(arg);
7058 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7059 {
7060 /* ":sign unplace {id}": remove placed sign by number */
7061 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
7062 if ((lnum = buf_delsign(buf, id)) != 0)
7063 update_debug_sign(buf, lnum);
7064 return;
7065 }
7066 }
7067 }
7068
7069 /*
7070 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7071 * Leave "arg" pointing to {fname}.
7072 */
7073 for (;;)
7074 {
7075 if (STRNCMP(arg, "line=", 5) == 0)
7076 {
7077 arg += 5;
7078 lnum = atoi((char *)arg);
7079 arg = skiptowhite(arg);
7080 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007081 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7082 {
7083 if (id != -1)
7084 {
7085 EMSG(_(e_invarg));
7086 return;
7087 }
7088 id = -2;
7089 arg = skiptowhite(arg + 1);
7090 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 else if (STRNCMP(arg, "name=", 5) == 0)
7092 {
7093 arg += 5;
7094 sign_name = arg;
7095 arg = skiptowhite(arg);
7096 if (*arg != NUL)
7097 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007098 while (sign_name[0] == '0' && sign_name[1] != NUL)
7099 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 }
7101 else if (STRNCMP(arg, "file=", 5) == 0)
7102 {
7103 arg += 5;
7104 buf = buflist_findname(arg);
7105 break;
7106 }
7107 else if (STRNCMP(arg, "buffer=", 7) == 0)
7108 {
7109 arg += 7;
7110 buf = buflist_findnr((int)getdigits(&arg));
7111 if (*skipwhite(arg) != NUL)
7112 EMSG(_(e_trailing));
7113 break;
7114 }
7115 else
7116 {
7117 EMSG(_(e_invarg));
7118 return;
7119 }
7120 arg = skipwhite(arg);
7121 }
7122
7123 if (buf == NULL)
7124 {
7125 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7126 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007127 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 {
7129 if (lnum >= 0 || sign_name != NULL)
7130 EMSG(_(e_invarg));
7131 else
7132 /* ":sign place file={fname}": list placed signs in one file */
7133 sign_list_placed(buf);
7134 }
7135 else if (idx == SIGNCMD_JUMP)
7136 {
7137 /* ":sign jump {id} file={fname}" */
7138 if (lnum >= 0 || sign_name != NULL)
7139 EMSG(_(e_invarg));
7140 else if ((lnum = buf_findsign(buf, id)) > 0)
7141 { /* goto a sign ... */
7142 if (buf_jump_open_win(buf) != NULL)
7143 { /* ... in a current window */
7144 curwin->w_cursor.lnum = lnum;
7145 check_cursor_lnum();
7146 beginline(BL_WHITE);
7147 }
7148 else
7149 { /* ... not currently in a window */
7150 char_u *cmd;
7151
7152 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7153 if (cmd == NULL)
7154 return;
7155 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7156 do_cmdline_cmd(cmd);
7157 vim_free(cmd);
7158 }
7159#ifdef FEAT_FOLDING
7160 foldOpenCursor();
7161#endif
7162 }
7163 else
7164 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7165 }
7166 else if (idx == SIGNCMD_UNPLACE)
7167 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 if (lnum >= 0 || sign_name != NULL)
7169 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007170 else if (id == -2)
7171 {
7172 /* ":sign unplace * file={fname}" */
7173 redraw_buf_later(buf, NOT_VALID);
7174 buf_delete_signs(buf);
7175 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 else
7177 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007178 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 lnum = buf_delsign(buf, id);
7180 update_debug_sign(buf, lnum);
7181 }
7182 }
7183 /* idx == SIGNCMD_PLACE */
7184 else if (sign_name != NULL)
7185 {
7186 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7187 if (STRCMP(sp->sn_name, sign_name) == 0)
7188 break;
7189 if (sp == NULL)
7190 {
7191 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7192 return;
7193 }
7194 if (lnum > 0)
7195 /* ":sign place {id} line={lnum} name={name} file={fname}":
7196 * place a sign */
7197 buf_addsign(buf, id, lnum, sp->sn_typenr);
7198 else
7199 /* ":sign place {id} file={fname}": change sign type */
7200 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
7201 update_debug_sign(buf, lnum);
7202 }
7203 else
7204 EMSG(_(e_invarg));
7205 }
7206}
7207
7208#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7209/*
7210 * Allocate the icons. Called when the GUI has started. Allows defining
7211 * signs before it starts.
7212 */
7213 void
7214sign_gui_started()
7215{
7216 sign_T *sp;
7217
7218 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7219 if (sp->sn_icon != NULL)
7220 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7221}
7222#endif
7223
7224/*
7225 * List one sign.
7226 */
7227 static void
7228sign_list_defined(sp)
7229 sign_T *sp;
7230{
7231 char_u *p;
7232
Bram Moolenaar555b2802005-05-19 21:08:39 +00007233 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 if (sp->sn_icon != NULL)
7235 {
7236 MSG_PUTS(" icon=");
7237 msg_outtrans(sp->sn_icon);
7238#ifdef FEAT_SIGN_ICONS
7239 if (sp->sn_image == NULL)
7240 MSG_PUTS(_(" (NOT FOUND)"));
7241#else
7242 MSG_PUTS(_(" (not supported)"));
7243#endif
7244 }
7245 if (sp->sn_text != NULL)
7246 {
7247 MSG_PUTS(" text=");
7248 msg_outtrans(sp->sn_text);
7249 }
7250 if (sp->sn_line_hl > 0)
7251 {
7252 MSG_PUTS(" linehl=");
7253 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7254 if (p == NULL)
7255 MSG_PUTS("NONE");
7256 else
7257 msg_puts(p);
7258 }
7259 if (sp->sn_text_hl > 0)
7260 {
7261 MSG_PUTS(" texthl=");
7262 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7263 if (p == NULL)
7264 MSG_PUTS("NONE");
7265 else
7266 msg_puts(p);
7267 }
7268}
7269
7270/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007271 * Undefine a sign and free its memory.
7272 */
7273 static void
7274sign_undefine(sp, sp_prev)
7275 sign_T *sp;
7276 sign_T *sp_prev;
7277{
7278 vim_free(sp->sn_name);
7279 vim_free(sp->sn_icon);
7280#ifdef FEAT_SIGN_ICONS
7281 if (sp->sn_image != NULL)
7282 {
7283 out_flush();
7284 gui_mch_destroy_sign(sp->sn_image);
7285 }
7286#endif
7287 vim_free(sp->sn_text);
7288 if (sp_prev == NULL)
7289 first_sign = sp->sn_next;
7290 else
7291 sp_prev->sn_next = sp->sn_next;
7292 vim_free(sp);
7293}
7294
7295/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 * Get highlighting attribute for sign "typenr".
7297 * If "line" is TRUE: line highl, if FALSE: text highl.
7298 */
7299 int
7300sign_get_attr(typenr, line)
7301 int typenr;
7302 int line;
7303{
7304 sign_T *sp;
7305
7306 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7307 if (sp->sn_typenr == typenr)
7308 {
7309 if (line)
7310 {
7311 if (sp->sn_line_hl > 0)
7312 return syn_id2attr(sp->sn_line_hl);
7313 }
7314 else
7315 {
7316 if (sp->sn_text_hl > 0)
7317 return syn_id2attr(sp->sn_text_hl);
7318 }
7319 break;
7320 }
7321 return 0;
7322}
7323
7324/*
7325 * Get text mark for sign "typenr".
7326 * Returns NULL if there isn't one.
7327 */
7328 char_u *
7329sign_get_text(typenr)
7330 int typenr;
7331{
7332 sign_T *sp;
7333
7334 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7335 if (sp->sn_typenr == typenr)
7336 return sp->sn_text;
7337 return NULL;
7338}
7339
7340#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7341 void *
7342sign_get_image(typenr)
7343 int typenr; /* the attribute which may have a sign */
7344{
7345 sign_T *sp;
7346
7347 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7348 if (sp->sn_typenr == typenr)
7349 return sp->sn_image;
7350 return NULL;
7351}
7352#endif
7353
7354/*
7355 * Get the name of a sign by its typenr.
7356 */
7357 char_u *
7358sign_typenr2name(typenr)
7359 int typenr;
7360{
7361 sign_T *sp;
7362
7363 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7364 if (sp->sn_typenr == typenr)
7365 return sp->sn_name;
7366 return (char_u *)_("[Deleted]");
7367}
7368
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007369#if defined(EXITFREE) || defined(PROTO)
7370/*
7371 * Undefine/free all signs.
7372 */
7373 void
7374free_signs()
7375{
7376 while (first_sign != NULL)
7377 sign_undefine(first_sign, NULL);
7378}
7379#endif
7380
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007381#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7382static enum
7383{
7384 EXP_SUBCMD, /* expand :sign sub-commands */
7385 EXP_DEFINE, /* expand :sign define {name} args */
7386 EXP_PLACE, /* expand :sign place {id} args */
7387 EXP_UNPLACE, /* expand :sign unplace" */
7388 EXP_SIGN_NAMES /* expand with name of placed signs */
7389} expand_what;
7390
7391/*
7392 * Function given to ExpandGeneric() to obtain the sign command
7393 * expansion.
7394 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007395 char_u *
7396get_sign_name(xp, idx)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00007397 expand_T *xp UNUSED;
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007398 int idx;
7399{
7400 sign_T *sp;
7401 int current_idx;
7402
7403 switch (expand_what)
7404 {
7405 case EXP_SUBCMD:
7406 return (char_u *)cmds[idx];
7407 case EXP_DEFINE:
7408 {
7409 char *define_arg[] =
7410 {
7411 "icon=", "linehl=", "text=", "texthl=", NULL
7412 };
7413 return (char_u *)define_arg[idx];
7414 }
7415 case EXP_PLACE:
7416 {
7417 char *place_arg[] =
7418 {
7419 "line=", "name=", "file=", "buffer=", NULL
7420 };
7421 return (char_u *)place_arg[idx];
7422 }
7423 case EXP_UNPLACE:
7424 {
7425 char *unplace_arg[] = { "file=", "buffer=", NULL };
7426 return (char_u *)unplace_arg[idx];
7427 }
7428 case EXP_SIGN_NAMES:
7429 /* Complete with name of signs already defined */
7430 current_idx = 0;
7431 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7432 if (current_idx++ == idx)
7433 return sp->sn_name;
7434 return NULL;
7435 default:
7436 return NULL;
7437 }
7438}
7439
7440/*
7441 * Handle command line completion for :sign command.
7442 */
7443 void
7444set_context_in_sign_cmd(xp, arg)
7445 expand_T *xp;
7446 char_u *arg;
7447{
7448 char_u *p;
7449 char_u *end_subcmd;
7450 char_u *last;
7451 int cmd_idx;
7452 char_u *begin_subcmd_args;
7453
7454 /* Default: expand subcommands. */
7455 xp->xp_context = EXPAND_SIGN;
7456 expand_what = EXP_SUBCMD;
7457 xp->xp_pattern = arg;
7458
7459 end_subcmd = skiptowhite(arg);
7460 if (*end_subcmd == NUL)
7461 /* expand subcmd name
7462 * :sign {subcmd}<CTRL-D>*/
7463 return;
7464
7465 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7466
7467 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007468 * |
7469 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007470 begin_subcmd_args = skipwhite(end_subcmd);
7471 p = skiptowhite(begin_subcmd_args);
7472 if (*p == NUL)
7473 {
7474 /*
7475 * Expand first argument of subcmd when possible.
7476 * For ":jump {id}" and ":unplace {id}", we could
7477 * possibly expand the ids of all signs already placed.
7478 */
7479 xp->xp_pattern = begin_subcmd_args;
7480 switch (cmd_idx)
7481 {
7482 case SIGNCMD_LIST:
7483 case SIGNCMD_UNDEFINE:
7484 /* :sign list <CTRL-D>
7485 * :sign undefine <CTRL-D> */
7486 expand_what = EXP_SIGN_NAMES;
7487 break;
7488 default:
7489 xp->xp_context = EXPAND_NOTHING;
7490 }
7491 return;
7492 }
7493
7494 /* expand last argument of subcmd */
7495
7496 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007497 * |
7498 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007499
7500 /* Loop until reaching last argument. */
7501 do
7502 {
7503 p = skipwhite(p);
7504 last = p;
7505 p = skiptowhite(p);
7506 } while (*p != NUL);
7507
7508 p = vim_strchr(last, '=');
7509
7510 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007511 * | |
7512 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007513 if (p == NUL)
7514 {
7515 /* Expand last argument name (before equal sign). */
7516 xp->xp_pattern = last;
7517 switch (cmd_idx)
7518 {
7519 case SIGNCMD_DEFINE:
7520 expand_what = EXP_DEFINE;
7521 break;
7522 case SIGNCMD_PLACE:
7523 expand_what = EXP_PLACE;
7524 break;
7525 case SIGNCMD_JUMP:
7526 case SIGNCMD_UNPLACE:
7527 expand_what = EXP_UNPLACE;
7528 break;
7529 default:
7530 xp->xp_context = EXPAND_NOTHING;
7531 }
7532 }
7533 else
7534 {
7535 /* Expand last argument value (after equal sign). */
7536 xp->xp_pattern = p + 1;
7537 switch (cmd_idx)
7538 {
7539 case SIGNCMD_DEFINE:
7540 if (STRNCMP(last, "texthl", p - last) == 0 ||
7541 STRNCMP(last, "linehl", p - last) == 0)
7542 xp->xp_context = EXPAND_HIGHLIGHT;
7543 else if (STRNCMP(last, "icon", p - last) == 0)
7544 xp->xp_context = EXPAND_FILES;
7545 else
7546 xp->xp_context = EXPAND_NOTHING;
7547 break;
7548 case SIGNCMD_PLACE:
7549 if (STRNCMP(last, "name", p - last) == 0)
7550 expand_what = EXP_SIGN_NAMES;
7551 else
7552 xp->xp_context = EXPAND_NOTHING;
7553 break;
7554 default:
7555 xp->xp_context = EXPAND_NOTHING;
7556 }
7557 }
7558}
7559#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560#endif
7561
7562#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7563/*
7564 * ":drop"
7565 * Opens the first argument in a window. When there are two or more arguments
7566 * the argument list is redefined.
7567 */
7568 void
7569ex_drop(eap)
7570 exarg_T *eap;
7571{
7572 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 win_T *wp;
7574 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007575# ifdef FEAT_WINDOWS
7576 tabpage_T *tp;
7577# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578
7579 /*
7580 * Check if the first argument is already being edited in a window. If
7581 * so, jump to that window.
7582 * We would actually need to check all arguments, but that's complicated
7583 * and mostly only one file is dropped.
7584 * This also ignores wildcards, since it is very unlikely the user is
7585 * editing a file name with a wildcard character.
7586 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007587 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007589 /*
7590 * Expanding wildcards may result in an empty argument list. E.g. when
7591 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7592 * already did an error message for this.
7593 */
7594 if (ARGCOUNT == 0)
7595 return;
7596
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007597# ifdef FEAT_WINDOWS
7598 if (cmdmod.tab)
7599 {
7600 /* ":tab drop file ...": open a tab for each argument that isn't
7601 * edited in a window yet. It's like ":tab all" but without closing
7602 * windows or tabs. */
7603 ex_all(eap);
7604 }
7605 else
7606# endif
7607 {
7608 /* ":drop file ...": Edit the first argument. Jump to an existing
7609 * window if possible, edit in current window if the current buffer
7610 * can be abandoned, otherwise open a new window. */
7611 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7612
7613 FOR_ALL_TAB_WINDOWS(tp, wp)
7614 {
7615 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007617# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007618 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007619# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 return;
7622 }
7623 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007625 /*
7626 * Check whether the current buffer is changed. If so, we will need
7627 * to split the current window or data could be lost.
7628 * Skip the check if the 'hidden' option is set, as in this case the
7629 * buffer won't be lost.
7630 */
7631 if (!P_HID(curbuf))
7632 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007634 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007636 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007638 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007640 if (split)
7641 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007643 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007645 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7646 if (split)
7647 {
7648 eap->cmdidx = CMD_sfirst;
7649 eap->cmd[0] = 's';
7650 }
7651 else
7652 eap->cmdidx = CMD_first;
7653 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655}
7656#endif