blob: 656b1f49d1d734b981bf65b9313e32483b908927 [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. */
418 if (s == p + 1 && last_search_pat() != NULL)
419 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
420 else
421 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000422 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000423 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000424 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000425 regmatch.rm_ic = p_ic;
426 }
427 else
428 {
429 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000430 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000431 }
432 }
433
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000434 /* Can only have one of 'n', 'o' and 'x'. */
435 if (sort_nr + sort_oct + sort_hex > 2)
436 {
437 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000438 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000439 }
440
441 /* From here on "sort_nr" is used as a flag for any number sorting. */
442 sort_nr += sort_oct + sort_hex;
443
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000444 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000445 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000446 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000447 * When sorting on strings "start_col_nr" is the offset in the line, for
448 * numbers sorting it's the number to sort on. This means the pattern
449 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000450 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000451 */
452 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
453 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000454 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000455 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000456 if (maxlen < len)
457 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000458
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000459 start_col = 0;
460 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000461 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000462 {
463 if (sort_rx)
464 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000465 start_col = (colnr_T)(regmatch.startp[0] - s);
466 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000467 }
468 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000469 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000470 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000471 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000472 if (regmatch.regprog != NULL)
473 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000474
475 if (sort_nr)
476 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000477 /* Make sure vim_str2nr doesn't read any digits past the end
478 * of the match, by temporarily terminating the string there */
479 s2 = s + end_col;
480 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200481 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000482 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000483 p = s + start_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000484 if (sort_hex)
Bram Moolenaar1387a602008-07-24 19:31:11 +0000485 s = skiptohex(p);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000486 else
Bram Moolenaar1387a602008-07-24 19:31:11 +0000487 s = skiptodigit(p);
488 if (s > p && s[-1] == '-')
489 --s; /* include preceding negative sign */
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200490 if (*s == NUL)
491 /* empty line should sort before any number */
492 nrs[lnum - eap->line1].start_col_nr = -MAXLNUM;
493 else
494 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
495 &nrs[lnum - eap->line1].start_col_nr, NULL);
496 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000497 }
498 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000499 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000500 /* Store the column to sort at. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000501 nrs[lnum - eap->line1].start_col_nr = start_col;
502 nrs[lnum - eap->line1].end_col_nr = end_col;
503 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000504
505 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000506
507 if (regmatch.regprog != NULL)
508 fast_breakcheck();
509 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000510 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000511 }
512
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000513 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000514 sortbuf1 = alloc((unsigned)maxlen + 1);
515 if (sortbuf1 == NULL)
516 goto sortend;
517 sortbuf2 = alloc((unsigned)maxlen + 1);
518 if (sortbuf2 == NULL)
519 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000520
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000521 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000522 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000523
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000524 if (sort_abort)
525 goto sortend;
526
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000527 /* Insert the lines in the sorted order below the last one. */
528 lnum = eap->line2;
529 for (i = 0; i < count; ++i)
530 {
531 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
532 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000533 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000534 {
535 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
536 break;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000537 if (unique)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000538 STRCPY(sortbuf1, s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000539 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000540 fast_breakcheck();
541 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000542 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000543 }
544
545 /* delete the original lines if appending worked */
546 if (i == count)
547 for (i = 0; i < count; ++i)
548 ml_delete(eap->line1, FALSE);
549 else
550 count = 0;
551
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000552 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000553 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000554 if (deleted > 0)
555 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
556 else if (deleted < 0)
557 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
558 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000559
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000560 curwin->w_cursor.lnum = eap->line1;
561 beginline(BL_WHITE | BL_FIX);
562
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000563sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000564 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000565 vim_free(sortbuf1);
566 vim_free(sortbuf2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000567 vim_free(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000568 if (got_int)
569 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000570}
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572/*
573 * ":retab".
574 */
575 void
576ex_retab(eap)
577 exarg_T *eap;
578{
579 linenr_T lnum;
580 int got_tab = FALSE;
581 long num_spaces = 0;
582 long num_tabs;
583 long len;
584 long col;
585 long vcol;
586 long start_col = 0; /* For start of white-space string */
587 long start_vcol = 0; /* For start of white-space string */
588 int temp;
589 long old_len;
590 char_u *ptr;
591 char_u *new_line = (char_u *)1; /* init to non-NULL */
592 int did_undo; /* called u_save for current line */
593 int new_ts;
594 int save_list;
595 linenr_T first_line = 0; /* first changed line */
596 linenr_T last_line = 0; /* last changed line */
597
598 save_list = curwin->w_p_list;
599 curwin->w_p_list = 0; /* don't want list mode here */
600
601 new_ts = getdigits(&(eap->arg));
602 if (new_ts < 0)
603 {
604 EMSG(_(e_positive));
605 return;
606 }
607 if (new_ts == 0)
608 new_ts = curbuf->b_p_ts;
609 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
610 {
611 ptr = ml_get(lnum);
612 col = 0;
613 vcol = 0;
614 did_undo = FALSE;
615 for (;;)
616 {
617 if (vim_iswhite(ptr[col]))
618 {
619 if (!got_tab && num_spaces == 0)
620 {
621 /* First consecutive white-space */
622 start_vcol = vcol;
623 start_col = col;
624 }
625 if (ptr[col] == ' ')
626 num_spaces++;
627 else
628 got_tab = TRUE;
629 }
630 else
631 {
632 if (got_tab || (eap->forceit && num_spaces > 1))
633 {
634 /* Retabulate this string of white-space */
635
636 /* len is virtual length of white string */
637 len = num_spaces = vcol - start_vcol;
638 num_tabs = 0;
639 if (!curbuf->b_p_et)
640 {
641 temp = new_ts - (start_vcol % new_ts);
642 if (num_spaces >= temp)
643 {
644 num_spaces -= temp;
645 num_tabs++;
646 }
647 num_tabs += num_spaces / new_ts;
648 num_spaces -= (num_spaces / new_ts) * new_ts;
649 }
650 if (curbuf->b_p_et || got_tab ||
651 (num_spaces + num_tabs < len))
652 {
653 if (did_undo == FALSE)
654 {
655 did_undo = TRUE;
656 if (u_save((linenr_T)(lnum - 1),
657 (linenr_T)(lnum + 1)) == FAIL)
658 {
659 new_line = NULL; /* flag out-of-memory */
660 break;
661 }
662 }
663
664 /* len is actual number of white characters used */
665 len = num_spaces + num_tabs;
666 old_len = (long)STRLEN(ptr);
667 new_line = lalloc(old_len - col + start_col + len + 1,
668 TRUE);
669 if (new_line == NULL)
670 break;
671 if (start_col > 0)
672 mch_memmove(new_line, ptr, (size_t)start_col);
673 mch_memmove(new_line + start_col + len,
674 ptr + col, (size_t)(old_len - col + 1));
675 ptr = new_line + start_col;
676 for (col = 0; col < len; col++)
677 ptr[col] = (col < num_tabs) ? '\t' : ' ';
678 ml_replace(lnum, new_line, FALSE);
679 if (first_line == 0)
680 first_line = lnum;
681 last_line = lnum;
682 ptr = new_line;
683 col = start_col + len;
684 }
685 }
686 got_tab = FALSE;
687 num_spaces = 0;
688 }
689 if (ptr[col] == NUL)
690 break;
691 vcol += chartabsize(ptr + col, (colnr_T)vcol);
692#ifdef FEAT_MBYTE
693 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000694 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 else
696#endif
697 ++col;
698 }
699 if (new_line == NULL) /* out of memory */
700 break;
701 line_breakcheck();
702 }
703 if (got_int)
704 EMSG(_(e_interr));
705
706 if (curbuf->b_p_ts != new_ts)
707 redraw_curbuf_later(NOT_VALID);
708 if (first_line != 0)
709 changed_lines(first_line, 0, last_line + 1, 0L);
710
711 curwin->w_p_list = save_list; /* restore 'list' */
712
713 curbuf->b_p_ts = new_ts;
714 coladvance(curwin->w_curswant);
715
716 u_clearline();
717}
718#endif
719
720/*
721 * :move command - move lines line1-line2 to line dest
722 *
723 * return FAIL for failure, OK otherwise
724 */
725 int
726do_move(line1, line2, dest)
727 linenr_T line1;
728 linenr_T line2;
729 linenr_T dest;
730{
731 char_u *str;
732 linenr_T l;
733 linenr_T extra; /* Num lines added before line1 */
734 linenr_T num_lines; /* Num lines moved */
735 linenr_T last_line; /* Last line in file after adding new text */
736
737 if (dest >= line1 && dest < line2)
738 {
739 EMSG(_("E134: Move lines into themselves"));
740 return FAIL;
741 }
742
743 num_lines = line2 - line1 + 1;
744
745 /*
746 * First we copy the old text to its new location -- webb
747 * Also copy the flag that ":global" command uses.
748 */
749 if (u_save(dest, dest + 1) == FAIL)
750 return FAIL;
751 for (extra = 0, l = line1; l <= line2; l++)
752 {
753 str = vim_strsave(ml_get(l + extra));
754 if (str != NULL)
755 {
756 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
757 vim_free(str);
758 if (dest < line1)
759 extra++;
760 }
761 }
762
763 /*
764 * Now we must be careful adjusting our marks so that we don't overlap our
765 * mark_adjust() calls.
766 *
767 * We adjust the marks within the old text so that they refer to the
768 * last lines of the file (temporarily), because we know no other marks
769 * will be set there since these line numbers did not exist until we added
770 * our new lines.
771 *
772 * Then we adjust the marks on lines between the old and new text positions
773 * (either forwards or backwards).
774 *
775 * And Finally we adjust the marks we put at the end of the file back to
776 * their final destination at the new text position -- webb
777 */
778 last_line = curbuf->b_ml.ml_line_count;
779 mark_adjust(line1, line2, last_line - line2, 0L);
780 if (dest >= line2)
781 {
782 mark_adjust(line2 + 1, dest, -num_lines, 0L);
783 curbuf->b_op_start.lnum = dest - num_lines + 1;
784 curbuf->b_op_end.lnum = dest;
785 }
786 else
787 {
788 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
789 curbuf->b_op_start.lnum = dest + 1;
790 curbuf->b_op_end.lnum = dest + num_lines;
791 }
792 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
793 mark_adjust(last_line - num_lines + 1, last_line,
794 -(last_line - dest - extra), 0L);
795
796 /*
797 * Now we delete the original text -- webb
798 */
799 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
800 return FAIL;
801
802 for (l = line1; l <= line2; l++)
803 ml_delete(line1 + extra, TRUE);
804
805 if (!global_busy && num_lines > p_report)
806 {
807 if (num_lines == 1)
808 MSG(_("1 line moved"));
809 else
810 smsg((char_u *)_("%ld lines moved"), num_lines);
811 }
812
813 /*
814 * Leave the cursor on the last of the moved lines.
815 */
816 if (dest >= line1)
817 curwin->w_cursor.lnum = dest;
818 else
819 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
820
821 if (line1 < dest)
Bram Moolenaar0612ec82011-11-30 17:01:58 +0100822 {
823 dest += num_lines + 1;
824 last_line = curbuf->b_ml.ml_line_count;
825 if (dest > last_line + 1)
826 dest = last_line + 1;
827 changed_lines(line1, 0, dest, 0L);
828 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 else
830 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
831
832 return OK;
833}
834
835/*
836 * ":copy"
837 */
838 void
839ex_copy(line1, line2, n)
840 linenr_T line1;
841 linenr_T line2;
842 linenr_T n;
843{
844 linenr_T count;
845 char_u *p;
846
847 count = line2 - line1 + 1;
848 curbuf->b_op_start.lnum = n + 1;
849 curbuf->b_op_end.lnum = n + count;
850 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
851
852 /*
853 * there are three situations:
854 * 1. destination is above line1
855 * 2. destination is between line1 and line2
856 * 3. destination is below line2
857 *
858 * n = destination (when starting)
859 * curwin->w_cursor.lnum = destination (while copying)
860 * line1 = start of source (while copying)
861 * line2 = end of source (while copying)
862 */
863 if (u_save(n, n + 1) == FAIL)
864 return;
865
866 curwin->w_cursor.lnum = n;
867 while (line1 <= line2)
868 {
869 /* need to use vim_strsave() because the line will be unlocked within
870 * ml_append() */
871 p = vim_strsave(ml_get(line1));
872 if (p != NULL)
873 {
874 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
875 vim_free(p);
876 }
877 /* situation 2: skip already copied lines */
878 if (line1 == n)
879 line1 = curwin->w_cursor.lnum;
880 ++line1;
881 if (curwin->w_cursor.lnum < line1)
882 ++line1;
883 if (curwin->w_cursor.lnum < line2)
884 ++line2;
885 ++curwin->w_cursor.lnum;
886 }
887
888 appended_lines_mark(n, count);
889
890 msgmore((long)count);
891}
892
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000893static char_u *prevcmd = NULL; /* the previous command */
894
895#if defined(EXITFREE) || defined(PROTO)
896 void
897free_prev_shellcmd()
898{
899 vim_free(prevcmd);
900}
901#endif
902
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903/*
904 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
905 * Bangs in the argument are replaced with the previously entered command.
906 * Remember the argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 */
908 void
909do_bang(addr_count, eap, forceit, do_in, do_out)
910 int addr_count;
911 exarg_T *eap;
912 int forceit;
913 int do_in, do_out;
914{
915 char_u *arg = eap->arg; /* command */
916 linenr_T line1 = eap->line1; /* start of range */
917 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918 char_u *newcmd = NULL; /* the new command */
919 int free_newcmd = FALSE; /* need to free() newcmd */
920 int ins_prevcmd;
921 char_u *t;
922 char_u *p;
923 char_u *trailarg;
924 int len;
925 int scroll_save = msg_scroll;
926
927 /*
928 * Disallow shell commands for "rvim".
929 * Disallow shell commands from .exrc and .vimrc in current directory for
930 * security reasons.
931 */
932 if (check_restricted() || check_secure())
933 return;
934
935 if (addr_count == 0) /* :! */
936 {
937 msg_scroll = FALSE; /* don't scroll here */
938 autowrite_all();
939 msg_scroll = scroll_save;
940 }
941
942 /*
943 * Try to find an embedded bang, like in :!<cmd> ! [args]
944 * (:!! is indicated by the 'forceit' variable)
945 */
946 ins_prevcmd = forceit;
947 trailarg = arg;
948 do
949 {
950 len = (int)STRLEN(trailarg) + 1;
951 if (newcmd != NULL)
952 len += (int)STRLEN(newcmd);
953 if (ins_prevcmd)
954 {
955 if (prevcmd == NULL)
956 {
957 EMSG(_(e_noprev));
958 vim_free(newcmd);
959 return;
960 }
961 len += (int)STRLEN(prevcmd);
962 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000963 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 {
965 vim_free(newcmd);
966 return;
967 }
968 *t = NUL;
969 if (newcmd != NULL)
970 STRCAT(t, newcmd);
971 if (ins_prevcmd)
972 STRCAT(t, prevcmd);
973 p = t + STRLEN(t);
974 STRCAT(t, trailarg);
975 vim_free(newcmd);
976 newcmd = t;
977
978 /*
979 * Scan the rest of the argument for '!', which is replaced by the
980 * previous command. "\!" is replaced by "!" (this is vi compatible).
981 */
982 trailarg = NULL;
983 while (*p)
984 {
Bram Moolenaare60acc12011-05-10 16:41:25 +0200985 if (*p == '!')
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 {
987 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000988 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 else
990 {
991 trailarg = p;
992 *trailarg++ = NUL;
993 ins_prevcmd = TRUE;
994 break;
995 }
996 }
997 ++p;
998 }
999 } while (trailarg != NULL);
1000
1001 vim_free(prevcmd);
1002 prevcmd = newcmd;
1003
1004 if (bangredo) /* put cmd in redo buffer for ! command */
1005 {
Bram Moolenaarebefac62005-12-28 22:39:57 +00001006 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 AppendToRedobuff((char_u *)"\n");
1008 bangredo = FALSE;
1009 }
1010 /*
1011 * Add quotes around the command, for shells that need them.
1012 */
1013 if (*p_shq != NUL)
1014 {
1015 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1016 if (newcmd == NULL)
1017 return;
1018 STRCPY(newcmd, p_shq);
1019 STRCAT(newcmd, prevcmd);
1020 STRCAT(newcmd, p_shq);
1021 free_newcmd = TRUE;
1022 }
1023 if (addr_count == 0) /* :! */
1024 {
1025 /* echo the command */
1026 msg_start();
1027 msg_putchar(':');
1028 msg_putchar('!');
1029 msg_outtrans(newcmd);
1030 msg_clr_eos();
1031 windgoto(msg_row, msg_col);
1032
1033 do_shell(newcmd, 0);
1034 }
1035 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001036 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 /* Careful: This may recursively call do_bang() again! (because of
1038 * autocommands) */
1039 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001040#ifdef FEAT_AUTOCMD
1041 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1042#endif
1043 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 if (free_newcmd)
1045 vim_free(newcmd);
1046}
1047
1048/*
1049 * do_filter: filter lines through a command given by the user
1050 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001051 * We mostly use temp files and the call_shell() routine here. This would
1052 * normally be done using pipes on a UNIX machine, but this is more portable
1053 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054 * to deal with redirection somehow, and should handle things like looking
1055 * at the PATH env. variable, and adding reasonable extensions to the
1056 * command name given by the user. All reasonable versions of call_shell()
1057 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001058 * Alternatively, if on Unix and redirecting input or output, but not both,
1059 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 * We use input redirection if do_in is TRUE.
1061 * We use output redirection if do_out is TRUE.
1062 */
1063 static void
1064do_filter(line1, line2, eap, cmd, do_in, do_out)
1065 linenr_T line1, line2;
1066 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1067 char_u *cmd;
1068 int do_in, do_out;
1069{
1070 char_u *itmp = NULL;
1071 char_u *otmp = NULL;
1072 linenr_T linecount;
1073 linenr_T read_linecount;
1074 pos_T cursor_save;
1075 char_u *cmd_buf;
1076#ifdef FEAT_AUTOCMD
1077 buf_T *old_curbuf = curbuf;
1078#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001079 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080
1081 if (*cmd == NUL) /* no filter command */
1082 return;
1083
1084#ifdef WIN3264
1085 /*
1086 * Check if external commands are allowed now.
1087 */
1088 if (can_end_termcap_mode(TRUE) == FALSE)
1089 return;
1090#endif
1091
1092 cursor_save = curwin->w_cursor;
1093 linecount = line2 - line1 + 1;
1094 curwin->w_cursor.lnum = line1;
1095 curwin->w_cursor.col = 0;
1096 changed_line_abv_curs();
1097 invalidate_botline();
1098
1099 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001100 * When using temp files:
1101 * 1. * Form temp file names
1102 * 2. * Write the lines to a temp file
1103 * 3. Run the filter command on the temp file
1104 * 4. * Read the output of the command into the buffer
1105 * 5. * Delete the original lines to be filtered
1106 * 6. * Remove the temp files
1107 *
1108 * When writing the input with a pipe or when catching the output with a
1109 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110 */
1111
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001112 if (do_out)
1113 shell_flags |= SHELL_DOOUT;
1114
Bram Moolenaar68a33fc2012-04-25 16:50:48 +02001115#ifdef FEAT_FILTERPIPE
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001116 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001118 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1119 shell_flags |= SHELL_READ;
1120 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001122 else if (do_in && !do_out && !p_stmp)
1123 {
1124 /* Use a pipe to write stdin of the command, do not use a temp file. */
1125 shell_flags |= SHELL_WRITE;
1126 curbuf->b_op_start.lnum = line1;
1127 curbuf->b_op_end.lnum = line2;
1128 }
1129 else if (do_in && do_out && !p_stmp)
1130 {
1131 /* Use a pipe to write stdin and fetch stdout of the command, do not
1132 * use a temp file. */
1133 shell_flags |= SHELL_READ|SHELL_WRITE;
1134 curbuf->b_op_start.lnum = line1;
1135 curbuf->b_op_end.lnum = line2;
1136 curwin->w_cursor.lnum = line2;
1137 }
1138 else
1139#endif
1140 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1141 || (do_out && (otmp = vim_tempname('o')) == NULL))
1142 {
1143 EMSG(_(e_notmp));
1144 goto filterend;
1145 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147/*
1148 * The writing and reading of temp files will not be shown.
1149 * Vi also doesn't do this and the messages are not very informative.
1150 */
1151 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001152 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 FALSE, FALSE, FALSE, TRUE) == FAIL)
1154 {
1155 msg_putchar('\n'); /* keep message from buf_write() */
1156 --no_wait_return;
1157#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1158 if (!aborting())
1159#endif
1160 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1161 goto filterend;
1162 }
1163#ifdef FEAT_AUTOCMD
1164 if (curbuf != old_curbuf)
1165 goto filterend;
1166#endif
1167
1168 if (!do_out)
1169 msg_putchar('\n');
1170
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001171 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1173 if (cmd_buf == NULL)
1174 goto filterend;
1175
1176 windgoto((int)Rows - 1, 0);
1177 cursor_on();
1178
1179 /*
1180 * When not redirecting the output the command can write anything to the
1181 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1182 * stderr output of external command. Clear the screen later.
1183 * If do_in is FALSE, this could be something like ":r !cat", which may
1184 * also mess up the screen, clear it later.
1185 */
1186 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1187 redraw_later_clear();
1188
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001189 if (do_out)
1190 {
1191 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001192 {
1193 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001194 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001195 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001196 redraw_curbuf_later(VALID);
1197 }
1198 read_linecount = curbuf->b_ml.ml_line_count;
1199
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 /*
1201 * When call_shell() fails wait_return() is called to give the user a
1202 * chance to read the error messages. Otherwise errors are ignored, so you
1203 * can see the error messages from the command that appear on stdout; use
1204 * 'u' to fix the text
1205 * Switch to cooked mode when not redirecting stdin, avoids that something
1206 * like ":r !cat" hangs.
1207 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1208 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001209 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 {
1211 redraw_later_clear();
1212 wait_return(FALSE);
1213 }
1214 vim_free(cmd_buf);
1215
1216 did_check_timestamps = FALSE;
1217 need_check_timestamps = TRUE;
1218
1219 /* When interrupting the shell command, it may still have produced some
1220 * useful output. Reset got_int here, so that readfile() won't cancel
1221 * reading. */
1222 ui_breakcheck();
1223 got_int = FALSE;
1224
1225 if (do_out)
1226 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001227 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001229 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1230 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001232#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1233 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001235 {
1236 msg_putchar('\n');
1237 EMSG2(_(e_notread), otmp);
1238 }
1239 goto error;
1240 }
1241#ifdef FEAT_AUTOCMD
1242 if (curbuf != old_curbuf)
1243 goto filterend;
1244#endif
1245 }
1246
1247 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1248
1249 if (shell_flags & SHELL_READ)
1250 {
1251 curbuf->b_op_start.lnum = line2 + 1;
1252 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1253 appended_lines_mark(line2, read_linecount);
1254 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256 if (do_in)
1257 {
1258 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1259 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 if (read_linecount >= linecount)
1261 /* move all marks from old lines to new lines */
1262 mark_adjust(line1, line2, linecount, 0L);
1263 else
1264 {
1265 /* move marks from old lines to new lines, delete marks
1266 * that are in deleted lines */
1267 mark_adjust(line1, line1 + read_linecount - 1,
1268 linecount, 0L);
1269 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1270 }
1271 }
1272
1273 /*
1274 * Put cursor on first filtered line for ":range!cmd".
1275 * Adjust '[ and '] (set by buf_write()).
1276 */
1277 curwin->w_cursor.lnum = line1;
1278 del_lines(linecount, TRUE);
1279 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1280 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1281 write_lnum_adjust(-linecount); /* adjust last line
1282 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001283#ifdef FEAT_FOLDING
1284 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1285#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286 }
1287 else
1288 {
1289 /*
1290 * Put cursor on last new line for ":r !cmd".
1291 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001293 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001295
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1297 --no_wait_return;
1298
1299 if (linecount > p_report)
1300 {
1301 if (do_in)
1302 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001303 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1304 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001307 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 }
1309 else
1310 msgmore((long)linecount);
1311 }
1312 }
1313 else
1314 {
1315error:
1316 /* put cursor back in same position for ":w !cmd" */
1317 curwin->w_cursor = cursor_save;
1318 --no_wait_return;
1319 wait_return(FALSE);
1320 }
1321
1322filterend:
1323
1324#ifdef FEAT_AUTOCMD
1325 if (curbuf != old_curbuf)
1326 {
1327 --no_wait_return;
1328 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1329 }
1330#endif
1331 if (itmp != NULL)
1332 mch_remove(itmp);
1333 if (otmp != NULL)
1334 mch_remove(otmp);
1335 vim_free(itmp);
1336 vim_free(otmp);
1337}
1338
1339/*
1340 * Call a shell to execute a command.
1341 * When "cmd" is NULL start an interactive shell.
1342 */
1343 void
1344do_shell(cmd, flags)
1345 char_u *cmd;
1346 int flags; /* may be SHELL_DOOUT when output is redirected */
1347{
1348 buf_T *buf;
1349#ifndef FEAT_GUI_MSWIN
1350 int save_nwr;
1351#endif
1352#ifdef MSWIN
1353 int winstart = FALSE;
1354#endif
1355
1356 /*
1357 * Disallow shell commands for "rvim".
1358 * Disallow shell commands from .exrc and .vimrc in current directory for
1359 * security reasons.
1360 */
1361 if (check_restricted() || check_secure())
1362 {
1363 msg_end();
1364 return;
1365 }
1366
1367#ifdef MSWIN
1368 /*
1369 * Check if external commands are allowed now.
1370 */
1371 if (can_end_termcap_mode(TRUE) == FALSE)
1372 return;
1373
1374 /*
1375 * Check if ":!start" is used.
1376 */
1377 if (cmd != NULL)
1378 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1379#endif
1380
1381 /*
1382 * For autocommands we want to get the output on the current screen, to
1383 * avoid having to type return below.
1384 */
1385 msg_putchar('\r'); /* put cursor at start of line */
1386#ifdef FEAT_AUTOCMD
1387 if (!autocmd_busy)
1388#endif
1389 {
1390#ifdef MSWIN
1391 if (!winstart)
1392#endif
1393 stoptermcap();
1394 }
1395#ifdef MSWIN
1396 if (!winstart)
1397#endif
1398 msg_putchar('\n'); /* may shift screen one line up */
1399
1400 /* warning message before calling the shell */
1401 if (p_warn
1402#ifdef FEAT_AUTOCMD
1403 && !autocmd_busy
1404#endif
1405 && msg_silent == 0)
1406 for (buf = firstbuf; buf; buf = buf->b_next)
1407 if (bufIsChanged(buf))
1408 {
1409#ifdef FEAT_GUI_MSWIN
1410 if (!winstart)
1411 starttermcap(); /* don't want a message box here */
1412#endif
1413 MSG_PUTS(_("[No write since last change]\n"));
1414#ifdef FEAT_GUI_MSWIN
1415 if (!winstart)
1416 stoptermcap();
1417#endif
1418 break;
1419 }
1420
1421 /* This windgoto is required for when the '\n' resulted in a "delete line
1422 * 1" command to the terminal. */
1423 if (!swapping_screen())
1424 windgoto(msg_row, msg_col);
1425 cursor_on();
1426 (void)call_shell(cmd, SHELL_COOKED | flags);
1427 did_check_timestamps = FALSE;
1428 need_check_timestamps = TRUE;
1429
1430 /*
1431 * put the message cursor at the end of the screen, avoids wait_return()
1432 * to overwrite the text that the external command showed
1433 */
1434 if (!swapping_screen())
1435 {
1436 msg_row = Rows - 1;
1437 msg_col = 0;
1438 }
1439
1440#ifdef FEAT_AUTOCMD
1441 if (autocmd_busy)
1442 {
1443 if (msg_silent == 0)
1444 redraw_later_clear();
1445 }
1446 else
1447#endif
1448 {
1449 /*
1450 * For ":sh" there is no need to call wait_return(), just redraw.
1451 * Also for the Win32 GUI (the output is in a console window).
1452 * Otherwise there is probably text on the screen that the user wants
1453 * to read before redrawing, so call wait_return().
1454 */
1455#ifndef FEAT_GUI_MSWIN
1456 if (cmd == NULL
1457# ifdef WIN3264
1458 || (winstart && !need_wait_return)
1459# endif
1460 )
1461 {
1462 if (msg_silent == 0)
1463 redraw_later_clear();
1464 need_wait_return = FALSE;
1465 }
1466 else
1467 {
1468 /*
1469 * If we switch screens when starttermcap() is called, we really
1470 * want to wait for "hit return to continue".
1471 */
1472 save_nwr = no_wait_return;
1473 if (swapping_screen())
1474 no_wait_return = FALSE;
1475# ifdef AMIGA
1476 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1477# else
1478 wait_return(msg_silent == 0);
1479# endif
1480 no_wait_return = save_nwr;
1481 }
1482#endif /* FEAT_GUI_W32 */
1483
1484#ifdef MSWIN
1485 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1486#endif
1487 starttermcap(); /* start termcap if not done by wait_return() */
1488
1489 /*
1490 * In an Amiga window redrawing is caused by asking the window size.
1491 * If we got an interrupt this will not work. The chance that the
1492 * window size is wrong is very small, but we need to redraw the
1493 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1494 * but it saves an extra redraw.
1495 */
1496#ifdef AMIGA
1497 if (skip_redraw) /* ':' hit in wait_return() */
1498 {
1499 if (msg_silent == 0)
1500 redraw_later_clear();
1501 }
1502 else if (term_console)
1503 {
1504 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1505 if (got_int && msg_silent == 0)
1506 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1507 else
1508 must_redraw = 0; /* no extra redraw needed */
1509 }
1510#endif
1511 }
1512
1513 /* display any error messages now */
1514 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001515
1516#ifdef FEAT_AUTOCMD
1517 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1518#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519}
1520
1521/*
1522 * Create a shell command from a command string, input redirection file and
1523 * output redirection file.
1524 * Returns an allocated string with the shell command, or NULL for failure.
1525 */
1526 char_u *
1527make_filter_cmd(cmd, itmp, otmp)
1528 char_u *cmd; /* command */
1529 char_u *itmp; /* NULL or name of input file */
1530 char_u *otmp; /* NULL or name of output file */
1531{
1532 char_u *buf;
1533 long_u len;
1534
1535 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1536 if (itmp != NULL)
1537 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1538 if (otmp != NULL)
1539 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1540 buf = lalloc(len, TRUE);
1541 if (buf == NULL)
1542 return NULL;
1543
1544#if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1545 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001546 * Put braces around the command (for concatenated commands) when
1547 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001549 if (itmp != NULL || otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001550 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001551 else
1552 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 if (itmp != NULL)
1554 {
1555 STRCAT(buf, " < ");
1556 STRCAT(buf, itmp);
1557 }
1558#else
1559 /*
1560 * for shells that don't understand braces around commands, at least allow
1561 * the use of commands in a pipe.
1562 */
1563 STRCPY(buf, cmd);
1564 if (itmp != NULL)
1565 {
1566 char_u *p;
1567
1568 /*
1569 * If there is a pipe, we have to put the '<' in front of it.
1570 * Don't do this when 'shellquote' is not empty, otherwise the
1571 * redirection would be inside the quotes.
1572 */
1573 if (*p_shq == NUL)
1574 {
1575 p = vim_strchr(buf, '|');
1576 if (p != NULL)
1577 *p = NUL;
1578 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1580 STRCAT(buf, itmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 if (*p_shq == NUL)
1582 {
1583 p = vim_strchr(cmd, '|');
1584 if (p != NULL)
1585 {
1586 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1587 STRCAT(buf, p);
1588 }
1589 }
1590 }
1591#endif
1592 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001593 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594
1595 return buf;
1596}
1597
1598/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001599 * Append output redirection for file "fname" to the end of string buffer
1600 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 * Works with the 'shellredir' and 'shellpipe' options.
1602 * The caller should make sure that there is enough room:
1603 * STRLEN(opt) + STRLEN(fname) + 3
1604 */
1605 void
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001606append_redir(buf, buflen, opt, fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 char_u *buf;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001608 int buflen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 char_u *opt;
1610 char_u *fname;
1611{
1612 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001613 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001615 end = buf + STRLEN(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 /* find "%s", skipping "%%" */
1617 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1618 if (p[1] == 's')
1619 break;
1620 if (p != NULL)
1621 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001622 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1623 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1624 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 }
1626 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001627 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628#ifdef FEAT_QUICKFIX
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 " %s %s",
1630#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 " %s%s", /* " > %s" causes problems on Amiga */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632#endif
1633 (char *)opt, (char *)fname);
1634}
1635
1636#ifdef FEAT_VIMINFO
1637
1638static int no_viminfo __ARGS((void));
1639static int viminfo_errcnt;
1640
1641 static int
1642no_viminfo()
1643{
1644 /* "vim -i NONE" does not read or write a viminfo file */
1645 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1646}
1647
1648/*
1649 * Report an error for reading a viminfo file.
1650 * Count the number of errors. When there are more than 10, return TRUE.
1651 */
1652 int
1653viminfo_error(errnum, message, line)
1654 char *errnum;
1655 char *message;
1656 char_u *line;
1657{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001658 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1659 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001660 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001661 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1662 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 emsg(IObuff);
1664 if (++viminfo_errcnt >= 10)
1665 {
1666 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1667 return TRUE;
1668 }
1669 return FALSE;
1670}
1671
1672/*
1673 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001674 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675 */
1676 int
Bram Moolenaard812df62008-11-09 12:46:09 +00001677read_viminfo(file, flags)
1678 char_u *file; /* file name or NULL to use default name */
1679 int flags; /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680{
1681 FILE *fp;
1682 char_u *fname;
1683
1684 if (no_viminfo())
1685 return FAIL;
1686
Bram Moolenaard812df62008-11-09 12:46:09 +00001687 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 if (fname == NULL)
1689 return FAIL;
1690 fp = mch_fopen((char *)fname, READBIN);
1691
1692 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001693 {
1694 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001695 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1696 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001697 (flags & VIF_WANT_INFO) ? _(" info") : "",
1698 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1699 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001700 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001701 verbose_leave();
1702 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703
1704 vim_free(fname);
1705 if (fp == NULL)
1706 return FAIL;
1707
1708 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001709 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710
1711 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 return OK;
1713}
1714
1715/*
1716 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1717 * that effectively a merge of current info and old info is done. This allows
1718 * multiple vims to run simultaneously, without losing any marks etc. If
1719 * forceit is TRUE, then the old file is not read in, and only internal info is
1720 * written to the file. -- webb
1721 */
1722 void
1723write_viminfo(file, forceit)
1724 char_u *file;
1725 int forceit;
1726{
1727 char_u *fname;
1728 FILE *fp_in = NULL; /* input viminfo file, if any */
1729 FILE *fp_out = NULL; /* output viminfo file */
1730 char_u *tempname = NULL; /* name of temp viminfo file */
1731 struct stat st_new; /* mch_stat() of potential new file */
1732 char_u *wp;
1733#if defined(UNIX) || defined(VMS)
1734 mode_t umask_save;
1735#endif
1736#ifdef UNIX
1737 int shortname = FALSE; /* use 8.3 file name */
1738 struct stat st_old; /* mch_stat() of existing viminfo file */
1739#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001740#ifdef WIN3264
1741 long perm = -1;
1742#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743
1744 if (no_viminfo())
1745 return;
1746
1747 fname = viminfo_filename(file); /* may set to default if NULL */
1748 if (fname == NULL)
1749 return;
1750
1751 fp_in = mch_fopen((char *)fname, READBIN);
1752 if (fp_in == NULL)
1753 {
1754 /* if it does exist, but we can't read it, don't try writing */
1755 if (mch_stat((char *)fname, &st_new) == 0)
1756 goto end;
1757#if defined(UNIX) || defined(VMS)
1758 /*
1759 * For Unix we create the .viminfo non-accessible for others,
1760 * because it may contain text from non-accessible documents.
1761 */
1762 umask_save = umask(077);
1763#endif
1764 fp_out = mch_fopen((char *)fname, WRITEBIN);
1765#if defined(UNIX) || defined(VMS)
1766 (void)umask(umask_save);
1767#endif
1768 }
1769 else
1770 {
1771 /*
1772 * There is an existing viminfo file. Create a temporary file to
1773 * write the new viminfo into, in the same directory as the
1774 * existing viminfo file, which will be renamed later.
1775 */
1776#ifdef UNIX
1777 /*
1778 * For Unix we check the owner of the file. It's not very nice to
1779 * overwrite a user's viminfo file after a "su root", with a
1780 * viminfo file that the user can't read.
1781 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001782 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001783 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001785 if (mch_stat((char *)fname, &st_old) == 0
1786 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001787 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 ? (st_old.st_mode & 0200)
1789 : (st_old.st_gid == getgid()
1790 ? (st_old.st_mode & 0020)
1791 : (st_old.st_mode & 0002))))
1792 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001793 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
1795 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1797 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001798 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 goto end;
1800 }
1801#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001802#ifdef WIN3264
1803 /* Get the file attributes of the existing viminfo file. */
1804 perm = mch_getperm(fname);
1805#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806
1807 /*
1808 * Make tempname.
1809 * May try twice: Once normal and once with shortname set, just in
1810 * case somebody puts his viminfo file in an 8.3 filesystem.
1811 */
1812 for (;;)
1813 {
1814 tempname = buf_modname(
1815#ifdef UNIX
1816 shortname,
1817#else
1818# ifdef SHORT_FNAME
1819 TRUE,
1820# else
1821# ifdef FEAT_GUI_W32
1822 gui_is_win32s(),
1823# else
1824 FALSE,
1825# endif
1826# endif
1827#endif
1828 fname,
1829#ifdef VMS
1830 (char_u *)"-tmp",
1831#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 (char_u *)".tmp",
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833#endif
1834 FALSE);
1835 if (tempname == NULL) /* out of memory */
1836 break;
1837
1838 /*
1839 * Check if tempfile already exists. Never overwrite an
1840 * existing file!
1841 */
1842 if (mch_stat((char *)tempname, &st_new) == 0)
1843 {
1844#ifdef UNIX
1845 /*
1846 * Check if tempfile is same as original file. May happen
1847 * when modname() gave the same file back. E.g. silly
1848 * link, or file name-length reached. Try again with
1849 * shortname set.
1850 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001851 if (!shortname && st_new.st_dev == st_old.st_dev
1852 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 {
1854 vim_free(tempname);
1855 tempname = NULL;
1856 shortname = TRUE;
1857 continue;
1858 }
1859#endif
1860 /*
1861 * Try another name. Change one character, just before
1862 * the extension. This should also work for an 8.3
1863 * file name, when after adding the extension it still is
1864 * the same file as the original.
1865 */
1866 wp = tempname + STRLEN(tempname) - 5;
1867 if (wp < gettail(tempname)) /* empty file name? */
1868 wp = gettail(tempname);
1869 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1870 --*wp)
1871 {
1872 /*
1873 * They all exist? Must be something wrong! Don't
1874 * write the viminfo file then.
1875 */
1876 if (*wp == 'a')
1877 {
1878 vim_free(tempname);
1879 tempname = NULL;
1880 break;
1881 }
1882 }
1883 }
1884 break;
1885 }
1886
1887 if (tempname != NULL)
1888 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001889#ifdef VMS
1890 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001891 umask_save = umask(077);
1892 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1893 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001894#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001895 int fd;
1896
1897 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001898 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001899 * Unix: same as original file, but strip s-bit. Reset umask to
1900 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001901 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001902# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001903 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001904 fd = mch_open((char *)tempname,
1905 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001906 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001907 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001908# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001909 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001910 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001911# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00001912 if (fd < 0)
1913 fp_out = NULL;
1914 else
1915 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001916#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917
1918 /*
1919 * If we can't create in the same directory, try creating a
1920 * "normal" temp file.
1921 */
1922 if (fp_out == NULL)
1923 {
1924 vim_free(tempname);
1925 if ((tempname = vim_tempname('o')) != NULL)
1926 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1927 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00001928
1929#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001931 * Make sure the owner can read/write it. This only works for
1932 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 */
1934 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001935 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936#endif
1937 }
1938 }
1939
1940 /*
1941 * Check if the new viminfo file can be written to.
1942 */
1943 if (fp_out == NULL)
1944 {
1945 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00001946 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 if (fp_in != NULL)
1948 fclose(fp_in);
1949 goto end;
1950 }
1951
1952 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001953 {
1954 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001955 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001956 verbose_leave();
1957 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958
1959 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001960 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961
1962 fclose(fp_out); /* errors are ignored !? */
1963 if (fp_in != NULL)
1964 {
1965 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001966
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 /*
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001968 * In case of an error keep the original viminfo file.
1969 * Otherwise rename the newly written file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 */
1971 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1972 mch_remove(tempname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001973
1974#ifdef WIN3264
1975 /* If the viminfo file was hidden then also hide the new file. */
1976 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1977 mch_hide(fname);
1978#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001980
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981end:
1982 vim_free(fname);
1983 vim_free(tempname);
1984}
1985
1986/*
1987 * Get the viminfo file name to use.
1988 * If "file" is given and not empty, use it (has already been expanded by
1989 * cmdline functions).
1990 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1991 * expand environment variables.
1992 * Returns an allocated string. NULL when out of memory.
1993 */
1994 static char_u *
1995viminfo_filename(file)
1996 char_u *file;
1997{
1998 if (file == NULL || *file == NUL)
1999 {
2000 if (use_viminfo != NULL)
2001 file = use_viminfo;
2002 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2003 {
2004#ifdef VIMINFO_FILE2
2005 /* don't use $HOME when not defined (turned into "c:/"!). */
2006# ifdef VMS
2007 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2008# else
2009 if (mch_getenv((char_u *)"HOME") == NULL)
2010# endif
2011 {
2012 /* don't use $VIM when not available. */
2013 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2014 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2015 file = (char_u *)VIMINFO_FILE2;
2016 else
2017 file = (char_u *)VIMINFO_FILE;
2018 }
2019 else
2020#endif
2021 file = (char_u *)VIMINFO_FILE;
2022 }
2023 expand_env(file, NameBuff, MAXPATHL);
2024 file = NameBuff;
2025 }
2026 return vim_strsave(file);
2027}
2028
2029/*
2030 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2031 */
2032 static void
Bram Moolenaard812df62008-11-09 12:46:09 +00002033do_viminfo(fp_in, fp_out, flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 FILE *fp_in;
2035 FILE *fp_out;
Bram Moolenaard812df62008-11-09 12:46:09 +00002036 int flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037{
2038 int count = 0;
2039 int eof = FALSE;
2040 vir_T vir;
2041
2042 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2043 return;
2044 vir.vir_fd = fp_in;
2045#ifdef FEAT_MBYTE
2046 vir.vir_conv.vc_type = CONV_NONE;
2047#endif
2048
2049 if (fp_in != NULL)
2050 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002051 if (flags & VIF_WANT_INFO)
2052 eof = read_viminfo_up_to_marks(&vir,
2053 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 else
2055 /* Skip info, find start of marks */
2056 while (!(eof = viminfo_readline(&vir))
2057 && vir.vir_line[0] != '>')
2058 ;
2059 }
2060 if (fp_out != NULL)
2061 {
2062 /* Write the info: */
2063 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2064 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002065 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002067 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2069#endif
2070 write_viminfo_search_pattern(fp_out);
2071 write_viminfo_sub_string(fp_out);
2072#ifdef FEAT_CMDHIST
2073 write_viminfo_history(fp_out);
2074#endif
2075 write_viminfo_registers(fp_out);
2076#ifdef FEAT_EVAL
2077 write_viminfo_varlist(fp_out);
2078#endif
2079 write_viminfo_filemarks(fp_out);
2080 write_viminfo_bufferlist(fp_out);
2081 count = write_viminfo_marks(fp_out);
2082 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002083 if (fp_in != NULL
2084 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2085 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086
2087 vim_free(vir.vir_line);
2088#ifdef FEAT_MBYTE
2089 if (vir.vir_conv.vc_type != CONV_NONE)
2090 convert_setup(&vir.vir_conv, NULL, NULL);
2091#endif
2092}
2093
2094/*
2095 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2096 * first part of the viminfo file which contains everything but the marks that
2097 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2098 */
2099 static int
2100read_viminfo_up_to_marks(virp, forceit, writing)
2101 vir_T *virp;
2102 int forceit;
2103 int writing;
2104{
2105 int eof;
2106 buf_T *buf;
2107
2108#ifdef FEAT_CMDHIST
2109 prepare_viminfo_history(forceit ? 9999 : 0);
2110#endif
2111 eof = viminfo_readline(virp);
2112 while (!eof && virp->vir_line[0] != '>')
2113 {
2114 switch (virp->vir_line[0])
2115 {
2116 /* Characters reserved for future expansion, ignored now */
2117 case '+': /* "+40 /path/dir file", for running vim without args */
2118 case '|': /* to be defined */
2119 case '^': /* to be defined */
2120 case '<': /* long line - ignored */
2121 /* A comment or empty line. */
2122 case NUL:
2123 case '\r':
2124 case '\n':
2125 case '#':
2126 eof = viminfo_readline(virp);
2127 break;
2128 case '*': /* "*encoding=value" */
2129 eof = viminfo_encoding(virp);
2130 break;
2131 case '!': /* global variable */
2132#ifdef FEAT_EVAL
2133 eof = read_viminfo_varlist(virp, writing);
2134#else
2135 eof = viminfo_readline(virp);
2136#endif
2137 break;
2138 case '%': /* entry for buffer list */
2139 eof = read_viminfo_bufferlist(virp, writing);
2140 break;
2141 case '"':
2142 eof = read_viminfo_register(virp, forceit);
2143 break;
2144 case '/': /* Search string */
2145 case '&': /* Substitute search string */
2146 case '~': /* Last search string, followed by '/' or '&' */
2147 eof = read_viminfo_search_pattern(virp, forceit);
2148 break;
2149 case '$':
2150 eof = read_viminfo_sub_string(virp, forceit);
2151 break;
2152 case ':':
2153 case '?':
2154 case '=':
2155 case '@':
2156#ifdef FEAT_CMDHIST
2157 eof = read_viminfo_history(virp);
2158#else
2159 eof = viminfo_readline(virp);
2160#endif
2161 break;
2162 case '-':
2163 case '\'':
2164 eof = read_viminfo_filemark(virp, forceit);
2165 break;
2166 default:
2167 if (viminfo_error("E575: ", _("Illegal starting char"),
2168 virp->vir_line))
2169 eof = TRUE;
2170 else
2171 eof = viminfo_readline(virp);
2172 break;
2173 }
2174 }
2175
2176#ifdef FEAT_CMDHIST
2177 /* Finish reading history items. */
2178 finish_viminfo_history();
2179#endif
2180
2181 /* Change file names to buffer numbers for fmarks. */
2182 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2183 fmarks_check_names(buf);
2184
2185 return eof;
2186}
2187
2188/*
2189 * Compare the 'encoding' value in the viminfo file with the current value of
2190 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2191 * conversion of text with iconv() in viminfo_readstring().
2192 */
2193 static int
2194viminfo_encoding(virp)
2195 vir_T *virp;
2196{
2197#ifdef FEAT_MBYTE
2198 char_u *p;
2199 int i;
2200
2201 if (get_viminfo_parameter('c') != 0)
2202 {
2203 p = vim_strchr(virp->vir_line, '=');
2204 if (p != NULL)
2205 {
2206 /* remove trailing newline */
2207 ++p;
2208 for (i = 0; vim_isprintc(p[i]); ++i)
2209 ;
2210 p[i] = NUL;
2211
2212 convert_setup(&virp->vir_conv, p, p_enc);
2213 }
2214 }
2215#endif
2216 return viminfo_readline(virp);
2217}
2218
2219/*
2220 * Read a line from the viminfo file.
2221 * Returns TRUE for end-of-file;
2222 */
2223 int
2224viminfo_readline(virp)
2225 vir_T *virp;
2226{
2227 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2228}
2229
2230/*
2231 * check string read from viminfo file
2232 * remove '\n' at the end of the line
2233 * - replace CTRL-V CTRL-V with CTRL-V
2234 * - replace CTRL-V 'n' with '\n'
2235 *
2236 * Check for a long line as written by viminfo_writestring().
2237 *
2238 * Return the string in allocated memory (NULL when out of memory).
2239 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 char_u *
2241viminfo_readstring(virp, off, convert)
2242 vir_T *virp;
2243 int off; /* offset for virp->vir_line */
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00002244 int convert UNUSED; /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245{
2246 char_u *retval;
2247 char_u *s, *d;
2248 long len;
2249
2250 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2251 {
2252 len = atol((char *)virp->vir_line + off + 1);
2253 retval = lalloc(len, TRUE);
2254 if (retval == NULL)
2255 {
2256 /* Line too long? File messed up? Skip next line. */
2257 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2258 return NULL;
2259 }
2260 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2261 s = retval + 1; /* Skip the leading '<' */
2262 }
2263 else
2264 {
2265 retval = vim_strsave(virp->vir_line + off);
2266 if (retval == NULL)
2267 return NULL;
2268 s = retval;
2269 }
2270
2271 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2272 d = retval;
2273 while (*s != NUL && *s != '\n')
2274 {
2275 if (s[0] == Ctrl_V && s[1] != NUL)
2276 {
2277 if (s[1] == 'n')
2278 *d++ = '\n';
2279 else
2280 *d++ = Ctrl_V;
2281 s += 2;
2282 }
2283 else
2284 *d++ = *s++;
2285 }
2286 *d = NUL;
2287
2288#ifdef FEAT_MBYTE
2289 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2290 {
2291 d = string_convert(&virp->vir_conv, retval, NULL);
2292 if (d != NULL)
2293 {
2294 vim_free(retval);
2295 retval = d;
2296 }
2297 }
2298#endif
2299
2300 return retval;
2301}
2302
2303/*
2304 * write string to viminfo file
2305 * - replace CTRL-V with CTRL-V CTRL-V
2306 * - replace '\n' with CTRL-V 'n'
2307 * - add a '\n' at the end
2308 *
2309 * For a long line:
2310 * - write " CTRL-V <length> \n " in first line
2311 * - write " < <string> \n " in second line
2312 */
2313 void
2314viminfo_writestring(fd, p)
2315 FILE *fd;
2316 char_u *p;
2317{
2318 int c;
2319 char_u *s;
2320 int len = 0;
2321
2322 for (s = p; *s != NUL; ++s)
2323 {
2324 if (*s == Ctrl_V || *s == '\n')
2325 ++len;
2326 ++len;
2327 }
2328
2329 /* If the string will be too long, write its length and put it in the next
2330 * line. Take into account that some room is needed for what comes before
2331 * the string (e.g., variable name). Add something to the length for the
2332 * '<', NL and trailing NUL. */
2333 if (len > LSIZE / 2)
2334 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2335
2336 while ((c = *p++) != NUL)
2337 {
2338 if (c == Ctrl_V || c == '\n')
2339 {
2340 putc(Ctrl_V, fd);
2341 if (c == '\n')
2342 c = 'n';
2343 }
2344 putc(c, fd);
2345 }
2346 putc('\n', fd);
2347}
2348#endif /* FEAT_VIMINFO */
2349
2350/*
2351 * Implementation of ":fixdel", also used by get_stty().
2352 * <BS> resulting <Del>
2353 * ^? ^H
2354 * not ^? ^?
2355 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 void
2357do_fixdel(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00002358 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359{
2360 char_u *p;
2361
2362 p = find_termcode((char_u *)"kb");
2363 add_termcode((char_u *)"kD", p != NULL
2364 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2365}
2366
2367 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002368print_line_no_prefix(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 linenr_T lnum;
2370 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002371 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002373 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374
2375 if (curwin->w_p_nu || use_number)
2376 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002377 vim_snprintf((char *)numbuf, sizeof(numbuf),
2378 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2380 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002381 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382}
2383
2384/*
2385 * Print a text line. Also in silent mode ("ex -s").
2386 */
2387 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002388print_line(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 linenr_T lnum;
2390 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002391 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392{
2393 int save_silent = silent_mode;
2394
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002396 silent_mode = FALSE;
2397 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2398 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 if (save_silent)
2400 {
2401 msg_putchar('\n');
2402 cursor_on(); /* msg_start() switches it off */
2403 out_flush();
2404 silent_mode = save_silent;
2405 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002406 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407}
2408
2409/*
2410 * ":file[!] [fname]".
2411 */
2412 void
2413ex_file(eap)
2414 exarg_T *eap;
2415{
2416 char_u *fname, *sfname, *xfname;
2417 buf_T *buf;
2418
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002419 /* ":0file" removes the file name. Check for illegal uses ":3file",
2420 * "0file name", etc. */
2421 if (eap->addr_count > 0
2422 && (*eap->arg != NUL
2423 || eap->line2 > 0
2424 || eap->addr_count > 1))
2425 {
2426 EMSG(_(e_invarg));
2427 return;
2428 }
2429
2430 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 {
2432#ifdef FEAT_AUTOCMD
2433 buf = curbuf;
2434 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2435 /* buffer changed, don't change name now */
2436 if (buf != curbuf)
2437 return;
2438# ifdef FEAT_EVAL
2439 if (aborting()) /* autocmds may abort script processing */
2440 return;
2441# endif
2442#endif
2443 /*
2444 * The name of the current buffer will be changed.
2445 * A new (unlisted) buffer entry needs to be made to hold the old file
2446 * name, which will become the alternate file name.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002447 * But don't set the alternate file name if the buffer didn't have a
2448 * name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 */
2450 fname = curbuf->b_ffname;
2451 sfname = curbuf->b_sfname;
2452 xfname = curbuf->b_fname;
2453 curbuf->b_ffname = NULL;
2454 curbuf->b_sfname = NULL;
2455 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2456 {
2457 curbuf->b_ffname = fname;
2458 curbuf->b_sfname = sfname;
2459 return;
2460 }
2461 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002462 if (xfname != NULL && *xfname != NUL)
2463 {
2464 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2465 if (buf != NULL && !cmdmod.keepalt)
2466 curwin->w_alt_fnum = buf->b_fnum;
2467 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 vim_free(fname);
2469 vim_free(sfname);
2470#ifdef FEAT_AUTOCMD
2471 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2472#endif
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002473 /* Change directories when the 'acd' option is set. */
2474 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 }
2476 /* print full file name if :cd used */
2477 fileinfo(FALSE, FALSE, eap->forceit);
2478}
2479
2480/*
2481 * ":update".
2482 */
2483 void
2484ex_update(eap)
2485 exarg_T *eap;
2486{
2487 if (curbufIsChanged())
2488 (void)do_write(eap);
2489}
2490
2491/*
2492 * ":write" and ":saveas".
2493 */
2494 void
2495ex_write(eap)
2496 exarg_T *eap;
2497{
2498 if (eap->usefilter) /* input lines to shell command */
2499 do_bang(1, eap, FALSE, TRUE, FALSE);
2500 else
2501 (void)do_write(eap);
2502}
2503
2504/*
2505 * write current buffer to file 'eap->arg'
2506 * if 'eap->append' is TRUE, append to the file
2507 *
2508 * if *eap->arg == NUL write to current file
2509 *
2510 * return FAIL for failure, OK otherwise
2511 */
2512 int
2513do_write(eap)
2514 exarg_T *eap;
2515{
2516 int other;
2517 char_u *fname = NULL; /* init to shut up gcc */
2518 char_u *ffname;
2519 int retval = FAIL;
2520 char_u *free_fname = NULL;
2521#ifdef FEAT_BROWSE
2522 char_u *browse_file = NULL;
2523#endif
2524 buf_T *alt_buf = NULL;
2525
2526 if (not_writing()) /* check 'write' option */
2527 return FAIL;
2528
2529 ffname = eap->arg;
2530#ifdef FEAT_BROWSE
2531 if (cmdmod.browse)
2532 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002533 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 NULL, NULL, NULL, curbuf);
2535 if (browse_file == NULL)
2536 goto theend;
2537 ffname = browse_file;
2538 }
2539#endif
2540 if (*ffname == NUL)
2541 {
2542 if (eap->cmdidx == CMD_saveas)
2543 {
2544 EMSG(_(e_argreq));
2545 goto theend;
2546 }
2547 other = FALSE;
2548 }
2549 else
2550 {
2551 fname = ffname;
2552 free_fname = fix_fname(ffname);
2553 /*
2554 * When out-of-memory, keep unexpanded file name, because we MUST be
2555 * able to write the file in this situation.
2556 */
2557 if (free_fname != NULL)
2558 ffname = free_fname;
2559 other = otherfile(ffname);
2560 }
2561
2562 /*
2563 * If we have a new file, put its name in the list of alternate file names.
2564 */
2565 if (other)
2566 {
2567 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2568 || eap->cmdidx == CMD_saveas)
2569 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2570 else
2571 alt_buf = buflist_findname(ffname);
2572 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2573 {
2574 /* Overwriting a file that is loaded in another buffer is not a
2575 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00002576 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 goto theend;
2578 }
2579 }
2580
2581 /*
2582 * Writing to the current file is not allowed in readonly mode
2583 * and a file name is required.
2584 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2585 */
2586 if (!other && (
2587#ifdef FEAT_QUICKFIX
2588 bt_dontwrite_msg(curbuf) ||
2589#endif
2590 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2591 goto theend;
2592
2593 if (!other)
2594 {
2595 ffname = curbuf->b_ffname;
2596 fname = curbuf->b_fname;
2597 /*
2598 * Not writing the whole file is only allowed with '!'.
2599 */
2600 if ( (eap->line1 != 1
2601 || eap->line2 != curbuf->b_ml.ml_line_count)
2602 && !eap->forceit
2603 && !eap->append
2604 && !p_wa)
2605 {
2606#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2607 if (p_confirm || cmdmod.confirm)
2608 {
2609 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2610 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2611 goto theend;
2612 eap->forceit = TRUE;
2613 }
2614 else
2615#endif
2616 {
2617 EMSG(_("E140: Use ! to write partial buffer"));
2618 goto theend;
2619 }
2620 }
2621 }
2622
2623 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2624 {
2625 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2626 {
2627#ifdef FEAT_AUTOCMD
2628 buf_T *was_curbuf = curbuf;
2629
2630 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002631 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632# ifdef FEAT_EVAL
2633 if (curbuf != was_curbuf || aborting())
2634# else
2635 if (curbuf != was_curbuf)
2636# endif
2637 {
2638 /* buffer changed, don't change name now */
2639 retval = FAIL;
2640 goto theend;
2641 }
2642#endif
2643 /* Exchange the file names for the current and the alternate
2644 * buffer. This makes it look like we are now editing the buffer
2645 * under the new name. Must be done before buf_write(), because
2646 * if there is no file name and 'cpo' contains 'F', it will set
2647 * the file name. */
2648 fname = alt_buf->b_fname;
2649 alt_buf->b_fname = curbuf->b_fname;
2650 curbuf->b_fname = fname;
2651 fname = alt_buf->b_ffname;
2652 alt_buf->b_ffname = curbuf->b_ffname;
2653 curbuf->b_ffname = fname;
2654 fname = alt_buf->b_sfname;
2655 alt_buf->b_sfname = curbuf->b_sfname;
2656 curbuf->b_sfname = fname;
2657 buf_name_changed(curbuf);
2658#ifdef FEAT_AUTOCMD
2659 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002660 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 if (!alt_buf->b_p_bl)
2662 {
2663 alt_buf->b_p_bl = TRUE;
2664 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2665 }
2666# ifdef FEAT_EVAL
2667 if (curbuf != was_curbuf || aborting())
2668# else
2669 if (curbuf != was_curbuf)
2670# endif
2671 {
2672 /* buffer changed, don't write the file */
2673 retval = FAIL;
2674 goto theend;
2675 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002676
2677 /* If 'filetype' was empty try detecting it now. */
2678 if (*curbuf->b_p_ft == NUL)
2679 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002680 if (au_has_group((char_u *)"filetypedetect"))
2681 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2682 TRUE);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002683 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002684 }
Bram Moolenaarf666f0e2010-11-24 17:59:32 +01002685
2686 /* Autocommands may have changed buffer names, esp. when
2687 * 'autochdir' is set. */
2688 fname = curbuf->b_sfname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689#endif
2690 }
2691
2692 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2693 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002694
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002695 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002696 if (eap->cmdidx == CMD_saveas)
2697 {
2698 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002699 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002700 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002701#ifdef FEAT_WINDOWS
2702 redraw_tabline = TRUE;
2703#endif
2704 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002705 /* Change directories when the 'acd' option is set. */
2706 DO_AUTOCHDIR
2707 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 }
2709
2710theend:
2711#ifdef FEAT_BROWSE
2712 vim_free(browse_file);
2713#endif
2714 vim_free(free_fname);
2715 return retval;
2716}
2717
2718/*
2719 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2720 * BF_NEW or BF_READERR, check for overwriting current file.
2721 * May set eap->forceit if a dialog says it's OK to overwrite.
2722 * Return OK if it's OK, FAIL if it is not.
2723 */
Bram Moolenaar8218f602012-04-25 17:32:18 +02002724 int
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725check_overwrite(eap, buf, fname, ffname, other)
2726 exarg_T *eap;
2727 buf_T *buf;
2728 char_u *fname; /* file name to be used (can differ from
2729 buf->ffname) */
2730 char_u *ffname; /* full path version of fname */
2731 int other; /* writing under other name */
2732{
2733 /*
2734 * write to other file or b_flags set or not writing the whole file:
2735 * overwriting only allowed with '!'
2736 */
2737 if ( (other
2738 || (buf->b_flags & BF_NOTEDITED)
2739 || ((buf->b_flags & BF_NEW)
2740 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2741 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002743#ifdef FEAT_QUICKFIX
2744 && !bt_nofile(buf)
2745#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 && vim_fexists(ffname))
2747 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002748 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002750#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002751 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002752 if (mch_isdir(ffname))
2753 {
2754 EMSG2(_(e_isadir2), ffname);
2755 return FAIL;
2756 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757#endif
2758#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002759 if (p_confirm || cmdmod.confirm)
2760 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002761 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002763 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2764 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2765 return FAIL;
2766 eap->forceit = TRUE;
2767 }
2768 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002770 {
2771 EMSG(_(e_exists));
2772 return FAIL;
2773 }
2774 }
2775
2776 /* For ":w! filename" check that no swap file exists for "filename". */
2777 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002779 char_u *dir;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002780 char_u *p;
2781 int r;
2782 char_u *swapname;
2783
2784 /* We only try the first entry in 'directory', without checking if
2785 * it's writable. If the "." directory is not writable the write
2786 * will probably fail anyway.
2787 * Use 'shortname' of the current buffer, since there is no buffer
2788 * for the written file. */
2789 if (*p_dir == NUL)
Bram Moolenaard9462e32011-04-11 21:35:11 +02002790 {
2791 dir = alloc(5);
2792 if (dir == NULL)
2793 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002794 STRCPY(dir, ".");
Bram Moolenaard9462e32011-04-11 21:35:11 +02002795 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002796 else
2797 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002798 dir = alloc(MAXPATHL);
2799 if (dir == NULL)
2800 return FAIL;
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002801 p = p_dir;
2802 copy_option_part(&p, dir, MAXPATHL, ",");
2803 }
2804 swapname = makeswapname(fname, ffname, curbuf, dir);
Bram Moolenaard9462e32011-04-11 21:35:11 +02002805 vim_free(dir);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002806 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002807 if (r)
2808 {
2809#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2810 if (p_confirm || cmdmod.confirm)
2811 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002812 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002813
2814 dialog_msg(buff,
2815 _("Swap file \"%s\" exists, overwrite anyway?"),
2816 swapname);
2817 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2818 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002819 {
2820 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002821 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002822 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002823 eap->forceit = TRUE;
2824 }
2825 else
2826#endif
2827 {
2828 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2829 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002830 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002831 return FAIL;
2832 }
2833 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002834 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 }
2836 }
2837 return OK;
2838}
2839
2840/*
2841 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2842 */
2843 void
2844ex_wnext(eap)
2845 exarg_T *eap;
2846{
2847 int i;
2848
2849 if (eap->cmd[1] == 'n')
2850 i = curwin->w_arg_idx + (int)eap->line2;
2851 else
2852 i = curwin->w_arg_idx - (int)eap->line2;
2853 eap->line1 = 1;
2854 eap->line2 = curbuf->b_ml.ml_line_count;
2855 if (do_write(eap) != FAIL)
2856 do_argfile(eap, i);
2857}
2858
2859/*
2860 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2861 */
2862 void
2863do_wqall(eap)
2864 exarg_T *eap;
2865{
2866 buf_T *buf;
2867 int error = 0;
2868 int save_forceit = eap->forceit;
2869
2870 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2871 exiting = TRUE;
2872
2873 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2874 {
2875 if (bufIsChanged(buf))
2876 {
2877 /*
2878 * Check if there is a reason the buffer cannot be written:
2879 * 1. if the 'write' option is set
2880 * 2. if there is no file name (even after browsing)
2881 * 3. if the 'readonly' is set (even after a dialog)
2882 * 4. if overwriting is allowed (even after a dialog)
2883 */
2884 if (not_writing())
2885 {
2886 ++error;
2887 break;
2888 }
2889#ifdef FEAT_BROWSE
2890 /* ":browse wall": ask for file name if there isn't one */
2891 if (buf->b_ffname == NULL && cmdmod.browse)
2892 browse_save_fname(buf);
2893#endif
2894 if (buf->b_ffname == NULL)
2895 {
2896 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2897 ++error;
2898 }
2899 else if (check_readonly(&eap->forceit, buf)
2900 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2901 FALSE) == FAIL)
2902 {
2903 ++error;
2904 }
2905 else
2906 {
2907 if (buf_write_all(buf, eap->forceit) == FAIL)
2908 ++error;
2909#ifdef FEAT_AUTOCMD
2910 /* an autocommand may have deleted the buffer */
2911 if (!buf_valid(buf))
2912 buf = firstbuf;
2913#endif
2914 }
2915 eap->forceit = save_forceit; /* check_overwrite() may set it */
2916 }
2917 }
2918 if (exiting)
2919 {
2920 if (!error)
2921 getout(0); /* exit Vim */
2922 not_exiting();
2923 }
2924}
2925
2926/*
2927 * Check the 'write' option.
2928 * Return TRUE and give a message when it's not st.
2929 */
2930 int
2931not_writing()
2932{
2933 if (p_write)
2934 return FALSE;
2935 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2936 return TRUE;
2937}
2938
2939/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002940 * Check if a buffer is read-only (either 'readonly' option is set or file is
2941 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2942 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 */
2944 static int
2945check_readonly(forceit, buf)
2946 int *forceit;
2947 buf_T *buf;
2948{
Bram Moolenaar5386a122007-06-28 20:02:32 +00002949 struct stat st;
2950
2951 /* Handle a file being readonly when the 'readonly' option is set or when
2952 * the file exists and permissions are read-only.
2953 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2954 * important for device checks but not here. */
2955 if (!*forceit && (buf->b_p_ro
2956 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2957 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 {
2959#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2960 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2961 {
Bram Moolenaard9462e32011-04-11 21:35:11 +02002962 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963
Bram Moolenaar5386a122007-06-28 20:02:32 +00002964 if (buf->b_p_ro)
2965 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2966 buf->b_fname);
2967 else
2968 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 +00002969 buf->b_fname);
2970
2971 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2972 {
2973 /* Set forceit, to force the writing of a readonly file */
2974 *forceit = TRUE;
2975 return FALSE;
2976 }
2977 else
2978 return TRUE;
2979 }
2980 else
2981#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002982 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002984 else
2985 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2986 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 return TRUE;
2988 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 return FALSE;
2991}
2992
2993/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002994 * Try to abandon current file and edit a new or existing file.
2995 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002997 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00002998 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3000 */
3001 int
3002getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3003 int fnum;
3004 char_u *ffname;
3005 char_u *sfname;
3006 int setpm;
3007 linenr_T lnum;
3008 int forceit;
3009{
3010 int other;
3011 int retval;
3012 char_u *free_me = NULL;
3013
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003014 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003016#ifdef FEAT_AUTOCMD
3017 if (curbuf_locked())
3018 return 1;
3019#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020
3021 if (fnum == 0)
3022 {
3023 /* make ffname full path, set sfname */
3024 fname_expand(curbuf, &ffname, &sfname);
3025 other = otherfile(ffname);
3026 free_me = ffname; /* has been allocated, free() later */
3027 }
3028 else
3029 other = (fnum != curbuf->b_fnum);
3030
3031 if (other)
3032 ++no_wait_return; /* don't wait for autowrite message */
3033 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3034 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3035 {
3036#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3037 if (p_confirm && p_write)
3038 dialog_changed(curbuf, FALSE);
3039 if (curbufIsChanged())
3040#endif
3041 {
3042 if (other)
3043 --no_wait_return;
3044 EMSG(_(e_nowrtmsg));
3045 retval = 2; /* file has been changed */
3046 goto theend;
3047 }
3048 }
3049 if (other)
3050 --no_wait_return;
3051 if (setpm)
3052 setpcmark();
3053 if (!other)
3054 {
3055 if (lnum != 0)
3056 curwin->w_cursor.lnum = lnum;
3057 check_cursor_lnum();
3058 beginline(BL_SOL | BL_FIX);
3059 retval = 0; /* it's in the same file */
3060 }
3061 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003062 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3063 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 retval = -1; /* opened another file */
3065 else
3066 retval = 1; /* error encountered */
3067
3068theend:
3069 vim_free(free_me);
3070 return retval;
3071}
3072
3073/*
3074 * start editing a new file
3075 *
3076 * fnum: file number; if zero use ffname/sfname
3077 * ffname: the file name
3078 * - full path if sfname used,
3079 * - any file name if sfname is NULL
3080 * - empty string to re-edit with the same file name (but may be
3081 * in a different directory)
3082 * - NULL to start an empty buffer
3083 * sfname: the short file name (or NULL)
3084 * eap: contains the command to be executed after loading the file and
3085 * forced 'ff' and 'fenc'
3086 * newlnum: if > 0: put cursor on this line number (if possible)
3087 * if ECMD_LASTL: use last position in loaded file
3088 * if ECMD_LAST: use last position in all files
3089 * if ECMD_ONE: use first line
3090 * flags:
3091 * ECMD_HIDE: if TRUE don't free the current buffer
3092 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3093 * ECMD_OLDBUF: use existing buffer if it exists
3094 * ECMD_FORCEIT: ! used for Ex command
3095 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003096 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003097 * window, NULL when splitting the window first. When not NULL info
3098 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 *
3100 * return FAIL for failure, OK otherwise
3101 */
3102 int
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003103do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 int fnum;
3105 char_u *ffname;
3106 char_u *sfname;
3107 exarg_T *eap; /* can be NULL! */
3108 linenr_T newlnum;
3109 int flags;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003110 win_T *oldwin;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111{
3112 int other_file; /* TRUE if editing another file */
3113 int oldbuf; /* TRUE if using existing buffer */
3114#ifdef FEAT_AUTOCMD
3115 int auto_buf = FALSE; /* TRUE if autocommands brought us
3116 into the buffer unexpectedly */
3117 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003118 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119#endif
3120 buf_T *buf;
3121#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3122 buf_T *old_curbuf = curbuf;
3123#endif
3124 char_u *free_fname = NULL;
3125#ifdef FEAT_BROWSE
3126 char_u *browse_file = NULL;
3127#endif
3128 int retval = FAIL;
3129 long n;
3130 linenr_T lnum;
3131 linenr_T topline = 0;
3132 int newcol = -1;
3133 int solcol = -1;
3134 pos_T *pos;
3135#ifdef FEAT_SUN_WORKSHOP
3136 char_u *cp;
3137#endif
3138 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003139#ifdef FEAT_SPELL
3140 int did_get_winopts = FALSE;
3141#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003142 int readfile_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143
3144 if (eap != NULL)
3145 command = eap->do_ecmd_cmd;
3146
3147 if (fnum != 0)
3148 {
3149 if (fnum == curbuf->b_fnum) /* file is already being edited */
3150 return OK; /* nothing to do */
3151 other_file = TRUE;
3152 }
3153 else
3154 {
3155#ifdef FEAT_BROWSE
3156 if (cmdmod.browse)
3157 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003158# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003159 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003160# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003161 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003162# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003163 au_has_group((char_u *)"FileExplorer"))
3164 {
3165 /* No browsing supported but we do have the file explorer:
3166 * Edit the directory. */
3167 if (ffname == NULL || !mch_isdir(ffname))
3168 ffname = (char_u *)".";
3169 }
3170 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003171# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003172 {
3173 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003175 if (browse_file == NULL)
3176 goto theend;
3177 ffname = browse_file;
3178 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 }
3180#endif
3181 /* if no short name given, use ffname for short name */
3182 if (sfname == NULL)
3183 sfname = ffname;
3184#ifdef USE_FNAME_CASE
3185# ifdef USE_LONG_FNAME
3186 if (USE_LONG_FNAME)
3187# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003188 if (sfname != NULL)
3189 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190#endif
3191
3192#ifdef FEAT_LISTCMDS
3193 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3194 goto theend;
3195#endif
3196
3197 if (ffname == NULL)
3198 other_file = TRUE;
3199 /* there is no file name */
3200 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3201 other_file = FALSE;
3202 else
3203 {
3204 if (*ffname == NUL) /* re-edit with same file name */
3205 {
3206 ffname = curbuf->b_ffname;
3207 sfname = curbuf->b_fname;
3208 }
3209 free_fname = fix_fname(ffname); /* may expand to full path name */
3210 if (free_fname != NULL)
3211 ffname = free_fname;
3212 other_file = otherfile(ffname);
3213#ifdef FEAT_SUN_WORKSHOP
3214 if (usingSunWorkShop && p_acd
3215 && (cp = vim_strrchr(sfname, '/')) != NULL)
3216 sfname = ++cp;
3217#endif
3218 }
3219 }
3220
3221 /*
3222 * if the file was changed we may not be allowed to abandon it
3223 * - if we are going to re-edit the same file
3224 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3225 */
3226 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3227 || (curbuf->b_nwindows == 1
3228 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3229 && check_changed(curbuf, p_awa, !other_file,
3230 (flags & ECMD_FORCEIT), FALSE))
3231 {
3232 if (fnum == 0 && other_file && ffname != NULL)
3233 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3234 goto theend;
3235 }
3236
3237#ifdef FEAT_VISUAL
3238 /*
3239 * End Visual mode before switching to another buffer, so the text can be
3240 * copied into the GUI selection buffer.
3241 */
3242 reset_VIsual();
3243#endif
3244
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003245#ifdef FEAT_AUTOCMD
3246 if ((command != NULL || newlnum > (linenr_T)0)
3247 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3248 {
3249 int len;
3250 char_u *p;
3251
3252 /* Set v:swapcommand for the SwapExists autocommands. */
3253 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003254 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003255 else
3256 len = 30;
3257 p = alloc((unsigned)len);
3258 if (p != NULL)
3259 {
3260 if (command != NULL)
3261 vim_snprintf((char *)p, len, ":%s\r", command);
3262 else
3263 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3264 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3265 did_set_swapcommand = TRUE;
3266 vim_free(p);
3267 }
3268 }
3269#endif
3270
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 /*
3272 * If we are starting to edit another file, open a (new) buffer.
3273 * Otherwise we re-use the current buffer.
3274 */
3275 if (other_file)
3276 {
3277#ifdef FEAT_LISTCMDS
3278 if (!(flags & ECMD_ADDBUF))
3279#endif
3280 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003281 if (!cmdmod.keepalt)
3282 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003283 if (oldwin != NULL)
3284 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 }
3286
3287 if (fnum)
3288 buf = buflist_findnr(fnum);
3289 else
3290 {
3291#ifdef FEAT_LISTCMDS
3292 if (flags & ECMD_ADDBUF)
3293 {
3294 linenr_T tlnum = 1L;
3295
3296 if (command != NULL)
3297 {
3298 tlnum = atol((char *)command);
3299 if (tlnum <= 0)
3300 tlnum = 1L;
3301 }
3302 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3303 goto theend;
3304 }
3305#endif
3306 buf = buflist_new(ffname, sfname, 0L,
3307 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3308 }
3309 if (buf == NULL)
3310 goto theend;
3311 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3312 {
3313 oldbuf = FALSE;
3314 buf->b_nwindows = 0;
3315 }
3316 else /* existing memfile */
3317 {
3318 oldbuf = TRUE;
3319 (void)buf_check_timestamp(buf, FALSE);
3320 /* Check if autocommands made buffer invalid or changed the current
3321 * buffer. */
3322 if (!buf_valid(buf)
3323#ifdef FEAT_AUTOCMD
3324 || curbuf != old_curbuf
3325#endif
3326 )
3327 goto theend;
3328#ifdef FEAT_EVAL
3329 if (aborting()) /* autocmds may abort script processing */
3330 goto theend;
3331#endif
3332 }
3333
3334 /* May jump to last used line number for a loaded buffer or when asked
3335 * for explicitly */
3336 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3337 {
3338 pos = buflist_findfpos(buf);
3339 newlnum = pos->lnum;
3340 solcol = pos->col;
3341 }
3342
3343 /*
3344 * Make the (new) buffer the one used by the current window.
3345 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3346 * If the current buffer was empty and has no file name, curbuf
3347 * is returned by buflist_new().
3348 */
3349 if (buf != curbuf)
3350 {
3351#ifdef FEAT_AUTOCMD
3352 /*
3353 * Be careful: The autocommands may delete any buffer and change
3354 * the current buffer.
3355 * - If the buffer we are going to edit is deleted, give up.
3356 * - If the current buffer is deleted, prefer to load the new
3357 * buffer when loading a buffer is required. This avoids
3358 * loading another buffer which then must be closed again.
3359 * - If we ended up in the new buffer already, need to skip a few
3360 * things, set auto_buf.
3361 */
3362 if (buf->b_fname != NULL)
3363 new_name = vim_strsave(buf->b_fname);
3364 au_new_curbuf = buf;
3365 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3366 if (!buf_valid(buf)) /* new buffer has been deleted */
3367 {
3368 delbuf_msg(new_name); /* frees new_name */
3369 goto theend;
3370 }
3371# ifdef FEAT_EVAL
3372 if (aborting()) /* autocmds may abort script processing */
3373 {
3374 vim_free(new_name);
3375 goto theend;
3376 }
3377# endif
3378 if (buf == curbuf) /* already in new buffer */
3379 auto_buf = TRUE;
3380 else
3381 {
3382 if (curbuf == old_curbuf)
3383#endif
3384 buf_copy_options(buf, BCO_ENTER);
3385
3386 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003387 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003388 close_buffer(oldwin, curbuf,
Bram Moolenaar42ec6562012-02-22 14:58:37 +01003389 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390
3391#ifdef FEAT_AUTOCMD
Bram Moolenaarfc573802011-12-30 15:01:59 +01003392 /* Autocommands may open a new window and leave oldwin open
3393 * which leads to crashes since the above call sets
3394 * oldwin->w_buffer to NULL. */
3395 if (curwin != oldwin && oldwin != aucmd_win
3396 && win_valid(oldwin) && oldwin->w_buffer == NULL)
3397 win_close(oldwin, FALSE);
3398
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399# ifdef FEAT_EVAL
3400 if (aborting()) /* autocmds may abort script processing */
3401 {
3402 vim_free(new_name);
3403 goto theend;
3404 }
3405# endif
3406 /* Be careful again, like above. */
3407 if (!buf_valid(buf)) /* new buffer has been deleted */
3408 {
3409 delbuf_msg(new_name); /* frees new_name */
3410 goto theend;
3411 }
3412 if (buf == curbuf) /* already in new buffer */
3413 auto_buf = TRUE;
3414 else
3415#endif
3416 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003417#ifdef FEAT_SYN_HL
3418 /*
3419 * <VN> We could instead free the synblock
3420 * and re-attach to buffer, perhaps.
3421 */
3422 if (curwin->w_s == &(curwin->w_buffer->b_s))
Bram Moolenaar720ce532012-04-25 12:57:28 +02003423 curwin->w_s = &(buf->b_s);
Bram Moolenaar860cae12010-06-05 23:22:07 +02003424#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 curwin->w_buffer = buf;
3426 curbuf = buf;
3427 ++curbuf->b_nwindows;
3428 /* set 'fileformat' */
3429 if (*p_ffs && !oldbuf)
3430 set_fileformat(default_fileformat(), OPT_LOCAL);
3431 }
3432
3433 /* May get the window options from the last time this buffer
3434 * was in this window (or another window). If not used
3435 * before, reset the local window options to the global
3436 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003437 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003438#ifdef FEAT_SPELL
3439 did_get_winopts = TRUE;
3440#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441
3442#ifdef FEAT_AUTOCMD
3443 }
3444 vim_free(new_name);
3445 au_new_curbuf = NULL;
3446#endif
3447 }
3448 else
3449 ++curbuf->b_nwindows;
3450
3451 curwin->w_pcmark.lnum = 1;
3452 curwin->w_pcmark.col = 0;
3453 }
3454 else /* !other_file */
3455 {
3456 if (
3457#ifdef FEAT_LISTCMDS
3458 (flags & ECMD_ADDBUF) ||
3459#endif
3460 check_fname() == FAIL)
3461 goto theend;
3462 oldbuf = (flags & ECMD_OLDBUF);
3463 }
3464
3465 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3466 {
3467 char_u *p;
3468
3469 curbuf->b_help = TRUE;
3470#ifdef FEAT_QUICKFIX
3471 set_string_option_direct((char_u *)"buftype", -1,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003472 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473#endif
3474
3475 /*
3476 * Always set these options after jumping to a help tag, because the
3477 * user may have an autocommand that gets in the way.
3478 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3479 * latin1 word characters (for translated help files).
3480 * Only set it when needed, buf_init_chartab() is some work.
3481 */
3482 p =
3483#ifdef EBCDIC
3484 (char_u *)"65-255,^*,^|,^\"";
3485#else
3486 (char_u *)"!-~,^*,^|,^\",192-255";
3487#endif
3488 if (STRCMP(curbuf->b_p_isk, p) != 0)
3489 {
3490 set_string_option_direct((char_u *)"isk", -1, p,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003491 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 check_buf_options(curbuf);
3493 (void)buf_init_chartab(curbuf, FALSE);
3494 }
3495
3496 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3497 curwin->w_p_list = FALSE; /* no list mode */
3498
3499 curbuf->b_p_ma = FALSE; /* not modifiable */
3500 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3501 curwin->w_p_nu = 0; /* no line numbers */
Bram Moolenaar64486672010-05-16 15:46:46 +02003502 curwin->w_p_rnu = 0; /* no relative line numbers */
Bram Moolenaar3368ea22010-09-21 16:56:35 +02003503 RESET_BINDING(curwin); /* no scroll or cursor binding */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504#ifdef FEAT_ARABIC
3505 curwin->w_p_arab = FALSE; /* no arabic mode */
3506#endif
3507#ifdef FEAT_RIGHTLEFT
3508 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3509#endif
3510#ifdef FEAT_FOLDING
3511 curwin->w_p_fen = FALSE; /* No folding in the help window */
3512#endif
3513#ifdef FEAT_DIFF
3514 curwin->w_p_diff = FALSE; /* No 'diff' */
3515#endif
Bram Moolenaara1956f62006-03-12 22:18:00 +00003516#ifdef FEAT_SPELL
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00003517 curwin->w_p_spell = FALSE; /* No spell checking */
3518#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519
3520#ifdef FEAT_AUTOCMD
3521 buf = curbuf;
3522#endif
3523 set_buflisted(FALSE);
3524 }
3525 else
3526 {
3527#ifdef FEAT_AUTOCMD
3528 buf = curbuf;
3529#endif
3530 /* Don't make a buffer listed if it's a help buffer. Useful when
3531 * using CTRL-O to go back to a help file. */
3532 if (!curbuf->b_help)
3533 set_buflisted(TRUE);
3534 }
3535
3536#ifdef FEAT_AUTOCMD
3537 /* If autocommands change buffers under our fingers, forget about
3538 * editing the file. */
3539 if (buf != curbuf)
3540 goto theend;
3541# ifdef FEAT_EVAL
3542 if (aborting()) /* autocmds may abort script processing */
3543 goto theend;
3544# endif
3545
3546 /* Since we are starting to edit a file, consider the filetype to be
3547 * unset. Helps for when an autocommand changes files and expects syntax
3548 * highlighting to work in the other file. */
3549 did_filetype = FALSE;
3550#endif
3551
3552/*
3553 * other_file oldbuf
3554 * FALSE FALSE re-edit same file, buffer is re-used
3555 * FALSE TRUE re-edit same file, nothing changes
3556 * TRUE FALSE start editing new file, new buffer
3557 * TRUE TRUE start editing in existing buffer (nothing to do)
3558 */
3559 if (!other_file && !oldbuf) /* re-use the buffer */
3560 {
3561 set_last_cursor(curwin); /* may set b_last_cursor */
3562 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3563 {
3564 newlnum = curwin->w_cursor.lnum;
3565 solcol = curwin->w_cursor.col;
3566 }
3567#ifdef FEAT_AUTOCMD
3568 buf = curbuf;
3569 if (buf->b_fname != NULL)
3570 new_name = vim_strsave(buf->b_fname);
3571 else
3572 new_name = NULL;
3573#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003574 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
3575 {
3576 /* Save all the text, so that the reload can be undone.
3577 * Sync first so that this is a separate undo-able action. */
3578 u_sync(FALSE);
3579 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
3580 == FAIL)
3581 goto theend;
3582 u_unchanged(curbuf);
3583 buf_freeall(curbuf, BFA_KEEP_UNDO);
3584
3585 /* tell readfile() not to clear or reload undo info */
3586 readfile_flags = READ_KEEP_UNDO;
3587 }
3588 else
3589 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590#ifdef FEAT_AUTOCMD
3591 /* If autocommands deleted the buffer we were going to re-edit, give
3592 * up and jump to the end. */
3593 if (!buf_valid(buf))
3594 {
3595 delbuf_msg(new_name); /* frees new_name */
3596 goto theend;
3597 }
3598 vim_free(new_name);
3599
3600 /* If autocommands change buffers under our fingers, forget about
3601 * re-editing the file. Should do the buf_clear_file(), but perhaps
3602 * the autocommands changed the buffer... */
3603 if (buf != curbuf)
3604 goto theend;
3605# ifdef FEAT_EVAL
3606 if (aborting()) /* autocmds may abort script processing */
3607 goto theend;
3608# endif
3609#endif
3610 buf_clear_file(curbuf);
3611 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3612 curbuf->b_op_end.lnum = 0;
3613 }
3614
3615/*
3616 * If we get here we are sure to start editing
3617 */
3618 /* don't redraw until the cursor is in the right line */
3619 ++RedrawingDisabled;
3620
3621 /* Assume success now */
3622 retval = OK;
3623
3624 /*
3625 * Reset cursor position, could be used by autocommands.
3626 */
3627 check_cursor();
3628
3629 /*
3630 * Check if we are editing the w_arg_idx file in the argument list.
3631 */
3632 check_arg_idx(curwin);
3633
3634#ifdef FEAT_AUTOCMD
3635 if (!auto_buf)
3636#endif
3637 {
3638 /*
3639 * Set cursor and init window before reading the file and executing
3640 * autocommands. This allows for the autocommands to position the
3641 * cursor.
3642 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003643 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644
3645#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003646 /* It's possible that all lines in the buffer changed. Need to update
3647 * automatic folding for all windows where it's used. */
3648# ifdef FEAT_WINDOWS
3649 {
3650 win_T *win;
3651 tabpage_T *tp;
3652
3653 FOR_ALL_TAB_WINDOWS(tp, win)
3654 if (win->w_buffer == curbuf)
3655 foldUpdateAll(win);
3656 }
3657# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003659# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660#endif
3661
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003662 /* Change directories when the 'acd' option is set. */
3663 DO_AUTOCHDIR
3664
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 /*
3666 * Careful: open_buffer() and apply_autocmds() may change the current
3667 * buffer and window.
3668 */
3669 lnum = curwin->w_cursor.lnum;
3670 topline = curwin->w_topline;
3671 if (!oldbuf) /* need to read the file */
3672 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003673#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 swap_exists_action = SEA_DIALOG;
3675#endif
3676 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3677
3678 /*
3679 * Open the buffer and read the file.
3680 */
3681#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003682 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 retval = FAIL;
3684#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003685 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686#endif
3687
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003688#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 if (swap_exists_action == SEA_QUIT)
3690 retval = FAIL;
3691 handle_swap_exists(old_curbuf);
3692#endif
3693 }
3694#ifdef FEAT_AUTOCMD
3695 else
3696 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003697 /* Read the modelines, but only to set window-local options. Any
3698 * buffer-local options have already been set and may have been
3699 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003700 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003701
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3703 &retval);
3704 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3705 &retval);
3706 }
3707 check_arg_idx(curwin);
3708#endif
3709
3710 /*
3711 * If autocommands change the cursor position or topline, we should
3712 * keep it.
3713 */
3714 if (curwin->w_cursor.lnum != lnum)
3715 {
3716 newlnum = curwin->w_cursor.lnum;
3717 newcol = curwin->w_cursor.col;
3718 }
3719 if (curwin->w_topline == topline)
3720 topline = 0;
3721
3722 /* Even when cursor didn't move we need to recompute topline. */
3723 changed_line_abv_curs();
3724
3725#ifdef FEAT_TITLE
3726 maketitle();
3727#endif
3728 }
3729
3730#ifdef FEAT_DIFF
3731 /* Tell the diff stuff that this buffer is new and/or needs updating.
3732 * Also needed when re-editing the same buffer, because unloading will
3733 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003734 if (curwin->w_p_diff)
3735 {
3736 diff_buf_add(curbuf);
3737 diff_invalidate(curbuf);
3738 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739#endif
3740
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003741#ifdef FEAT_SPELL
3742 /* If the window options were changed may need to set the spell language.
3743 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003744 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3745 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003746#endif
3747
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 if (command == NULL)
3749 {
3750 if (newcol >= 0) /* position set by autocommands */
3751 {
3752 curwin->w_cursor.lnum = newlnum;
3753 curwin->w_cursor.col = newcol;
3754 check_cursor();
3755 }
3756 else if (newlnum > 0) /* line number from caller or old position */
3757 {
3758 curwin->w_cursor.lnum = newlnum;
3759 check_cursor_lnum();
3760 if (solcol >= 0 && !p_sol)
3761 {
3762 /* 'sol' is off: Use last known column. */
3763 curwin->w_cursor.col = solcol;
3764 check_cursor_col();
3765#ifdef FEAT_VIRTUALEDIT
3766 curwin->w_cursor.coladd = 0;
3767#endif
3768 curwin->w_set_curswant = TRUE;
3769 }
3770 else
3771 beginline(BL_SOL | BL_FIX);
3772 }
3773 else /* no line number, go to last line in Ex mode */
3774 {
3775 if (exmode_active)
3776 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3777 beginline(BL_WHITE | BL_FIX);
3778 }
3779 }
3780
3781#ifdef FEAT_WINDOWS
3782 /* Check if cursors in other windows on the same buffer are still valid */
3783 check_lnums(FALSE);
3784#endif
3785
3786 /*
3787 * Did not read the file, need to show some info about the file.
3788 * Do this after setting the cursor.
3789 */
3790 if (oldbuf
3791#ifdef FEAT_AUTOCMD
3792 && !auto_buf
3793#endif
3794 )
3795 {
3796 int msg_scroll_save = msg_scroll;
3797
3798 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3799 * message. */
3800 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3801 msg_scroll = FALSE;
3802 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3803 check_for_delay(FALSE);
3804 msg_start();
3805 msg_scroll = msg_scroll_save;
3806 msg_scrolled_ign = TRUE;
3807
3808 fileinfo(FALSE, TRUE, FALSE);
3809
3810 msg_scrolled_ign = FALSE;
3811 }
3812
3813 if (command != NULL)
3814 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3815
3816#ifdef FEAT_KEYMAP
3817 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003818 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819#endif
3820
3821 --RedrawingDisabled;
3822 if (!skip_redraw)
3823 {
3824 n = p_so;
3825 if (topline == 0 && command == NULL)
3826 p_so = 999; /* force cursor halfway the window */
3827 update_topline();
3828#ifdef FEAT_SCROLLBIND
3829 curwin->w_scbind_pos = curwin->w_topline;
3830#endif
3831 p_so = n;
3832 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3833 }
3834
3835 if (p_im)
3836 need_start_insertmode = TRUE;
3837
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003838 /* Change directories when the 'acd' option is set. */
3839 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00003841#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003842 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 {
3844# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02003845 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3847# endif
3848# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003849 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003850 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851# endif
3852 }
3853#endif
3854
3855theend:
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003856#ifdef FEAT_AUTOCMD
3857 if (did_set_swapcommand)
3858 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3859#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860#ifdef FEAT_BROWSE
3861 vim_free(browse_file);
3862#endif
3863 vim_free(free_fname);
3864 return retval;
3865}
3866
3867#ifdef FEAT_AUTOCMD
3868 static void
3869delbuf_msg(name)
3870 char_u *name;
3871{
3872 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3873 name == NULL ? (char_u *)"" : name);
3874 vim_free(name);
3875 au_new_curbuf = NULL;
3876}
3877#endif
3878
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003879static int append_indent = 0; /* autoindent for first line */
3880
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881/*
3882 * ":insert" and ":append", also used by ":change"
3883 */
3884 void
3885ex_append(eap)
3886 exarg_T *eap;
3887{
3888 char_u *theline;
3889 int did_undo = FALSE;
3890 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003891 int indent = 0;
3892 char_u *p;
3893 int vcol;
3894 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003896 /* the ! flag toggles autoindent */
3897 if (eap->forceit)
3898 curbuf->b_p_ai = !curbuf->b_p_ai;
3899
3900 /* First autoindent comes from the line we start on */
3901 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3902 append_indent = get_indent_lnum(lnum);
3903
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 if (eap->cmdidx != CMD_append)
3905 --lnum;
3906
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003907 /* when the buffer is empty append to line 0 and delete the dummy line */
3908 if (empty && lnum == 1)
3909 lnum = 0;
3910
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 State = INSERT; /* behave like in Insert mode */
3912 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3913 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003914
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003915 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 {
3917 msg_scroll = TRUE;
3918 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003919 if (curbuf->b_p_ai)
3920 {
3921 if (append_indent >= 0)
3922 {
3923 indent = append_indent;
3924 append_indent = -1;
3925 }
3926 else if (lnum > 0)
3927 indent = get_indent_lnum(lnum);
3928 }
3929 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003931 {
3932 /* No getline() function, use the lines that follow. This ends
3933 * when there is no more. */
3934 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3935 break;
3936 p = vim_strchr(eap->nextcmd, NL);
3937 if (p == NULL)
3938 p = eap->nextcmd + STRLEN(eap->nextcmd);
3939 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3940 if (*p != NUL)
3941 ++p;
3942 eap->nextcmd = p;
3943 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 else
3945 theline = eap->getline(
3946#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003947 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003949 NUL, eap->cookie, indent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003951 if (theline == NULL)
3952 break;
3953
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003954 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3955 if (ex_keep_indent)
3956 append_indent = indent;
3957
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003958 /* Look for the "." after automatic indent. */
3959 vcol = 0;
3960 for (p = theline; indent > vcol; ++p)
3961 {
3962 if (*p == ' ')
3963 ++vcol;
3964 else if (*p == TAB)
3965 vcol += 8 - vcol % 8;
3966 else
3967 break;
3968 }
3969 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003970 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3971 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 {
3973 vim_free(theline);
3974 break;
3975 }
3976
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003977 /* don't use autoindent if nothing was typed. */
3978 if (p[0] == NUL)
3979 theline[0] = NUL;
3980
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 did_undo = TRUE;
3982 ml_append(lnum, theline, (colnr_T)0, FALSE);
3983 appended_lines_mark(lnum, 1L);
3984
3985 vim_free(theline);
3986 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003987
3988 if (empty)
3989 {
3990 ml_delete(2L, FALSE);
3991 empty = FALSE;
3992 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 }
3994 State = NORMAL;
3995
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003996 if (eap->forceit)
3997 curbuf->b_p_ai = !curbuf->b_p_ai;
3998
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004000 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 * "end" is set to lnum when something has been appended, otherwise
4002 * it is the same than "start" -- Acevedo */
4003 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4004 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4005 if (eap->cmdidx != CMD_append)
4006 --curbuf->b_op_start.lnum;
4007 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4008 ? lnum : curbuf->b_op_start.lnum;
4009 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4010 curwin->w_cursor.lnum = lnum;
4011 check_cursor_lnum();
4012 beginline(BL_SOL | BL_FIX);
4013
4014 need_wait_return = FALSE; /* don't use wait_return() now */
4015 ex_no_reprint = TRUE;
4016}
4017
4018/*
4019 * ":change"
4020 */
4021 void
4022ex_change(eap)
4023 exarg_T *eap;
4024{
4025 linenr_T lnum;
4026
4027 if (eap->line2 >= eap->line1
4028 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4029 return;
4030
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004031 /* the ! flag toggles autoindent */
4032 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4033 append_indent = get_indent_lnum(eap->line1);
4034
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4036 {
4037 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4038 break;
4039 ml_delete(eap->line1, FALSE);
4040 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004041
4042 /* make sure the cursor is not beyond the end of the file now */
4043 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4045
4046 /* ":append" on the line above the deleted lines. */
4047 eap->line2 = eap->line1;
4048 ex_append(eap);
4049}
4050
4051 void
4052ex_z(eap)
4053 exarg_T *eap;
4054{
4055 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004056 int bigness;
4057 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 int minus = 0;
4059 linenr_T start, end, curs, i;
4060 int j;
4061 linenr_T lnum = eap->line2;
4062
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004063 /* Vi compatible: ":z!" uses display height, without a count uses
4064 * 'scroll' */
4065 if (eap->forceit)
4066 bigness = curwin->w_height;
4067 else if (firstwin == lastwin)
4068 bigness = curwin->w_p_scr * 2;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004069#ifdef FEAT_WINDOWS
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004070 else
4071 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004072#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 if (bigness < 1)
4074 bigness = 1;
4075
4076 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004077 kind = x;
4078 if (*kind == '-' || *kind == '+' || *kind == '='
4079 || *kind == '^' || *kind == '.')
4080 ++x;
4081 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 ++x;
4083
4084 if (*x != 0)
4085 {
4086 if (!VIM_ISDIGIT(*x))
4087 {
4088 EMSG(_("E144: non-numeric argument to :z"));
4089 return;
4090 }
4091 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004092 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004094 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004095 if (*kind == '=')
4096 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004097 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 }
4099
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004100 /* the number of '-' and '+' multiplies the distance */
4101 if (*kind == '-' || *kind == '+')
4102 for (x = kind + 1; *x == *kind; ++x)
4103 ;
4104
4105 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 {
4107 case '-':
Bram Moolenaard9758e32011-06-12 22:03:23 +02004108 start = lnum - bigness * (linenr_T)(x - kind) + 1;
4109 end = start + bigness - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004110 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 break;
4112
4113 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004114 start = lnum - (bigness + 1) / 2 + 1;
4115 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 curs = lnum;
4117 minus = 1;
4118 break;
4119
4120 case '^':
4121 start = lnum - bigness * 2;
4122 end = lnum - bigness;
4123 curs = lnum - bigness;
4124 break;
4125
4126 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004127 start = lnum - (bigness + 1) / 2 + 1;
4128 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 curs = end;
4130 break;
4131
4132 default: /* '+' */
4133 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004134 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004135 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004136 else if (eap->addr_count == 0)
4137 ++start;
4138 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 curs = end;
4140 break;
4141 }
4142
4143 if (start < 1)
4144 start = 1;
4145
4146 if (end > curbuf->b_ml.ml_line_count)
4147 end = curbuf->b_ml.ml_line_count;
4148
4149 if (curs > curbuf->b_ml.ml_line_count)
4150 curs = curbuf->b_ml.ml_line_count;
4151
4152 for (i = start; i <= end; i++)
4153 {
4154 if (minus && i == lnum)
4155 {
4156 msg_putchar('\n');
4157
4158 for (j = 1; j < Columns; j++)
4159 msg_putchar('-');
4160 }
4161
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004162 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163
4164 if (minus && i == lnum)
4165 {
4166 msg_putchar('\n');
4167
4168 for (j = 1; j < Columns; j++)
4169 msg_putchar('-');
4170 }
4171 }
4172
4173 curwin->w_cursor.lnum = curs;
4174 ex_no_reprint = TRUE;
4175}
4176
4177/*
4178 * Check if the restricted flag is set.
4179 * If so, give an error message and return TRUE.
4180 * Otherwise, return FALSE.
4181 */
4182 int
4183check_restricted()
4184{
4185 if (restricted)
4186 {
4187 EMSG(_("E145: Shell commands not allowed in rvim"));
4188 return TRUE;
4189 }
4190 return FALSE;
4191}
4192
4193/*
4194 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4195 * If so, give an error message and return TRUE.
4196 * Otherwise, return FALSE.
4197 */
4198 int
4199check_secure()
4200{
4201 if (secure)
4202 {
4203 secure = 2;
4204 EMSG(_(e_curdir));
4205 return TRUE;
4206 }
4207#ifdef HAVE_SANDBOX
4208 /*
4209 * In the sandbox more things are not allowed, including the things
4210 * disallowed in secure mode.
4211 */
4212 if (sandbox != 0)
4213 {
4214 EMSG(_(e_sandbox));
4215 return TRUE;
4216 }
4217#endif
4218 return FALSE;
4219}
4220
4221static char_u *old_sub = NULL; /* previous substitute pattern */
4222static int global_need_beginline; /* call beginline() after ":g" */
4223
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224/* do_sub()
4225 *
4226 * Perform a substitution from line eap->line1 to line eap->line2 using the
4227 * command pointed to by eap->arg which should be of the form:
4228 *
4229 * /pattern/substitution/{flags}
4230 *
4231 * The usual escapes are supported as described in the regexp docs.
4232 */
4233 void
4234do_sub(eap)
4235 exarg_T *eap;
4236{
4237 linenr_T lnum;
4238 long i = 0;
4239 regmmatch_T regmatch;
4240 static int do_all = FALSE; /* do multiple substitutions per line */
4241 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004242 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 static int do_error = TRUE; /* if false, ignore errors */
4244 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004245 static int do_list = FALSE; /* list last line with subs. */
4246 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 static int do_ic = 0; /* ignore case flag */
4248 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4249 int delimiter;
4250 int sublen;
4251 int got_quit = FALSE;
4252 int got_match = FALSE;
4253 int temp;
4254 int which_pat;
4255 char_u *cmd;
4256 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004257 linenr_T first_line = 0; /* first changed line */
4258 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 * change */
4260 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4261 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004262 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004263 char_u *sub_firstline; /* allocated copy of first sub line */
4264 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004265 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004266 int start_nsubs;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004267#ifdef FEAT_EVAL
4268 int save_ma = 0;
4269#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270
4271 cmd = eap->arg;
4272 if (!global_busy)
4273 {
4274 sub_nsubs = 0;
4275 sub_nlines = 0;
4276 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004277 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 if (eap->cmdidx == CMD_tilde)
4280 which_pat = RE_LAST; /* use last used regexp */
4281 else
4282 which_pat = RE_SUBST; /* use last substitute regexp */
4283
4284 /* new pattern and substitution */
4285 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4286 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4287 {
4288 /* don't accept alphanumeric for separator */
4289 if (isalpha(*cmd))
4290 {
4291 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4292 return;
4293 }
4294 /*
4295 * undocumented vi feature:
4296 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4297 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4298 */
4299 if (*cmd == '\\')
4300 {
4301 ++cmd;
4302 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4303 {
4304 EMSG(_(e_backslash));
4305 return;
4306 }
4307 if (*cmd != '&')
4308 which_pat = RE_SEARCH; /* use last '/' pattern */
4309 pat = (char_u *)""; /* empty search pattern */
4310 delimiter = *cmd++; /* remember delimiter character */
4311 }
4312 else /* find the end of the regexp */
4313 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004314#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4315 if (p_altkeymap && curwin->w_p_rl)
4316 lrF_sub(cmd);
4317#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 which_pat = RE_LAST; /* use last used regexp */
4319 delimiter = *cmd++; /* remember delimiter character */
4320 pat = cmd; /* remember start of search pat */
4321 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4322 if (cmd[0] == delimiter) /* end delimiter found */
4323 *cmd++ = NUL; /* replace it with a NUL */
4324 }
4325
4326 /*
4327 * Small incompatibility: vi sees '\n' as end of the command, but in
4328 * Vim we want to use '\n' to find/substitute a NUL.
4329 */
4330 sub = cmd; /* remember the start of the substitution */
4331
4332 while (cmd[0])
4333 {
4334 if (cmd[0] == delimiter) /* end delimiter found */
4335 {
4336 *cmd++ = NUL; /* replace it with a NUL */
4337 break;
4338 }
4339 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4340 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004341 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 }
4343
4344 if (!eap->skip)
4345 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004346 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4347 if (STRCMP(sub, "%") == 0
4348 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4349 {
4350 if (old_sub == NULL) /* there is no previous command */
4351 {
4352 EMSG(_(e_nopresub));
4353 return;
4354 }
4355 sub = old_sub;
4356 }
4357 else
4358 {
4359 vim_free(old_sub);
4360 old_sub = vim_strsave(sub);
4361 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 }
4363 }
4364 else if (!eap->skip) /* use previous pattern and substitution */
4365 {
4366 if (old_sub == NULL) /* there is no previous command */
4367 {
4368 EMSG(_(e_nopresub));
4369 return;
4370 }
4371 pat = NULL; /* search_regcomp() will use previous pattern */
4372 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004373
4374 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4375 * last column after using "$". */
4376 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 }
4378
4379 /*
4380 * Find trailing options. When '&' is used, keep old options.
4381 */
4382 if (*cmd == '&')
4383 ++cmd;
4384 else
4385 {
4386 if (!p_ed)
4387 {
4388 if (p_gd) /* default is global on */
4389 do_all = TRUE;
4390 else
4391 do_all = FALSE;
4392 do_ask = FALSE;
4393 }
4394 do_error = TRUE;
4395 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004396 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004397 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 do_ic = 0;
4399 }
4400 while (*cmd)
4401 {
4402 /*
4403 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4404 * 'r' is never inverted.
4405 */
4406 if (*cmd == 'g')
4407 do_all = !do_all;
4408 else if (*cmd == 'c')
4409 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004410 else if (*cmd == 'n')
4411 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 else if (*cmd == 'e')
4413 do_error = !do_error;
4414 else if (*cmd == 'r') /* use last used regexp */
4415 which_pat = RE_LAST;
4416 else if (*cmd == 'p')
4417 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004418 else if (*cmd == '#')
4419 {
4420 do_print = TRUE;
4421 do_number = TRUE;
4422 }
4423 else if (*cmd == 'l')
4424 {
4425 do_print = TRUE;
4426 do_list = TRUE;
4427 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 else if (*cmd == 'i') /* ignore case */
4429 do_ic = 'i';
4430 else if (*cmd == 'I') /* don't ignore case */
4431 do_ic = 'I';
4432 else
4433 break;
4434 ++cmd;
4435 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004436 if (do_count)
4437 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438
4439 /*
4440 * check for a trailing count
4441 */
4442 cmd = skipwhite(cmd);
4443 if (VIM_ISDIGIT(*cmd))
4444 {
4445 i = getdigits(&cmd);
4446 if (i <= 0 && !eap->skip && do_error)
4447 {
4448 EMSG(_(e_zerocount));
4449 return;
4450 }
4451 eap->line1 = eap->line2;
4452 eap->line2 += i - 1;
4453 if (eap->line2 > curbuf->b_ml.ml_line_count)
4454 eap->line2 = curbuf->b_ml.ml_line_count;
4455 }
4456
4457 /*
4458 * check for trailing command or garbage
4459 */
4460 cmd = skipwhite(cmd);
4461 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4462 {
4463 eap->nextcmd = check_nextcmd(cmd);
4464 if (eap->nextcmd == NULL)
4465 {
4466 EMSG(_(e_trailing));
4467 return;
4468 }
4469 }
4470
4471 if (eap->skip) /* not executing commands, only parsing */
4472 return;
4473
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004474 if (!do_count && !curbuf->b_p_ma)
4475 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004476 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004477 EMSG(_(e_modifiable));
4478 return;
4479 }
4480
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4482 {
4483 if (do_error)
4484 EMSG(_(e_invcmd));
4485 return;
4486 }
4487
4488 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4489 if (do_ic == 'i')
4490 regmatch.rmm_ic = TRUE;
4491 else if (do_ic == 'I')
4492 regmatch.rmm_ic = FALSE;
4493
4494 sub_firstline = NULL;
4495
4496 /*
4497 * ~ in the substitute pattern is replaced with the old pattern.
4498 * We do it here once to avoid it to be replaced over and over again.
4499 * But don't do it when it starts with "\=", then it's an expression.
4500 */
4501 if (!(sub[0] == '\\' && sub[1] == '='))
4502 sub = regtilde(sub, p_magic);
4503
4504 /*
4505 * Check for a match on each line.
4506 */
4507 line2 = eap->line2;
4508 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4509#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4510 || aborting()
4511#endif
4512 ); ++lnum)
4513 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004514 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4515 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 if (nmatch)
4517 {
4518 colnr_T copycol;
4519 colnr_T matchcol;
4520 colnr_T prev_matchcol = MAXCOL;
4521 char_u *new_end, *new_start = NULL;
4522 unsigned new_start_len = 0;
4523 char_u *p1;
4524 int did_sub = FALSE;
4525 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004526 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 long nmatch_tl = 0; /* nr of lines matched below lnum */
4528 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004529 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004530 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531
4532 /*
4533 * The new text is build up step by step, to avoid too much
4534 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004535 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 * copycol Column in the old text where we started
4537 * looking for a match; from here old text still
4538 * needs to be copied to the new text.
4539 * matchcol Column number of the old text where to look
4540 * for the next match. It's just after the
4541 * previous match or one further.
4542 * prev_matchcol Column just after the previous match (if any).
4543 * Mostly equal to matchcol, except for the first
4544 * match and after skipping an empty match.
4545 * regmatch.*pos Where the pattern matched in the old text.
4546 * new_start The new text, all that has been produced so
4547 * far.
4548 * new_end The new text, where to append new text.
4549 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004550 * lnum The line number where we found the start of
4551 * the match. Can be below the line we searched
4552 * when there is a \n before a \zs in the
4553 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 * sub_firstlnum The line number in the buffer where to look
4555 * for a match. Can be different from "lnum"
4556 * when the pattern or substitute string contains
4557 * line breaks.
4558 *
4559 * Special situations:
4560 * - When the substitute string contains a line break, the part up
4561 * to the line break is inserted in the text, but the copy of
4562 * the original line is kept. "sub_firstlnum" is adjusted for
4563 * the inserted lines.
4564 * - When the matched pattern contains a line break, the old line
4565 * is taken from the line at the end of the pattern. The lines
4566 * in the match are deleted later, "sub_firstlnum" is adjusted
4567 * accordingly.
4568 *
4569 * The new text is built up in new_start[]. It has some extra
4570 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004571 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 *
4573 * Make a copy of the old line, so it won't be taken away when
4574 * updating the screen or handling a multi-line match. The "old_"
4575 * pointers point into this copy.
4576 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004577 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 copycol = 0;
4579 matchcol = 0;
4580
4581 /* At first match, remember current cursor position. */
4582 if (!got_match)
4583 {
4584 setpcmark();
4585 got_match = TRUE;
4586 }
4587
4588 /*
4589 * Loop until nothing more to replace in this line.
4590 * 1. Handle match with empty string.
4591 * 2. If do_ask is set, ask for confirmation.
4592 * 3. substitute the string.
4593 * 4. if do_all is set, find next match
4594 * 5. break if there isn't another match in this line
4595 */
4596 for (;;)
4597 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004598 /* Advance "lnum" to the line where the match starts. The
4599 * match does not start in the first line when there is a line
4600 * break before \zs. */
4601 if (regmatch.startpos[0].lnum > 0)
4602 {
4603 lnum += regmatch.startpos[0].lnum;
4604 sub_firstlnum += regmatch.startpos[0].lnum;
4605 nmatch -= regmatch.startpos[0].lnum;
4606 vim_free(sub_firstline);
4607 sub_firstline = NULL;
4608 }
4609
4610 if (sub_firstline == NULL)
4611 {
4612 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4613 if (sub_firstline == NULL)
4614 {
4615 vim_free(new_start);
4616 goto outofmem;
4617 }
4618 }
4619
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 /* Save the line number of the last change for the final
4621 * cursor position (just like Vi). */
4622 curwin->w_cursor.lnum = lnum;
4623 do_again = FALSE;
4624
4625 /*
4626 * 1. Match empty string does not count, except for first
4627 * match. This reproduces the strange vi behaviour.
4628 * This also catches endless loops.
4629 */
4630 if (matchcol == prev_matchcol
4631 && regmatch.endpos[0].lnum == 0
4632 && matchcol == regmatch.endpos[0].col)
4633 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004634 if (sub_firstline[matchcol] == NUL)
4635 /* We already were at the end of the line. Don't look
4636 * for a match in this line again. */
4637 skip_match = TRUE;
4638 else
Bram Moolenaar0df11022011-05-19 14:30:16 +02004639 {
4640 /* search for a match at next column */
4641#ifdef FEAT_MBYTE
4642 if (has_mbyte)
4643 matchcol += mb_ptr2len(sub_firstline + matchcol);
4644 else
4645#endif
4646 ++matchcol;
4647 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 goto skip;
4649 }
4650
4651 /* Normally we continue searching for a match just after the
4652 * previous match. */
4653 matchcol = regmatch.endpos[0].col;
4654 prev_matchcol = matchcol;
4655
4656 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004657 * 2. If do_count is set only increase the counter.
4658 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004660 if (do_count)
4661 {
4662 /* For a multi-line match, put matchcol at the NUL at
4663 * the end of the line and set nmatch to one, so that
4664 * we continue looking for a match on the next line.
4665 * Avoids that ":s/\nB\@=//gc" get stuck. */
4666 if (nmatch > 1)
4667 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004668 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004669 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004670 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004671 }
4672 sub_nsubs++;
4673 did_sub = TRUE;
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004674#ifdef FEAT_EVAL
4675 /* Skip the substitution, unless an expression is used,
4676 * then it is evaluated in the sandbox. */
4677 if (!(sub[0] == '\\' && sub[1] == '='))
4678#endif
4679 goto skip;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004680 }
4681
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 if (do_ask)
4683 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004684 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004685
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 /* change State to CONFIRM, so that the mouse works
4687 * properly */
4688 save_State = State;
4689 State = CONFIRM;
4690#ifdef FEAT_MOUSE
4691 setmouse(); /* disable mouse in xterm */
4692#endif
4693 curwin->w_cursor.col = regmatch.startpos[0].col;
4694
4695 /* When 'cpoptions' contains "u" don't sync undo when
4696 * asking for confirmation. */
4697 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4698 ++no_u_sync;
4699
4700 /*
4701 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4702 */
4703 while (do_ask)
4704 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004705 if (exmode_active)
4706 {
4707 char_u *resp;
4708 colnr_T sc, ec;
4709
4710 print_line_no_prefix(lnum, FALSE, FALSE);
4711
4712 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4713 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4714 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4715 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004716 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004717 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004718 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004719 msg_putchar('^');
4720
4721 resp = getexmodeline('?', NULL, 0);
4722 if (resp != NULL)
4723 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004724 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004725 vim_free(resp);
4726 }
4727 }
4728 else
4729 {
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004730 char_u *orig_line = NULL;
4731 int len_change = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004733 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004735 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004737 /* Invert the matched string.
4738 * Remove the inversion afterwards. */
4739 temp = RedrawingDisabled;
4740 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004742 if (new_start != NULL)
4743 {
4744 /* There already was a substitution, we would
4745 * like to show this to the user. We cannot
4746 * really update the line, it would change
4747 * what matches. Temporarily replace the line
4748 * and change it back afterwards. */
4749 orig_line = vim_strsave(ml_get(lnum));
4750 if (orig_line != NULL)
4751 {
4752 char_u *new_line = concat_str(new_start,
4753 sub_firstline + copycol);
4754
4755 if (new_line == NULL)
4756 {
4757 vim_free(orig_line);
4758 orig_line = NULL;
4759 }
4760 else
4761 {
4762 /* Position the cursor relative to the
4763 * end of the line, the previous
4764 * substitute may have inserted or
4765 * deleted characters before the
4766 * cursor. */
Bram Moolenaar04e5b5a2013-01-30 21:56:21 +01004767 len_change = (int)STRLEN(new_line)
4768 - (int)STRLEN(orig_line);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004769 curwin->w_cursor.col += len_change;
4770 ml_replace(lnum, new_line, FALSE);
4771 }
4772 }
4773 }
4774
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004775 search_match_lines = regmatch.endpos[0].lnum
4776 - regmatch.startpos[0].lnum;
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004777 search_match_endcol = regmatch.endpos[0].col
4778 + len_change;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004779 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004781 update_topline();
4782 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004783 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004784 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004785 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786
4787#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004788 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004790 if (msg_row == Rows - 1)
4791 msg_didout = FALSE; /* avoid a scroll-up */
4792 msg_starthere();
4793 i = msg_scroll;
4794 msg_scroll = 0; /* truncate msg when
4795 needed */
4796 msg_no_more = TRUE;
4797 /* write message same highlighting as for
4798 * wait_return */
4799 smsg_attr(hl_attr(HLF_R),
4800 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4801 msg_no_more = FALSE;
4802 msg_scroll = i;
4803 showruler(TRUE);
4804 windgoto(msg_row, msg_col);
4805 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
4807#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004808 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004810 ++no_mapping; /* don't map this key */
4811 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004812 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004813 --allow_keys;
4814 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004816 /* clear the question */
4817 msg_didout = FALSE; /* don't scroll up */
4818 msg_col = 0;
4819 gotocmdline(TRUE);
Bram Moolenaar4bc8cf02013-01-30 16:30:26 +01004820
4821 /* restore the line */
4822 if (orig_line != NULL)
4823 ml_replace(lnum, orig_line, FALSE);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004824 }
4825
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004827 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004829 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830#endif
4831 )
4832 {
4833 got_quit = TRUE;
4834 break;
4835 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004836 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004838 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004840 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 {
4842 /* last: replace and then stop */
4843 do_all = FALSE;
4844 line2 = lnum;
4845 break;
4846 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004847 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 {
4849 do_ask = FALSE;
4850 break;
4851 }
4852#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004853 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004855 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 scrolldown_clamp();
4857#endif
4858 }
4859 State = save_State;
4860#ifdef FEAT_MOUSE
4861 setmouse();
4862#endif
4863 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4864 --no_u_sync;
4865
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004866 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 {
4868 /* For a multi-line match, put matchcol at the NUL at
4869 * the end of the line and set nmatch to one, so that
4870 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004871 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4872 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 if (nmatch > 1)
4874 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004875 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004876 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 }
4878 goto skip;
4879 }
4880 if (got_quit)
Bram Moolenaar11cb6e62013-02-06 18:24:02 +01004881 goto skip;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 }
4883
4884 /* Move the cursor to the start of the match, so that we can
4885 * use "\=col("."). */
4886 curwin->w_cursor.col = regmatch.startpos[0].col;
4887
4888 /*
4889 * 3. substitute the string.
4890 */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004891#ifdef FEAT_EVAL
4892 if (do_count)
4893 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02004894 /* prevent accidentally changing the buffer by a function */
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004895 save_ma = curbuf->b_p_ma;
4896 curbuf->b_p_ma = FALSE;
4897 sandbox++;
4898 }
4899#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004901 sublen = vim_regsub_multi(&regmatch,
4902 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 sub, sub_firstline, FALSE, p_magic, TRUE);
Bram Moolenaar07e31c52012-08-08 16:51:15 +02004904#ifdef FEAT_EVAL
4905 if (do_count)
4906 {
4907 curbuf->b_p_ma = save_ma;
4908 sandbox--;
4909 goto skip;
4910 }
4911#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912
Bram Moolenaar4463f292005-09-25 22:20:24 +00004913 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004914 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004915 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4916 {
4917 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4918 skip_match = TRUE;
4919 }
4920
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 /* Need room for:
4922 * - result so far in new_start (not for first sub in line)
4923 * - original text up to match
4924 * - length of substituted part
4925 * - original text after match
4926 */
4927 if (nmatch == 1)
4928 p1 = sub_firstline;
4929 else
4930 {
4931 p1 = ml_get(sub_firstlnum + nmatch - 1);
4932 nmatch_tl += nmatch - 1;
4933 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004934 copy_len = regmatch.startpos[0].col - copycol;
4935 needed_len = copy_len + ((unsigned)STRLEN(p1)
4936 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 if (new_start == NULL)
4938 {
4939 /*
4940 * Get some space for a temporary buffer to do the
4941 * substitution into (and some extra space to avoid
4942 * too many calls to alloc()/free()).
4943 */
4944 new_start_len = needed_len + 50;
4945 if ((new_start = alloc_check(new_start_len)) == NULL)
4946 goto outofmem;
4947 *new_start = NUL;
4948 new_end = new_start;
4949 }
4950 else
4951 {
4952 /*
4953 * Check if the temporary buffer is long enough to do the
4954 * substitution into. If not, make it larger (with a bit
4955 * extra to avoid too many calls to alloc()/free()).
4956 */
4957 len = (unsigned)STRLEN(new_start);
4958 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004959 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 {
4961 new_start_len = needed_len + 50;
4962 if ((p1 = alloc_check(new_start_len)) == NULL)
4963 {
4964 vim_free(new_start);
4965 goto outofmem;
4966 }
4967 mch_memmove(p1, new_start, (size_t)(len + 1));
4968 vim_free(new_start);
4969 new_start = p1;
4970 }
4971 new_end = new_start + len;
4972 }
4973
4974 /*
4975 * copy the text up to the part that matched
4976 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004977 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4978 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004980 (void)vim_regsub_multi(&regmatch,
4981 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 sub, new_end, TRUE, p_magic, TRUE);
4983 sub_nsubs++;
4984 did_sub = TRUE;
4985
4986 /* Move the cursor to the start of the line, to avoid that it
4987 * is beyond the end of the line after the substitution. */
4988 curwin->w_cursor.col = 0;
4989
4990 /* For a multi-line match, make a copy of the last matched
4991 * line and continue in that one. */
4992 if (nmatch > 1)
4993 {
4994 sub_firstlnum += nmatch - 1;
4995 vim_free(sub_firstline);
4996 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4997 /* When going beyond the last line, stop substituting. */
4998 if (sub_firstlnum <= line2)
4999 do_again = TRUE;
5000 else
5001 do_all = FALSE;
5002 }
5003
5004 /* Remember next character to be copied. */
5005 copycol = regmatch.endpos[0].col;
5006
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005007 if (skip_match)
5008 {
5009 /* Already hit end of the buffer, sub_firstlnum is one
5010 * less than what it ought to be. */
5011 vim_free(sub_firstline);
5012 sub_firstline = vim_strsave((char_u *)"");
5013 copycol = 0;
5014 }
5015
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 /*
5017 * Now the trick is to replace CTRL-M chars with a real line
5018 * break. This would make it impossible to insert a CTRL-M in
5019 * the text. The line break can be avoided by preceding the
5020 * CTRL-M with a backslash. To be able to insert a backslash,
5021 * they must be doubled in the string and are halved here.
5022 * That is Vi compatible.
5023 */
5024 for (p1 = new_end; *p1; ++p1)
5025 {
5026 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005027 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 else if (*p1 == CAR)
5029 {
5030 if (u_inssub(lnum) == OK) /* prepare for undo */
5031 {
5032 *p1 = NUL; /* truncate up to the CR */
5033 ml_append(lnum - 1, new_start,
5034 (colnr_T)(p1 - new_start + 1), FALSE);
5035 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
5036 if (do_ask)
5037 appended_lines(lnum - 1, 1L);
5038 else
5039 {
5040 if (first_line == 0)
5041 first_line = lnum;
5042 last_line = lnum + 1;
5043 }
5044 /* All line numbers increase. */
5045 ++sub_firstlnum;
5046 ++lnum;
5047 ++line2;
5048 /* move the cursor to the new line, like Vi */
5049 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00005050 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005051 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 p1 = new_start - 1;
5053 }
5054 }
5055#ifdef FEAT_MBYTE
5056 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00005057 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058#endif
5059 }
5060
5061 /*
5062 * 4. If do_all is set, find next match.
5063 * Prevent endless loop with patterns that match empty
5064 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
5065 * But ":s/\n/#/" is OK.
5066 */
5067skip:
5068 /* We already know that we did the last subst when we are at
5069 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005070 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5071 * "line2" when there is a \zs in the pattern after a line
5072 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005073 lastone = (skip_match
5074 || got_int
5075 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005076 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005077 || !(do_all || do_again)
5078 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5079 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 nmatch = -1;
5081
5082 /*
5083 * Replace the line in the buffer when needed. This is
5084 * skipped when there are more matches.
5085 * The check for nmatch_tl is needed for when multi-line
5086 * matching must replace the lines before trying to do another
5087 * match, otherwise "\@<=" won't work.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005088 * When the match starts below where we start searching also
5089 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 */
5091 if (lastone
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 || nmatch_tl > 0
5093 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005094 curbuf, sub_firstlnum,
5095 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005096 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 {
5098 if (new_start != NULL)
5099 {
5100 /*
5101 * Copy the rest of the line, that didn't match.
5102 * "matchcol" has to be adjusted, we use the end of
5103 * the line as reference, because the substitute may
5104 * have changed the number of characters. Same for
5105 * "prev_matchcol".
5106 */
5107 STRCAT(new_start, sub_firstline + copycol);
5108 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5109 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5110 - prev_matchcol;
5111
5112 if (u_savesub(lnum) != OK)
5113 break;
5114 ml_replace(lnum, new_start, TRUE);
5115
5116 if (nmatch_tl > 0)
5117 {
5118 /*
5119 * Matched lines have now been substituted and are
5120 * useless, delete them. The part after the match
5121 * has been appended to new_start, we don't need
5122 * it in the buffer.
5123 */
5124 ++lnum;
5125 if (u_savedel(lnum, nmatch_tl) != OK)
5126 break;
5127 for (i = 0; i < nmatch_tl; ++i)
5128 ml_delete(lnum, (int)FALSE);
5129 mark_adjust(lnum, lnum + nmatch_tl - 1,
5130 (long)MAXLNUM, -nmatch_tl);
5131 if (do_ask)
5132 deleted_lines(lnum, nmatch_tl);
5133 --lnum;
5134 line2 -= nmatch_tl; /* nr of lines decreases */
5135 nmatch_tl = 0;
5136 }
5137
5138 /* When asking, undo is saved each time, must also set
5139 * changed flag each time. */
5140 if (do_ask)
5141 changed_bytes(lnum, 0);
5142 else
5143 {
5144 if (first_line == 0)
5145 first_line = lnum;
5146 last_line = lnum + 1;
5147 }
5148
5149 sub_firstlnum = lnum;
5150 vim_free(sub_firstline); /* free the temp buffer */
5151 sub_firstline = new_start;
5152 new_start = NULL;
5153 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5154 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5155 - prev_matchcol;
5156 copycol = 0;
5157 }
5158 if (nmatch == -1 && !lastone)
5159 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005160 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161
5162 /*
5163 * 5. break if there isn't another match in this line
5164 */
5165 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005166 {
5167 /* If the match found didn't start where we were
5168 * searching, do the next search in the line where we
5169 * found the match. */
5170 if (nmatch == -1)
5171 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005173 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 }
5175
5176 line_breakcheck();
5177 }
5178
5179 if (did_sub)
5180 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005181 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 vim_free(sub_firstline); /* free the copy of the original line */
5183 sub_firstline = NULL;
5184 }
5185
5186 line_breakcheck();
5187 }
5188
5189 if (first_line != 0)
5190 {
5191 /* Need to subtract the number of added lines from "last_line" to get
5192 * the line number before the change (same as adding the number of
5193 * deleted lines). */
5194 i = curbuf->b_ml.ml_line_count - old_line_count;
5195 changed_lines(first_line, 0, last_line - i, i);
5196 }
5197
5198outofmem:
5199 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005200
5201 /* ":s/pat//n" doesn't move the cursor */
5202 if (do_count)
5203 curwin->w_cursor = old_cursor;
5204
Bram Moolenaar46475522010-03-23 17:36:29 +01005205 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 {
5207 /* Set the '[ and '] marks. */
5208 curbuf->b_op_start.lnum = eap->line1;
5209 curbuf->b_op_end.lnum = line2;
5210 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5211
5212 if (!global_busy)
5213 {
Bram Moolenaar0faaeb82012-03-07 14:57:52 +01005214 if (!do_ask) /* when interactive leave cursor on the match */
5215 {
5216 if (endcolumn)
5217 coladvance((colnr_T)MAXCOL);
5218 else
5219 beginline(BL_WHITE | BL_FIX);
5220 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00005221 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 MSG("");
5223 }
5224 else
5225 global_need_beginline = TRUE;
5226 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005227 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 }
5229 else if (!global_busy)
5230 {
5231 if (got_int) /* interrupted */
5232 EMSG(_(e_interr));
5233 else if (got_match) /* did find something but nothing substituted */
5234 MSG("");
5235 else if (do_error) /* nothing found */
5236 EMSG2(_(e_patnotf2), get_search_pat());
5237 }
5238
Bram Moolenaar8c4fbd12013-01-17 18:34:05 +01005239#ifdef FEAT_FOLDING
5240 if (do_ask && hasAnyFolding(curwin))
5241 /* Cursor position may require updating */
5242 changed_window_setting();
5243#endif
5244
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 vim_free(regmatch.regprog);
5246}
5247
5248/*
5249 * Give message for number of substitutions.
5250 * Can also be used after a ":global" command.
5251 * Return TRUE if a message was given.
5252 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005253 int
Bram Moolenaar05159a02005-02-26 23:04:13 +00005254do_sub_msg(count_only)
5255 int count_only; /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256{
5257 /*
5258 * Only report substitutions when:
5259 * - more than 'report' substitutions
5260 * - command was typed by user, or number of changed lines > 'report'
5261 * - giving messages is not disabled by 'lazyredraw'
5262 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005263 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5264 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 && messaging())
5266 {
5267 if (got_int)
5268 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005269 else
5270 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005272 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005273 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005275 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005276 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 sub_nsubs);
5278 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005279 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005280 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005282 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005283 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005286 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 return TRUE;
5288 }
5289 if (got_int)
5290 {
5291 EMSG(_(e_interr));
5292 return TRUE;
5293 }
5294 return FALSE;
5295}
5296
5297/*
5298 * Execute a global command of the form:
5299 *
5300 * g/pattern/X : execute X on all lines where pattern matches
5301 * v/pattern/X : execute X on all lines where pattern does not match
5302 *
5303 * where 'X' is an EX command
5304 *
5305 * The command character (as well as the trailing slash) is optional, and
5306 * is assumed to be 'p' if missing.
5307 *
5308 * This is implemented in two passes: first we scan the file for the pattern and
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005309 * set a mark for each line that (not) matches. Secondly we execute the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 * for each line that has a mark. This is required because after deleting
5311 * lines we do not know where to search for the next match.
5312 */
5313 void
5314ex_global(eap)
5315 exarg_T *eap;
5316{
5317 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005318 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 int type; /* first char of cmd: 'v' or 'g' */
5320 char_u *cmd; /* command argument */
5321
5322 char_u delim; /* delimiter, normally '/' */
5323 char_u *pat;
5324 regmmatch_T regmatch;
5325 int match;
5326 int which_pat;
5327
5328 if (global_busy)
5329 {
5330 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5331 return;
5332 }
5333
5334 if (eap->forceit) /* ":global!" is like ":vglobal" */
5335 type = 'v';
5336 else
5337 type = *eap->cmd;
5338 cmd = eap->arg;
5339 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340
5341 /*
5342 * undocumented vi feature:
5343 * "\/" and "\?": use previous search pattern.
5344 * "\&": use previous substitute pattern.
5345 */
5346 if (*cmd == '\\')
5347 {
5348 ++cmd;
5349 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5350 {
5351 EMSG(_(e_backslash));
5352 return;
5353 }
5354 if (*cmd == '&')
5355 which_pat = RE_SUBST; /* use previous substitute pattern */
5356 else
5357 which_pat = RE_SEARCH; /* use previous search pattern */
5358 ++cmd;
5359 pat = (char_u *)"";
5360 }
5361 else if (*cmd == NUL)
5362 {
5363 EMSG(_("E148: Regular expression missing from global"));
5364 return;
5365 }
5366 else
5367 {
5368 delim = *cmd; /* get the delimiter */
5369 if (delim)
5370 ++cmd; /* skip delimiter if there is one */
5371 pat = cmd; /* remember start of pattern */
5372 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5373 if (cmd[0] == delim) /* end delimiter found */
5374 *cmd++ = NUL; /* replace it with a NUL */
5375 }
5376
5377#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5378 if (p_altkeymap && curwin->w_p_rl)
5379 lrFswap(pat,0);
5380#endif
5381
5382 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5383 {
5384 EMSG(_(e_invcmd));
5385 return;
5386 }
5387
5388 /*
5389 * pass 1: set marks for each (not) matching line
5390 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5392 {
5393 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005394 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5395 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 if ((type == 'g' && match) || (type == 'v' && !match))
5397 {
5398 ml_setmarked(lnum);
5399 ndone++;
5400 }
5401 line_breakcheck();
5402 }
5403
5404 /*
5405 * pass 2: execute the command for each line that has been marked
5406 */
5407 if (got_int)
5408 MSG(_(e_interr));
5409 else if (ndone == 0)
5410 {
5411 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005412 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 else
Bram Moolenaar555b2802005-05-19 21:08:39 +00005414 smsg((char_u *)_(e_patnotf2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 }
5416 else
5417 global_exe(cmd);
5418
5419 ml_clearmarked(); /* clear rest of the marks */
5420 vim_free(regmatch.regprog);
5421}
5422
5423/*
5424 * Execute "cmd" on lines marked with ml_setmarked().
5425 */
5426 void
5427global_exe(cmd)
5428 char_u *cmd;
5429{
Bram Moolenaarbb993222011-05-10 16:00:47 +02005430 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5431 buf_T *old_buf = curbuf; /* remember what buffer we started in */
5432 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433
5434 /*
5435 * Set current position only once for a global command.
5436 * If global_busy is set, setpcmark() will not do anything.
5437 * If there is an error, global_busy will be incremented.
5438 */
5439 setpcmark();
5440
5441 /* When the command writes a message, don't overwrite the command. */
5442 msg_didout = TRUE;
5443
Bram Moolenaard25bc232010-03-23 17:49:24 +01005444 sub_nsubs = 0;
5445 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 global_need_beginline = FALSE;
5447 global_busy = 1;
5448 old_lcount = curbuf->b_ml.ml_line_count;
5449 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5450 {
5451 curwin->w_cursor.lnum = lnum;
5452 curwin->w_cursor.col = 0;
5453 if (*cmd == NUL || *cmd == '\n')
5454 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5455 else
5456 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5457 ui_breakcheck();
5458 }
5459
5460 global_busy = 0;
5461 if (global_need_beginline)
5462 beginline(BL_WHITE | BL_FIX);
5463 else
5464 check_cursor(); /* cursor may be beyond the end of the line */
5465
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005466 /* the cursor may not have moved in the text but a change in a previous
5467 * line may move it on the screen */
5468 changed_line_abv_curs();
5469
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 /* If it looks like no message was written, allow overwriting the
5471 * command with the report for number of changes. */
5472 if (msg_col == 0 && msg_scrolled == 0)
5473 msg_didout = FALSE;
5474
Bram Moolenaar45667512007-05-10 19:24:43 +00005475 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaarbb993222011-05-10 16:00:47 +02005476 * number of extra or deleted lines.
5477 * Don't report extra or deleted lines in the edge case where the buffer
5478 * we are in after execution is different from the buffer we started in. */
5479 if (!do_sub_msg(FALSE) && curbuf == old_buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5481}
5482
5483#ifdef FEAT_VIMINFO
5484 int
5485read_viminfo_sub_string(virp, force)
5486 vir_T *virp;
5487 int force;
5488{
Bram Moolenaar3c2d6532011-02-01 13:48:53 +01005489 if (force)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 vim_free(old_sub);
5491 if (force || old_sub == NULL)
5492 old_sub = viminfo_readstring(virp, 1, TRUE);
5493 return viminfo_readline(virp);
5494}
5495
5496 void
5497write_viminfo_sub_string(fp)
5498 FILE *fp;
5499{
5500 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5501 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02005502 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 viminfo_writestring(fp, old_sub);
5504 }
5505}
5506#endif /* FEAT_VIMINFO */
5507
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005508#if defined(EXITFREE) || defined(PROTO)
5509 void
5510free_old_sub()
5511{
5512 vim_free(old_sub);
5513}
5514#endif
5515
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5517/*
5518 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005519 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005521 int
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005522prepare_tagpreview(undo_sync)
5523 int undo_sync; /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524{
5525 win_T *wp;
5526
5527# ifdef FEAT_GUI
5528 need_mouse_correct = TRUE;
5529# endif
5530
5531 /*
5532 * If there is already a preview window open, use that one.
5533 */
5534 if (!curwin->w_p_pvw)
5535 {
5536 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5537 if (wp->w_p_pvw)
5538 break;
5539 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005540 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 else
5542 {
5543 /*
5544 * There is no preview window open yet. Create one.
5545 */
5546 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5547 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005548 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 curwin->w_p_pvw = TRUE;
5550 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02005551 RESET_BINDING(curwin); /* don't take over 'scrollbind'
5552 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553# ifdef FEAT_DIFF
5554 curwin->w_p_diff = FALSE; /* no 'diff' */
5555# endif
5556# ifdef FEAT_FOLDING
5557 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5558# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005559 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 }
5561 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005562 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563}
5564
5565#endif
5566
5567
5568/*
5569 * ":help": open a read-only window on a help file
5570 */
5571 void
5572ex_help(eap)
5573 exarg_T *eap;
5574{
5575 char_u *arg;
5576 char_u *tag;
5577 FILE *helpfd; /* file descriptor of help file */
5578 int n;
5579 int i;
5580#ifdef FEAT_WINDOWS
5581 win_T *wp;
5582#endif
5583 int num_matches;
5584 char_u **matches;
5585 char_u *p;
5586 int empty_fnum = 0;
5587 int alt_fnum = 0;
5588 buf_T *buf;
5589#ifdef FEAT_MULTI_LANG
5590 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005591 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592#endif
Bram Moolenaar8f535582011-09-30 17:30:31 +02005593#ifdef FEAT_FOLDING
5594 int old_KeyTyped = KeyTyped;
5595#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596
5597 if (eap != NULL)
5598 {
5599 /*
5600 * A ":help" command ends at the first LF, or at a '|' that is
5601 * followed by some text. Set nextcmd to the following command.
5602 */
5603 for (arg = eap->arg; *arg; ++arg)
5604 {
5605 if (*arg == '\n' || *arg == '\r'
5606 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5607 {
5608 *arg++ = NUL;
5609 eap->nextcmd = arg;
5610 break;
5611 }
5612 }
5613 arg = eap->arg;
5614
Bram Moolenaar3dbde622012-04-05 16:05:05 +02005615 if (eap->forceit && *arg == NUL && !curbuf->b_help)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 {
5617 EMSG(_("E478: Don't panic!"));
5618 return;
5619 }
5620
5621 if (eap->skip) /* not executing commands */
5622 return;
5623 }
5624 else
5625 arg = (char_u *)"";
5626
5627 /* remove trailing blanks */
5628 p = arg + STRLEN(arg) - 1;
5629 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5630 *p-- = NUL;
5631
5632#ifdef FEAT_MULTI_LANG
5633 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005634 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635#endif
5636
5637 /* When no argument given go to the index. */
5638 if (*arg == NUL)
5639 arg = (char_u *)"help.txt";
5640
5641 /*
5642 * Check if there is a match for the argument.
5643 */
5644 n = find_help_tags(arg, &num_matches, &matches,
5645 eap != NULL && eap->forceit);
5646
5647 i = 0;
5648#ifdef FEAT_MULTI_LANG
5649 if (n != FAIL && lang != NULL)
5650 /* Find first item with the requested language. */
5651 for (i = 0; i < num_matches; ++i)
5652 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005653 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 if (len > 3 && matches[i][len - 3] == '@'
5655 && STRICMP(matches[i] + len - 2, lang) == 0)
5656 break;
5657 }
5658#endif
5659 if (i >= num_matches || n == FAIL)
5660 {
5661#ifdef FEAT_MULTI_LANG
5662 if (lang != NULL)
5663 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5664 else
5665#endif
5666 EMSG2(_("E149: Sorry, no help for %s"), arg);
5667 if (n != FAIL)
5668 FreeWild(num_matches, matches);
5669 return;
5670 }
5671
5672 /* The first match (in the requested language) is the best match. */
5673 tag = vim_strsave(matches[i]);
5674 FreeWild(num_matches, matches);
5675
5676#ifdef FEAT_GUI
5677 need_mouse_correct = TRUE;
5678#endif
5679
5680 /*
5681 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005682 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005684 if (!curwin->w_buffer->b_help
5685#ifdef FEAT_WINDOWS
5686 || cmdmod.tab != 0
5687#endif
5688 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 {
5690#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005691 if (cmdmod.tab != 0)
5692 wp = NULL;
5693 else
5694 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5695 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5696 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5698 win_enter(wp, TRUE);
5699 else
5700#endif
5701 {
5702 /*
5703 * There is no help window yet.
5704 * Try to open the file specified by the "helpfile" option.
5705 */
5706 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5707 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00005708 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 goto erret;
5710 }
5711 fclose(helpfd);
5712
5713#ifdef FEAT_WINDOWS
5714 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005715 * specified, the current window is vertically split and
5716 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 n = WSP_HELP;
5718# ifdef FEAT_VERTSPLIT
5719 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005720 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 n |= WSP_TOP;
5722# endif
5723 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005724 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725#else
5726 /* use current window */
5727 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005729#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730
5731#ifdef FEAT_WINDOWS
5732 if (curwin->w_height < p_hh)
5733 win_setheight((int)p_hh);
5734#endif
5735
5736 /*
5737 * Open help file (do_ecmd() will set b_help flag, readfile() will
5738 * set b_p_ro flag).
5739 * Set the alternate file to the previously edited file.
5740 */
5741 alt_fnum = curbuf->b_fnum;
5742 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005743 ECMD_HIDE + ECMD_SET_HELP,
5744#ifdef FEAT_WINDOWS
5745 NULL /* buffer is still open, don't store info */
5746#else
5747 curwin
5748#endif
5749 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005750 if (!cmdmod.keepalt)
5751 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 empty_fnum = curbuf->b_fnum;
5753 }
5754 }
5755
5756 if (!p_im)
5757 restart_edit = 0; /* don't want insert mode in help file */
5758
Bram Moolenaar8f535582011-09-30 17:30:31 +02005759#ifdef FEAT_FOLDING
5760 /* Restore KeyTyped, setting 'filetype=help' may reset it.
5761 * It is needed for do_tag top open folds under the cursor. */
5762 KeyTyped = old_KeyTyped;
5763#endif
5764
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 if (tag != NULL)
5766 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5767
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005768 /* Delete the empty buffer if we're not using it. Careful: autocommands
5769 * may have jumped to another window, check that the buffer is not in a
5770 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5772 {
5773 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005774 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 wipe_buffer(buf, TRUE);
5776 }
5777
5778 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005779 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 curwin->w_alt_fnum = alt_fnum;
5781
5782erret:
5783 vim_free(tag);
5784}
5785
5786
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005787#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5788/*
5789 * In an argument search for a language specifiers in the form "@xx".
5790 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5791 * Returns NULL if not found.
5792 */
5793 char_u *
5794check_help_lang(arg)
5795 char_u *arg;
5796{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005797 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005798
5799 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5800 && ASCII_ISALPHA(arg[len - 1]))
5801 {
5802 arg[len - 3] = NUL; /* remove the '@' */
5803 return arg + len - 2;
5804 }
5805 return NULL;
5806}
5807#endif
5808
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809/*
5810 * Return a heuristic indicating how well the given string matches. The
5811 * smaller the number, the better the match. This is the order of priorities,
5812 * from best match to worst match:
5813 * - Match with least alpha-numeric characters is better.
5814 * - Match with least total characters is better.
5815 * - Match towards the start is better.
5816 * - Match starting with "+" is worse (feature instead of command)
5817 * Assumption is made that the matched_string passed has already been found to
5818 * match some string for which help is requested. webb.
5819 */
5820 int
5821help_heuristic(matched_string, offset, wrong_case)
5822 char_u *matched_string;
5823 int offset; /* offset for match */
5824 int wrong_case; /* no matching case */
5825{
5826 int num_letters;
5827 char_u *p;
5828
5829 num_letters = 0;
5830 for (p = matched_string; *p; p++)
5831 if (ASCII_ISALNUM(*p))
5832 num_letters++;
5833
5834 /*
5835 * Multiply the number of letters by 100 to give it a much bigger
5836 * weighting than the number of characters.
5837 * If there only is a match while ignoring case, add 5000.
5838 * If the match starts in the middle of a word, add 10000 to put it
5839 * somewhere in the last half.
5840 * If the match is more than 2 chars from the start, multiply by 200 to
5841 * put it after matches at the start.
5842 */
5843 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5844 && ASCII_ISALNUM(matched_string[offset - 1]))
5845 offset += 10000;
5846 else if (offset > 2)
5847 offset *= 200;
5848 if (wrong_case)
5849 offset += 5000;
5850 /* Features are less interesting than the subjects themselves, but "+"
5851 * alone is not a feature. */
5852 if (matched_string[0] == '+' && matched_string[1] != NUL)
5853 offset += 100;
5854 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5855}
5856
5857/*
5858 * Compare functions for qsort() below, that checks the help heuristics number
5859 * that has been put after the tagname by find_tags().
5860 */
5861 static int
5862#ifdef __BORLANDC__
5863_RTLENTRYF
5864#endif
5865help_compare(s1, s2)
5866 const void *s1;
5867 const void *s2;
5868{
5869 char *p1;
5870 char *p2;
5871
5872 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5873 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5874 return strcmp(p1, p2);
5875}
5876
5877/*
5878 * Find all help tags matching "arg", sort them and return in matches[], with
5879 * the number of matches in num_matches.
5880 * The matches will be sorted with a "best" match algorithm.
5881 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5882 */
5883 int
5884find_help_tags(arg, num_matches, matches, keep_lang)
5885 char_u *arg;
5886 int *num_matches;
5887 char_u ***matches;
5888 int keep_lang;
5889{
5890 char_u *s, *d;
5891 int i;
5892 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005893 "/*", "/\\*", "\"*", "**",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005894 "cpo-*", "/\\(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005895 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005896 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 "[count]", "[quotex]", "[range]",
5898 "[pattern]", "\\|", "\\%$"};
5899 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005900 "/star", "/\\\\star", "quotestar", "starstar",
Bram Moolenaar117f2c42013-01-17 14:09:44 +01005901 "cpo-star", "/\\\\(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005902 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005903 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 "\\[count]", "\\[quotex]", "\\[range]",
5905 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5906 int flags;
5907
5908 d = IObuff; /* assume IObuff is long enough! */
5909
5910 /*
5911 * Recognize a few exceptions to the rule. Some strings that contain '*'
5912 * with "star". Otherwise '*' is recognized as a wildcard.
5913 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005914 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 if (STRCMP(arg, mtable[i]) == 0)
5916 {
5917 STRCPY(d, rtable[i]);
5918 break;
5919 }
5920
5921 if (i < 0) /* no match in table */
5922 {
5923 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5924 * Also replace "\%^" and "\%(", they match every tag too.
5925 * Also "\zs", "\z1", etc.
5926 * Also "\@<", "\@=", "\@<=", etc.
5927 * And also "\_$" and "\_^". */
5928 if (arg[0] == '\\'
5929 && ((arg[1] != NUL && arg[2] == NUL)
5930 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5931 && arg[2] != NUL)))
5932 {
5933 STRCPY(d, "/\\\\");
5934 STRCPY(d + 3, arg + 1);
5935 /* Check for "/\\_$", should be "/\\_\$" */
5936 if (d[3] == '_' && d[4] == '$')
5937 STRCPY(d + 4, "\\$");
5938 }
5939 else
5940 {
Bram Moolenaar7c0a86b2012-09-05 15:15:07 +02005941 /* Replace:
5942 * "[:...:]" with "\[:...:]"
5943 * "[++...]" with "\[++...]"
5944 * "\{" with "\\{"
5945 */
5946 if ((arg[0] == '[' && (arg[1] == ':'
5947 || (arg[1] == '+' && arg[2] == '+')))
5948 || (arg[0] == '\\' && arg[1] == '{'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 *d++ = '\\';
5950
5951 for (s = arg; *s; ++s)
5952 {
5953 /*
5954 * Replace "|" with "bar" and '"' with "quote" to match the name of
5955 * the tags for these commands.
5956 * Replace "*" with ".*" and "?" with "." to match command line
5957 * completion.
5958 * Insert a backslash before '~', '$' and '.' to avoid their
5959 * special meaning.
5960 */
5961 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5962 break;
5963 switch (*s)
5964 {
5965 case '|': STRCPY(d, "bar");
5966 d += 3;
5967 continue;
5968 case '"': STRCPY(d, "quote");
5969 d += 5;
5970 continue;
5971 case '*': *d++ = '.';
5972 break;
5973 case '?': *d++ = '.';
5974 continue;
5975 case '$':
5976 case '.':
5977 case '~': *d++ = '\\';
5978 break;
5979 }
5980
5981 /*
5982 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5983 * ":help i_^_CTRL-D" work.
5984 * Insert '-' before and after "CTRL-X" when applicable.
5985 */
5986 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5987 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5988 {
5989 if (d > IObuff && d[-1] != '_')
5990 *d++ = '_'; /* prepend a '_' */
5991 STRCPY(d, "CTRL-");
5992 d += 5;
5993 if (*s < ' ')
5994 {
5995#ifdef EBCDIC
5996 *d++ = CtrlChar(*s);
5997#else
5998 *d++ = *s + '@';
5999#endif
6000 if (d[-1] == '\\')
6001 *d++ = '\\'; /* double a backslash */
6002 }
6003 else
6004 *d++ = *++s;
6005 if (s[1] != NUL && s[1] != '_')
6006 *d++ = '_'; /* append a '_' */
6007 continue;
6008 }
6009 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
6010 *d++ = '\\';
6011
6012 /*
6013 * Insert a backslash before a backslash after a slash, for search
6014 * pattern tags: "/\|" --> "/\\|".
6015 */
6016 else if (s[0] == '\\' && s[1] != '\\'
6017 && *arg == '/' && s == arg + 1)
6018 *d++ = '\\';
6019
6020 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
6021 * "CTRL-\_CTRL-N" */
6022 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
6023 {
6024 STRCPY(d, "CTRL-\\\\");
6025 d += 7;
6026 s += 6;
6027 }
6028
6029 *d++ = *s;
6030
6031 /*
6032 * If tag starts with ', toss everything after a second '. Fixes
6033 * CTRL-] on 'option'. (would include the trailing '.').
6034 */
6035 if (*s == '\'' && s > arg && *arg == '\'')
6036 break;
6037 }
6038 *d = NUL;
Bram Moolenaar720ce532012-04-25 12:57:28 +02006039
6040 if (*IObuff == '`')
6041 {
6042 if (d > IObuff + 2 && d[-1] == '`')
6043 {
6044 /* remove the backticks from `command` */
6045 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6046 d[-2] = NUL;
6047 }
6048 else if (d > IObuff + 3 && d[-2] == '`' && d[-1] == ',')
6049 {
6050 /* remove the backticks and comma from `command`, */
6051 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6052 d[-3] = NUL;
6053 }
6054 else if (d > IObuff + 4 && d[-3] == '`'
6055 && d[-2] == '\\' && d[-1] == '.')
6056 {
6057 /* remove the backticks and dot from `command`\. */
6058 mch_memmove(IObuff, IObuff + 1, STRLEN(IObuff));
6059 d[-4] = NUL;
6060 }
6061 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 }
6063 }
6064
6065 *matches = (char_u **)"";
6066 *num_matches = 0;
6067 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
6068 if (keep_lang)
6069 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006070 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006072 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 /* Sort the matches found on the heuristic number that is after the
6074 * tag name. */
6075 qsort((void *)*matches, (size_t)*num_matches,
6076 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00006077 /* Delete more than TAG_MANY to reduce the size of the listing. */
6078 while (*num_matches > TAG_MANY)
6079 vim_free((*matches)[--*num_matches]);
6080 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 return OK;
6082}
6083
6084/*
6085 * After reading a help file: May cleanup a help buffer when syntax
6086 * highlighting is not used.
6087 */
6088 void
6089fix_help_buffer()
6090{
6091 linenr_T lnum;
6092 char_u *line;
6093 int in_example = FALSE;
6094 int len;
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006095 char_u *fname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 char_u *p;
6097 char_u *rt;
6098 int mustfree;
6099
6100 /* set filetype to "help". */
6101 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
6102
6103#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02006104 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105#endif
6106 {
6107 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
6108 {
6109 line = ml_get_buf(curbuf, lnum, FALSE);
6110 len = (int)STRLEN(line);
6111 if (in_example && len > 0 && !vim_iswhite(line[0]))
6112 {
6113 /* End of example: non-white or '<' in first column. */
6114 if (line[0] == '<')
6115 {
6116 /* blank-out a '<' in the first column */
6117 line = ml_get_buf(curbuf, lnum, TRUE);
6118 line[0] = ' ';
6119 }
6120 in_example = FALSE;
6121 }
6122 if (!in_example && len > 0)
6123 {
6124 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6125 {
6126 /* blank-out a '>' in the last column (start of example) */
6127 line = ml_get_buf(curbuf, lnum, TRUE);
6128 line[len - 1] = ' ';
6129 in_example = TRUE;
6130 }
6131 else if (line[len - 1] == '~')
6132 {
6133 /* blank-out a '~' at the end of line (header marker) */
6134 line = ml_get_buf(curbuf, lnum, TRUE);
6135 line[len - 1] = ' ';
6136 }
6137 }
6138 }
6139 }
6140
6141 /*
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006142 * In the "help.txt" and "help.abx" file, add the locally added help
6143 * files. This uses the very first line in the help file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 */
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006145 fname = gettail(curbuf->b_fname);
6146 if (fnamecmp(fname, "help.txt") == 0
6147#ifdef FEAT_MULTI_LANG
6148 || (fnamencmp(fname, "help.", 5) == 0
6149 && ASCII_ISALPHA(fname[5])
6150 && ASCII_ISALPHA(fname[6])
6151 && TOLOWER_ASC(fname[7]) == 'x'
6152 && fname[8] == NUL)
6153#endif
6154 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 {
6156 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6157 {
6158 line = ml_get_buf(curbuf, lnum, FALSE);
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006159 if (strstr((char *)line, "*local-additions*") == NULL)
6160 continue;
6161
6162 /* Go through all directories in 'runtimepath', skipping
6163 * $VIMRUNTIME. */
6164 p = p_rtp;
6165 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006167 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6168 mustfree = FALSE;
6169 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6170 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 {
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006172 int fcount;
6173 char_u **fnames;
6174 FILE *fd;
6175 char_u *s;
6176 int fi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177#ifdef FEAT_MBYTE
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006178 vimconv_T vc;
6179 char_u *cp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180#endif
6181
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006182 /* Find all "doc/ *.txt" files in this directory. */
6183 add_pathsep(NameBuff);
6184#ifdef FEAT_MULTI_LANG
6185 STRCAT(NameBuff, "doc/*.??[tx]");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186#else
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006187 STRCAT(NameBuff, "doc/*.txt");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188#endif
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006189 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6190 &fnames, EW_FILE|EW_SILENT) == OK
6191 && fcount > 0)
6192 {
6193#ifdef FEAT_MULTI_LANG
6194 int i1;
6195 int i2;
6196 char_u *f1;
6197 char_u *f2;
6198 char_u *t1;
6199 char_u *e1;
6200 char_u *e2;
6201
6202 /* If foo.abx is found use it instead of foo.txt in
6203 * the same directory. */
6204 for (i1 = 0; i1 < fcount; ++i1)
6205 {
6206 for (i2 = 0; i2 < fcount; ++i2)
6207 {
6208 if (i1 == i2)
6209 continue;
6210 if (fnames[i1] == NULL || fnames[i2] == NULL)
6211 continue;
6212 f1 = fnames[i1];
6213 f2 = fnames[i2];
6214 t1 = gettail(f1);
6215 if (fnamencmp(f1, f2, t1 - f1) != 0)
6216 continue;
6217 e1 = vim_strrchr(t1, '.');
6218 e2 = vim_strrchr(gettail(f2), '.');
6219 if (e1 == NUL || e2 == NUL)
6220 continue;
6221 if (fnamecmp(e1, ".txt") != 0
6222 && fnamecmp(e1, fname + 4) != 0)
6223 {
6224 /* Not .txt and not .abx, remove it. */
6225 vim_free(fnames[i1]);
6226 fnames[i1] = NULL;
6227 continue;
6228 }
6229 if (fnamencmp(f1, f2, e1 - f1) != 0)
6230 continue;
6231 if (fnamecmp(e1, ".txt") == 0
6232 && fnamecmp(e2, fname + 4) == 0)
6233 {
6234 /* use .abx instead of .txt */
6235 vim_free(fnames[i1]);
6236 fnames[i1] = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 }
6238 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006240#endif
6241 for (fi = 0; fi < fcount; ++fi)
6242 {
6243 if (fnames[fi] == NULL)
6244 continue;
6245 fd = mch_fopen((char *)fnames[fi], "r");
6246 if (fd != NULL)
6247 {
6248 vim_fgets(IObuff, IOSIZE, fd);
6249 if (IObuff[0] == '*'
6250 && (s = vim_strchr(IObuff + 1, '*'))
6251 != NULL)
6252 {
6253#ifdef FEAT_MBYTE
6254 int this_utf = MAYBE;
6255#endif
6256 /* Change tag definition to a
6257 * reference and remove <CR>/<NL>. */
6258 IObuff[0] = '|';
6259 *s = '|';
6260 while (*s != NUL)
6261 {
6262 if (*s == '\r' || *s == '\n')
6263 *s = NUL;
6264#ifdef FEAT_MBYTE
6265 /* The text is utf-8 when a byte
6266 * above 127 is found and no
6267 * illegal byte sequence is found.
6268 */
6269 if (*s >= 0x80 && this_utf != FALSE)
6270 {
6271 int l;
6272
6273 this_utf = TRUE;
6274 l = utf_ptr2len(s);
6275 if (l == 1)
6276 this_utf = FALSE;
6277 s += l - 1;
6278 }
6279#endif
6280 ++s;
6281 }
6282#ifdef FEAT_MBYTE
6283 /* The help file is latin1 or utf-8;
6284 * conversion to the current
6285 * 'encoding' may be required. */
6286 vc.vc_type = CONV_NONE;
6287 convert_setup(&vc, (char_u *)(
6288 this_utf == TRUE ? "utf-8"
6289 : "latin1"), p_enc);
6290 if (vc.vc_type == CONV_NONE)
6291 /* No conversion needed. */
6292 cp = IObuff;
6293 else
6294 {
6295 /* Do the conversion. If it fails
6296 * use the unconverted text. */
6297 cp = string_convert(&vc, IObuff,
6298 NULL);
6299 if (cp == NULL)
6300 cp = IObuff;
6301 }
6302 convert_setup(&vc, NULL, NULL);
6303
6304 ml_append(lnum, cp, (colnr_T)0, FALSE);
6305 if (cp != IObuff)
6306 vim_free(cp);
6307#else
6308 ml_append(lnum, IObuff, (colnr_T)0,
6309 FALSE);
6310#endif
6311 ++lnum;
6312 }
6313 fclose(fd);
6314 }
6315 }
6316 FreeWild(fcount, fnames);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006319 if (mustfree)
6320 vim_free(rt);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 }
Bram Moolenaar667b4d22011-10-20 18:17:42 +02006322 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323 }
6324 }
6325}
6326
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006327/*
6328 * ":exusage"
6329 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006330 void
6331ex_exusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006332 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006333{
6334 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6335}
6336
6337/*
6338 * ":viusage"
6339 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006340 void
6341ex_viusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006342 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006343{
6344 do_cmdline_cmd((char_u *)"help normal-index");
6345}
6346
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347#if defined(FEAT_EX_EXTRA) || defined(PROTO)
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006348static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349
6350/*
6351 * ":helptags"
6352 */
6353 void
6354ex_helptags(eap)
6355 exarg_T *eap;
6356{
6357 garray_T ga;
6358 int i, j;
6359 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006360#ifdef FEAT_MULTI_LANG
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 char_u lang[2];
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006362#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006363 expand_T xpc;
6364 char_u *dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 char_u ext[5];
6366 char_u fname[8];
6367 int filecount;
6368 char_u **files;
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006369 int add_help_tags = FALSE;
6370
6371 /* Check for ":helptags ++t {dir}". */
6372 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6373 {
6374 add_help_tags = TRUE;
6375 eap->arg = skipwhite(eap->arg + 3);
6376 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377
Bram Moolenaar0e253142008-01-13 12:31:34 +00006378 ExpandInit(&xpc);
6379 xpc.xp_context = EXPAND_DIRECTORIES;
6380 dirname = ExpandOne(&xpc, eap->arg, NULL,
6381 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6382 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 {
6384 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6385 return;
6386 }
6387
6388#ifdef FEAT_MULTI_LANG
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006389 /* Get a list of all files in the help directory and in subdirectories. */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006390 STRCPY(NameBuff, dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 add_pathsep(NameBuff);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006392 STRCAT(NameBuff, "**");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6394 EW_FILE|EW_SILENT) == FAIL
6395 || filecount == 0)
6396 {
6397 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar0e253142008-01-13 12:31:34 +00006398 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 return;
6400 }
6401
6402 /* Go over all files in the directory to find out what languages are
6403 * present. */
6404 ga_init2(&ga, 1, 10);
6405 for (i = 0; i < filecount; ++i)
6406 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006407 len = (int)STRLEN(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 if (len > 4)
6409 {
6410 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6411 {
6412 /* ".txt" -> language "en" */
6413 lang[0] = 'e';
6414 lang[1] = 'n';
6415 }
6416 else if (files[i][len - 4] == '.'
6417 && ASCII_ISALPHA(files[i][len - 3])
6418 && ASCII_ISALPHA(files[i][len - 2])
6419 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6420 {
6421 /* ".abx" -> language "ab" */
6422 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6423 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6424 }
6425 else
6426 continue;
6427
6428 /* Did we find this language already? */
6429 for (j = 0; j < ga.ga_len; j += 2)
6430 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6431 break;
6432 if (j == ga.ga_len)
6433 {
6434 /* New language, add it. */
6435 if (ga_grow(&ga, 2) == FAIL)
6436 break;
6437 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6438 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 }
6440 }
6441 }
6442
6443 /*
6444 * Loop over the found languages to generate a tags file for each one.
6445 */
6446 for (j = 0; j < ga.ga_len; j += 2)
6447 {
6448 STRCPY(fname, "tags-xx");
6449 fname[5] = ((char_u *)ga.ga_data)[j];
6450 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6451 if (fname[5] == 'e' && fname[6] == 'n')
6452 {
6453 /* English is an exception: use ".txt" and "tags". */
6454 fname[4] = NUL;
6455 STRCPY(ext, ".txt");
6456 }
6457 else
6458 {
6459 /* Language "ab" uses ".abx" and "tags-ab". */
6460 STRCPY(ext, ".xxx");
6461 ext[1] = fname[5];
6462 ext[2] = fname[6];
6463 }
Bram Moolenaar0e253142008-01-13 12:31:34 +00006464 helptags_one(dirname, ext, fname, add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 }
6466
6467 ga_clear(&ga);
6468 FreeWild(filecount, files);
6469
6470#else
6471 /* No language support, just use "*.txt" and "tags". */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006472 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006474 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475}
6476
6477 static void
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006478helptags_one(dir, ext, tagfname, add_help_tags)
6479 char_u *dir; /* doc directory */
6480 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006481 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6482 int add_help_tags; /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483{
6484 FILE *fd_tags;
6485 FILE *fd;
6486 garray_T ga;
6487 int filecount;
6488 char_u **files;
6489 char_u *p1, *p2;
6490 int fi;
6491 char_u *s;
6492 int i;
6493 char_u *fname;
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006494 int dirlen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495# ifdef FEAT_MBYTE
6496 int utf8 = MAYBE;
6497 int this_utf8;
6498 int firstline;
6499 int mix = FALSE; /* detected mixed encodings */
6500# endif
6501
6502 /*
6503 * Find all *.txt files.
6504 */
Bram Moolenaar862cfa32012-11-29 20:10:00 +01006505 dirlen = (int)STRLEN(dir);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 STRCPY(NameBuff, dir);
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006507 STRCAT(NameBuff, "/**/*");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 STRCAT(NameBuff, ext);
6509 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6510 EW_FILE|EW_SILENT) == FAIL
6511 || filecount == 0)
6512 {
6513 if (!got_int)
6514 EMSG2("E151: No match: %s", NameBuff);
6515 return;
6516 }
6517
6518 /*
6519 * Open the tags file for writing.
6520 * Do this before scanning through all the files.
6521 */
6522 STRCPY(NameBuff, dir);
6523 add_pathsep(NameBuff);
6524 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006525 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 if (fd_tags == NULL)
6527 {
6528 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6529 FreeWild(filecount, files);
6530 return;
6531 }
6532
6533 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006534 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6535 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 */
6537 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006538 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6539 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 {
6541 if (ga_grow(&ga, 1) == FAIL)
6542 got_int = TRUE;
6543 else
6544 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006545 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 if (s == NULL)
6547 got_int = TRUE;
6548 else
6549 {
6550 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6551 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6552 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 }
6554 }
6555 }
6556
6557 /*
6558 * Go over all the files and extract the tags.
6559 */
6560 for (fi = 0; fi < filecount && !got_int; ++fi)
6561 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006562 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 if (fd == NULL)
6564 {
6565 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6566 continue;
6567 }
Bram Moolenaar442b5c42012-11-28 16:06:22 +01006568 fname = files[fi] + dirlen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569
6570# ifdef FEAT_MBYTE
6571 firstline = TRUE;
6572# endif
6573 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6574 {
6575# ifdef FEAT_MBYTE
6576 if (firstline)
6577 {
6578 /* Detect utf-8 file by a non-ASCII char in the first line. */
6579 this_utf8 = MAYBE;
6580 for (s = IObuff; *s != NUL; ++s)
6581 if (*s >= 0x80)
6582 {
6583 int l;
6584
6585 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006586 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 if (l == 1)
6588 {
6589 /* Illegal UTF-8 byte sequence. */
6590 this_utf8 = FALSE;
6591 break;
6592 }
6593 s += l - 1;
6594 }
6595 if (this_utf8 == MAYBE) /* only ASCII characters found */
6596 this_utf8 = FALSE;
6597 if (utf8 == MAYBE) /* first file */
6598 utf8 = this_utf8;
6599 else if (utf8 != this_utf8)
6600 {
6601 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6602 mix = !got_int;
6603 got_int = TRUE;
6604 }
6605 firstline = FALSE;
6606 }
6607# endif
6608 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6609 while (p1 != NULL)
6610 {
Bram Moolenaara0149c72012-05-18 16:24:11 +02006611 /* Use vim_strbyte() instead of vim_strchr() so that when
6612 * 'encoding' is dbcs it still works, don't find '*' in the
6613 * second byte. */
6614 p2 = vim_strbyte(p1 + 1, '*'); /* find second '*' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6616 {
6617 for (s = p1 + 1; s < p2; ++s)
6618 if (*s == ' ' || *s == '\t' || *s == '|')
6619 break;
6620
6621 /*
6622 * Only accept a *tag* when it consists of valid
6623 * characters, there is white space before it and is
6624 * followed by a white character or end-of-line.
6625 */
6626 if (s == p2
6627 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6628 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6629 || s[1] == '\0'))
6630 {
6631 *p2 = '\0';
6632 ++p1;
6633 if (ga_grow(&ga, 1) == FAIL)
6634 {
6635 got_int = TRUE;
6636 break;
6637 }
6638 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6639 if (s == NULL)
6640 {
6641 got_int = TRUE;
6642 break;
6643 }
6644 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6645 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 sprintf((char *)s, "%s\t%s", p1, fname);
6647
6648 /* find next '*' */
6649 p2 = vim_strchr(p2 + 1, '*');
6650 }
6651 }
6652 p1 = p2;
6653 }
6654 line_breakcheck();
6655 }
6656
6657 fclose(fd);
6658 }
6659
6660 FreeWild(filecount, files);
6661
6662 if (!got_int)
6663 {
6664 /*
6665 * Sort the tags.
6666 */
6667 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6668
6669 /*
6670 * Check for duplicates.
6671 */
6672 for (i = 1; i < ga.ga_len; ++i)
6673 {
6674 p1 = ((char_u **)ga.ga_data)[i - 1];
6675 p2 = ((char_u **)ga.ga_data)[i];
6676 while (*p1 == *p2)
6677 {
6678 if (*p2 == '\t')
6679 {
6680 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006681 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6683 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6684 EMSG(NameBuff);
6685 *p2 = '\t';
6686 break;
6687 }
6688 ++p1;
6689 ++p2;
6690 }
6691 }
6692
6693# ifdef FEAT_MBYTE
6694 if (utf8 == TRUE)
6695 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6696# endif
6697
6698 /*
6699 * Write the tags into the file.
6700 */
6701 for (i = 0; i < ga.ga_len; ++i)
6702 {
6703 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006704 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006706 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 else
6708 {
6709 fprintf(fd_tags, "%s\t/*", s);
6710 for (p1 = s; *p1 != '\t'; ++p1)
6711 {
6712 /* insert backslash before '\\' and '/' */
6713 if (*p1 == '\\' || *p1 == '/')
6714 putc('\\', fd_tags);
6715 putc(*p1, fd_tags);
6716 }
6717 fprintf(fd_tags, "*\n");
6718 }
6719 }
6720 }
6721#ifdef FEAT_MBYTE
6722 if (mix)
6723 got_int = FALSE; /* continue with other languages */
6724#endif
6725
6726 for (i = 0; i < ga.ga_len; ++i)
6727 vim_free(((char_u **)ga.ga_data)[i]);
6728 ga_clear(&ga);
6729 fclose(fd_tags); /* there is no check for an error... */
6730}
6731#endif
6732
6733#if defined(FEAT_SIGNS) || defined(PROTO)
6734
6735/*
6736 * Struct to hold the sign properties.
6737 */
6738typedef struct sign sign_T;
6739
6740struct sign
6741{
6742 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02006743 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 char_u *sn_name; /* name of sign */
6745 char_u *sn_icon; /* name of pixmap */
6746#ifdef FEAT_SIGN_ICONS
6747 void *sn_image; /* icon image */
6748#endif
6749 char_u *sn_text; /* text used instead of pixmap */
6750 int sn_line_hl; /* highlight ID for line */
6751 int sn_text_hl; /* highlight ID for text */
6752};
6753
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006755static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756
Bram Moolenaar985cb442009-05-14 19:51:46 +00006757static int sign_cmd_idx __ARGS((char_u *begin_cmd, char_u *end_cmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758static void sign_list_defined __ARGS((sign_T *sp));
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006759static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006761static char *cmds[] = {
6762 "define",
6763#define SIGNCMD_DEFINE 0
6764 "undefine",
6765#define SIGNCMD_UNDEFINE 1
6766 "list",
6767#define SIGNCMD_LIST 2
6768 "place",
6769#define SIGNCMD_PLACE 3
6770 "unplace",
6771#define SIGNCMD_UNPLACE 4
6772 "jump",
6773#define SIGNCMD_JUMP 5
6774 NULL
6775#define SIGNCMD_LAST 6
6776};
6777
6778/*
6779 * Find index of a ":sign" subcmd from its name.
6780 * "*end_cmd" must be writable.
6781 */
6782 static int
6783sign_cmd_idx(begin_cmd, end_cmd)
Bram Moolenaar985cb442009-05-14 19:51:46 +00006784 char_u *begin_cmd; /* begin of sign subcmd */
6785 char_u *end_cmd; /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006786{
6787 int idx;
6788 char save = *end_cmd;
6789
6790 *end_cmd = NUL;
6791 for (idx = 0; ; ++idx)
6792 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6793 break;
6794 *end_cmd = save;
6795 return idx;
6796}
6797
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798/*
6799 * ":sign" command
6800 */
6801 void
6802ex_sign(eap)
6803 exarg_T *eap;
6804{
6805 char_u *arg = eap->arg;
6806 char_u *p;
6807 int idx;
6808 sign_T *sp;
6809 sign_T *sp_prev;
6810 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811
6812 /* Parse the subcommand. */
6813 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006814 idx = sign_cmd_idx(arg, p);
6815 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006817 EMSG2(_("E160: Unknown sign command: %s"), arg);
6818 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 }
6820 arg = skipwhite(p);
6821
6822 if (idx <= SIGNCMD_LIST)
6823 {
6824 /*
6825 * Define, undefine or list signs.
6826 */
6827 if (idx == SIGNCMD_LIST && *arg == NUL)
6828 {
6829 /* ":sign list": list all defined signs */
Bram Moolenaar1c0b03e2012-03-16 14:32:15 +01006830 for (sp = first_sign; sp != NULL && !got_int; sp = sp->sn_next)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 sign_list_defined(sp);
6832 }
6833 else if (*arg == NUL)
6834 EMSG(_("E156: Missing sign name"));
6835 else
6836 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006837 /* Isolate the sign name. If it's a number skip leading zeroes,
6838 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 p = skiptowhite(arg);
6840 if (*p != NUL)
6841 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006842 while (arg[0] == '0' && arg[1] != NUL)
6843 ++arg;
6844
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 sp_prev = NULL;
6846 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6847 {
6848 if (STRCMP(sp->sn_name, arg) == 0)
6849 break;
6850 sp_prev = sp;
6851 }
6852 if (idx == SIGNCMD_DEFINE)
6853 {
6854 /* ":sign define {name} ...": define a sign */
6855 if (sp == NULL)
6856 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006857 sign_T *lp;
6858 int start = next_sign_typenr;
6859
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 /* Allocate a new sign. */
6861 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6862 if (sp == NULL)
6863 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006865 /* Check that next_sign_typenr is not already being used.
6866 * This only happens after wrapping around. Hopefully
6867 * another one got deleted and we can use its number. */
6868 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006870 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006872 ++next_sign_typenr;
6873 if (next_sign_typenr == MAX_TYPENR)
6874 next_sign_typenr = 1;
6875 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006877 vim_free(sp);
6878 EMSG(_("E612: Too many signs defined"));
6879 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006881 lp = first_sign; /* start all over */
6882 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006884 lp = lp->sn_next;
6885 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006887 sp->sn_typenr = next_sign_typenr;
6888 if (++next_sign_typenr == MAX_TYPENR)
6889 next_sign_typenr = 1; /* wrap around */
6890
6891 sp->sn_name = vim_strsave(arg);
6892 if (sp->sn_name == NULL) /* out of memory */
6893 {
6894 vim_free(sp);
6895 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02006897
6898 /* add the new sign to the list of signs */
6899 if (sp_prev == NULL)
6900 first_sign = sp;
6901 else
6902 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 }
6904
6905 /* set values for a defined sign. */
6906 for (;;)
6907 {
6908 arg = skipwhite(p);
6909 if (*arg == NUL)
6910 break;
6911 p = skiptowhite_esc(arg);
6912 if (STRNCMP(arg, "icon=", 5) == 0)
6913 {
6914 arg += 5;
6915 vim_free(sp->sn_icon);
6916 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6917 backslash_halve(sp->sn_icon);
6918#ifdef FEAT_SIGN_ICONS
6919 if (gui.in_use)
6920 {
6921 out_flush();
6922 if (sp->sn_image != NULL)
6923 gui_mch_destroy_sign(sp->sn_image);
6924 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6925 }
6926#endif
6927 }
6928 else if (STRNCMP(arg, "text=", 5) == 0)
6929 {
6930 char_u *s;
6931 int cells;
6932 int len;
6933
6934 arg += 5;
6935#ifdef FEAT_MBYTE
6936 /* Count cells and check for non-printable chars */
6937 if (has_mbyte)
6938 {
6939 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006940 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 {
6942 if (!vim_isprintc((*mb_ptr2char)(s)))
6943 break;
6944 cells += (*mb_ptr2cells)(s);
6945 }
6946 }
6947 else
6948#endif
6949 {
6950 for (s = arg; s < p; ++s)
6951 if (!vim_isprintc(*s))
6952 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006953 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 }
6955 /* Currently must be one or two display cells */
6956 if (s != p || cells < 1 || cells > 2)
6957 {
6958 *p = NUL;
6959 EMSG2(_("E239: Invalid sign text: %s"), arg);
6960 return;
6961 }
6962
6963 vim_free(sp->sn_text);
6964 /* Allocate one byte more if we need to pad up
6965 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006966 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 sp->sn_text = vim_strnsave(arg, len);
6968
6969 if (sp->sn_text != NULL && cells == 1)
6970 STRCPY(sp->sn_text + len - 1, " ");
6971 }
6972 else if (STRNCMP(arg, "linehl=", 7) == 0)
6973 {
6974 arg += 7;
6975 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6976 }
6977 else if (STRNCMP(arg, "texthl=", 7) == 0)
6978 {
6979 arg += 7;
6980 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6981 }
6982 else
6983 {
6984 EMSG2(_(e_invarg2), arg);
6985 return;
6986 }
6987 }
6988 }
6989 else if (sp == NULL)
6990 EMSG2(_("E155: Unknown sign: %s"), arg);
6991 else if (idx == SIGNCMD_LIST)
6992 /* ":sign list {name}" */
6993 sign_list_defined(sp);
6994 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006996 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 }
6998 }
6999 else
7000 {
7001 int id = -1;
7002 linenr_T lnum = -1;
7003 char_u *sign_name = NULL;
7004 char_u *arg1;
7005
7006 if (*arg == NUL)
7007 {
7008 if (idx == SIGNCMD_PLACE)
7009 {
7010 /* ":sign place": list placed signs in all buffers */
7011 sign_list_placed(NULL);
7012 }
7013 else if (idx == SIGNCMD_UNPLACE)
7014 {
7015 /* ":sign unplace": remove placed sign at cursor */
7016 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
7017 if (id > 0)
7018 {
7019 buf_delsign(curwin->w_buffer, id);
7020 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
7021 }
7022 else
7023 EMSG(_("E159: Missing sign number"));
7024 }
7025 else
7026 EMSG(_(e_argreq));
7027 return;
7028 }
7029
7030 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
7031 {
7032 /* ":sign unplace *": remove all placed signs */
7033 buf_delete_all_signs();
7034 return;
7035 }
7036
7037 /* first arg could be placed sign id */
7038 arg1 = arg;
7039 if (VIM_ISDIGIT(*arg))
7040 {
7041 id = getdigits(&arg);
7042 if (!vim_iswhite(*arg) && *arg != NUL)
7043 {
7044 id = -1;
7045 arg = arg1;
7046 }
7047 else
7048 {
7049 arg = skipwhite(arg);
7050 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
7051 {
7052 /* ":sign unplace {id}": remove placed sign by number */
7053 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
7054 if ((lnum = buf_delsign(buf, id)) != 0)
7055 update_debug_sign(buf, lnum);
7056 return;
7057 }
7058 }
7059 }
7060
7061 /*
7062 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
7063 * Leave "arg" pointing to {fname}.
7064 */
7065 for (;;)
7066 {
7067 if (STRNCMP(arg, "line=", 5) == 0)
7068 {
7069 arg += 5;
7070 lnum = atoi((char *)arg);
7071 arg = skiptowhite(arg);
7072 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007073 else if (STRNCMP(arg, "*", 1) == 0 && idx == SIGNCMD_UNPLACE)
7074 {
7075 if (id != -1)
7076 {
7077 EMSG(_(e_invarg));
7078 return;
7079 }
7080 id = -2;
7081 arg = skiptowhite(arg + 1);
7082 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 else if (STRNCMP(arg, "name=", 5) == 0)
7084 {
7085 arg += 5;
7086 sign_name = arg;
7087 arg = skiptowhite(arg);
7088 if (*arg != NUL)
7089 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02007090 while (sign_name[0] == '0' && sign_name[1] != NUL)
7091 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 }
7093 else if (STRNCMP(arg, "file=", 5) == 0)
7094 {
7095 arg += 5;
7096 buf = buflist_findname(arg);
7097 break;
7098 }
7099 else if (STRNCMP(arg, "buffer=", 7) == 0)
7100 {
7101 arg += 7;
7102 buf = buflist_findnr((int)getdigits(&arg));
7103 if (*skipwhite(arg) != NUL)
7104 EMSG(_(e_trailing));
7105 break;
7106 }
7107 else
7108 {
7109 EMSG(_(e_invarg));
7110 return;
7111 }
7112 arg = skipwhite(arg);
7113 }
7114
7115 if (buf == NULL)
7116 {
7117 EMSG2(_("E158: Invalid buffer name: %s"), arg);
7118 }
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007119 else if (id <= 0 && !(idx == SIGNCMD_UNPLACE && id == -2))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 {
7121 if (lnum >= 0 || sign_name != NULL)
7122 EMSG(_(e_invarg));
7123 else
7124 /* ":sign place file={fname}": list placed signs in one file */
7125 sign_list_placed(buf);
7126 }
7127 else if (idx == SIGNCMD_JUMP)
7128 {
7129 /* ":sign jump {id} file={fname}" */
7130 if (lnum >= 0 || sign_name != NULL)
7131 EMSG(_(e_invarg));
7132 else if ((lnum = buf_findsign(buf, id)) > 0)
7133 { /* goto a sign ... */
7134 if (buf_jump_open_win(buf) != NULL)
7135 { /* ... in a current window */
7136 curwin->w_cursor.lnum = lnum;
7137 check_cursor_lnum();
7138 beginline(BL_WHITE);
7139 }
7140 else
7141 { /* ... not currently in a window */
7142 char_u *cmd;
7143
7144 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
7145 if (cmd == NULL)
7146 return;
7147 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
7148 do_cmdline_cmd(cmd);
7149 vim_free(cmd);
7150 }
7151#ifdef FEAT_FOLDING
7152 foldOpenCursor();
7153#endif
7154 }
7155 else
7156 EMSGN(_("E157: Invalid sign ID: %ld"), id);
7157 }
7158 else if (idx == SIGNCMD_UNPLACE)
7159 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 if (lnum >= 0 || sign_name != NULL)
7161 EMSG(_(e_invarg));
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007162 else if (id == -2)
7163 {
7164 /* ":sign unplace * file={fname}" */
7165 redraw_buf_later(buf, NOT_VALID);
7166 buf_delete_signs(buf);
7167 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 else
7169 {
Bram Moolenaarf65e5662012-07-10 15:18:22 +02007170 /* ":sign unplace {id} file={fname}" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 lnum = buf_delsign(buf, id);
7172 update_debug_sign(buf, lnum);
7173 }
7174 }
7175 /* idx == SIGNCMD_PLACE */
7176 else if (sign_name != NULL)
7177 {
7178 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7179 if (STRCMP(sp->sn_name, sign_name) == 0)
7180 break;
7181 if (sp == NULL)
7182 {
7183 EMSG2(_("E155: Unknown sign: %s"), sign_name);
7184 return;
7185 }
7186 if (lnum > 0)
7187 /* ":sign place {id} line={lnum} name={name} file={fname}":
7188 * place a sign */
7189 buf_addsign(buf, id, lnum, sp->sn_typenr);
7190 else
7191 /* ":sign place {id} file={fname}": change sign type */
7192 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
7193 update_debug_sign(buf, lnum);
7194 }
7195 else
7196 EMSG(_(e_invarg));
7197 }
7198}
7199
7200#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7201/*
7202 * Allocate the icons. Called when the GUI has started. Allows defining
7203 * signs before it starts.
7204 */
7205 void
7206sign_gui_started()
7207{
7208 sign_T *sp;
7209
7210 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7211 if (sp->sn_icon != NULL)
7212 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7213}
7214#endif
7215
7216/*
7217 * List one sign.
7218 */
7219 static void
7220sign_list_defined(sp)
7221 sign_T *sp;
7222{
7223 char_u *p;
7224
Bram Moolenaar555b2802005-05-19 21:08:39 +00007225 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 if (sp->sn_icon != NULL)
7227 {
7228 MSG_PUTS(" icon=");
7229 msg_outtrans(sp->sn_icon);
7230#ifdef FEAT_SIGN_ICONS
7231 if (sp->sn_image == NULL)
7232 MSG_PUTS(_(" (NOT FOUND)"));
7233#else
7234 MSG_PUTS(_(" (not supported)"));
7235#endif
7236 }
7237 if (sp->sn_text != NULL)
7238 {
7239 MSG_PUTS(" text=");
7240 msg_outtrans(sp->sn_text);
7241 }
7242 if (sp->sn_line_hl > 0)
7243 {
7244 MSG_PUTS(" linehl=");
7245 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7246 if (p == NULL)
7247 MSG_PUTS("NONE");
7248 else
7249 msg_puts(p);
7250 }
7251 if (sp->sn_text_hl > 0)
7252 {
7253 MSG_PUTS(" texthl=");
7254 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7255 if (p == NULL)
7256 MSG_PUTS("NONE");
7257 else
7258 msg_puts(p);
7259 }
7260}
7261
7262/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007263 * Undefine a sign and free its memory.
7264 */
7265 static void
7266sign_undefine(sp, sp_prev)
7267 sign_T *sp;
7268 sign_T *sp_prev;
7269{
7270 vim_free(sp->sn_name);
7271 vim_free(sp->sn_icon);
7272#ifdef FEAT_SIGN_ICONS
7273 if (sp->sn_image != NULL)
7274 {
7275 out_flush();
7276 gui_mch_destroy_sign(sp->sn_image);
7277 }
7278#endif
7279 vim_free(sp->sn_text);
7280 if (sp_prev == NULL)
7281 first_sign = sp->sn_next;
7282 else
7283 sp_prev->sn_next = sp->sn_next;
7284 vim_free(sp);
7285}
7286
7287/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 * Get highlighting attribute for sign "typenr".
7289 * If "line" is TRUE: line highl, if FALSE: text highl.
7290 */
7291 int
7292sign_get_attr(typenr, line)
7293 int typenr;
7294 int line;
7295{
7296 sign_T *sp;
7297
7298 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7299 if (sp->sn_typenr == typenr)
7300 {
7301 if (line)
7302 {
7303 if (sp->sn_line_hl > 0)
7304 return syn_id2attr(sp->sn_line_hl);
7305 }
7306 else
7307 {
7308 if (sp->sn_text_hl > 0)
7309 return syn_id2attr(sp->sn_text_hl);
7310 }
7311 break;
7312 }
7313 return 0;
7314}
7315
7316/*
7317 * Get text mark for sign "typenr".
7318 * Returns NULL if there isn't one.
7319 */
7320 char_u *
7321sign_get_text(typenr)
7322 int typenr;
7323{
7324 sign_T *sp;
7325
7326 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7327 if (sp->sn_typenr == typenr)
7328 return sp->sn_text;
7329 return NULL;
7330}
7331
7332#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7333 void *
7334sign_get_image(typenr)
7335 int typenr; /* the attribute which may have a sign */
7336{
7337 sign_T *sp;
7338
7339 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7340 if (sp->sn_typenr == typenr)
7341 return sp->sn_image;
7342 return NULL;
7343}
7344#endif
7345
7346/*
7347 * Get the name of a sign by its typenr.
7348 */
7349 char_u *
7350sign_typenr2name(typenr)
7351 int typenr;
7352{
7353 sign_T *sp;
7354
7355 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7356 if (sp->sn_typenr == typenr)
7357 return sp->sn_name;
7358 return (char_u *)_("[Deleted]");
7359}
7360
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007361#if defined(EXITFREE) || defined(PROTO)
7362/*
7363 * Undefine/free all signs.
7364 */
7365 void
7366free_signs()
7367{
7368 while (first_sign != NULL)
7369 sign_undefine(first_sign, NULL);
7370}
7371#endif
7372
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007373#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7374static enum
7375{
7376 EXP_SUBCMD, /* expand :sign sub-commands */
7377 EXP_DEFINE, /* expand :sign define {name} args */
7378 EXP_PLACE, /* expand :sign place {id} args */
7379 EXP_UNPLACE, /* expand :sign unplace" */
7380 EXP_SIGN_NAMES /* expand with name of placed signs */
7381} expand_what;
7382
7383/*
7384 * Function given to ExpandGeneric() to obtain the sign command
7385 * expansion.
7386 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007387 char_u *
7388get_sign_name(xp, idx)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00007389 expand_T *xp UNUSED;
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007390 int idx;
7391{
7392 sign_T *sp;
7393 int current_idx;
7394
7395 switch (expand_what)
7396 {
7397 case EXP_SUBCMD:
7398 return (char_u *)cmds[idx];
7399 case EXP_DEFINE:
7400 {
7401 char *define_arg[] =
7402 {
7403 "icon=", "linehl=", "text=", "texthl=", NULL
7404 };
7405 return (char_u *)define_arg[idx];
7406 }
7407 case EXP_PLACE:
7408 {
7409 char *place_arg[] =
7410 {
7411 "line=", "name=", "file=", "buffer=", NULL
7412 };
7413 return (char_u *)place_arg[idx];
7414 }
7415 case EXP_UNPLACE:
7416 {
7417 char *unplace_arg[] = { "file=", "buffer=", NULL };
7418 return (char_u *)unplace_arg[idx];
7419 }
7420 case EXP_SIGN_NAMES:
7421 /* Complete with name of signs already defined */
7422 current_idx = 0;
7423 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7424 if (current_idx++ == idx)
7425 return sp->sn_name;
7426 return NULL;
7427 default:
7428 return NULL;
7429 }
7430}
7431
7432/*
7433 * Handle command line completion for :sign command.
7434 */
7435 void
7436set_context_in_sign_cmd(xp, arg)
7437 expand_T *xp;
7438 char_u *arg;
7439{
7440 char_u *p;
7441 char_u *end_subcmd;
7442 char_u *last;
7443 int cmd_idx;
7444 char_u *begin_subcmd_args;
7445
7446 /* Default: expand subcommands. */
7447 xp->xp_context = EXPAND_SIGN;
7448 expand_what = EXP_SUBCMD;
7449 xp->xp_pattern = arg;
7450
7451 end_subcmd = skiptowhite(arg);
7452 if (*end_subcmd == NUL)
7453 /* expand subcmd name
7454 * :sign {subcmd}<CTRL-D>*/
7455 return;
7456
7457 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7458
7459 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007460 * |
7461 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007462 begin_subcmd_args = skipwhite(end_subcmd);
7463 p = skiptowhite(begin_subcmd_args);
7464 if (*p == NUL)
7465 {
7466 /*
7467 * Expand first argument of subcmd when possible.
7468 * For ":jump {id}" and ":unplace {id}", we could
7469 * possibly expand the ids of all signs already placed.
7470 */
7471 xp->xp_pattern = begin_subcmd_args;
7472 switch (cmd_idx)
7473 {
7474 case SIGNCMD_LIST:
7475 case SIGNCMD_UNDEFINE:
7476 /* :sign list <CTRL-D>
7477 * :sign undefine <CTRL-D> */
7478 expand_what = EXP_SIGN_NAMES;
7479 break;
7480 default:
7481 xp->xp_context = EXPAND_NOTHING;
7482 }
7483 return;
7484 }
7485
7486 /* expand last argument of subcmd */
7487
7488 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007489 * |
7490 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007491
7492 /* Loop until reaching last argument. */
7493 do
7494 {
7495 p = skipwhite(p);
7496 last = p;
7497 p = skiptowhite(p);
7498 } while (*p != NUL);
7499
7500 p = vim_strchr(last, '=');
7501
7502 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007503 * | |
7504 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007505 if (p == NUL)
7506 {
7507 /* Expand last argument name (before equal sign). */
7508 xp->xp_pattern = last;
7509 switch (cmd_idx)
7510 {
7511 case SIGNCMD_DEFINE:
7512 expand_what = EXP_DEFINE;
7513 break;
7514 case SIGNCMD_PLACE:
7515 expand_what = EXP_PLACE;
7516 break;
7517 case SIGNCMD_JUMP:
7518 case SIGNCMD_UNPLACE:
7519 expand_what = EXP_UNPLACE;
7520 break;
7521 default:
7522 xp->xp_context = EXPAND_NOTHING;
7523 }
7524 }
7525 else
7526 {
7527 /* Expand last argument value (after equal sign). */
7528 xp->xp_pattern = p + 1;
7529 switch (cmd_idx)
7530 {
7531 case SIGNCMD_DEFINE:
7532 if (STRNCMP(last, "texthl", p - last) == 0 ||
7533 STRNCMP(last, "linehl", p - last) == 0)
7534 xp->xp_context = EXPAND_HIGHLIGHT;
7535 else if (STRNCMP(last, "icon", p - last) == 0)
7536 xp->xp_context = EXPAND_FILES;
7537 else
7538 xp->xp_context = EXPAND_NOTHING;
7539 break;
7540 case SIGNCMD_PLACE:
7541 if (STRNCMP(last, "name", p - last) == 0)
7542 expand_what = EXP_SIGN_NAMES;
7543 else
7544 xp->xp_context = EXPAND_NOTHING;
7545 break;
7546 default:
7547 xp->xp_context = EXPAND_NOTHING;
7548 }
7549 }
7550}
7551#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552#endif
7553
7554#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7555/*
7556 * ":drop"
7557 * Opens the first argument in a window. When there are two or more arguments
7558 * the argument list is redefined.
7559 */
7560 void
7561ex_drop(eap)
7562 exarg_T *eap;
7563{
7564 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 win_T *wp;
7566 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007567# ifdef FEAT_WINDOWS
7568 tabpage_T *tp;
7569# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570
7571 /*
7572 * Check if the first argument is already being edited in a window. If
7573 * so, jump to that window.
7574 * We would actually need to check all arguments, but that's complicated
7575 * and mostly only one file is dropped.
7576 * This also ignores wildcards, since it is very unlikely the user is
7577 * editing a file name with a wildcard character.
7578 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007579 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007581 /*
7582 * Expanding wildcards may result in an empty argument list. E.g. when
7583 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7584 * already did an error message for this.
7585 */
7586 if (ARGCOUNT == 0)
7587 return;
7588
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007589# ifdef FEAT_WINDOWS
7590 if (cmdmod.tab)
7591 {
7592 /* ":tab drop file ...": open a tab for each argument that isn't
7593 * edited in a window yet. It's like ":tab all" but without closing
7594 * windows or tabs. */
7595 ex_all(eap);
7596 }
7597 else
7598# endif
7599 {
7600 /* ":drop file ...": Edit the first argument. Jump to an existing
7601 * window if possible, edit in current window if the current buffer
7602 * can be abandoned, otherwise open a new window. */
7603 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7604
7605 FOR_ALL_TAB_WINDOWS(tp, wp)
7606 {
7607 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007609# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007610 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007611# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 return;
7614 }
7615 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007617 /*
7618 * Check whether the current buffer is changed. If so, we will need
7619 * to split the current window or data could be lost.
7620 * Skip the check if the 'hidden' option is set, as in this case the
7621 * buffer won't be lost.
7622 */
7623 if (!P_HID(curbuf))
7624 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007626 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007628 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007630 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007632 if (split)
7633 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007635 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007637 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7638 if (split)
7639 {
7640 eap->cmdidx = CMD_sfirst;
7641 eap->cmd[0] = 's';
7642 }
7643 else
7644 eap->cmdidx = CMD_first;
7645 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647}
7648#endif