blob: b3f76192151e52b620442a0c9bcc1cc630b97c97 [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 Moolenaarc236c162008-07-13 17:41:49 +000014#if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
Bram Moolenaar8c8de832008-06-24 22:58:06 +000015# include "vimio.h" /* for mch_open(), must be before vim.h */
Bram Moolenaara5792f52005-11-23 21:25:05 +000016#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +000017
18#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000019#include "version.h"
20
21#ifdef FEAT_EX_EXTRA
22static int linelen __ARGS((int *has_tab));
23#endif
24static void do_filter __ARGS((linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out));
25#ifdef FEAT_VIMINFO
26static char_u *viminfo_filename __ARGS((char_u *));
Bram Moolenaard812df62008-11-09 12:46:09 +000027static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int flags));
Bram Moolenaar071d4272004-06-13 20:20:40 +000028static int viminfo_encoding __ARGS((vir_T *virp));
29static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
30#endif
31
32static int check_overwrite __ARGS((exarg_T *eap, buf_T *buf, char_u *fname, char_u *ffname, int other));
33static int check_readonly __ARGS((int *forceit, buf_T *buf));
34#ifdef FEAT_AUTOCMD
35static void delbuf_msg __ARGS((char_u *name));
36#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000037static int
38#ifdef __BORLANDC__
39 _RTLENTRYF
40#endif
41 help_compare __ARGS((const void *s1, const void *s2));
42
43/*
44 * ":ascii" and "ga".
45 */
Bram Moolenaar071d4272004-06-13 20:20:40 +000046 void
47do_ascii(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +000048 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +000049{
50 int c;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000051 int cval;
Bram Moolenaar071d4272004-06-13 20:20:40 +000052 char buf1[20];
53 char buf2[20];
54 char_u buf3[7];
55#ifdef FEAT_MBYTE
Bram Moolenaar362e1a32006-03-06 23:29:24 +000056 int cc[MAX_MCO];
57 int ci = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 int len;
59
60 if (enc_utf8)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000061 c = utfc_ptr2char(ml_get_cursor(), cc);
Bram Moolenaar071d4272004-06-13 20:20:40 +000062 else
63#endif
64 c = gchar_cursor();
65 if (c == NUL)
66 {
67 MSG("NUL");
68 return;
69 }
70
71#ifdef FEAT_MBYTE
72 IObuff[0] = NUL;
73 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
74#endif
75 {
76 if (c == NL) /* NUL is stored as NL */
77 c = NUL;
Bram Moolenaar1418a0d2009-01-13 15:58:01 +000078 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
79 cval = NL; /* NL is stored as CR */
80 else
81 cval = c;
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 if (vim_isprintc_strict(c) && (c < ' '
83#ifndef EBCDIC
84 || c > '~'
85#endif
86 ))
87 {
88 transchar_nonprint(buf3, c);
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000089 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
Bram Moolenaar071d4272004-06-13 20:20:40 +000090 }
91 else
92 buf1[0] = NUL;
93#ifndef EBCDIC
94 if (c >= 0x80)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +000095 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
96 (char *)transchar(c & 0x7f));
Bram Moolenaar071d4272004-06-13 20:20:40 +000097 else
98#endif
99 buf2[0] = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +0000100 vim_snprintf((char *)IObuff, IOSIZE,
101 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
Bram Moolenaar1418a0d2009-01-13 15:58:01 +0000102 transchar(c), buf1, buf2, cval, cval, cval);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103#ifdef FEAT_MBYTE
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000104 if (enc_utf8)
105 c = cc[ci++];
106 else
107 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108#endif
109 }
110
111#ifdef FEAT_MBYTE
112 /* Repeat for combining characters. */
113 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
114 {
115 len = (int)STRLEN(IObuff);
116 /* This assumes every multi-byte char is printable... */
117 if (len > 0)
118 IObuff[len++] = ' ';
119 IObuff[len++] = '<';
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000120 if (enc_utf8 && utf_iscomposing(c)
Bram Moolenaar4770d092006-01-12 23:22:24 +0000121# ifdef USE_GUI
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122 && !gui.in_use
Bram Moolenaar4770d092006-01-12 23:22:24 +0000123# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 )
125 IObuff[len++] = ' '; /* draw composing char on top of a space */
Bram Moolenaar555b2802005-05-19 21:08:39 +0000126 len += (*mb_char2bytes)(c, IObuff + len);
127 vim_snprintf((char *)IObuff + len, IOSIZE - len,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
129 : _("> %d, Hex %08x, Octal %o"), c, c, c);
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000130 if (ci == MAX_MCO)
131 break;
Bram Moolenaar1f788e72006-09-05 16:30:40 +0000132 if (enc_utf8)
133 c = cc[ci++];
134 else
135 c = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000136 }
137#endif
138
139 msg(IObuff);
140}
141
142#if defined(FEAT_EX_EXTRA) || defined(PROTO)
143/*
144 * ":left", ":center" and ":right": align text.
145 */
146 void
147ex_align(eap)
148 exarg_T *eap;
149{
150 pos_T save_curpos;
151 int len;
152 int indent = 0;
153 int new_indent;
154 int has_tab;
155 int width;
156
157#ifdef FEAT_RIGHTLEFT
158 if (curwin->w_p_rl)
159 {
160 /* switch left and right aligning */
161 if (eap->cmdidx == CMD_right)
162 eap->cmdidx = CMD_left;
163 else if (eap->cmdidx == CMD_left)
164 eap->cmdidx = CMD_right;
165 }
166#endif
167
168 width = atoi((char *)eap->arg);
169 save_curpos = curwin->w_cursor;
170 if (eap->cmdidx == CMD_left) /* width is used for new indent */
171 {
172 if (width >= 0)
173 indent = width;
174 }
175 else
176 {
177 /*
178 * if 'textwidth' set, use it
179 * else if 'wrapmargin' set, use it
180 * if invalid value, use 80
181 */
182 if (width <= 0)
183 width = curbuf->b_p_tw;
184 if (width == 0 && curbuf->b_p_wm > 0)
185 width = W_WIDTH(curwin) - curbuf->b_p_wm;
186 if (width <= 0)
187 width = 80;
188 }
189
190 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
191 return;
192
193 for (curwin->w_cursor.lnum = eap->line1;
194 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
195 {
196 if (eap->cmdidx == CMD_left) /* left align */
197 new_indent = indent;
198 else
199 {
Bram Moolenaar89d40322006-08-29 15:30:07 +0000200 has_tab = FALSE; /* avoid uninit warnings */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 len = linelen(eap->cmdidx == CMD_right ? &has_tab
202 : NULL) - get_indent();
203
204 if (len <= 0) /* skip blank lines */
205 continue;
206
207 if (eap->cmdidx == CMD_center)
208 new_indent = (width - len) / 2;
209 else
210 {
211 new_indent = width - len; /* right align */
212
213 /*
214 * Make sure that embedded TABs don't make the text go too far
215 * to the right.
216 */
217 if (has_tab)
218 while (new_indent > 0)
219 {
220 (void)set_indent(new_indent, 0);
221 if (linelen(NULL) <= width)
222 {
223 /*
224 * Now try to move the line as much as possible to
225 * the right. Stop when it moves too far.
226 */
227 do
228 (void)set_indent(++new_indent, 0);
229 while (linelen(NULL) <= width);
230 --new_indent;
231 break;
232 }
233 --new_indent;
234 }
235 }
236 }
237 if (new_indent < 0)
238 new_indent = 0;
239 (void)set_indent(new_indent, 0); /* set indent */
240 }
241 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
242 curwin->w_cursor = save_curpos;
243 beginline(BL_WHITE | BL_FIX);
244}
245
246/*
247 * Get the length of the current line, excluding trailing white space.
248 */
249 static int
250linelen(has_tab)
251 int *has_tab;
252{
253 char_u *line;
254 char_u *first;
255 char_u *last;
256 int save;
257 int len;
258
259 /* find the first non-blank character */
260 line = ml_get_curline();
261 first = skipwhite(line);
262
263 /* find the character after the last non-blank character */
264 for (last = first + STRLEN(first);
265 last > first && vim_iswhite(last[-1]); --last)
266 ;
267 save = *last;
268 *last = NUL;
269 len = linetabsize(line); /* get line length */
270 if (has_tab != NULL) /* check for embedded TAB */
271 *has_tab = (vim_strrchr(first, TAB) != NULL);
272 *last = save;
273
274 return len;
275}
276
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000277/* Buffer for two lines used during sorting. They are allocated to
278 * contain the longest line being sorted. */
279static char_u *sortbuf1;
280static char_u *sortbuf2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000281
282static int sort_ic; /* ignore case */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000283static int sort_nr; /* sort on number */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000284static int sort_rx; /* sort on regex instead of skipping it */
285
286static int sort_abort; /* flag to indicate if sorting has been interrupted */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000287
288/* Struct to store info to be sorted. */
289typedef struct
290{
291 linenr_T lnum; /* line number */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000292 long start_col_nr; /* starting column number or number */
293 long end_col_nr; /* ending column number */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000294} sorti_T;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000295
296static int
297#ifdef __BORLANDC__
298_RTLENTRYF
299#endif
300sort_compare __ARGS((const void *s1, const void *s2));
301
302 static int
303#ifdef __BORLANDC__
304_RTLENTRYF
305#endif
306sort_compare(s1, s2)
307 const void *s1;
308 const void *s2;
309{
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000310 sorti_T l1 = *(sorti_T *)s1;
311 sorti_T l2 = *(sorti_T *)s2;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000312 int result = 0;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000313
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000314 /* If the user interrupts, there's no way to stop qsort() immediately, but
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000315 * if we return 0 every time, qsort will assume it's done sorting and
316 * exit. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000317 if (sort_abort)
318 return 0;
319 fast_breakcheck();
320 if (got_int)
321 sort_abort = TRUE;
322
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000323 /* When sorting numbers "start_col_nr" is the number, not the column
324 * number. */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000325 if (sort_nr)
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200326 result = l1.start_col_nr == l2.start_col_nr ? 0
327 : l1.start_col_nr > l2.start_col_nr ? 1 : -1;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000328 else
329 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000330 /* We need to copy one line into "sortbuf1", because there is no
331 * guarantee that the first pointer becomes invalid when obtaining the
332 * second one. */
333 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
334 l1.end_col_nr - l1.start_col_nr + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000335 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000336 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
337 l2.end_col_nr - l2.start_col_nr + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000338 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000339
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000340 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
341 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000342 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000343
344 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000345 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000346 return (int)(l1.lnum - l2.lnum);
347 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000348}
349
350/*
351 * ":sort".
352 */
353 void
354ex_sort(eap)
355 exarg_T *eap;
356{
357 regmatch_T regmatch;
358 int len;
359 linenr_T lnum;
360 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000361 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000362 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000363 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000364 char_u *p;
365 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000366 char_u *s2;
367 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000368 int unique = FALSE;
369 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000370 colnr_T start_col;
371 colnr_T end_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000372 int sort_oct; /* sort on octal number */
373 int sort_hex; /* sort on hex number */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000374
Bram Moolenaar48c99162008-02-18 18:42:52 +0000375 /* Sorting one line is really quick! */
376 if (count <= 1)
377 return;
378
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000379 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
380 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000381 sortbuf1 = NULL;
382 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000383 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000384 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000385 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000386 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000387
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000388 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000389
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000390 for (p = eap->arg; *p != NUL; ++p)
391 {
392 if (vim_iswhite(*p))
393 ;
394 else if (*p == 'i')
395 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000396 else if (*p == 'r')
397 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000398 else if (*p == 'n')
399 sort_nr = 2;
400 else if (*p == 'o')
401 sort_oct = 2;
402 else if (*p == 'x')
403 sort_hex = 2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000404 else if (*p == 'u')
405 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000406 else if (*p == '"') /* comment start */
407 break;
408 else if (check_nextcmd(p) != NULL)
409 {
410 eap->nextcmd = check_nextcmd(p);
411 break;
412 }
413 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000414 {
415 s = skip_regexp(p + 1, *p, TRUE, NULL);
416 if (*s != *p)
417 {
418 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000419 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000420 }
421 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000422 /* Use last search pattern if sort pattern is empty. */
423 if (s == p + 1 && last_search_pat() != NULL)
424 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
425 else
426 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000427 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000428 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000429 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000430 regmatch.rm_ic = p_ic;
431 }
432 else
433 {
434 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000435 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000436 }
437 }
438
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000439 /* Can only have one of 'n', 'o' and 'x'. */
440 if (sort_nr + sort_oct + sort_hex > 2)
441 {
442 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000443 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000444 }
445
446 /* From here on "sort_nr" is used as a flag for any number sorting. */
447 sort_nr += sort_oct + sort_hex;
448
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000449 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000450 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000451 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000452 * When sorting on strings "start_col_nr" is the offset in the line, for
453 * numbers sorting it's the number to sort on. This means the pattern
454 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000455 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000456 */
457 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
458 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000459 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000460 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000461 if (maxlen < len)
462 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000463
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000464 start_col = 0;
465 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000466 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000467 {
468 if (sort_rx)
469 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000470 start_col = (colnr_T)(regmatch.startp[0] - s);
471 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000472 }
473 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000474 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000475 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000476 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000477 if (regmatch.regprog != NULL)
478 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000479
480 if (sort_nr)
481 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000482 /* Make sure vim_str2nr doesn't read any digits past the end
483 * of the match, by temporarily terminating the string there */
484 s2 = s + end_col;
485 c = *s2;
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200486 *s2 = NUL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000487 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000488 p = s + start_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000489 if (sort_hex)
Bram Moolenaar1387a602008-07-24 19:31:11 +0000490 s = skiptohex(p);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000491 else
Bram Moolenaar1387a602008-07-24 19:31:11 +0000492 s = skiptodigit(p);
493 if (s > p && s[-1] == '-')
494 --s; /* include preceding negative sign */
Bram Moolenaarf75d4982010-10-15 20:20:05 +0200495 if (*s == NUL)
496 /* empty line should sort before any number */
497 nrs[lnum - eap->line1].start_col_nr = -MAXLNUM;
498 else
499 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
500 &nrs[lnum - eap->line1].start_col_nr, NULL);
501 *s2 = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000502 }
503 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000504 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000505 /* Store the column to sort at. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000506 nrs[lnum - eap->line1].start_col_nr = start_col;
507 nrs[lnum - eap->line1].end_col_nr = end_col;
508 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000509
510 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000511
512 if (regmatch.regprog != NULL)
513 fast_breakcheck();
514 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000515 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000516 }
517
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000518 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000519 sortbuf1 = alloc((unsigned)maxlen + 1);
520 if (sortbuf1 == NULL)
521 goto sortend;
522 sortbuf2 = alloc((unsigned)maxlen + 1);
523 if (sortbuf2 == NULL)
524 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000525
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000526 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000527 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000528
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000529 if (sort_abort)
530 goto sortend;
531
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000532 /* Insert the lines in the sorted order below the last one. */
533 lnum = eap->line2;
534 for (i = 0; i < count; ++i)
535 {
536 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
537 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000538 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000539 {
540 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
541 break;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000542 if (unique)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000543 STRCPY(sortbuf1, s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000544 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000545 fast_breakcheck();
546 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000547 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000548 }
549
550 /* delete the original lines if appending worked */
551 if (i == count)
552 for (i = 0; i < count; ++i)
553 ml_delete(eap->line1, FALSE);
554 else
555 count = 0;
556
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000557 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000558 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000559 if (deleted > 0)
560 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
561 else if (deleted < 0)
562 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
563 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000564
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000565 curwin->w_cursor.lnum = eap->line1;
566 beginline(BL_WHITE | BL_FIX);
567
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000568sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000569 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000570 vim_free(sortbuf1);
571 vim_free(sortbuf2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000572 vim_free(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000573 if (got_int)
574 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000575}
576
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577/*
578 * ":retab".
579 */
580 void
581ex_retab(eap)
582 exarg_T *eap;
583{
584 linenr_T lnum;
585 int got_tab = FALSE;
586 long num_spaces = 0;
587 long num_tabs;
588 long len;
589 long col;
590 long vcol;
591 long start_col = 0; /* For start of white-space string */
592 long start_vcol = 0; /* For start of white-space string */
593 int temp;
594 long old_len;
595 char_u *ptr;
596 char_u *new_line = (char_u *)1; /* init to non-NULL */
597 int did_undo; /* called u_save for current line */
598 int new_ts;
599 int save_list;
600 linenr_T first_line = 0; /* first changed line */
601 linenr_T last_line = 0; /* last changed line */
602
603 save_list = curwin->w_p_list;
604 curwin->w_p_list = 0; /* don't want list mode here */
605
606 new_ts = getdigits(&(eap->arg));
607 if (new_ts < 0)
608 {
609 EMSG(_(e_positive));
610 return;
611 }
612 if (new_ts == 0)
613 new_ts = curbuf->b_p_ts;
614 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
615 {
616 ptr = ml_get(lnum);
617 col = 0;
618 vcol = 0;
619 did_undo = FALSE;
620 for (;;)
621 {
622 if (vim_iswhite(ptr[col]))
623 {
624 if (!got_tab && num_spaces == 0)
625 {
626 /* First consecutive white-space */
627 start_vcol = vcol;
628 start_col = col;
629 }
630 if (ptr[col] == ' ')
631 num_spaces++;
632 else
633 got_tab = TRUE;
634 }
635 else
636 {
637 if (got_tab || (eap->forceit && num_spaces > 1))
638 {
639 /* Retabulate this string of white-space */
640
641 /* len is virtual length of white string */
642 len = num_spaces = vcol - start_vcol;
643 num_tabs = 0;
644 if (!curbuf->b_p_et)
645 {
646 temp = new_ts - (start_vcol % new_ts);
647 if (num_spaces >= temp)
648 {
649 num_spaces -= temp;
650 num_tabs++;
651 }
652 num_tabs += num_spaces / new_ts;
653 num_spaces -= (num_spaces / new_ts) * new_ts;
654 }
655 if (curbuf->b_p_et || got_tab ||
656 (num_spaces + num_tabs < len))
657 {
658 if (did_undo == FALSE)
659 {
660 did_undo = TRUE;
661 if (u_save((linenr_T)(lnum - 1),
662 (linenr_T)(lnum + 1)) == FAIL)
663 {
664 new_line = NULL; /* flag out-of-memory */
665 break;
666 }
667 }
668
669 /* len is actual number of white characters used */
670 len = num_spaces + num_tabs;
671 old_len = (long)STRLEN(ptr);
672 new_line = lalloc(old_len - col + start_col + len + 1,
673 TRUE);
674 if (new_line == NULL)
675 break;
676 if (start_col > 0)
677 mch_memmove(new_line, ptr, (size_t)start_col);
678 mch_memmove(new_line + start_col + len,
679 ptr + col, (size_t)(old_len - col + 1));
680 ptr = new_line + start_col;
681 for (col = 0; col < len; col++)
682 ptr[col] = (col < num_tabs) ? '\t' : ' ';
683 ml_replace(lnum, new_line, FALSE);
684 if (first_line == 0)
685 first_line = lnum;
686 last_line = lnum;
687 ptr = new_line;
688 col = start_col + len;
689 }
690 }
691 got_tab = FALSE;
692 num_spaces = 0;
693 }
694 if (ptr[col] == NUL)
695 break;
696 vcol += chartabsize(ptr + col, (colnr_T)vcol);
697#ifdef FEAT_MBYTE
698 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000699 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 else
701#endif
702 ++col;
703 }
704 if (new_line == NULL) /* out of memory */
705 break;
706 line_breakcheck();
707 }
708 if (got_int)
709 EMSG(_(e_interr));
710
711 if (curbuf->b_p_ts != new_ts)
712 redraw_curbuf_later(NOT_VALID);
713 if (first_line != 0)
714 changed_lines(first_line, 0, last_line + 1, 0L);
715
716 curwin->w_p_list = save_list; /* restore 'list' */
717
718 curbuf->b_p_ts = new_ts;
719 coladvance(curwin->w_curswant);
720
721 u_clearline();
722}
723#endif
724
725/*
726 * :move command - move lines line1-line2 to line dest
727 *
728 * return FAIL for failure, OK otherwise
729 */
730 int
731do_move(line1, line2, dest)
732 linenr_T line1;
733 linenr_T line2;
734 linenr_T dest;
735{
736 char_u *str;
737 linenr_T l;
738 linenr_T extra; /* Num lines added before line1 */
739 linenr_T num_lines; /* Num lines moved */
740 linenr_T last_line; /* Last line in file after adding new text */
741
742 if (dest >= line1 && dest < line2)
743 {
744 EMSG(_("E134: Move lines into themselves"));
745 return FAIL;
746 }
747
748 num_lines = line2 - line1 + 1;
749
750 /*
751 * First we copy the old text to its new location -- webb
752 * Also copy the flag that ":global" command uses.
753 */
754 if (u_save(dest, dest + 1) == FAIL)
755 return FAIL;
756 for (extra = 0, l = line1; l <= line2; l++)
757 {
758 str = vim_strsave(ml_get(l + extra));
759 if (str != NULL)
760 {
761 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
762 vim_free(str);
763 if (dest < line1)
764 extra++;
765 }
766 }
767
768 /*
769 * Now we must be careful adjusting our marks so that we don't overlap our
770 * mark_adjust() calls.
771 *
772 * We adjust the marks within the old text so that they refer to the
773 * last lines of the file (temporarily), because we know no other marks
774 * will be set there since these line numbers did not exist until we added
775 * our new lines.
776 *
777 * Then we adjust the marks on lines between the old and new text positions
778 * (either forwards or backwards).
779 *
780 * And Finally we adjust the marks we put at the end of the file back to
781 * their final destination at the new text position -- webb
782 */
783 last_line = curbuf->b_ml.ml_line_count;
784 mark_adjust(line1, line2, last_line - line2, 0L);
785 if (dest >= line2)
786 {
787 mark_adjust(line2 + 1, dest, -num_lines, 0L);
788 curbuf->b_op_start.lnum = dest - num_lines + 1;
789 curbuf->b_op_end.lnum = dest;
790 }
791 else
792 {
793 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
794 curbuf->b_op_start.lnum = dest + 1;
795 curbuf->b_op_end.lnum = dest + num_lines;
796 }
797 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
798 mark_adjust(last_line - num_lines + 1, last_line,
799 -(last_line - dest - extra), 0L);
800
801 /*
802 * Now we delete the original text -- webb
803 */
804 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
805 return FAIL;
806
807 for (l = line1; l <= line2; l++)
808 ml_delete(line1 + extra, TRUE);
809
810 if (!global_busy && num_lines > p_report)
811 {
812 if (num_lines == 1)
813 MSG(_("1 line moved"));
814 else
815 smsg((char_u *)_("%ld lines moved"), num_lines);
816 }
817
818 /*
819 * Leave the cursor on the last of the moved lines.
820 */
821 if (dest >= line1)
822 curwin->w_cursor.lnum = dest;
823 else
824 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
825
826 if (line1 < dest)
827 changed_lines(line1, 0, dest + num_lines + 1, 0L);
828 else
829 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
830
831 return OK;
832}
833
834/*
835 * ":copy"
836 */
837 void
838ex_copy(line1, line2, n)
839 linenr_T line1;
840 linenr_T line2;
841 linenr_T n;
842{
843 linenr_T count;
844 char_u *p;
845
846 count = line2 - line1 + 1;
847 curbuf->b_op_start.lnum = n + 1;
848 curbuf->b_op_end.lnum = n + count;
849 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
850
851 /*
852 * there are three situations:
853 * 1. destination is above line1
854 * 2. destination is between line1 and line2
855 * 3. destination is below line2
856 *
857 * n = destination (when starting)
858 * curwin->w_cursor.lnum = destination (while copying)
859 * line1 = start of source (while copying)
860 * line2 = end of source (while copying)
861 */
862 if (u_save(n, n + 1) == FAIL)
863 return;
864
865 curwin->w_cursor.lnum = n;
866 while (line1 <= line2)
867 {
868 /* need to use vim_strsave() because the line will be unlocked within
869 * ml_append() */
870 p = vim_strsave(ml_get(line1));
871 if (p != NULL)
872 {
873 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
874 vim_free(p);
875 }
876 /* situation 2: skip already copied lines */
877 if (line1 == n)
878 line1 = curwin->w_cursor.lnum;
879 ++line1;
880 if (curwin->w_cursor.lnum < line1)
881 ++line1;
882 if (curwin->w_cursor.lnum < line2)
883 ++line2;
884 ++curwin->w_cursor.lnum;
885 }
886
887 appended_lines_mark(n, count);
888
889 msgmore((long)count);
890}
891
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000892static char_u *prevcmd = NULL; /* the previous command */
893
894#if defined(EXITFREE) || defined(PROTO)
895 void
896free_prev_shellcmd()
897{
898 vim_free(prevcmd);
899}
900#endif
901
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902/*
903 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
904 * Bangs in the argument are replaced with the previously entered command.
905 * Remember the argument.
906 *
907 * RISCOS: Bangs only replaced when followed by a space, since many
908 * pathnames contain one.
909 */
910 void
911do_bang(addr_count, eap, forceit, do_in, do_out)
912 int addr_count;
913 exarg_T *eap;
914 int forceit;
915 int do_in, do_out;
916{
917 char_u *arg = eap->arg; /* command */
918 linenr_T line1 = eap->line1; /* start of range */
919 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 char_u *newcmd = NULL; /* the new command */
921 int free_newcmd = FALSE; /* need to free() newcmd */
922 int ins_prevcmd;
923 char_u *t;
924 char_u *p;
925 char_u *trailarg;
926 int len;
927 int scroll_save = msg_scroll;
928
929 /*
930 * Disallow shell commands for "rvim".
931 * Disallow shell commands from .exrc and .vimrc in current directory for
932 * security reasons.
933 */
934 if (check_restricted() || check_secure())
935 return;
936
937 if (addr_count == 0) /* :! */
938 {
939 msg_scroll = FALSE; /* don't scroll here */
940 autowrite_all();
941 msg_scroll = scroll_save;
942 }
943
944 /*
945 * Try to find an embedded bang, like in :!<cmd> ! [args]
946 * (:!! is indicated by the 'forceit' variable)
947 */
948 ins_prevcmd = forceit;
949 trailarg = arg;
950 do
951 {
952 len = (int)STRLEN(trailarg) + 1;
953 if (newcmd != NULL)
954 len += (int)STRLEN(newcmd);
955 if (ins_prevcmd)
956 {
957 if (prevcmd == NULL)
958 {
959 EMSG(_(e_noprev));
960 vim_free(newcmd);
961 return;
962 }
963 len += (int)STRLEN(prevcmd);
964 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000965 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 {
967 vim_free(newcmd);
968 return;
969 }
970 *t = NUL;
971 if (newcmd != NULL)
972 STRCAT(t, newcmd);
973 if (ins_prevcmd)
974 STRCAT(t, prevcmd);
975 p = t + STRLEN(t);
976 STRCAT(t, trailarg);
977 vim_free(newcmd);
978 newcmd = t;
979
980 /*
981 * Scan the rest of the argument for '!', which is replaced by the
982 * previous command. "\!" is replaced by "!" (this is vi compatible).
983 */
984 trailarg = NULL;
985 while (*p)
986 {
987 if (*p == '!'
988#ifdef RISCOS
989 && (p[1] == ' ' || p[1] == NUL)
990#endif
991 )
992 {
993 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000994 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 else
996 {
997 trailarg = p;
998 *trailarg++ = NUL;
999 ins_prevcmd = TRUE;
1000 break;
1001 }
1002 }
1003 ++p;
1004 }
1005 } while (trailarg != NULL);
1006
1007 vim_free(prevcmd);
1008 prevcmd = newcmd;
1009
1010 if (bangredo) /* put cmd in redo buffer for ! command */
1011 {
Bram Moolenaarebefac62005-12-28 22:39:57 +00001012 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 AppendToRedobuff((char_u *)"\n");
1014 bangredo = FALSE;
1015 }
1016 /*
1017 * Add quotes around the command, for shells that need them.
1018 */
1019 if (*p_shq != NUL)
1020 {
1021 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1022 if (newcmd == NULL)
1023 return;
1024 STRCPY(newcmd, p_shq);
1025 STRCAT(newcmd, prevcmd);
1026 STRCAT(newcmd, p_shq);
1027 free_newcmd = TRUE;
1028 }
1029 if (addr_count == 0) /* :! */
1030 {
1031 /* echo the command */
1032 msg_start();
1033 msg_putchar(':');
1034 msg_putchar('!');
1035 msg_outtrans(newcmd);
1036 msg_clr_eos();
1037 windgoto(msg_row, msg_col);
1038
1039 do_shell(newcmd, 0);
1040 }
1041 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001042 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 /* Careful: This may recursively call do_bang() again! (because of
1044 * autocommands) */
1045 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001046#ifdef FEAT_AUTOCMD
1047 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1048#endif
1049 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 if (free_newcmd)
1051 vim_free(newcmd);
1052}
1053
1054/*
1055 * do_filter: filter lines through a command given by the user
1056 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001057 * We mostly use temp files and the call_shell() routine here. This would
1058 * normally be done using pipes on a UNIX machine, but this is more portable
1059 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 * to deal with redirection somehow, and should handle things like looking
1061 * at the PATH env. variable, and adding reasonable extensions to the
1062 * command name given by the user. All reasonable versions of call_shell()
1063 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001064 * Alternatively, if on Unix and redirecting input or output, but not both,
1065 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 * We use input redirection if do_in is TRUE.
1067 * We use output redirection if do_out is TRUE.
1068 */
1069 static void
1070do_filter(line1, line2, eap, cmd, do_in, do_out)
1071 linenr_T line1, line2;
1072 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1073 char_u *cmd;
1074 int do_in, do_out;
1075{
1076 char_u *itmp = NULL;
1077 char_u *otmp = NULL;
1078 linenr_T linecount;
1079 linenr_T read_linecount;
1080 pos_T cursor_save;
1081 char_u *cmd_buf;
1082#ifdef FEAT_AUTOCMD
1083 buf_T *old_curbuf = curbuf;
1084#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001085 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086
1087 if (*cmd == NUL) /* no filter command */
1088 return;
1089
1090#ifdef WIN3264
1091 /*
1092 * Check if external commands are allowed now.
1093 */
1094 if (can_end_termcap_mode(TRUE) == FALSE)
1095 return;
1096#endif
1097
1098 cursor_save = curwin->w_cursor;
1099 linecount = line2 - line1 + 1;
1100 curwin->w_cursor.lnum = line1;
1101 curwin->w_cursor.col = 0;
1102 changed_line_abv_curs();
1103 invalidate_botline();
1104
1105 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001106 * When using temp files:
1107 * 1. * Form temp file names
1108 * 2. * Write the lines to a temp file
1109 * 3. Run the filter command on the temp file
1110 * 4. * Read the output of the command into the buffer
1111 * 5. * Delete the original lines to be filtered
1112 * 6. * Remove the temp files
1113 *
1114 * When writing the input with a pipe or when catching the output with a
1115 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 */
1117
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001118 if (do_out)
1119 shell_flags |= SHELL_DOOUT;
1120
1121#if !defined(USE_SYSTEM) && defined(UNIX)
1122 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001124 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1125 shell_flags |= SHELL_READ;
1126 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001128 else if (do_in && !do_out && !p_stmp)
1129 {
1130 /* Use a pipe to write stdin of the command, do not use a temp file. */
1131 shell_flags |= SHELL_WRITE;
1132 curbuf->b_op_start.lnum = line1;
1133 curbuf->b_op_end.lnum = line2;
1134 }
1135 else if (do_in && do_out && !p_stmp)
1136 {
1137 /* Use a pipe to write stdin and fetch stdout of the command, do not
1138 * use a temp file. */
1139 shell_flags |= SHELL_READ|SHELL_WRITE;
1140 curbuf->b_op_start.lnum = line1;
1141 curbuf->b_op_end.lnum = line2;
1142 curwin->w_cursor.lnum = line2;
1143 }
1144 else
1145#endif
1146 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1147 || (do_out && (otmp = vim_tempname('o')) == NULL))
1148 {
1149 EMSG(_(e_notmp));
1150 goto filterend;
1151 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152
1153/*
1154 * The writing and reading of temp files will not be shown.
1155 * Vi also doesn't do this and the messages are not very informative.
1156 */
1157 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001158 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 FALSE, FALSE, FALSE, TRUE) == FAIL)
1160 {
1161 msg_putchar('\n'); /* keep message from buf_write() */
1162 --no_wait_return;
1163#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1164 if (!aborting())
1165#endif
1166 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1167 goto filterend;
1168 }
1169#ifdef FEAT_AUTOCMD
1170 if (curbuf != old_curbuf)
1171 goto filterend;
1172#endif
1173
1174 if (!do_out)
1175 msg_putchar('\n');
1176
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001177 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1179 if (cmd_buf == NULL)
1180 goto filterend;
1181
1182 windgoto((int)Rows - 1, 0);
1183 cursor_on();
1184
1185 /*
1186 * When not redirecting the output the command can write anything to the
1187 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1188 * stderr output of external command. Clear the screen later.
1189 * If do_in is FALSE, this could be something like ":r !cat", which may
1190 * also mess up the screen, clear it later.
1191 */
1192 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1193 redraw_later_clear();
1194
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001195 if (do_out)
1196 {
1197 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001198 {
1199 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001200 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001201 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001202 redraw_curbuf_later(VALID);
1203 }
1204 read_linecount = curbuf->b_ml.ml_line_count;
1205
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 /*
1207 * When call_shell() fails wait_return() is called to give the user a
1208 * chance to read the error messages. Otherwise errors are ignored, so you
1209 * can see the error messages from the command that appear on stdout; use
1210 * 'u' to fix the text
1211 * Switch to cooked mode when not redirecting stdin, avoids that something
1212 * like ":r !cat" hangs.
1213 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1214 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001215 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 {
1217 redraw_later_clear();
1218 wait_return(FALSE);
1219 }
1220 vim_free(cmd_buf);
1221
1222 did_check_timestamps = FALSE;
1223 need_check_timestamps = TRUE;
1224
1225 /* When interrupting the shell command, it may still have produced some
1226 * useful output. Reset got_int here, so that readfile() won't cancel
1227 * reading. */
1228 ui_breakcheck();
1229 got_int = FALSE;
1230
1231 if (do_out)
1232 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001233 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001235 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1236 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001238#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1239 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001241 {
1242 msg_putchar('\n');
1243 EMSG2(_(e_notread), otmp);
1244 }
1245 goto error;
1246 }
1247#ifdef FEAT_AUTOCMD
1248 if (curbuf != old_curbuf)
1249 goto filterend;
1250#endif
1251 }
1252
1253 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1254
1255 if (shell_flags & SHELL_READ)
1256 {
1257 curbuf->b_op_start.lnum = line2 + 1;
1258 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1259 appended_lines_mark(line2, read_linecount);
1260 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
1262 if (do_in)
1263 {
1264 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1265 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 if (read_linecount >= linecount)
1267 /* move all marks from old lines to new lines */
1268 mark_adjust(line1, line2, linecount, 0L);
1269 else
1270 {
1271 /* move marks from old lines to new lines, delete marks
1272 * that are in deleted lines */
1273 mark_adjust(line1, line1 + read_linecount - 1,
1274 linecount, 0L);
1275 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1276 }
1277 }
1278
1279 /*
1280 * Put cursor on first filtered line for ":range!cmd".
1281 * Adjust '[ and '] (set by buf_write()).
1282 */
1283 curwin->w_cursor.lnum = line1;
1284 del_lines(linecount, TRUE);
1285 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1286 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1287 write_lnum_adjust(-linecount); /* adjust last line
1288 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001289#ifdef FEAT_FOLDING
1290 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1291#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 }
1293 else
1294 {
1295 /*
1296 * Put cursor on last new line for ":r !cmd".
1297 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001299 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001301
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1303 --no_wait_return;
1304
1305 if (linecount > p_report)
1306 {
1307 if (do_in)
1308 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001309 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1310 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001313 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 }
1315 else
1316 msgmore((long)linecount);
1317 }
1318 }
1319 else
1320 {
1321error:
1322 /* put cursor back in same position for ":w !cmd" */
1323 curwin->w_cursor = cursor_save;
1324 --no_wait_return;
1325 wait_return(FALSE);
1326 }
1327
1328filterend:
1329
1330#ifdef FEAT_AUTOCMD
1331 if (curbuf != old_curbuf)
1332 {
1333 --no_wait_return;
1334 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1335 }
1336#endif
1337 if (itmp != NULL)
1338 mch_remove(itmp);
1339 if (otmp != NULL)
1340 mch_remove(otmp);
1341 vim_free(itmp);
1342 vim_free(otmp);
1343}
1344
1345/*
1346 * Call a shell to execute a command.
1347 * When "cmd" is NULL start an interactive shell.
1348 */
1349 void
1350do_shell(cmd, flags)
1351 char_u *cmd;
1352 int flags; /* may be SHELL_DOOUT when output is redirected */
1353{
1354 buf_T *buf;
1355#ifndef FEAT_GUI_MSWIN
1356 int save_nwr;
1357#endif
1358#ifdef MSWIN
1359 int winstart = FALSE;
1360#endif
1361
1362 /*
1363 * Disallow shell commands for "rvim".
1364 * Disallow shell commands from .exrc and .vimrc in current directory for
1365 * security reasons.
1366 */
1367 if (check_restricted() || check_secure())
1368 {
1369 msg_end();
1370 return;
1371 }
1372
1373#ifdef MSWIN
1374 /*
1375 * Check if external commands are allowed now.
1376 */
1377 if (can_end_termcap_mode(TRUE) == FALSE)
1378 return;
1379
1380 /*
1381 * Check if ":!start" is used.
1382 */
1383 if (cmd != NULL)
1384 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1385#endif
1386
1387 /*
1388 * For autocommands we want to get the output on the current screen, to
1389 * avoid having to type return below.
1390 */
1391 msg_putchar('\r'); /* put cursor at start of line */
1392#ifdef FEAT_AUTOCMD
1393 if (!autocmd_busy)
1394#endif
1395 {
1396#ifdef MSWIN
1397 if (!winstart)
1398#endif
1399 stoptermcap();
1400 }
1401#ifdef MSWIN
1402 if (!winstart)
1403#endif
1404 msg_putchar('\n'); /* may shift screen one line up */
1405
1406 /* warning message before calling the shell */
1407 if (p_warn
1408#ifdef FEAT_AUTOCMD
1409 && !autocmd_busy
1410#endif
1411 && msg_silent == 0)
1412 for (buf = firstbuf; buf; buf = buf->b_next)
1413 if (bufIsChanged(buf))
1414 {
1415#ifdef FEAT_GUI_MSWIN
1416 if (!winstart)
1417 starttermcap(); /* don't want a message box here */
1418#endif
1419 MSG_PUTS(_("[No write since last change]\n"));
1420#ifdef FEAT_GUI_MSWIN
1421 if (!winstart)
1422 stoptermcap();
1423#endif
1424 break;
1425 }
1426
1427 /* This windgoto is required for when the '\n' resulted in a "delete line
1428 * 1" command to the terminal. */
1429 if (!swapping_screen())
1430 windgoto(msg_row, msg_col);
1431 cursor_on();
1432 (void)call_shell(cmd, SHELL_COOKED | flags);
1433 did_check_timestamps = FALSE;
1434 need_check_timestamps = TRUE;
1435
1436 /*
1437 * put the message cursor at the end of the screen, avoids wait_return()
1438 * to overwrite the text that the external command showed
1439 */
1440 if (!swapping_screen())
1441 {
1442 msg_row = Rows - 1;
1443 msg_col = 0;
1444 }
1445
1446#ifdef FEAT_AUTOCMD
1447 if (autocmd_busy)
1448 {
1449 if (msg_silent == 0)
1450 redraw_later_clear();
1451 }
1452 else
1453#endif
1454 {
1455 /*
1456 * For ":sh" there is no need to call wait_return(), just redraw.
1457 * Also for the Win32 GUI (the output is in a console window).
1458 * Otherwise there is probably text on the screen that the user wants
1459 * to read before redrawing, so call wait_return().
1460 */
1461#ifndef FEAT_GUI_MSWIN
1462 if (cmd == NULL
1463# ifdef WIN3264
1464 || (winstart && !need_wait_return)
1465# endif
1466 )
1467 {
1468 if (msg_silent == 0)
1469 redraw_later_clear();
1470 need_wait_return = FALSE;
1471 }
1472 else
1473 {
1474 /*
1475 * If we switch screens when starttermcap() is called, we really
1476 * want to wait for "hit return to continue".
1477 */
1478 save_nwr = no_wait_return;
1479 if (swapping_screen())
1480 no_wait_return = FALSE;
1481# ifdef AMIGA
1482 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1483# else
1484 wait_return(msg_silent == 0);
1485# endif
1486 no_wait_return = save_nwr;
1487 }
1488#endif /* FEAT_GUI_W32 */
1489
1490#ifdef MSWIN
1491 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1492#endif
1493 starttermcap(); /* start termcap if not done by wait_return() */
1494
1495 /*
1496 * In an Amiga window redrawing is caused by asking the window size.
1497 * If we got an interrupt this will not work. The chance that the
1498 * window size is wrong is very small, but we need to redraw the
1499 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1500 * but it saves an extra redraw.
1501 */
1502#ifdef AMIGA
1503 if (skip_redraw) /* ':' hit in wait_return() */
1504 {
1505 if (msg_silent == 0)
1506 redraw_later_clear();
1507 }
1508 else if (term_console)
1509 {
1510 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1511 if (got_int && msg_silent == 0)
1512 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1513 else
1514 must_redraw = 0; /* no extra redraw needed */
1515 }
1516#endif
1517 }
1518
1519 /* display any error messages now */
1520 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001521
1522#ifdef FEAT_AUTOCMD
1523 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1524#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525}
1526
1527/*
1528 * Create a shell command from a command string, input redirection file and
1529 * output redirection file.
1530 * Returns an allocated string with the shell command, or NULL for failure.
1531 */
1532 char_u *
1533make_filter_cmd(cmd, itmp, otmp)
1534 char_u *cmd; /* command */
1535 char_u *itmp; /* NULL or name of input file */
1536 char_u *otmp; /* NULL or name of output file */
1537{
1538 char_u *buf;
1539 long_u len;
1540
1541 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1542 if (itmp != NULL)
1543 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1544 if (otmp != NULL)
1545 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1546 buf = lalloc(len, TRUE);
1547 if (buf == NULL)
1548 return NULL;
1549
1550#if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1551 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001552 * Put braces around the command (for concatenated commands) when
1553 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001555 if (itmp != NULL || otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001556 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001557 else
1558 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 if (itmp != NULL)
1560 {
1561 STRCAT(buf, " < ");
1562 STRCAT(buf, itmp);
1563 }
1564#else
1565 /*
1566 * for shells that don't understand braces around commands, at least allow
1567 * the use of commands in a pipe.
1568 */
1569 STRCPY(buf, cmd);
1570 if (itmp != NULL)
1571 {
1572 char_u *p;
1573
1574 /*
1575 * If there is a pipe, we have to put the '<' in front of it.
1576 * Don't do this when 'shellquote' is not empty, otherwise the
1577 * redirection would be inside the quotes.
1578 */
1579 if (*p_shq == NUL)
1580 {
1581 p = vim_strchr(buf, '|');
1582 if (p != NULL)
1583 *p = NUL;
1584 }
1585# ifdef RISCOS
1586 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1587 STRCAT(buf, itmp);
1588 STRCAT(buf, " } ");
1589# else
1590 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1591 STRCAT(buf, itmp);
1592# endif
1593 if (*p_shq == NUL)
1594 {
1595 p = vim_strchr(cmd, '|');
1596 if (p != NULL)
1597 {
1598 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1599 STRCAT(buf, p);
1600 }
1601 }
1602 }
1603#endif
1604 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001605 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606
1607 return buf;
1608}
1609
1610/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001611 * Append output redirection for file "fname" to the end of string buffer
1612 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 * Works with the 'shellredir' and 'shellpipe' options.
1614 * The caller should make sure that there is enough room:
1615 * STRLEN(opt) + STRLEN(fname) + 3
1616 */
1617 void
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001618append_redir(buf, buflen, opt, fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 char_u *buf;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001620 int buflen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 char_u *opt;
1622 char_u *fname;
1623{
1624 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001625 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001627 end = buf + STRLEN(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 /* find "%s", skipping "%%" */
1629 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1630 if (p[1] == 's')
1631 break;
1632 if (p != NULL)
1633 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001634 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1635 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1636 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 }
1638 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001639 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640#ifdef FEAT_QUICKFIX
1641# ifndef RISCOS
1642 opt != p_sp ? " %s%s" :
1643# endif
1644 " %s %s",
1645#else
1646# ifndef RISCOS
1647 " %s%s", /* " > %s" causes problems on Amiga */
1648# else
1649 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1650# endif
1651#endif
1652 (char *)opt, (char *)fname);
1653}
1654
1655#ifdef FEAT_VIMINFO
1656
1657static int no_viminfo __ARGS((void));
1658static int viminfo_errcnt;
1659
1660 static int
1661no_viminfo()
1662{
1663 /* "vim -i NONE" does not read or write a viminfo file */
1664 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1665}
1666
1667/*
1668 * Report an error for reading a viminfo file.
1669 * Count the number of errors. When there are more than 10, return TRUE.
1670 */
1671 int
1672viminfo_error(errnum, message, line)
1673 char *errnum;
1674 char *message;
1675 char_u *line;
1676{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001677 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1678 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001679 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001680 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1681 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 emsg(IObuff);
1683 if (++viminfo_errcnt >= 10)
1684 {
1685 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1686 return TRUE;
1687 }
1688 return FALSE;
1689}
1690
1691/*
1692 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001693 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 */
1695 int
Bram Moolenaard812df62008-11-09 12:46:09 +00001696read_viminfo(file, flags)
1697 char_u *file; /* file name or NULL to use default name */
1698 int flags; /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699{
1700 FILE *fp;
1701 char_u *fname;
1702
1703 if (no_viminfo())
1704 return FAIL;
1705
Bram Moolenaard812df62008-11-09 12:46:09 +00001706 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 if (fname == NULL)
1708 return FAIL;
1709 fp = mch_fopen((char *)fname, READBIN);
1710
1711 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001712 {
1713 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001714 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1715 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001716 (flags & VIF_WANT_INFO) ? _(" info") : "",
1717 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1718 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001719 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001720 verbose_leave();
1721 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722
1723 vim_free(fname);
1724 if (fp == NULL)
1725 return FAIL;
1726
1727 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001728 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729
1730 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 return OK;
1732}
1733
1734/*
1735 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1736 * that effectively a merge of current info and old info is done. This allows
1737 * multiple vims to run simultaneously, without losing any marks etc. If
1738 * forceit is TRUE, then the old file is not read in, and only internal info is
1739 * written to the file. -- webb
1740 */
1741 void
1742write_viminfo(file, forceit)
1743 char_u *file;
1744 int forceit;
1745{
1746 char_u *fname;
1747 FILE *fp_in = NULL; /* input viminfo file, if any */
1748 FILE *fp_out = NULL; /* output viminfo file */
1749 char_u *tempname = NULL; /* name of temp viminfo file */
1750 struct stat st_new; /* mch_stat() of potential new file */
1751 char_u *wp;
1752#if defined(UNIX) || defined(VMS)
1753 mode_t umask_save;
1754#endif
1755#ifdef UNIX
1756 int shortname = FALSE; /* use 8.3 file name */
1757 struct stat st_old; /* mch_stat() of existing viminfo file */
1758#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001759#ifdef WIN3264
1760 long perm = -1;
1761#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762
1763 if (no_viminfo())
1764 return;
1765
1766 fname = viminfo_filename(file); /* may set to default if NULL */
1767 if (fname == NULL)
1768 return;
1769
1770 fp_in = mch_fopen((char *)fname, READBIN);
1771 if (fp_in == NULL)
1772 {
1773 /* if it does exist, but we can't read it, don't try writing */
1774 if (mch_stat((char *)fname, &st_new) == 0)
1775 goto end;
1776#if defined(UNIX) || defined(VMS)
1777 /*
1778 * For Unix we create the .viminfo non-accessible for others,
1779 * because it may contain text from non-accessible documents.
1780 */
1781 umask_save = umask(077);
1782#endif
1783 fp_out = mch_fopen((char *)fname, WRITEBIN);
1784#if defined(UNIX) || defined(VMS)
1785 (void)umask(umask_save);
1786#endif
1787 }
1788 else
1789 {
1790 /*
1791 * There is an existing viminfo file. Create a temporary file to
1792 * write the new viminfo into, in the same directory as the
1793 * existing viminfo file, which will be renamed later.
1794 */
1795#ifdef UNIX
1796 /*
1797 * For Unix we check the owner of the file. It's not very nice to
1798 * overwrite a user's viminfo file after a "su root", with a
1799 * viminfo file that the user can't read.
1800 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001801 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001802 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001804 if (mch_stat((char *)fname, &st_old) == 0
1805 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001806 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 ? (st_old.st_mode & 0200)
1808 : (st_old.st_gid == getgid()
1809 ? (st_old.st_mode & 0020)
1810 : (st_old.st_mode & 0002))))
1811 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001812 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813
1814 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1816 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001817 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 goto end;
1819 }
1820#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001821#ifdef WIN3264
1822 /* Get the file attributes of the existing viminfo file. */
1823 perm = mch_getperm(fname);
1824#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825
1826 /*
1827 * Make tempname.
1828 * May try twice: Once normal and once with shortname set, just in
1829 * case somebody puts his viminfo file in an 8.3 filesystem.
1830 */
1831 for (;;)
1832 {
1833 tempname = buf_modname(
1834#ifdef UNIX
1835 shortname,
1836#else
1837# ifdef SHORT_FNAME
1838 TRUE,
1839# else
1840# ifdef FEAT_GUI_W32
1841 gui_is_win32s(),
1842# else
1843 FALSE,
1844# endif
1845# endif
1846#endif
1847 fname,
1848#ifdef VMS
1849 (char_u *)"-tmp",
1850#else
1851# ifdef RISCOS
1852 (char_u *)"/tmp",
1853# else
1854 (char_u *)".tmp",
1855# endif
1856#endif
1857 FALSE);
1858 if (tempname == NULL) /* out of memory */
1859 break;
1860
1861 /*
1862 * Check if tempfile already exists. Never overwrite an
1863 * existing file!
1864 */
1865 if (mch_stat((char *)tempname, &st_new) == 0)
1866 {
1867#ifdef UNIX
1868 /*
1869 * Check if tempfile is same as original file. May happen
1870 * when modname() gave the same file back. E.g. silly
1871 * link, or file name-length reached. Try again with
1872 * shortname set.
1873 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001874 if (!shortname && st_new.st_dev == st_old.st_dev
1875 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 {
1877 vim_free(tempname);
1878 tempname = NULL;
1879 shortname = TRUE;
1880 continue;
1881 }
1882#endif
1883 /*
1884 * Try another name. Change one character, just before
1885 * the extension. This should also work for an 8.3
1886 * file name, when after adding the extension it still is
1887 * the same file as the original.
1888 */
1889 wp = tempname + STRLEN(tempname) - 5;
1890 if (wp < gettail(tempname)) /* empty file name? */
1891 wp = gettail(tempname);
1892 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1893 --*wp)
1894 {
1895 /*
1896 * They all exist? Must be something wrong! Don't
1897 * write the viminfo file then.
1898 */
1899 if (*wp == 'a')
1900 {
1901 vim_free(tempname);
1902 tempname = NULL;
1903 break;
1904 }
1905 }
1906 }
1907 break;
1908 }
1909
1910 if (tempname != NULL)
1911 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001912#ifdef VMS
1913 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001914 umask_save = umask(077);
1915 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1916 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001917#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001918 int fd;
1919
1920 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001921 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001922 * Unix: same as original file, but strip s-bit. Reset umask to
1923 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001924 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001925# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001926 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001927 fd = mch_open((char *)tempname,
1928 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001929 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001930 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001931# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001932 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001933 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001934# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00001935 if (fd < 0)
1936 fp_out = NULL;
1937 else
1938 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001939#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940
1941 /*
1942 * If we can't create in the same directory, try creating a
1943 * "normal" temp file.
1944 */
1945 if (fp_out == NULL)
1946 {
1947 vim_free(tempname);
1948 if ((tempname = vim_tempname('o')) != NULL)
1949 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1950 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00001951
1952#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001954 * Make sure the owner can read/write it. This only works for
1955 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 */
1957 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001958 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959#endif
1960 }
1961 }
1962
1963 /*
1964 * Check if the new viminfo file can be written to.
1965 */
1966 if (fp_out == NULL)
1967 {
1968 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00001969 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970 if (fp_in != NULL)
1971 fclose(fp_in);
1972 goto end;
1973 }
1974
1975 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001976 {
1977 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001978 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001979 verbose_leave();
1980 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981
1982 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001983 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984
1985 fclose(fp_out); /* errors are ignored !? */
1986 if (fp_in != NULL)
1987 {
1988 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001989
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 /*
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001991 * In case of an error keep the original viminfo file.
1992 * Otherwise rename the newly written file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 */
1994 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1995 mch_remove(tempname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001996
1997#ifdef WIN3264
1998 /* If the viminfo file was hidden then also hide the new file. */
1999 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
2000 mch_hide(fname);
2001#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00002003
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004end:
2005 vim_free(fname);
2006 vim_free(tempname);
2007}
2008
2009/*
2010 * Get the viminfo file name to use.
2011 * If "file" is given and not empty, use it (has already been expanded by
2012 * cmdline functions).
2013 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2014 * expand environment variables.
2015 * Returns an allocated string. NULL when out of memory.
2016 */
2017 static char_u *
2018viminfo_filename(file)
2019 char_u *file;
2020{
2021 if (file == NULL || *file == NUL)
2022 {
2023 if (use_viminfo != NULL)
2024 file = use_viminfo;
2025 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2026 {
2027#ifdef VIMINFO_FILE2
2028 /* don't use $HOME when not defined (turned into "c:/"!). */
2029# ifdef VMS
2030 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2031# else
2032 if (mch_getenv((char_u *)"HOME") == NULL)
2033# endif
2034 {
2035 /* don't use $VIM when not available. */
2036 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2037 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2038 file = (char_u *)VIMINFO_FILE2;
2039 else
2040 file = (char_u *)VIMINFO_FILE;
2041 }
2042 else
2043#endif
2044 file = (char_u *)VIMINFO_FILE;
2045 }
2046 expand_env(file, NameBuff, MAXPATHL);
2047 file = NameBuff;
2048 }
2049 return vim_strsave(file);
2050}
2051
2052/*
2053 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2054 */
2055 static void
Bram Moolenaard812df62008-11-09 12:46:09 +00002056do_viminfo(fp_in, fp_out, flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 FILE *fp_in;
2058 FILE *fp_out;
Bram Moolenaard812df62008-11-09 12:46:09 +00002059 int flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060{
2061 int count = 0;
2062 int eof = FALSE;
2063 vir_T vir;
2064
2065 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2066 return;
2067 vir.vir_fd = fp_in;
2068#ifdef FEAT_MBYTE
2069 vir.vir_conv.vc_type = CONV_NONE;
2070#endif
2071
2072 if (fp_in != NULL)
2073 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002074 if (flags & VIF_WANT_INFO)
2075 eof = read_viminfo_up_to_marks(&vir,
2076 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 else
2078 /* Skip info, find start of marks */
2079 while (!(eof = viminfo_readline(&vir))
2080 && vir.vir_line[0] != '>')
2081 ;
2082 }
2083 if (fp_out != NULL)
2084 {
2085 /* Write the info: */
2086 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2087 VIM_VERSION_MEDIUM);
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002088 fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089#ifdef FEAT_MBYTE
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02002090 fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2092#endif
2093 write_viminfo_search_pattern(fp_out);
2094 write_viminfo_sub_string(fp_out);
2095#ifdef FEAT_CMDHIST
2096 write_viminfo_history(fp_out);
2097#endif
2098 write_viminfo_registers(fp_out);
2099#ifdef FEAT_EVAL
2100 write_viminfo_varlist(fp_out);
2101#endif
2102 write_viminfo_filemarks(fp_out);
2103 write_viminfo_bufferlist(fp_out);
2104 count = write_viminfo_marks(fp_out);
2105 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002106 if (fp_in != NULL
2107 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2108 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109
2110 vim_free(vir.vir_line);
2111#ifdef FEAT_MBYTE
2112 if (vir.vir_conv.vc_type != CONV_NONE)
2113 convert_setup(&vir.vir_conv, NULL, NULL);
2114#endif
2115}
2116
2117/*
2118 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2119 * first part of the viminfo file which contains everything but the marks that
2120 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2121 */
2122 static int
2123read_viminfo_up_to_marks(virp, forceit, writing)
2124 vir_T *virp;
2125 int forceit;
2126 int writing;
2127{
2128 int eof;
2129 buf_T *buf;
2130
2131#ifdef FEAT_CMDHIST
2132 prepare_viminfo_history(forceit ? 9999 : 0);
2133#endif
2134 eof = viminfo_readline(virp);
2135 while (!eof && virp->vir_line[0] != '>')
2136 {
2137 switch (virp->vir_line[0])
2138 {
2139 /* Characters reserved for future expansion, ignored now */
2140 case '+': /* "+40 /path/dir file", for running vim without args */
2141 case '|': /* to be defined */
2142 case '^': /* to be defined */
2143 case '<': /* long line - ignored */
2144 /* A comment or empty line. */
2145 case NUL:
2146 case '\r':
2147 case '\n':
2148 case '#':
2149 eof = viminfo_readline(virp);
2150 break;
2151 case '*': /* "*encoding=value" */
2152 eof = viminfo_encoding(virp);
2153 break;
2154 case '!': /* global variable */
2155#ifdef FEAT_EVAL
2156 eof = read_viminfo_varlist(virp, writing);
2157#else
2158 eof = viminfo_readline(virp);
2159#endif
2160 break;
2161 case '%': /* entry for buffer list */
2162 eof = read_viminfo_bufferlist(virp, writing);
2163 break;
2164 case '"':
2165 eof = read_viminfo_register(virp, forceit);
2166 break;
2167 case '/': /* Search string */
2168 case '&': /* Substitute search string */
2169 case '~': /* Last search string, followed by '/' or '&' */
2170 eof = read_viminfo_search_pattern(virp, forceit);
2171 break;
2172 case '$':
2173 eof = read_viminfo_sub_string(virp, forceit);
2174 break;
2175 case ':':
2176 case '?':
2177 case '=':
2178 case '@':
2179#ifdef FEAT_CMDHIST
2180 eof = read_viminfo_history(virp);
2181#else
2182 eof = viminfo_readline(virp);
2183#endif
2184 break;
2185 case '-':
2186 case '\'':
2187 eof = read_viminfo_filemark(virp, forceit);
2188 break;
2189 default:
2190 if (viminfo_error("E575: ", _("Illegal starting char"),
2191 virp->vir_line))
2192 eof = TRUE;
2193 else
2194 eof = viminfo_readline(virp);
2195 break;
2196 }
2197 }
2198
2199#ifdef FEAT_CMDHIST
2200 /* Finish reading history items. */
2201 finish_viminfo_history();
2202#endif
2203
2204 /* Change file names to buffer numbers for fmarks. */
2205 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2206 fmarks_check_names(buf);
2207
2208 return eof;
2209}
2210
2211/*
2212 * Compare the 'encoding' value in the viminfo file with the current value of
2213 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2214 * conversion of text with iconv() in viminfo_readstring().
2215 */
2216 static int
2217viminfo_encoding(virp)
2218 vir_T *virp;
2219{
2220#ifdef FEAT_MBYTE
2221 char_u *p;
2222 int i;
2223
2224 if (get_viminfo_parameter('c') != 0)
2225 {
2226 p = vim_strchr(virp->vir_line, '=');
2227 if (p != NULL)
2228 {
2229 /* remove trailing newline */
2230 ++p;
2231 for (i = 0; vim_isprintc(p[i]); ++i)
2232 ;
2233 p[i] = NUL;
2234
2235 convert_setup(&virp->vir_conv, p, p_enc);
2236 }
2237 }
2238#endif
2239 return viminfo_readline(virp);
2240}
2241
2242/*
2243 * Read a line from the viminfo file.
2244 * Returns TRUE for end-of-file;
2245 */
2246 int
2247viminfo_readline(virp)
2248 vir_T *virp;
2249{
2250 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2251}
2252
2253/*
2254 * check string read from viminfo file
2255 * remove '\n' at the end of the line
2256 * - replace CTRL-V CTRL-V with CTRL-V
2257 * - replace CTRL-V 'n' with '\n'
2258 *
2259 * Check for a long line as written by viminfo_writestring().
2260 *
2261 * Return the string in allocated memory (NULL when out of memory).
2262 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 char_u *
2264viminfo_readstring(virp, off, convert)
2265 vir_T *virp;
2266 int off; /* offset for virp->vir_line */
Bram Moolenaar2c4278f2009-05-17 11:33:22 +00002267 int convert UNUSED; /* convert the string */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268{
2269 char_u *retval;
2270 char_u *s, *d;
2271 long len;
2272
2273 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2274 {
2275 len = atol((char *)virp->vir_line + off + 1);
2276 retval = lalloc(len, TRUE);
2277 if (retval == NULL)
2278 {
2279 /* Line too long? File messed up? Skip next line. */
2280 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2281 return NULL;
2282 }
2283 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2284 s = retval + 1; /* Skip the leading '<' */
2285 }
2286 else
2287 {
2288 retval = vim_strsave(virp->vir_line + off);
2289 if (retval == NULL)
2290 return NULL;
2291 s = retval;
2292 }
2293
2294 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2295 d = retval;
2296 while (*s != NUL && *s != '\n')
2297 {
2298 if (s[0] == Ctrl_V && s[1] != NUL)
2299 {
2300 if (s[1] == 'n')
2301 *d++ = '\n';
2302 else
2303 *d++ = Ctrl_V;
2304 s += 2;
2305 }
2306 else
2307 *d++ = *s++;
2308 }
2309 *d = NUL;
2310
2311#ifdef FEAT_MBYTE
2312 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2313 {
2314 d = string_convert(&virp->vir_conv, retval, NULL);
2315 if (d != NULL)
2316 {
2317 vim_free(retval);
2318 retval = d;
2319 }
2320 }
2321#endif
2322
2323 return retval;
2324}
2325
2326/*
2327 * write string to viminfo file
2328 * - replace CTRL-V with CTRL-V CTRL-V
2329 * - replace '\n' with CTRL-V 'n'
2330 * - add a '\n' at the end
2331 *
2332 * For a long line:
2333 * - write " CTRL-V <length> \n " in first line
2334 * - write " < <string> \n " in second line
2335 */
2336 void
2337viminfo_writestring(fd, p)
2338 FILE *fd;
2339 char_u *p;
2340{
2341 int c;
2342 char_u *s;
2343 int len = 0;
2344
2345 for (s = p; *s != NUL; ++s)
2346 {
2347 if (*s == Ctrl_V || *s == '\n')
2348 ++len;
2349 ++len;
2350 }
2351
2352 /* If the string will be too long, write its length and put it in the next
2353 * line. Take into account that some room is needed for what comes before
2354 * the string (e.g., variable name). Add something to the length for the
2355 * '<', NL and trailing NUL. */
2356 if (len > LSIZE / 2)
2357 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2358
2359 while ((c = *p++) != NUL)
2360 {
2361 if (c == Ctrl_V || c == '\n')
2362 {
2363 putc(Ctrl_V, fd);
2364 if (c == '\n')
2365 c = 'n';
2366 }
2367 putc(c, fd);
2368 }
2369 putc('\n', fd);
2370}
2371#endif /* FEAT_VIMINFO */
2372
2373/*
2374 * Implementation of ":fixdel", also used by get_stty().
2375 * <BS> resulting <Del>
2376 * ^? ^H
2377 * not ^? ^?
2378 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 void
2380do_fixdel(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00002381 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382{
2383 char_u *p;
2384
2385 p = find_termcode((char_u *)"kb");
2386 add_termcode((char_u *)"kD", p != NULL
2387 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2388}
2389
2390 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002391print_line_no_prefix(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 linenr_T lnum;
2393 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002394 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002396 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397
2398 if (curwin->w_p_nu || use_number)
2399 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002400 vim_snprintf((char *)numbuf, sizeof(numbuf),
2401 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2403 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002404 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405}
2406
2407/*
2408 * Print a text line. Also in silent mode ("ex -s").
2409 */
2410 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002411print_line(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 linenr_T lnum;
2413 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002414 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415{
2416 int save_silent = silent_mode;
2417
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002419 silent_mode = FALSE;
2420 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2421 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 if (save_silent)
2423 {
2424 msg_putchar('\n');
2425 cursor_on(); /* msg_start() switches it off */
2426 out_flush();
2427 silent_mode = save_silent;
2428 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002429 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430}
2431
2432/*
2433 * ":file[!] [fname]".
2434 */
2435 void
2436ex_file(eap)
2437 exarg_T *eap;
2438{
2439 char_u *fname, *sfname, *xfname;
2440 buf_T *buf;
2441
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002442 /* ":0file" removes the file name. Check for illegal uses ":3file",
2443 * "0file name", etc. */
2444 if (eap->addr_count > 0
2445 && (*eap->arg != NUL
2446 || eap->line2 > 0
2447 || eap->addr_count > 1))
2448 {
2449 EMSG(_(e_invarg));
2450 return;
2451 }
2452
2453 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002454 {
2455#ifdef FEAT_AUTOCMD
2456 buf = curbuf;
2457 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2458 /* buffer changed, don't change name now */
2459 if (buf != curbuf)
2460 return;
2461# ifdef FEAT_EVAL
2462 if (aborting()) /* autocmds may abort script processing */
2463 return;
2464# endif
2465#endif
2466 /*
2467 * The name of the current buffer will be changed.
2468 * A new (unlisted) buffer entry needs to be made to hold the old file
2469 * name, which will become the alternate file name.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002470 * But don't set the alternate file name if the buffer didn't have a
2471 * name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 */
2473 fname = curbuf->b_ffname;
2474 sfname = curbuf->b_sfname;
2475 xfname = curbuf->b_fname;
2476 curbuf->b_ffname = NULL;
2477 curbuf->b_sfname = NULL;
2478 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2479 {
2480 curbuf->b_ffname = fname;
2481 curbuf->b_sfname = sfname;
2482 return;
2483 }
2484 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002485 if (xfname != NULL && *xfname != NUL)
2486 {
2487 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2488 if (buf != NULL && !cmdmod.keepalt)
2489 curwin->w_alt_fnum = buf->b_fnum;
2490 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 vim_free(fname);
2492 vim_free(sfname);
2493#ifdef FEAT_AUTOCMD
2494 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2495#endif
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002496 /* Change directories when the 'acd' option is set. */
2497 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 }
2499 /* print full file name if :cd used */
2500 fileinfo(FALSE, FALSE, eap->forceit);
2501}
2502
2503/*
2504 * ":update".
2505 */
2506 void
2507ex_update(eap)
2508 exarg_T *eap;
2509{
2510 if (curbufIsChanged())
2511 (void)do_write(eap);
2512}
2513
2514/*
2515 * ":write" and ":saveas".
2516 */
2517 void
2518ex_write(eap)
2519 exarg_T *eap;
2520{
2521 if (eap->usefilter) /* input lines to shell command */
2522 do_bang(1, eap, FALSE, TRUE, FALSE);
2523 else
2524 (void)do_write(eap);
2525}
2526
2527/*
2528 * write current buffer to file 'eap->arg'
2529 * if 'eap->append' is TRUE, append to the file
2530 *
2531 * if *eap->arg == NUL write to current file
2532 *
2533 * return FAIL for failure, OK otherwise
2534 */
2535 int
2536do_write(eap)
2537 exarg_T *eap;
2538{
2539 int other;
2540 char_u *fname = NULL; /* init to shut up gcc */
2541 char_u *ffname;
2542 int retval = FAIL;
2543 char_u *free_fname = NULL;
2544#ifdef FEAT_BROWSE
2545 char_u *browse_file = NULL;
2546#endif
2547 buf_T *alt_buf = NULL;
2548
2549 if (not_writing()) /* check 'write' option */
2550 return FAIL;
2551
2552 ffname = eap->arg;
2553#ifdef FEAT_BROWSE
2554 if (cmdmod.browse)
2555 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002556 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 NULL, NULL, NULL, curbuf);
2558 if (browse_file == NULL)
2559 goto theend;
2560 ffname = browse_file;
2561 }
2562#endif
2563 if (*ffname == NUL)
2564 {
2565 if (eap->cmdidx == CMD_saveas)
2566 {
2567 EMSG(_(e_argreq));
2568 goto theend;
2569 }
2570 other = FALSE;
2571 }
2572 else
2573 {
2574 fname = ffname;
2575 free_fname = fix_fname(ffname);
2576 /*
2577 * When out-of-memory, keep unexpanded file name, because we MUST be
2578 * able to write the file in this situation.
2579 */
2580 if (free_fname != NULL)
2581 ffname = free_fname;
2582 other = otherfile(ffname);
2583 }
2584
2585 /*
2586 * If we have a new file, put its name in the list of alternate file names.
2587 */
2588 if (other)
2589 {
2590 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2591 || eap->cmdidx == CMD_saveas)
2592 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2593 else
2594 alt_buf = buflist_findname(ffname);
2595 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2596 {
2597 /* Overwriting a file that is loaded in another buffer is not a
2598 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00002599 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 goto theend;
2601 }
2602 }
2603
2604 /*
2605 * Writing to the current file is not allowed in readonly mode
2606 * and a file name is required.
2607 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2608 */
2609 if (!other && (
2610#ifdef FEAT_QUICKFIX
2611 bt_dontwrite_msg(curbuf) ||
2612#endif
2613 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2614 goto theend;
2615
2616 if (!other)
2617 {
2618 ffname = curbuf->b_ffname;
2619 fname = curbuf->b_fname;
2620 /*
2621 * Not writing the whole file is only allowed with '!'.
2622 */
2623 if ( (eap->line1 != 1
2624 || eap->line2 != curbuf->b_ml.ml_line_count)
2625 && !eap->forceit
2626 && !eap->append
2627 && !p_wa)
2628 {
2629#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2630 if (p_confirm || cmdmod.confirm)
2631 {
2632 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2633 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2634 goto theend;
2635 eap->forceit = TRUE;
2636 }
2637 else
2638#endif
2639 {
2640 EMSG(_("E140: Use ! to write partial buffer"));
2641 goto theend;
2642 }
2643 }
2644 }
2645
2646 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2647 {
2648 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2649 {
2650#ifdef FEAT_AUTOCMD
2651 buf_T *was_curbuf = curbuf;
2652
2653 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002654 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655# ifdef FEAT_EVAL
2656 if (curbuf != was_curbuf || aborting())
2657# else
2658 if (curbuf != was_curbuf)
2659# endif
2660 {
2661 /* buffer changed, don't change name now */
2662 retval = FAIL;
2663 goto theend;
2664 }
2665#endif
2666 /* Exchange the file names for the current and the alternate
2667 * buffer. This makes it look like we are now editing the buffer
2668 * under the new name. Must be done before buf_write(), because
2669 * if there is no file name and 'cpo' contains 'F', it will set
2670 * the file name. */
2671 fname = alt_buf->b_fname;
2672 alt_buf->b_fname = curbuf->b_fname;
2673 curbuf->b_fname = fname;
2674 fname = alt_buf->b_ffname;
2675 alt_buf->b_ffname = curbuf->b_ffname;
2676 curbuf->b_ffname = fname;
2677 fname = alt_buf->b_sfname;
2678 alt_buf->b_sfname = curbuf->b_sfname;
2679 curbuf->b_sfname = fname;
2680 buf_name_changed(curbuf);
2681#ifdef FEAT_AUTOCMD
2682 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002683 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 if (!alt_buf->b_p_bl)
2685 {
2686 alt_buf->b_p_bl = TRUE;
2687 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2688 }
2689# ifdef FEAT_EVAL
2690 if (curbuf != was_curbuf || aborting())
2691# else
2692 if (curbuf != was_curbuf)
2693# endif
2694 {
2695 /* buffer changed, don't write the file */
2696 retval = FAIL;
2697 goto theend;
2698 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002699
2700 /* If 'filetype' was empty try detecting it now. */
2701 if (*curbuf->b_p_ft == NUL)
2702 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002703 if (au_has_group((char_u *)"filetypedetect"))
2704 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2705 TRUE);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002706 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002707 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708#endif
2709 }
2710
2711 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2712 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002713
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002714 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002715 if (eap->cmdidx == CMD_saveas)
2716 {
2717 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002718 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002719 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002720#ifdef FEAT_WINDOWS
2721 redraw_tabline = TRUE;
2722#endif
2723 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002724 /* Change directories when the 'acd' option is set. */
2725 DO_AUTOCHDIR
2726 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 }
2728
2729theend:
2730#ifdef FEAT_BROWSE
2731 vim_free(browse_file);
2732#endif
2733 vim_free(free_fname);
2734 return retval;
2735}
2736
2737/*
2738 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2739 * BF_NEW or BF_READERR, check for overwriting current file.
2740 * May set eap->forceit if a dialog says it's OK to overwrite.
2741 * Return OK if it's OK, FAIL if it is not.
2742 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 static int
2744check_overwrite(eap, buf, fname, ffname, other)
2745 exarg_T *eap;
2746 buf_T *buf;
2747 char_u *fname; /* file name to be used (can differ from
2748 buf->ffname) */
2749 char_u *ffname; /* full path version of fname */
2750 int other; /* writing under other name */
2751{
2752 /*
2753 * write to other file or b_flags set or not writing the whole file:
2754 * overwriting only allowed with '!'
2755 */
2756 if ( (other
2757 || (buf->b_flags & BF_NOTEDITED)
2758 || ((buf->b_flags & BF_NEW)
2759 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2760 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002762#ifdef FEAT_QUICKFIX
2763 && !bt_nofile(buf)
2764#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 && vim_fexists(ffname))
2766 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002767 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002769#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002770 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002771 if (mch_isdir(ffname))
2772 {
2773 EMSG2(_(e_isadir2), ffname);
2774 return FAIL;
2775 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776#endif
2777#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002778 if (p_confirm || cmdmod.confirm)
2779 {
2780 char_u buff[IOSIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002782 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2783 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2784 return FAIL;
2785 eap->forceit = TRUE;
2786 }
2787 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002789 {
2790 EMSG(_(e_exists));
2791 return FAIL;
2792 }
2793 }
2794
2795 /* For ":w! filename" check that no swap file exists for "filename". */
2796 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002798 char_u dir[MAXPATHL];
2799 char_u *p;
2800 int r;
2801 char_u *swapname;
2802
2803 /* We only try the first entry in 'directory', without checking if
2804 * it's writable. If the "." directory is not writable the write
2805 * will probably fail anyway.
2806 * Use 'shortname' of the current buffer, since there is no buffer
2807 * for the written file. */
2808 if (*p_dir == NUL)
2809 STRCPY(dir, ".");
2810 else
2811 {
2812 p = p_dir;
2813 copy_option_part(&p, dir, MAXPATHL, ",");
2814 }
2815 swapname = makeswapname(fname, ffname, curbuf, dir);
2816 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002817 if (r)
2818 {
2819#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2820 if (p_confirm || cmdmod.confirm)
2821 {
2822 char_u buff[IOSIZE];
2823
2824 dialog_msg(buff,
2825 _("Swap file \"%s\" exists, overwrite anyway?"),
2826 swapname);
2827 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2828 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002829 {
2830 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002831 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002832 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002833 eap->forceit = TRUE;
2834 }
2835 else
2836#endif
2837 {
2838 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2839 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002840 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002841 return FAIL;
2842 }
2843 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002844 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 }
2846 }
2847 return OK;
2848}
2849
2850/*
2851 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2852 */
2853 void
2854ex_wnext(eap)
2855 exarg_T *eap;
2856{
2857 int i;
2858
2859 if (eap->cmd[1] == 'n')
2860 i = curwin->w_arg_idx + (int)eap->line2;
2861 else
2862 i = curwin->w_arg_idx - (int)eap->line2;
2863 eap->line1 = 1;
2864 eap->line2 = curbuf->b_ml.ml_line_count;
2865 if (do_write(eap) != FAIL)
2866 do_argfile(eap, i);
2867}
2868
2869/*
2870 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2871 */
2872 void
2873do_wqall(eap)
2874 exarg_T *eap;
2875{
2876 buf_T *buf;
2877 int error = 0;
2878 int save_forceit = eap->forceit;
2879
2880 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2881 exiting = TRUE;
2882
2883 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2884 {
2885 if (bufIsChanged(buf))
2886 {
2887 /*
2888 * Check if there is a reason the buffer cannot be written:
2889 * 1. if the 'write' option is set
2890 * 2. if there is no file name (even after browsing)
2891 * 3. if the 'readonly' is set (even after a dialog)
2892 * 4. if overwriting is allowed (even after a dialog)
2893 */
2894 if (not_writing())
2895 {
2896 ++error;
2897 break;
2898 }
2899#ifdef FEAT_BROWSE
2900 /* ":browse wall": ask for file name if there isn't one */
2901 if (buf->b_ffname == NULL && cmdmod.browse)
2902 browse_save_fname(buf);
2903#endif
2904 if (buf->b_ffname == NULL)
2905 {
2906 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2907 ++error;
2908 }
2909 else if (check_readonly(&eap->forceit, buf)
2910 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2911 FALSE) == FAIL)
2912 {
2913 ++error;
2914 }
2915 else
2916 {
2917 if (buf_write_all(buf, eap->forceit) == FAIL)
2918 ++error;
2919#ifdef FEAT_AUTOCMD
2920 /* an autocommand may have deleted the buffer */
2921 if (!buf_valid(buf))
2922 buf = firstbuf;
2923#endif
2924 }
2925 eap->forceit = save_forceit; /* check_overwrite() may set it */
2926 }
2927 }
2928 if (exiting)
2929 {
2930 if (!error)
2931 getout(0); /* exit Vim */
2932 not_exiting();
2933 }
2934}
2935
2936/*
2937 * Check the 'write' option.
2938 * Return TRUE and give a message when it's not st.
2939 */
2940 int
2941not_writing()
2942{
2943 if (p_write)
2944 return FALSE;
2945 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2946 return TRUE;
2947}
2948
2949/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002950 * Check if a buffer is read-only (either 'readonly' option is set or file is
2951 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2952 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 */
2954 static int
2955check_readonly(forceit, buf)
2956 int *forceit;
2957 buf_T *buf;
2958{
Bram Moolenaar5386a122007-06-28 20:02:32 +00002959 struct stat st;
2960
2961 /* Handle a file being readonly when the 'readonly' option is set or when
2962 * the file exists and permissions are read-only.
2963 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2964 * important for device checks but not here. */
2965 if (!*forceit && (buf->b_p_ro
2966 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2967 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 {
2969#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2970 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2971 {
2972 char_u buff[IOSIZE];
2973
Bram Moolenaar5386a122007-06-28 20:02:32 +00002974 if (buf->b_p_ro)
2975 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2976 buf->b_fname);
2977 else
2978 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 +00002979 buf->b_fname);
2980
2981 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2982 {
2983 /* Set forceit, to force the writing of a readonly file */
2984 *forceit = TRUE;
2985 return FALSE;
2986 }
2987 else
2988 return TRUE;
2989 }
2990 else
2991#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002992 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002994 else
2995 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2996 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 return TRUE;
2998 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002999
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 return FALSE;
3001}
3002
3003/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003004 * Try to abandon current file and edit a new or existing file.
3005 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003007 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003008 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3010 */
3011 int
3012getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3013 int fnum;
3014 char_u *ffname;
3015 char_u *sfname;
3016 int setpm;
3017 linenr_T lnum;
3018 int forceit;
3019{
3020 int other;
3021 int retval;
3022 char_u *free_me = NULL;
3023
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003024 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003026#ifdef FEAT_AUTOCMD
3027 if (curbuf_locked())
3028 return 1;
3029#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030
3031 if (fnum == 0)
3032 {
3033 /* make ffname full path, set sfname */
3034 fname_expand(curbuf, &ffname, &sfname);
3035 other = otherfile(ffname);
3036 free_me = ffname; /* has been allocated, free() later */
3037 }
3038 else
3039 other = (fnum != curbuf->b_fnum);
3040
3041 if (other)
3042 ++no_wait_return; /* don't wait for autowrite message */
3043 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3044 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3045 {
3046#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3047 if (p_confirm && p_write)
3048 dialog_changed(curbuf, FALSE);
3049 if (curbufIsChanged())
3050#endif
3051 {
3052 if (other)
3053 --no_wait_return;
3054 EMSG(_(e_nowrtmsg));
3055 retval = 2; /* file has been changed */
3056 goto theend;
3057 }
3058 }
3059 if (other)
3060 --no_wait_return;
3061 if (setpm)
3062 setpcmark();
3063 if (!other)
3064 {
3065 if (lnum != 0)
3066 curwin->w_cursor.lnum = lnum;
3067 check_cursor_lnum();
3068 beginline(BL_SOL | BL_FIX);
3069 retval = 0; /* it's in the same file */
3070 }
3071 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003072 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3073 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 retval = -1; /* opened another file */
3075 else
3076 retval = 1; /* error encountered */
3077
3078theend:
3079 vim_free(free_me);
3080 return retval;
3081}
3082
3083/*
3084 * start editing a new file
3085 *
3086 * fnum: file number; if zero use ffname/sfname
3087 * ffname: the file name
3088 * - full path if sfname used,
3089 * - any file name if sfname is NULL
3090 * - empty string to re-edit with the same file name (but may be
3091 * in a different directory)
3092 * - NULL to start an empty buffer
3093 * sfname: the short file name (or NULL)
3094 * eap: contains the command to be executed after loading the file and
3095 * forced 'ff' and 'fenc'
3096 * newlnum: if > 0: put cursor on this line number (if possible)
3097 * if ECMD_LASTL: use last position in loaded file
3098 * if ECMD_LAST: use last position in all files
3099 * if ECMD_ONE: use first line
3100 * flags:
3101 * ECMD_HIDE: if TRUE don't free the current buffer
3102 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3103 * ECMD_OLDBUF: use existing buffer if it exists
3104 * ECMD_FORCEIT: ! used for Ex command
3105 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003106 * oldwin: Should be "curwin" when editing a new buffer in the current
Bram Moolenaarcc448b32010-07-14 16:52:17 +02003107 * window, NULL when splitting the window first. When not NULL info
3108 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 *
3110 * return FAIL for failure, OK otherwise
3111 */
3112 int
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003113do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 int fnum;
3115 char_u *ffname;
3116 char_u *sfname;
3117 exarg_T *eap; /* can be NULL! */
3118 linenr_T newlnum;
3119 int flags;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003120 win_T *oldwin;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121{
3122 int other_file; /* TRUE if editing another file */
3123 int oldbuf; /* TRUE if using existing buffer */
3124#ifdef FEAT_AUTOCMD
3125 int auto_buf = FALSE; /* TRUE if autocommands brought us
3126 into the buffer unexpectedly */
3127 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003128 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129#endif
3130 buf_T *buf;
3131#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3132 buf_T *old_curbuf = curbuf;
3133#endif
3134 char_u *free_fname = NULL;
3135#ifdef FEAT_BROWSE
3136 char_u *browse_file = NULL;
3137#endif
3138 int retval = FAIL;
3139 long n;
3140 linenr_T lnum;
3141 linenr_T topline = 0;
3142 int newcol = -1;
3143 int solcol = -1;
3144 pos_T *pos;
3145#ifdef FEAT_SUN_WORKSHOP
3146 char_u *cp;
3147#endif
3148 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003149#ifdef FEAT_SPELL
3150 int did_get_winopts = FALSE;
3151#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003152 int readfile_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153
3154 if (eap != NULL)
3155 command = eap->do_ecmd_cmd;
3156
3157 if (fnum != 0)
3158 {
3159 if (fnum == curbuf->b_fnum) /* file is already being edited */
3160 return OK; /* nothing to do */
3161 other_file = TRUE;
3162 }
3163 else
3164 {
3165#ifdef FEAT_BROWSE
3166 if (cmdmod.browse)
3167 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003168# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003169 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003170# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003171 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003172# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003173 au_has_group((char_u *)"FileExplorer"))
3174 {
3175 /* No browsing supported but we do have the file explorer:
3176 * Edit the directory. */
3177 if (ffname == NULL || !mch_isdir(ffname))
3178 ffname = (char_u *)".";
3179 }
3180 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003181# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003182 {
3183 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003185 if (browse_file == NULL)
3186 goto theend;
3187 ffname = browse_file;
3188 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 }
3190#endif
3191 /* if no short name given, use ffname for short name */
3192 if (sfname == NULL)
3193 sfname = ffname;
3194#ifdef USE_FNAME_CASE
3195# ifdef USE_LONG_FNAME
3196 if (USE_LONG_FNAME)
3197# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003198 if (sfname != NULL)
3199 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200#endif
3201
3202#ifdef FEAT_LISTCMDS
3203 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3204 goto theend;
3205#endif
3206
3207 if (ffname == NULL)
3208 other_file = TRUE;
3209 /* there is no file name */
3210 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3211 other_file = FALSE;
3212 else
3213 {
3214 if (*ffname == NUL) /* re-edit with same file name */
3215 {
3216 ffname = curbuf->b_ffname;
3217 sfname = curbuf->b_fname;
3218 }
3219 free_fname = fix_fname(ffname); /* may expand to full path name */
3220 if (free_fname != NULL)
3221 ffname = free_fname;
3222 other_file = otherfile(ffname);
3223#ifdef FEAT_SUN_WORKSHOP
3224 if (usingSunWorkShop && p_acd
3225 && (cp = vim_strrchr(sfname, '/')) != NULL)
3226 sfname = ++cp;
3227#endif
3228 }
3229 }
3230
3231 /*
3232 * if the file was changed we may not be allowed to abandon it
3233 * - if we are going to re-edit the same file
3234 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3235 */
3236 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3237 || (curbuf->b_nwindows == 1
3238 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3239 && check_changed(curbuf, p_awa, !other_file,
3240 (flags & ECMD_FORCEIT), FALSE))
3241 {
3242 if (fnum == 0 && other_file && ffname != NULL)
3243 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3244 goto theend;
3245 }
3246
3247#ifdef FEAT_VISUAL
3248 /*
3249 * End Visual mode before switching to another buffer, so the text can be
3250 * copied into the GUI selection buffer.
3251 */
3252 reset_VIsual();
3253#endif
3254
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003255#ifdef FEAT_AUTOCMD
3256 if ((command != NULL || newlnum > (linenr_T)0)
3257 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3258 {
3259 int len;
3260 char_u *p;
3261
3262 /* Set v:swapcommand for the SwapExists autocommands. */
3263 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003264 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003265 else
3266 len = 30;
3267 p = alloc((unsigned)len);
3268 if (p != NULL)
3269 {
3270 if (command != NULL)
3271 vim_snprintf((char *)p, len, ":%s\r", command);
3272 else
3273 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3274 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3275 did_set_swapcommand = TRUE;
3276 vim_free(p);
3277 }
3278 }
3279#endif
3280
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 /*
3282 * If we are starting to edit another file, open a (new) buffer.
3283 * Otherwise we re-use the current buffer.
3284 */
3285 if (other_file)
3286 {
3287#ifdef FEAT_LISTCMDS
3288 if (!(flags & ECMD_ADDBUF))
3289#endif
3290 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003291 if (!cmdmod.keepalt)
3292 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003293 if (oldwin != NULL)
3294 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 }
3296
3297 if (fnum)
3298 buf = buflist_findnr(fnum);
3299 else
3300 {
3301#ifdef FEAT_LISTCMDS
3302 if (flags & ECMD_ADDBUF)
3303 {
3304 linenr_T tlnum = 1L;
3305
3306 if (command != NULL)
3307 {
3308 tlnum = atol((char *)command);
3309 if (tlnum <= 0)
3310 tlnum = 1L;
3311 }
3312 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3313 goto theend;
3314 }
3315#endif
3316 buf = buflist_new(ffname, sfname, 0L,
3317 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3318 }
3319 if (buf == NULL)
3320 goto theend;
3321 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3322 {
3323 oldbuf = FALSE;
3324 buf->b_nwindows = 0;
3325 }
3326 else /* existing memfile */
3327 {
3328 oldbuf = TRUE;
3329 (void)buf_check_timestamp(buf, FALSE);
3330 /* Check if autocommands made buffer invalid or changed the current
3331 * buffer. */
3332 if (!buf_valid(buf)
3333#ifdef FEAT_AUTOCMD
3334 || curbuf != old_curbuf
3335#endif
3336 )
3337 goto theend;
3338#ifdef FEAT_EVAL
3339 if (aborting()) /* autocmds may abort script processing */
3340 goto theend;
3341#endif
3342 }
3343
3344 /* May jump to last used line number for a loaded buffer or when asked
3345 * for explicitly */
3346 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3347 {
3348 pos = buflist_findfpos(buf);
3349 newlnum = pos->lnum;
3350 solcol = pos->col;
3351 }
3352
3353 /*
3354 * Make the (new) buffer the one used by the current window.
3355 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3356 * If the current buffer was empty and has no file name, curbuf
3357 * is returned by buflist_new().
3358 */
3359 if (buf != curbuf)
3360 {
3361#ifdef FEAT_AUTOCMD
3362 /*
3363 * Be careful: The autocommands may delete any buffer and change
3364 * the current buffer.
3365 * - If the buffer we are going to edit is deleted, give up.
3366 * - If the current buffer is deleted, prefer to load the new
3367 * buffer when loading a buffer is required. This avoids
3368 * loading another buffer which then must be closed again.
3369 * - If we ended up in the new buffer already, need to skip a few
3370 * things, set auto_buf.
3371 */
3372 if (buf->b_fname != NULL)
3373 new_name = vim_strsave(buf->b_fname);
3374 au_new_curbuf = buf;
3375 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3376 if (!buf_valid(buf)) /* new buffer has been deleted */
3377 {
3378 delbuf_msg(new_name); /* frees new_name */
3379 goto theend;
3380 }
3381# ifdef FEAT_EVAL
3382 if (aborting()) /* autocmds may abort script processing */
3383 {
3384 vim_free(new_name);
3385 goto theend;
3386 }
3387# endif
3388 if (buf == curbuf) /* already in new buffer */
3389 auto_buf = TRUE;
3390 else
3391 {
3392 if (curbuf == old_curbuf)
3393#endif
3394 buf_copy_options(buf, BCO_ENTER);
3395
3396 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003397 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003398 close_buffer(oldwin, curbuf,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3400
3401#ifdef FEAT_AUTOCMD
3402# ifdef FEAT_EVAL
3403 if (aborting()) /* autocmds may abort script processing */
3404 {
3405 vim_free(new_name);
3406 goto theend;
3407 }
3408# endif
3409 /* Be careful again, like above. */
3410 if (!buf_valid(buf)) /* new buffer has been deleted */
3411 {
3412 delbuf_msg(new_name); /* frees new_name */
3413 goto theend;
3414 }
3415 if (buf == curbuf) /* already in new buffer */
3416 auto_buf = TRUE;
3417 else
3418#endif
3419 {
Bram Moolenaar860cae12010-06-05 23:22:07 +02003420#ifdef FEAT_SYN_HL
3421 /*
3422 * <VN> We could instead free the synblock
3423 * and re-attach to buffer, perhaps.
3424 */
3425 if (curwin->w_s == &(curwin->w_buffer->b_s))
3426 curwin->w_s = &(buf->b_s);
3427#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 curwin->w_buffer = buf;
3429 curbuf = buf;
3430 ++curbuf->b_nwindows;
3431 /* set 'fileformat' */
3432 if (*p_ffs && !oldbuf)
3433 set_fileformat(default_fileformat(), OPT_LOCAL);
3434 }
3435
3436 /* May get the window options from the last time this buffer
3437 * was in this window (or another window). If not used
3438 * before, reset the local window options to the global
3439 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003440 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003441#ifdef FEAT_SPELL
3442 did_get_winopts = TRUE;
3443#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444
3445#ifdef FEAT_AUTOCMD
3446 }
3447 vim_free(new_name);
3448 au_new_curbuf = NULL;
3449#endif
3450 }
3451 else
3452 ++curbuf->b_nwindows;
3453
3454 curwin->w_pcmark.lnum = 1;
3455 curwin->w_pcmark.col = 0;
3456 }
3457 else /* !other_file */
3458 {
3459 if (
3460#ifdef FEAT_LISTCMDS
3461 (flags & ECMD_ADDBUF) ||
3462#endif
3463 check_fname() == FAIL)
3464 goto theend;
3465 oldbuf = (flags & ECMD_OLDBUF);
3466 }
3467
3468 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3469 {
3470 char_u *p;
3471
3472 curbuf->b_help = TRUE;
3473#ifdef FEAT_QUICKFIX
3474 set_string_option_direct((char_u *)"buftype", -1,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003475 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476#endif
3477
3478 /*
3479 * Always set these options after jumping to a help tag, because the
3480 * user may have an autocommand that gets in the way.
3481 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3482 * latin1 word characters (for translated help files).
3483 * Only set it when needed, buf_init_chartab() is some work.
3484 */
3485 p =
3486#ifdef EBCDIC
3487 (char_u *)"65-255,^*,^|,^\"";
3488#else
3489 (char_u *)"!-~,^*,^|,^\",192-255";
3490#endif
3491 if (STRCMP(curbuf->b_p_isk, p) != 0)
3492 {
3493 set_string_option_direct((char_u *)"isk", -1, p,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003494 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 check_buf_options(curbuf);
3496 (void)buf_init_chartab(curbuf, FALSE);
3497 }
3498
3499 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3500 curwin->w_p_list = FALSE; /* no list mode */
3501
3502 curbuf->b_p_ma = FALSE; /* not modifiable */
3503 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3504 curwin->w_p_nu = 0; /* no line numbers */
Bram Moolenaar64486672010-05-16 15:46:46 +02003505 curwin->w_p_rnu = 0; /* no relative line numbers */
Bram Moolenaar3368ea22010-09-21 16:56:35 +02003506 RESET_BINDING(curwin); /* no scroll or cursor binding */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507#ifdef FEAT_ARABIC
3508 curwin->w_p_arab = FALSE; /* no arabic mode */
3509#endif
3510#ifdef FEAT_RIGHTLEFT
3511 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3512#endif
3513#ifdef FEAT_FOLDING
3514 curwin->w_p_fen = FALSE; /* No folding in the help window */
3515#endif
3516#ifdef FEAT_DIFF
3517 curwin->w_p_diff = FALSE; /* No 'diff' */
3518#endif
Bram Moolenaara1956f62006-03-12 22:18:00 +00003519#ifdef FEAT_SPELL
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00003520 curwin->w_p_spell = FALSE; /* No spell checking */
3521#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522
3523#ifdef FEAT_AUTOCMD
3524 buf = curbuf;
3525#endif
3526 set_buflisted(FALSE);
3527 }
3528 else
3529 {
3530#ifdef FEAT_AUTOCMD
3531 buf = curbuf;
3532#endif
3533 /* Don't make a buffer listed if it's a help buffer. Useful when
3534 * using CTRL-O to go back to a help file. */
3535 if (!curbuf->b_help)
3536 set_buflisted(TRUE);
3537 }
3538
3539#ifdef FEAT_AUTOCMD
3540 /* If autocommands change buffers under our fingers, forget about
3541 * editing the file. */
3542 if (buf != curbuf)
3543 goto theend;
3544# ifdef FEAT_EVAL
3545 if (aborting()) /* autocmds may abort script processing */
3546 goto theend;
3547# endif
3548
3549 /* Since we are starting to edit a file, consider the filetype to be
3550 * unset. Helps for when an autocommand changes files and expects syntax
3551 * highlighting to work in the other file. */
3552 did_filetype = FALSE;
3553#endif
3554
3555/*
3556 * other_file oldbuf
3557 * FALSE FALSE re-edit same file, buffer is re-used
3558 * FALSE TRUE re-edit same file, nothing changes
3559 * TRUE FALSE start editing new file, new buffer
3560 * TRUE TRUE start editing in existing buffer (nothing to do)
3561 */
3562 if (!other_file && !oldbuf) /* re-use the buffer */
3563 {
3564 set_last_cursor(curwin); /* may set b_last_cursor */
3565 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3566 {
3567 newlnum = curwin->w_cursor.lnum;
3568 solcol = curwin->w_cursor.col;
3569 }
3570#ifdef FEAT_AUTOCMD
3571 buf = curbuf;
3572 if (buf->b_fname != NULL)
3573 new_name = vim_strsave(buf->b_fname);
3574 else
3575 new_name = NULL;
3576#endif
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003577 if (p_ur < 0 || curbuf->b_ml.ml_line_count <= p_ur)
3578 {
3579 /* Save all the text, so that the reload can be undone.
3580 * Sync first so that this is a separate undo-able action. */
3581 u_sync(FALSE);
3582 if (u_savecommon(0, curbuf->b_ml.ml_line_count + 1, 0, TRUE)
3583 == FAIL)
3584 goto theend;
3585 u_unchanged(curbuf);
3586 buf_freeall(curbuf, BFA_KEEP_UNDO);
3587
3588 /* tell readfile() not to clear or reload undo info */
3589 readfile_flags = READ_KEEP_UNDO;
3590 }
3591 else
3592 buf_freeall(curbuf, 0); /* free all things for buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593#ifdef FEAT_AUTOCMD
3594 /* If autocommands deleted the buffer we were going to re-edit, give
3595 * up and jump to the end. */
3596 if (!buf_valid(buf))
3597 {
3598 delbuf_msg(new_name); /* frees new_name */
3599 goto theend;
3600 }
3601 vim_free(new_name);
3602
3603 /* If autocommands change buffers under our fingers, forget about
3604 * re-editing the file. Should do the buf_clear_file(), but perhaps
3605 * the autocommands changed the buffer... */
3606 if (buf != curbuf)
3607 goto theend;
3608# ifdef FEAT_EVAL
3609 if (aborting()) /* autocmds may abort script processing */
3610 goto theend;
3611# endif
3612#endif
3613 buf_clear_file(curbuf);
3614 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3615 curbuf->b_op_end.lnum = 0;
3616 }
3617
3618/*
3619 * If we get here we are sure to start editing
3620 */
3621 /* don't redraw until the cursor is in the right line */
3622 ++RedrawingDisabled;
3623
3624 /* Assume success now */
3625 retval = OK;
3626
3627 /*
3628 * Reset cursor position, could be used by autocommands.
3629 */
3630 check_cursor();
3631
3632 /*
3633 * Check if we are editing the w_arg_idx file in the argument list.
3634 */
3635 check_arg_idx(curwin);
3636
Bram Moolenaardebe25a2010-06-06 17:41:24 +02003637#ifdef FEAT_SYN_HL
3638 reset_synblock(curwin); /* remove any ownsyntax */
3639#endif
3640
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641#ifdef FEAT_AUTOCMD
3642 if (!auto_buf)
3643#endif
3644 {
3645 /*
3646 * Set cursor and init window before reading the file and executing
3647 * autocommands. This allows for the autocommands to position the
3648 * cursor.
3649 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003650 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651
3652#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003653 /* It's possible that all lines in the buffer changed. Need to update
3654 * automatic folding for all windows where it's used. */
3655# ifdef FEAT_WINDOWS
3656 {
3657 win_T *win;
3658 tabpage_T *tp;
3659
3660 FOR_ALL_TAB_WINDOWS(tp, win)
3661 if (win->w_buffer == curbuf)
3662 foldUpdateAll(win);
3663 }
3664# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003666# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667#endif
3668
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003669 /* Change directories when the 'acd' option is set. */
3670 DO_AUTOCHDIR
3671
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 /*
3673 * Careful: open_buffer() and apply_autocmds() may change the current
3674 * buffer and window.
3675 */
3676 lnum = curwin->w_cursor.lnum;
3677 topline = curwin->w_topline;
3678 if (!oldbuf) /* need to read the file */
3679 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003680#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 swap_exists_action = SEA_DIALOG;
3682#endif
3683 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3684
3685 /*
3686 * Open the buffer and read the file.
3687 */
3688#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003689 if (should_abort(open_buffer(FALSE, eap, readfile_flags)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 retval = FAIL;
3691#else
Bram Moolenaar59f931e2010-07-24 20:27:03 +02003692 (void)open_buffer(FALSE, eap, readfile_flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693#endif
3694
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003695#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 if (swap_exists_action == SEA_QUIT)
3697 retval = FAIL;
3698 handle_swap_exists(old_curbuf);
3699#endif
3700 }
3701#ifdef FEAT_AUTOCMD
3702 else
3703 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003704 /* Read the modelines, but only to set window-local options. Any
3705 * buffer-local options have already been set and may have been
3706 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003707 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003708
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3710 &retval);
3711 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3712 &retval);
3713 }
3714 check_arg_idx(curwin);
3715#endif
3716
3717 /*
3718 * If autocommands change the cursor position or topline, we should
3719 * keep it.
3720 */
3721 if (curwin->w_cursor.lnum != lnum)
3722 {
3723 newlnum = curwin->w_cursor.lnum;
3724 newcol = curwin->w_cursor.col;
3725 }
3726 if (curwin->w_topline == topline)
3727 topline = 0;
3728
3729 /* Even when cursor didn't move we need to recompute topline. */
3730 changed_line_abv_curs();
3731
3732#ifdef FEAT_TITLE
3733 maketitle();
3734#endif
3735 }
3736
3737#ifdef FEAT_DIFF
3738 /* Tell the diff stuff that this buffer is new and/or needs updating.
3739 * Also needed when re-editing the same buffer, because unloading will
3740 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003741 if (curwin->w_p_diff)
3742 {
3743 diff_buf_add(curbuf);
3744 diff_invalidate(curbuf);
3745 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746#endif
3747
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003748#ifdef FEAT_SPELL
3749 /* If the window options were changed may need to set the spell language.
3750 * Can only do this after the buffer has been properly setup. */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003751 if (did_get_winopts && curwin->w_p_spell && *curwin->w_s->b_p_spl != NUL)
3752 (void)did_set_spelllang(curwin);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003753#endif
3754
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 if (command == NULL)
3756 {
3757 if (newcol >= 0) /* position set by autocommands */
3758 {
3759 curwin->w_cursor.lnum = newlnum;
3760 curwin->w_cursor.col = newcol;
3761 check_cursor();
3762 }
3763 else if (newlnum > 0) /* line number from caller or old position */
3764 {
3765 curwin->w_cursor.lnum = newlnum;
3766 check_cursor_lnum();
3767 if (solcol >= 0 && !p_sol)
3768 {
3769 /* 'sol' is off: Use last known column. */
3770 curwin->w_cursor.col = solcol;
3771 check_cursor_col();
3772#ifdef FEAT_VIRTUALEDIT
3773 curwin->w_cursor.coladd = 0;
3774#endif
3775 curwin->w_set_curswant = TRUE;
3776 }
3777 else
3778 beginline(BL_SOL | BL_FIX);
3779 }
3780 else /* no line number, go to last line in Ex mode */
3781 {
3782 if (exmode_active)
3783 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3784 beginline(BL_WHITE | BL_FIX);
3785 }
3786 }
3787
3788#ifdef FEAT_WINDOWS
3789 /* Check if cursors in other windows on the same buffer are still valid */
3790 check_lnums(FALSE);
3791#endif
3792
3793 /*
3794 * Did not read the file, need to show some info about the file.
3795 * Do this after setting the cursor.
3796 */
3797 if (oldbuf
3798#ifdef FEAT_AUTOCMD
3799 && !auto_buf
3800#endif
3801 )
3802 {
3803 int msg_scroll_save = msg_scroll;
3804
3805 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3806 * message. */
3807 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3808 msg_scroll = FALSE;
3809 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3810 check_for_delay(FALSE);
3811 msg_start();
3812 msg_scroll = msg_scroll_save;
3813 msg_scrolled_ign = TRUE;
3814
3815 fileinfo(FALSE, TRUE, FALSE);
3816
3817 msg_scrolled_ign = FALSE;
3818 }
3819
3820 if (command != NULL)
3821 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3822
3823#ifdef FEAT_KEYMAP
3824 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003825 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826#endif
3827
3828 --RedrawingDisabled;
3829 if (!skip_redraw)
3830 {
3831 n = p_so;
3832 if (topline == 0 && command == NULL)
3833 p_so = 999; /* force cursor halfway the window */
3834 update_topline();
3835#ifdef FEAT_SCROLLBIND
3836 curwin->w_scbind_pos = curwin->w_topline;
3837#endif
3838 p_so = n;
3839 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3840 }
3841
3842 if (p_im)
3843 need_start_insertmode = TRUE;
3844
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003845 /* Change directories when the 'acd' option is set. */
3846 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00003848#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar67c53842010-05-22 18:28:27 +02003849 if (curbuf->b_ffname != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 {
3851# ifdef FEAT_SUN_WORKSHOP
Bram Moolenaar67c53842010-05-22 18:28:27 +02003852 if (gui.in_use && usingSunWorkShop)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3854# endif
3855# ifdef FEAT_NETBEANS_INTG
Bram Moolenaarb26e6322010-05-22 21:34:09 +02003856 if ((flags & ECMD_SET_HELP) != ECMD_SET_HELP)
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003857 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858# endif
3859 }
3860#endif
3861
3862theend:
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003863#ifdef FEAT_AUTOCMD
3864 if (did_set_swapcommand)
3865 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3866#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867#ifdef FEAT_BROWSE
3868 vim_free(browse_file);
3869#endif
3870 vim_free(free_fname);
3871 return retval;
3872}
3873
3874#ifdef FEAT_AUTOCMD
3875 static void
3876delbuf_msg(name)
3877 char_u *name;
3878{
3879 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3880 name == NULL ? (char_u *)"" : name);
3881 vim_free(name);
3882 au_new_curbuf = NULL;
3883}
3884#endif
3885
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003886static int append_indent = 0; /* autoindent for first line */
3887
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888/*
3889 * ":insert" and ":append", also used by ":change"
3890 */
3891 void
3892ex_append(eap)
3893 exarg_T *eap;
3894{
3895 char_u *theline;
3896 int did_undo = FALSE;
3897 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003898 int indent = 0;
3899 char_u *p;
3900 int vcol;
3901 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003903 /* the ! flag toggles autoindent */
3904 if (eap->forceit)
3905 curbuf->b_p_ai = !curbuf->b_p_ai;
3906
3907 /* First autoindent comes from the line we start on */
3908 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3909 append_indent = get_indent_lnum(lnum);
3910
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 if (eap->cmdidx != CMD_append)
3912 --lnum;
3913
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003914 /* when the buffer is empty append to line 0 and delete the dummy line */
3915 if (empty && lnum == 1)
3916 lnum = 0;
3917
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 State = INSERT; /* behave like in Insert mode */
3919 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3920 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003921
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003922 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 {
3924 msg_scroll = TRUE;
3925 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003926 if (curbuf->b_p_ai)
3927 {
3928 if (append_indent >= 0)
3929 {
3930 indent = append_indent;
3931 append_indent = -1;
3932 }
3933 else if (lnum > 0)
3934 indent = get_indent_lnum(lnum);
3935 }
3936 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003938 {
3939 /* No getline() function, use the lines that follow. This ends
3940 * when there is no more. */
3941 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3942 break;
3943 p = vim_strchr(eap->nextcmd, NL);
3944 if (p == NULL)
3945 p = eap->nextcmd + STRLEN(eap->nextcmd);
3946 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3947 if (*p != NUL)
3948 ++p;
3949 eap->nextcmd = p;
3950 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 else
3952 theline = eap->getline(
3953#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003954 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003956 NUL, eap->cookie, indent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003958 if (theline == NULL)
3959 break;
3960
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003961 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3962 if (ex_keep_indent)
3963 append_indent = indent;
3964
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003965 /* Look for the "." after automatic indent. */
3966 vcol = 0;
3967 for (p = theline; indent > vcol; ++p)
3968 {
3969 if (*p == ' ')
3970 ++vcol;
3971 else if (*p == TAB)
3972 vcol += 8 - vcol % 8;
3973 else
3974 break;
3975 }
3976 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003977 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3978 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 {
3980 vim_free(theline);
3981 break;
3982 }
3983
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003984 /* don't use autoindent if nothing was typed. */
3985 if (p[0] == NUL)
3986 theline[0] = NUL;
3987
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 did_undo = TRUE;
3989 ml_append(lnum, theline, (colnr_T)0, FALSE);
3990 appended_lines_mark(lnum, 1L);
3991
3992 vim_free(theline);
3993 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003994
3995 if (empty)
3996 {
3997 ml_delete(2L, FALSE);
3998 empty = FALSE;
3999 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 }
4001 State = NORMAL;
4002
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004003 if (eap->forceit)
4004 curbuf->b_p_ai = !curbuf->b_p_ai;
4005
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00004007 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 * "end" is set to lnum when something has been appended, otherwise
4009 * it is the same than "start" -- Acevedo */
4010 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
4011 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
4012 if (eap->cmdidx != CMD_append)
4013 --curbuf->b_op_start.lnum;
4014 curbuf->b_op_end.lnum = (eap->line2 < lnum)
4015 ? lnum : curbuf->b_op_start.lnum;
4016 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4017 curwin->w_cursor.lnum = lnum;
4018 check_cursor_lnum();
4019 beginline(BL_SOL | BL_FIX);
4020
4021 need_wait_return = FALSE; /* don't use wait_return() now */
4022 ex_no_reprint = TRUE;
4023}
4024
4025/*
4026 * ":change"
4027 */
4028 void
4029ex_change(eap)
4030 exarg_T *eap;
4031{
4032 linenr_T lnum;
4033
4034 if (eap->line2 >= eap->line1
4035 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4036 return;
4037
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004038 /* the ! flag toggles autoindent */
4039 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4040 append_indent = get_indent_lnum(eap->line1);
4041
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4043 {
4044 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4045 break;
4046 ml_delete(eap->line1, FALSE);
4047 }
Bram Moolenaarcdcaa582009-07-09 18:06:49 +00004048
4049 /* make sure the cursor is not beyond the end of the file now */
4050 check_cursor_lnum();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4052
4053 /* ":append" on the line above the deleted lines. */
4054 eap->line2 = eap->line1;
4055 ex_append(eap);
4056}
4057
4058 void
4059ex_z(eap)
4060 exarg_T *eap;
4061{
4062 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004063 int bigness;
4064 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 int minus = 0;
4066 linenr_T start, end, curs, i;
4067 int j;
4068 linenr_T lnum = eap->line2;
4069
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004070 /* Vi compatible: ":z!" uses display height, without a count uses
4071 * 'scroll' */
4072 if (eap->forceit)
4073 bigness = curwin->w_height;
4074 else if (firstwin == lastwin)
4075 bigness = curwin->w_p_scr * 2;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004076#ifdef FEAT_WINDOWS
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004077 else
4078 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004079#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 if (bigness < 1)
4081 bigness = 1;
4082
4083 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004084 kind = x;
4085 if (*kind == '-' || *kind == '+' || *kind == '='
4086 || *kind == '^' || *kind == '.')
4087 ++x;
4088 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 ++x;
4090
4091 if (*x != 0)
4092 {
4093 if (!VIM_ISDIGIT(*x))
4094 {
4095 EMSG(_("E144: non-numeric argument to :z"));
4096 return;
4097 }
4098 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004099 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004101 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004102 if (*kind == '=')
4103 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004104 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 }
4106
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004107 /* the number of '-' and '+' multiplies the distance */
4108 if (*kind == '-' || *kind == '+')
4109 for (x = kind + 1; *x == *kind; ++x)
4110 ;
4111
4112 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 {
4114 case '-':
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004115 start = lnum - bigness * (linenr_T)(x - kind);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004116 end = start + bigness;
4117 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 break;
4119
4120 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004121 start = lnum - (bigness + 1) / 2 + 1;
4122 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 curs = lnum;
4124 minus = 1;
4125 break;
4126
4127 case '^':
4128 start = lnum - bigness * 2;
4129 end = lnum - bigness;
4130 curs = lnum - bigness;
4131 break;
4132
4133 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004134 start = lnum - (bigness + 1) / 2 + 1;
4135 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 curs = end;
4137 break;
4138
4139 default: /* '+' */
4140 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004141 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004142 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004143 else if (eap->addr_count == 0)
4144 ++start;
4145 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 curs = end;
4147 break;
4148 }
4149
4150 if (start < 1)
4151 start = 1;
4152
4153 if (end > curbuf->b_ml.ml_line_count)
4154 end = curbuf->b_ml.ml_line_count;
4155
4156 if (curs > curbuf->b_ml.ml_line_count)
4157 curs = curbuf->b_ml.ml_line_count;
4158
4159 for (i = start; i <= end; i++)
4160 {
4161 if (minus && i == lnum)
4162 {
4163 msg_putchar('\n');
4164
4165 for (j = 1; j < Columns; j++)
4166 msg_putchar('-');
4167 }
4168
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004169 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170
4171 if (minus && i == lnum)
4172 {
4173 msg_putchar('\n');
4174
4175 for (j = 1; j < Columns; j++)
4176 msg_putchar('-');
4177 }
4178 }
4179
4180 curwin->w_cursor.lnum = curs;
4181 ex_no_reprint = TRUE;
4182}
4183
4184/*
4185 * Check if the restricted flag is set.
4186 * If so, give an error message and return TRUE.
4187 * Otherwise, return FALSE.
4188 */
4189 int
4190check_restricted()
4191{
4192 if (restricted)
4193 {
4194 EMSG(_("E145: Shell commands not allowed in rvim"));
4195 return TRUE;
4196 }
4197 return FALSE;
4198}
4199
4200/*
4201 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4202 * If so, give an error message and return TRUE.
4203 * Otherwise, return FALSE.
4204 */
4205 int
4206check_secure()
4207{
4208 if (secure)
4209 {
4210 secure = 2;
4211 EMSG(_(e_curdir));
4212 return TRUE;
4213 }
4214#ifdef HAVE_SANDBOX
4215 /*
4216 * In the sandbox more things are not allowed, including the things
4217 * disallowed in secure mode.
4218 */
4219 if (sandbox != 0)
4220 {
4221 EMSG(_(e_sandbox));
4222 return TRUE;
4223 }
4224#endif
4225 return FALSE;
4226}
4227
4228static char_u *old_sub = NULL; /* previous substitute pattern */
4229static int global_need_beginline; /* call beginline() after ":g" */
4230
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231/* do_sub()
4232 *
4233 * Perform a substitution from line eap->line1 to line eap->line2 using the
4234 * command pointed to by eap->arg which should be of the form:
4235 *
4236 * /pattern/substitution/{flags}
4237 *
4238 * The usual escapes are supported as described in the regexp docs.
4239 */
4240 void
4241do_sub(eap)
4242 exarg_T *eap;
4243{
4244 linenr_T lnum;
4245 long i = 0;
4246 regmmatch_T regmatch;
4247 static int do_all = FALSE; /* do multiple substitutions per line */
4248 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004249 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 static int do_error = TRUE; /* if false, ignore errors */
4251 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004252 static int do_list = FALSE; /* list last line with subs. */
4253 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 static int do_ic = 0; /* ignore case flag */
4255 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4256 int delimiter;
4257 int sublen;
4258 int got_quit = FALSE;
4259 int got_match = FALSE;
4260 int temp;
4261 int which_pat;
4262 char_u *cmd;
4263 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004264 linenr_T first_line = 0; /* first changed line */
4265 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 * change */
4267 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4268 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004269 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004270 char_u *sub_firstline; /* allocated copy of first sub line */
4271 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004272 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar46475522010-03-23 17:36:29 +01004273 int start_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
4275 cmd = eap->arg;
4276 if (!global_busy)
4277 {
4278 sub_nsubs = 0;
4279 sub_nlines = 0;
4280 }
Bram Moolenaar46475522010-03-23 17:36:29 +01004281 start_nsubs = sub_nsubs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 if (eap->cmdidx == CMD_tilde)
4284 which_pat = RE_LAST; /* use last used regexp */
4285 else
4286 which_pat = RE_SUBST; /* use last substitute regexp */
4287
4288 /* new pattern and substitution */
4289 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4290 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4291 {
4292 /* don't accept alphanumeric for separator */
4293 if (isalpha(*cmd))
4294 {
4295 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4296 return;
4297 }
4298 /*
4299 * undocumented vi feature:
4300 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4301 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4302 */
4303 if (*cmd == '\\')
4304 {
4305 ++cmd;
4306 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4307 {
4308 EMSG(_(e_backslash));
4309 return;
4310 }
4311 if (*cmd != '&')
4312 which_pat = RE_SEARCH; /* use last '/' pattern */
4313 pat = (char_u *)""; /* empty search pattern */
4314 delimiter = *cmd++; /* remember delimiter character */
4315 }
4316 else /* find the end of the regexp */
4317 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004318#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4319 if (p_altkeymap && curwin->w_p_rl)
4320 lrF_sub(cmd);
4321#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 which_pat = RE_LAST; /* use last used regexp */
4323 delimiter = *cmd++; /* remember delimiter character */
4324 pat = cmd; /* remember start of search pat */
4325 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4326 if (cmd[0] == delimiter) /* end delimiter found */
4327 *cmd++ = NUL; /* replace it with a NUL */
4328 }
4329
4330 /*
4331 * Small incompatibility: vi sees '\n' as end of the command, but in
4332 * Vim we want to use '\n' to find/substitute a NUL.
4333 */
4334 sub = cmd; /* remember the start of the substitution */
4335
4336 while (cmd[0])
4337 {
4338 if (cmd[0] == delimiter) /* end delimiter found */
4339 {
4340 *cmd++ = NUL; /* replace it with a NUL */
4341 break;
4342 }
4343 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4344 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004345 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 }
4347
4348 if (!eap->skip)
4349 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004350 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4351 if (STRCMP(sub, "%") == 0
4352 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4353 {
4354 if (old_sub == NULL) /* there is no previous command */
4355 {
4356 EMSG(_(e_nopresub));
4357 return;
4358 }
4359 sub = old_sub;
4360 }
4361 else
4362 {
4363 vim_free(old_sub);
4364 old_sub = vim_strsave(sub);
4365 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 }
4367 }
4368 else if (!eap->skip) /* use previous pattern and substitution */
4369 {
4370 if (old_sub == NULL) /* there is no previous command */
4371 {
4372 EMSG(_(e_nopresub));
4373 return;
4374 }
4375 pat = NULL; /* search_regcomp() will use previous pattern */
4376 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004377
4378 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4379 * last column after using "$". */
4380 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 }
4382
4383 /*
4384 * Find trailing options. When '&' is used, keep old options.
4385 */
4386 if (*cmd == '&')
4387 ++cmd;
4388 else
4389 {
4390 if (!p_ed)
4391 {
4392 if (p_gd) /* default is global on */
4393 do_all = TRUE;
4394 else
4395 do_all = FALSE;
4396 do_ask = FALSE;
4397 }
4398 do_error = TRUE;
4399 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004400 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004401 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 do_ic = 0;
4403 }
4404 while (*cmd)
4405 {
4406 /*
4407 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4408 * 'r' is never inverted.
4409 */
4410 if (*cmd == 'g')
4411 do_all = !do_all;
4412 else if (*cmd == 'c')
4413 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004414 else if (*cmd == 'n')
4415 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 else if (*cmd == 'e')
4417 do_error = !do_error;
4418 else if (*cmd == 'r') /* use last used regexp */
4419 which_pat = RE_LAST;
4420 else if (*cmd == 'p')
4421 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004422 else if (*cmd == '#')
4423 {
4424 do_print = TRUE;
4425 do_number = TRUE;
4426 }
4427 else if (*cmd == 'l')
4428 {
4429 do_print = TRUE;
4430 do_list = TRUE;
4431 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 else if (*cmd == 'i') /* ignore case */
4433 do_ic = 'i';
4434 else if (*cmd == 'I') /* don't ignore case */
4435 do_ic = 'I';
4436 else
4437 break;
4438 ++cmd;
4439 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004440 if (do_count)
4441 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442
4443 /*
4444 * check for a trailing count
4445 */
4446 cmd = skipwhite(cmd);
4447 if (VIM_ISDIGIT(*cmd))
4448 {
4449 i = getdigits(&cmd);
4450 if (i <= 0 && !eap->skip && do_error)
4451 {
4452 EMSG(_(e_zerocount));
4453 return;
4454 }
4455 eap->line1 = eap->line2;
4456 eap->line2 += i - 1;
4457 if (eap->line2 > curbuf->b_ml.ml_line_count)
4458 eap->line2 = curbuf->b_ml.ml_line_count;
4459 }
4460
4461 /*
4462 * check for trailing command or garbage
4463 */
4464 cmd = skipwhite(cmd);
4465 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4466 {
4467 eap->nextcmd = check_nextcmd(cmd);
4468 if (eap->nextcmd == NULL)
4469 {
4470 EMSG(_(e_trailing));
4471 return;
4472 }
4473 }
4474
4475 if (eap->skip) /* not executing commands, only parsing */
4476 return;
4477
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004478 if (!do_count && !curbuf->b_p_ma)
4479 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004480 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004481 EMSG(_(e_modifiable));
4482 return;
4483 }
4484
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4486 {
4487 if (do_error)
4488 EMSG(_(e_invcmd));
4489 return;
4490 }
4491
4492 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4493 if (do_ic == 'i')
4494 regmatch.rmm_ic = TRUE;
4495 else if (do_ic == 'I')
4496 regmatch.rmm_ic = FALSE;
4497
4498 sub_firstline = NULL;
4499
4500 /*
4501 * ~ in the substitute pattern is replaced with the old pattern.
4502 * We do it here once to avoid it to be replaced over and over again.
4503 * But don't do it when it starts with "\=", then it's an expression.
4504 */
4505 if (!(sub[0] == '\\' && sub[1] == '='))
4506 sub = regtilde(sub, p_magic);
4507
4508 /*
4509 * Check for a match on each line.
4510 */
4511 line2 = eap->line2;
4512 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4513#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4514 || aborting()
4515#endif
4516 ); ++lnum)
4517 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004518 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4519 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 if (nmatch)
4521 {
4522 colnr_T copycol;
4523 colnr_T matchcol;
4524 colnr_T prev_matchcol = MAXCOL;
4525 char_u *new_end, *new_start = NULL;
4526 unsigned new_start_len = 0;
4527 char_u *p1;
4528 int did_sub = FALSE;
4529 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004530 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 long nmatch_tl = 0; /* nr of lines matched below lnum */
4532 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004533 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004534 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535
4536 /*
4537 * The new text is build up step by step, to avoid too much
4538 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004539 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 * copycol Column in the old text where we started
4541 * looking for a match; from here old text still
4542 * needs to be copied to the new text.
4543 * matchcol Column number of the old text where to look
4544 * for the next match. It's just after the
4545 * previous match or one further.
4546 * prev_matchcol Column just after the previous match (if any).
4547 * Mostly equal to matchcol, except for the first
4548 * match and after skipping an empty match.
4549 * regmatch.*pos Where the pattern matched in the old text.
4550 * new_start The new text, all that has been produced so
4551 * far.
4552 * new_end The new text, where to append new text.
4553 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004554 * lnum The line number where we found the start of
4555 * the match. Can be below the line we searched
4556 * when there is a \n before a \zs in the
4557 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 * sub_firstlnum The line number in the buffer where to look
4559 * for a match. Can be different from "lnum"
4560 * when the pattern or substitute string contains
4561 * line breaks.
4562 *
4563 * Special situations:
4564 * - When the substitute string contains a line break, the part up
4565 * to the line break is inserted in the text, but the copy of
4566 * the original line is kept. "sub_firstlnum" is adjusted for
4567 * the inserted lines.
4568 * - When the matched pattern contains a line break, the old line
4569 * is taken from the line at the end of the pattern. The lines
4570 * in the match are deleted later, "sub_firstlnum" is adjusted
4571 * accordingly.
4572 *
4573 * The new text is built up in new_start[]. It has some extra
4574 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004575 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 *
4577 * Make a copy of the old line, so it won't be taken away when
4578 * updating the screen or handling a multi-line match. The "old_"
4579 * pointers point into this copy.
4580 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004581 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 copycol = 0;
4583 matchcol = 0;
4584
4585 /* At first match, remember current cursor position. */
4586 if (!got_match)
4587 {
4588 setpcmark();
4589 got_match = TRUE;
4590 }
4591
4592 /*
4593 * Loop until nothing more to replace in this line.
4594 * 1. Handle match with empty string.
4595 * 2. If do_ask is set, ask for confirmation.
4596 * 3. substitute the string.
4597 * 4. if do_all is set, find next match
4598 * 5. break if there isn't another match in this line
4599 */
4600 for (;;)
4601 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004602 /* Advance "lnum" to the line where the match starts. The
4603 * match does not start in the first line when there is a line
4604 * break before \zs. */
4605 if (regmatch.startpos[0].lnum > 0)
4606 {
4607 lnum += regmatch.startpos[0].lnum;
4608 sub_firstlnum += regmatch.startpos[0].lnum;
4609 nmatch -= regmatch.startpos[0].lnum;
4610 vim_free(sub_firstline);
4611 sub_firstline = NULL;
4612 }
4613
4614 if (sub_firstline == NULL)
4615 {
4616 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4617 if (sub_firstline == NULL)
4618 {
4619 vim_free(new_start);
4620 goto outofmem;
4621 }
4622 }
4623
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 /* Save the line number of the last change for the final
4625 * cursor position (just like Vi). */
4626 curwin->w_cursor.lnum = lnum;
4627 do_again = FALSE;
4628
4629 /*
4630 * 1. Match empty string does not count, except for first
4631 * match. This reproduces the strange vi behaviour.
4632 * This also catches endless loops.
4633 */
4634 if (matchcol == prev_matchcol
4635 && regmatch.endpos[0].lnum == 0
4636 && matchcol == regmatch.endpos[0].col)
4637 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004638 if (sub_firstline[matchcol] == NUL)
4639 /* We already were at the end of the line. Don't look
4640 * for a match in this line again. */
4641 skip_match = TRUE;
4642 else
4643 ++matchcol; /* search for a match at next column */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 goto skip;
4645 }
4646
4647 /* Normally we continue searching for a match just after the
4648 * previous match. */
4649 matchcol = regmatch.endpos[0].col;
4650 prev_matchcol = matchcol;
4651
4652 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004653 * 2. If do_count is set only increase the counter.
4654 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004656 if (do_count)
4657 {
4658 /* For a multi-line match, put matchcol at the NUL at
4659 * the end of the line and set nmatch to one, so that
4660 * we continue looking for a match on the next line.
4661 * Avoids that ":s/\nB\@=//gc" get stuck. */
4662 if (nmatch > 1)
4663 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004664 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004665 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004666 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004667 }
4668 sub_nsubs++;
4669 did_sub = TRUE;
4670 goto skip;
4671 }
4672
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 if (do_ask)
4674 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004675 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004676
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 /* change State to CONFIRM, so that the mouse works
4678 * properly */
4679 save_State = State;
4680 State = CONFIRM;
4681#ifdef FEAT_MOUSE
4682 setmouse(); /* disable mouse in xterm */
4683#endif
4684 curwin->w_cursor.col = regmatch.startpos[0].col;
4685
4686 /* When 'cpoptions' contains "u" don't sync undo when
4687 * asking for confirmation. */
4688 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4689 ++no_u_sync;
4690
4691 /*
4692 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4693 */
4694 while (do_ask)
4695 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004696 if (exmode_active)
4697 {
4698 char_u *resp;
4699 colnr_T sc, ec;
4700
4701 print_line_no_prefix(lnum, FALSE, FALSE);
4702
4703 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4704 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4705 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4706 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004707 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004708 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004709 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004710 msg_putchar('^');
4711
4712 resp = getexmodeline('?', NULL, 0);
4713 if (resp != NULL)
4714 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004715 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004716 vim_free(resp);
4717 }
4718 }
4719 else
4720 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004722 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004724 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004726 /* Invert the matched string.
4727 * Remove the inversion afterwards. */
4728 temp = RedrawingDisabled;
4729 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004731 search_match_lines = regmatch.endpos[0].lnum
4732 - regmatch.startpos[0].lnum;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004733 search_match_endcol = regmatch.endpos[0].col;
4734 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004736 update_topline();
4737 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004738 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004739 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004740 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741
4742#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004743 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004745 if (msg_row == Rows - 1)
4746 msg_didout = FALSE; /* avoid a scroll-up */
4747 msg_starthere();
4748 i = msg_scroll;
4749 msg_scroll = 0; /* truncate msg when
4750 needed */
4751 msg_no_more = TRUE;
4752 /* write message same highlighting as for
4753 * wait_return */
4754 smsg_attr(hl_attr(HLF_R),
4755 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4756 msg_no_more = FALSE;
4757 msg_scroll = i;
4758 showruler(TRUE);
4759 windgoto(msg_row, msg_col);
4760 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761
4762#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004763 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004765 ++no_mapping; /* don't map this key */
4766 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004767 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004768 --allow_keys;
4769 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004771 /* clear the question */
4772 msg_didout = FALSE; /* don't scroll up */
4773 msg_col = 0;
4774 gotocmdline(TRUE);
4775 }
4776
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004778 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004780 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781#endif
4782 )
4783 {
4784 got_quit = TRUE;
4785 break;
4786 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004787 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004789 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004791 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 {
4793 /* last: replace and then stop */
4794 do_all = FALSE;
4795 line2 = lnum;
4796 break;
4797 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004798 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 {
4800 do_ask = FALSE;
4801 break;
4802 }
4803#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004804 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004806 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807 scrolldown_clamp();
4808#endif
4809 }
4810 State = save_State;
4811#ifdef FEAT_MOUSE
4812 setmouse();
4813#endif
4814 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4815 --no_u_sync;
4816
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004817 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 {
4819 /* For a multi-line match, put matchcol at the NUL at
4820 * the end of the line and set nmatch to one, so that
4821 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004822 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4823 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 if (nmatch > 1)
4825 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004826 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004827 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 }
4829 goto skip;
4830 }
4831 if (got_quit)
4832 break;
4833 }
4834
4835 /* Move the cursor to the start of the match, so that we can
4836 * use "\=col("."). */
4837 curwin->w_cursor.col = regmatch.startpos[0].col;
4838
4839 /*
4840 * 3. substitute the string.
4841 */
4842 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004843 sublen = vim_regsub_multi(&regmatch,
4844 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 sub, sub_firstline, FALSE, p_magic, TRUE);
4846
Bram Moolenaar4463f292005-09-25 22:20:24 +00004847 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004848 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004849 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4850 {
4851 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4852 skip_match = TRUE;
4853 }
4854
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 /* Need room for:
4856 * - result so far in new_start (not for first sub in line)
4857 * - original text up to match
4858 * - length of substituted part
4859 * - original text after match
4860 */
4861 if (nmatch == 1)
4862 p1 = sub_firstline;
4863 else
4864 {
4865 p1 = ml_get(sub_firstlnum + nmatch - 1);
4866 nmatch_tl += nmatch - 1;
4867 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004868 copy_len = regmatch.startpos[0].col - copycol;
4869 needed_len = copy_len + ((unsigned)STRLEN(p1)
4870 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 if (new_start == NULL)
4872 {
4873 /*
4874 * Get some space for a temporary buffer to do the
4875 * substitution into (and some extra space to avoid
4876 * too many calls to alloc()/free()).
4877 */
4878 new_start_len = needed_len + 50;
4879 if ((new_start = alloc_check(new_start_len)) == NULL)
4880 goto outofmem;
4881 *new_start = NUL;
4882 new_end = new_start;
4883 }
4884 else
4885 {
4886 /*
4887 * Check if the temporary buffer is long enough to do the
4888 * substitution into. If not, make it larger (with a bit
4889 * extra to avoid too many calls to alloc()/free()).
4890 */
4891 len = (unsigned)STRLEN(new_start);
4892 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004893 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 {
4895 new_start_len = needed_len + 50;
4896 if ((p1 = alloc_check(new_start_len)) == NULL)
4897 {
4898 vim_free(new_start);
4899 goto outofmem;
4900 }
4901 mch_memmove(p1, new_start, (size_t)(len + 1));
4902 vim_free(new_start);
4903 new_start = p1;
4904 }
4905 new_end = new_start + len;
4906 }
4907
4908 /*
4909 * copy the text up to the part that matched
4910 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004911 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4912 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004914 (void)vim_regsub_multi(&regmatch,
4915 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 sub, new_end, TRUE, p_magic, TRUE);
4917 sub_nsubs++;
4918 did_sub = TRUE;
4919
4920 /* Move the cursor to the start of the line, to avoid that it
4921 * is beyond the end of the line after the substitution. */
4922 curwin->w_cursor.col = 0;
4923
4924 /* For a multi-line match, make a copy of the last matched
4925 * line and continue in that one. */
4926 if (nmatch > 1)
4927 {
4928 sub_firstlnum += nmatch - 1;
4929 vim_free(sub_firstline);
4930 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4931 /* When going beyond the last line, stop substituting. */
4932 if (sub_firstlnum <= line2)
4933 do_again = TRUE;
4934 else
4935 do_all = FALSE;
4936 }
4937
4938 /* Remember next character to be copied. */
4939 copycol = regmatch.endpos[0].col;
4940
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004941 if (skip_match)
4942 {
4943 /* Already hit end of the buffer, sub_firstlnum is one
4944 * less than what it ought to be. */
4945 vim_free(sub_firstline);
4946 sub_firstline = vim_strsave((char_u *)"");
4947 copycol = 0;
4948 }
4949
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 /*
4951 * Now the trick is to replace CTRL-M chars with a real line
4952 * break. This would make it impossible to insert a CTRL-M in
4953 * the text. The line break can be avoided by preceding the
4954 * CTRL-M with a backslash. To be able to insert a backslash,
4955 * they must be doubled in the string and are halved here.
4956 * That is Vi compatible.
4957 */
4958 for (p1 = new_end; *p1; ++p1)
4959 {
4960 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004961 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 else if (*p1 == CAR)
4963 {
4964 if (u_inssub(lnum) == OK) /* prepare for undo */
4965 {
4966 *p1 = NUL; /* truncate up to the CR */
4967 ml_append(lnum - 1, new_start,
4968 (colnr_T)(p1 - new_start + 1), FALSE);
4969 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4970 if (do_ask)
4971 appended_lines(lnum - 1, 1L);
4972 else
4973 {
4974 if (first_line == 0)
4975 first_line = lnum;
4976 last_line = lnum + 1;
4977 }
4978 /* All line numbers increase. */
4979 ++sub_firstlnum;
4980 ++lnum;
4981 ++line2;
4982 /* move the cursor to the new line, like Vi */
4983 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00004984 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004985 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 p1 = new_start - 1;
4987 }
4988 }
4989#ifdef FEAT_MBYTE
4990 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004991 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992#endif
4993 }
4994
4995 /*
4996 * 4. If do_all is set, find next match.
4997 * Prevent endless loop with patterns that match empty
4998 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4999 * But ":s/\n/#/" is OK.
5000 */
5001skip:
5002 /* We already know that we did the last subst when we are at
5003 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005004 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
5005 * "line2" when there is a \zs in the pattern after a line
5006 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00005007 lastone = (skip_match
5008 || got_int
5009 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005010 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00005011 || !(do_all || do_again)
5012 || (sub_firstline[matchcol] == NUL && nmatch <= 1
5013 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014 nmatch = -1;
5015
5016 /*
5017 * Replace the line in the buffer when needed. This is
5018 * skipped when there are more matches.
5019 * The check for nmatch_tl is needed for when multi-line
5020 * matching must replace the lines before trying to do another
5021 * match, otherwise "\@<=" won't work.
5022 * When asking the user we like to show the already replaced
5023 * text, but don't do it when "\<@=" or "\<@!" is used, it
5024 * changes what matches.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005025 * When the match starts below where we start searching also
5026 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 */
5028 if (lastone
5029 || (do_ask && !re_lookbehind(regmatch.regprog))
5030 || nmatch_tl > 0
5031 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005032 curbuf, sub_firstlnum,
5033 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005034 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 {
5036 if (new_start != NULL)
5037 {
5038 /*
5039 * Copy the rest of the line, that didn't match.
5040 * "matchcol" has to be adjusted, we use the end of
5041 * the line as reference, because the substitute may
5042 * have changed the number of characters. Same for
5043 * "prev_matchcol".
5044 */
5045 STRCAT(new_start, sub_firstline + copycol);
5046 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5047 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5048 - prev_matchcol;
5049
5050 if (u_savesub(lnum) != OK)
5051 break;
5052 ml_replace(lnum, new_start, TRUE);
5053
5054 if (nmatch_tl > 0)
5055 {
5056 /*
5057 * Matched lines have now been substituted and are
5058 * useless, delete them. The part after the match
5059 * has been appended to new_start, we don't need
5060 * it in the buffer.
5061 */
5062 ++lnum;
5063 if (u_savedel(lnum, nmatch_tl) != OK)
5064 break;
5065 for (i = 0; i < nmatch_tl; ++i)
5066 ml_delete(lnum, (int)FALSE);
5067 mark_adjust(lnum, lnum + nmatch_tl - 1,
5068 (long)MAXLNUM, -nmatch_tl);
5069 if (do_ask)
5070 deleted_lines(lnum, nmatch_tl);
5071 --lnum;
5072 line2 -= nmatch_tl; /* nr of lines decreases */
5073 nmatch_tl = 0;
5074 }
5075
5076 /* When asking, undo is saved each time, must also set
5077 * changed flag each time. */
5078 if (do_ask)
5079 changed_bytes(lnum, 0);
5080 else
5081 {
5082 if (first_line == 0)
5083 first_line = lnum;
5084 last_line = lnum + 1;
5085 }
5086
5087 sub_firstlnum = lnum;
5088 vim_free(sub_firstline); /* free the temp buffer */
5089 sub_firstline = new_start;
5090 new_start = NULL;
5091 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5092 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5093 - prev_matchcol;
5094 copycol = 0;
5095 }
5096 if (nmatch == -1 && !lastone)
5097 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005098 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099
5100 /*
5101 * 5. break if there isn't another match in this line
5102 */
5103 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005104 {
5105 /* If the match found didn't start where we were
5106 * searching, do the next search in the line where we
5107 * found the match. */
5108 if (nmatch == -1)
5109 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005111 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 }
5113
5114 line_breakcheck();
5115 }
5116
5117 if (did_sub)
5118 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005119 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 vim_free(sub_firstline); /* free the copy of the original line */
5121 sub_firstline = NULL;
5122 }
5123
5124 line_breakcheck();
5125 }
5126
5127 if (first_line != 0)
5128 {
5129 /* Need to subtract the number of added lines from "last_line" to get
5130 * the line number before the change (same as adding the number of
5131 * deleted lines). */
5132 i = curbuf->b_ml.ml_line_count - old_line_count;
5133 changed_lines(first_line, 0, last_line - i, i);
5134 }
5135
5136outofmem:
5137 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005138
5139 /* ":s/pat//n" doesn't move the cursor */
5140 if (do_count)
5141 curwin->w_cursor = old_cursor;
5142
Bram Moolenaar46475522010-03-23 17:36:29 +01005143 if (sub_nsubs > start_nsubs)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 {
5145 /* Set the '[ and '] marks. */
5146 curbuf->b_op_start.lnum = eap->line1;
5147 curbuf->b_op_end.lnum = line2;
5148 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5149
5150 if (!global_busy)
5151 {
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00005152 if (endcolumn)
5153 coladvance((colnr_T)MAXCOL);
5154 else
5155 beginline(BL_WHITE | BL_FIX);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005156 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 MSG("");
5158 }
5159 else
5160 global_need_beginline = TRUE;
5161 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005162 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 }
5164 else if (!global_busy)
5165 {
5166 if (got_int) /* interrupted */
5167 EMSG(_(e_interr));
5168 else if (got_match) /* did find something but nothing substituted */
5169 MSG("");
5170 else if (do_error) /* nothing found */
5171 EMSG2(_(e_patnotf2), get_search_pat());
5172 }
5173
5174 vim_free(regmatch.regprog);
5175}
5176
5177/*
5178 * Give message for number of substitutions.
5179 * Can also be used after a ":global" command.
5180 * Return TRUE if a message was given.
5181 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005182 int
Bram Moolenaar05159a02005-02-26 23:04:13 +00005183do_sub_msg(count_only)
5184 int count_only; /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185{
5186 /*
5187 * Only report substitutions when:
5188 * - more than 'report' substitutions
5189 * - command was typed by user, or number of changed lines > 'report'
5190 * - giving messages is not disabled by 'lazyredraw'
5191 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005192 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5193 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 && messaging())
5195 {
5196 if (got_int)
5197 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005198 else
5199 *msg_buf = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 if (sub_nsubs == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005201 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005202 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005204 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar05159a02005-02-26 23:04:13 +00005205 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 sub_nsubs);
5207 if (sub_nlines == 1)
Bram Moolenaara800b422010-06-27 01:15:55 +02005208 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005209 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 else
Bram Moolenaara800b422010-06-27 01:15:55 +02005211 vim_snprintf_add((char *)msg_buf, sizeof(msg_buf),
Bram Moolenaar555b2802005-05-19 21:08:39 +00005212 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005215 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 return TRUE;
5217 }
5218 if (got_int)
5219 {
5220 EMSG(_(e_interr));
5221 return TRUE;
5222 }
5223 return FALSE;
5224}
5225
5226/*
5227 * Execute a global command of the form:
5228 *
5229 * g/pattern/X : execute X on all lines where pattern matches
5230 * v/pattern/X : execute X on all lines where pattern does not match
5231 *
5232 * where 'X' is an EX command
5233 *
5234 * The command character (as well as the trailing slash) is optional, and
5235 * is assumed to be 'p' if missing.
5236 *
5237 * This is implemented in two passes: first we scan the file for the pattern and
5238 * set a mark for each line that (not) matches. secondly we execute the command
5239 * for each line that has a mark. This is required because after deleting
5240 * lines we do not know where to search for the next match.
5241 */
5242 void
5243ex_global(eap)
5244 exarg_T *eap;
5245{
5246 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005247 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 int type; /* first char of cmd: 'v' or 'g' */
5249 char_u *cmd; /* command argument */
5250
5251 char_u delim; /* delimiter, normally '/' */
5252 char_u *pat;
5253 regmmatch_T regmatch;
5254 int match;
5255 int which_pat;
5256
5257 if (global_busy)
5258 {
5259 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5260 return;
5261 }
5262
5263 if (eap->forceit) /* ":global!" is like ":vglobal" */
5264 type = 'v';
5265 else
5266 type = *eap->cmd;
5267 cmd = eap->arg;
5268 which_pat = RE_LAST; /* default: use last used regexp */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269
5270 /*
5271 * undocumented vi feature:
5272 * "\/" and "\?": use previous search pattern.
5273 * "\&": use previous substitute pattern.
5274 */
5275 if (*cmd == '\\')
5276 {
5277 ++cmd;
5278 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5279 {
5280 EMSG(_(e_backslash));
5281 return;
5282 }
5283 if (*cmd == '&')
5284 which_pat = RE_SUBST; /* use previous substitute pattern */
5285 else
5286 which_pat = RE_SEARCH; /* use previous search pattern */
5287 ++cmd;
5288 pat = (char_u *)"";
5289 }
5290 else if (*cmd == NUL)
5291 {
5292 EMSG(_("E148: Regular expression missing from global"));
5293 return;
5294 }
5295 else
5296 {
5297 delim = *cmd; /* get the delimiter */
5298 if (delim)
5299 ++cmd; /* skip delimiter if there is one */
5300 pat = cmd; /* remember start of pattern */
5301 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5302 if (cmd[0] == delim) /* end delimiter found */
5303 *cmd++ = NUL; /* replace it with a NUL */
5304 }
5305
5306#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5307 if (p_altkeymap && curwin->w_p_rl)
5308 lrFswap(pat,0);
5309#endif
5310
5311 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5312 {
5313 EMSG(_(e_invcmd));
5314 return;
5315 }
5316
5317 /*
5318 * pass 1: set marks for each (not) matching line
5319 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5321 {
5322 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005323 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5324 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 if ((type == 'g' && match) || (type == 'v' && !match))
5326 {
5327 ml_setmarked(lnum);
5328 ndone++;
5329 }
5330 line_breakcheck();
5331 }
5332
5333 /*
5334 * pass 2: execute the command for each line that has been marked
5335 */
5336 if (got_int)
5337 MSG(_(e_interr));
5338 else if (ndone == 0)
5339 {
5340 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005341 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 else
Bram Moolenaar555b2802005-05-19 21:08:39 +00005343 smsg((char_u *)_(e_patnotf2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 }
5345 else
5346 global_exe(cmd);
5347
5348 ml_clearmarked(); /* clear rest of the marks */
5349 vim_free(regmatch.regprog);
5350}
5351
5352/*
5353 * Execute "cmd" on lines marked with ml_setmarked().
5354 */
5355 void
5356global_exe(cmd)
5357 char_u *cmd;
5358{
5359 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5360 linenr_T lnum; /* line number according to old situation */
5361
5362 /*
5363 * Set current position only once for a global command.
5364 * If global_busy is set, setpcmark() will not do anything.
5365 * If there is an error, global_busy will be incremented.
5366 */
5367 setpcmark();
5368
5369 /* When the command writes a message, don't overwrite the command. */
5370 msg_didout = TRUE;
5371
Bram Moolenaard25bc232010-03-23 17:49:24 +01005372 sub_nsubs = 0;
5373 sub_nlines = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 global_need_beginline = FALSE;
5375 global_busy = 1;
5376 old_lcount = curbuf->b_ml.ml_line_count;
5377 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5378 {
5379 curwin->w_cursor.lnum = lnum;
5380 curwin->w_cursor.col = 0;
5381 if (*cmd == NUL || *cmd == '\n')
5382 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5383 else
5384 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5385 ui_breakcheck();
5386 }
5387
5388 global_busy = 0;
5389 if (global_need_beginline)
5390 beginline(BL_WHITE | BL_FIX);
5391 else
5392 check_cursor(); /* cursor may be beyond the end of the line */
5393
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005394 /* the cursor may not have moved in the text but a change in a previous
5395 * line may move it on the screen */
5396 changed_line_abv_curs();
5397
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 /* If it looks like no message was written, allow overwriting the
5399 * command with the report for number of changes. */
5400 if (msg_col == 0 && msg_scrolled == 0)
5401 msg_didout = FALSE;
5402
Bram Moolenaar45667512007-05-10 19:24:43 +00005403 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 * number of extra or deleted lines. */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005405 if (!do_sub_msg(FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5407}
5408
5409#ifdef FEAT_VIMINFO
5410 int
5411read_viminfo_sub_string(virp, force)
5412 vir_T *virp;
5413 int force;
5414{
5415 if (old_sub != NULL && force)
5416 vim_free(old_sub);
5417 if (force || old_sub == NULL)
5418 old_sub = viminfo_readstring(virp, 1, TRUE);
5419 return viminfo_readline(virp);
5420}
5421
5422 void
5423write_viminfo_sub_string(fp)
5424 FILE *fp;
5425{
5426 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5427 {
Bram Moolenaar2f1e0502010-08-13 11:18:02 +02005428 fputs(_("\n# Last Substitute String:\n$"), fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 viminfo_writestring(fp, old_sub);
5430 }
5431}
5432#endif /* FEAT_VIMINFO */
5433
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005434#if defined(EXITFREE) || defined(PROTO)
5435 void
5436free_old_sub()
5437{
5438 vim_free(old_sub);
5439}
5440#endif
5441
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5443/*
5444 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005445 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005447 int
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005448prepare_tagpreview(undo_sync)
5449 int undo_sync; /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450{
5451 win_T *wp;
5452
5453# ifdef FEAT_GUI
5454 need_mouse_correct = TRUE;
5455# endif
5456
5457 /*
5458 * If there is already a preview window open, use that one.
5459 */
5460 if (!curwin->w_p_pvw)
5461 {
5462 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5463 if (wp->w_p_pvw)
5464 break;
5465 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005466 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 else
5468 {
5469 /*
5470 * There is no preview window open yet. Create one.
5471 */
5472 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5473 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005474 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 curwin->w_p_pvw = TRUE;
5476 curwin->w_p_wfh = TRUE;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02005477 RESET_BINDING(curwin); /* don't take over 'scrollbind'
5478 and 'cursorbind' */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479# ifdef FEAT_DIFF
5480 curwin->w_p_diff = FALSE; /* no 'diff' */
5481# endif
5482# ifdef FEAT_FOLDING
5483 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5484# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005485 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 }
5487 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005488 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489}
5490
5491#endif
5492
5493
5494/*
5495 * ":help": open a read-only window on a help file
5496 */
5497 void
5498ex_help(eap)
5499 exarg_T *eap;
5500{
5501 char_u *arg;
5502 char_u *tag;
5503 FILE *helpfd; /* file descriptor of help file */
5504 int n;
5505 int i;
5506#ifdef FEAT_WINDOWS
5507 win_T *wp;
5508#endif
5509 int num_matches;
5510 char_u **matches;
5511 char_u *p;
5512 int empty_fnum = 0;
5513 int alt_fnum = 0;
5514 buf_T *buf;
5515#ifdef FEAT_MULTI_LANG
5516 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005517 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518#endif
5519
5520 if (eap != NULL)
5521 {
5522 /*
5523 * A ":help" command ends at the first LF, or at a '|' that is
5524 * followed by some text. Set nextcmd to the following command.
5525 */
5526 for (arg = eap->arg; *arg; ++arg)
5527 {
5528 if (*arg == '\n' || *arg == '\r'
5529 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5530 {
5531 *arg++ = NUL;
5532 eap->nextcmd = arg;
5533 break;
5534 }
5535 }
5536 arg = eap->arg;
5537
5538 if (eap->forceit && *arg == NUL)
5539 {
5540 EMSG(_("E478: Don't panic!"));
5541 return;
5542 }
5543
5544 if (eap->skip) /* not executing commands */
5545 return;
5546 }
5547 else
5548 arg = (char_u *)"";
5549
5550 /* remove trailing blanks */
5551 p = arg + STRLEN(arg) - 1;
5552 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5553 *p-- = NUL;
5554
5555#ifdef FEAT_MULTI_LANG
5556 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005557 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558#endif
5559
5560 /* When no argument given go to the index. */
5561 if (*arg == NUL)
5562 arg = (char_u *)"help.txt";
5563
5564 /*
5565 * Check if there is a match for the argument.
5566 */
5567 n = find_help_tags(arg, &num_matches, &matches,
5568 eap != NULL && eap->forceit);
5569
5570 i = 0;
5571#ifdef FEAT_MULTI_LANG
5572 if (n != FAIL && lang != NULL)
5573 /* Find first item with the requested language. */
5574 for (i = 0; i < num_matches; ++i)
5575 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005576 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 if (len > 3 && matches[i][len - 3] == '@'
5578 && STRICMP(matches[i] + len - 2, lang) == 0)
5579 break;
5580 }
5581#endif
5582 if (i >= num_matches || n == FAIL)
5583 {
5584#ifdef FEAT_MULTI_LANG
5585 if (lang != NULL)
5586 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5587 else
5588#endif
5589 EMSG2(_("E149: Sorry, no help for %s"), arg);
5590 if (n != FAIL)
5591 FreeWild(num_matches, matches);
5592 return;
5593 }
5594
5595 /* The first match (in the requested language) is the best match. */
5596 tag = vim_strsave(matches[i]);
5597 FreeWild(num_matches, matches);
5598
5599#ifdef FEAT_GUI
5600 need_mouse_correct = TRUE;
5601#endif
5602
5603 /*
5604 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005605 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005607 if (!curwin->w_buffer->b_help
5608#ifdef FEAT_WINDOWS
5609 || cmdmod.tab != 0
5610#endif
5611 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 {
5613#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005614 if (cmdmod.tab != 0)
5615 wp = NULL;
5616 else
5617 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5618 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5619 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5621 win_enter(wp, TRUE);
5622 else
5623#endif
5624 {
5625 /*
5626 * There is no help window yet.
5627 * Try to open the file specified by the "helpfile" option.
5628 */
5629 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5630 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00005631 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005632 goto erret;
5633 }
5634 fclose(helpfd);
5635
5636#ifdef FEAT_WINDOWS
5637 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005638 * specified, the current window is vertically split and
5639 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 n = WSP_HELP;
5641# ifdef FEAT_VERTSPLIT
5642 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005643 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 n |= WSP_TOP;
5645# endif
5646 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005647 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648#else
5649 /* use current window */
5650 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005652#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653
5654#ifdef FEAT_WINDOWS
5655 if (curwin->w_height < p_hh)
5656 win_setheight((int)p_hh);
5657#endif
5658
5659 /*
5660 * Open help file (do_ecmd() will set b_help flag, readfile() will
5661 * set b_p_ro flag).
5662 * Set the alternate file to the previously edited file.
5663 */
5664 alt_fnum = curbuf->b_fnum;
5665 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005666 ECMD_HIDE + ECMD_SET_HELP,
5667#ifdef FEAT_WINDOWS
5668 NULL /* buffer is still open, don't store info */
5669#else
5670 curwin
5671#endif
5672 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005673 if (!cmdmod.keepalt)
5674 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 empty_fnum = curbuf->b_fnum;
5676 }
5677 }
5678
5679 if (!p_im)
5680 restart_edit = 0; /* don't want insert mode in help file */
5681
5682 if (tag != NULL)
5683 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5684
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005685 /* Delete the empty buffer if we're not using it. Careful: autocommands
5686 * may have jumped to another window, check that the buffer is not in a
5687 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5689 {
5690 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005691 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 wipe_buffer(buf, TRUE);
5693 }
5694
5695 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005696 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 curwin->w_alt_fnum = alt_fnum;
5698
5699erret:
5700 vim_free(tag);
5701}
5702
5703
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005704#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5705/*
5706 * In an argument search for a language specifiers in the form "@xx".
5707 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5708 * Returns NULL if not found.
5709 */
5710 char_u *
5711check_help_lang(arg)
5712 char_u *arg;
5713{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005714 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005715
5716 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5717 && ASCII_ISALPHA(arg[len - 1]))
5718 {
5719 arg[len - 3] = NUL; /* remove the '@' */
5720 return arg + len - 2;
5721 }
5722 return NULL;
5723}
5724#endif
5725
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726/*
5727 * Return a heuristic indicating how well the given string matches. The
5728 * smaller the number, the better the match. This is the order of priorities,
5729 * from best match to worst match:
5730 * - Match with least alpha-numeric characters is better.
5731 * - Match with least total characters is better.
5732 * - Match towards the start is better.
5733 * - Match starting with "+" is worse (feature instead of command)
5734 * Assumption is made that the matched_string passed has already been found to
5735 * match some string for which help is requested. webb.
5736 */
5737 int
5738help_heuristic(matched_string, offset, wrong_case)
5739 char_u *matched_string;
5740 int offset; /* offset for match */
5741 int wrong_case; /* no matching case */
5742{
5743 int num_letters;
5744 char_u *p;
5745
5746 num_letters = 0;
5747 for (p = matched_string; *p; p++)
5748 if (ASCII_ISALNUM(*p))
5749 num_letters++;
5750
5751 /*
5752 * Multiply the number of letters by 100 to give it a much bigger
5753 * weighting than the number of characters.
5754 * If there only is a match while ignoring case, add 5000.
5755 * If the match starts in the middle of a word, add 10000 to put it
5756 * somewhere in the last half.
5757 * If the match is more than 2 chars from the start, multiply by 200 to
5758 * put it after matches at the start.
5759 */
5760 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5761 && ASCII_ISALNUM(matched_string[offset - 1]))
5762 offset += 10000;
5763 else if (offset > 2)
5764 offset *= 200;
5765 if (wrong_case)
5766 offset += 5000;
5767 /* Features are less interesting than the subjects themselves, but "+"
5768 * alone is not a feature. */
5769 if (matched_string[0] == '+' && matched_string[1] != NUL)
5770 offset += 100;
5771 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5772}
5773
5774/*
5775 * Compare functions for qsort() below, that checks the help heuristics number
5776 * that has been put after the tagname by find_tags().
5777 */
5778 static int
5779#ifdef __BORLANDC__
5780_RTLENTRYF
5781#endif
5782help_compare(s1, s2)
5783 const void *s1;
5784 const void *s2;
5785{
5786 char *p1;
5787 char *p2;
5788
5789 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5790 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5791 return strcmp(p1, p2);
5792}
5793
5794/*
5795 * Find all help tags matching "arg", sort them and return in matches[], with
5796 * the number of matches in num_matches.
5797 * The matches will be sorted with a "best" match algorithm.
5798 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5799 */
5800 int
5801find_help_tags(arg, num_matches, matches, keep_lang)
5802 char_u *arg;
5803 int *num_matches;
5804 char_u ***matches;
5805 int keep_lang;
5806{
5807 char_u *s, *d;
5808 int i;
5809 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005810 "/*", "/\\*", "\"*", "**",
5811 "/\\(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005812 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005813 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 "[count]", "[quotex]", "[range]",
5815 "[pattern]", "\\|", "\\%$"};
5816 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005817 "/star", "/\\\\star", "quotestar", "starstar",
5818 "/\\\\(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005819 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005820 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 "\\[count]", "\\[quotex]", "\\[range]",
5822 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5823 int flags;
5824
5825 d = IObuff; /* assume IObuff is long enough! */
5826
5827 /*
5828 * Recognize a few exceptions to the rule. Some strings that contain '*'
5829 * with "star". Otherwise '*' is recognized as a wildcard.
5830 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005831 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 if (STRCMP(arg, mtable[i]) == 0)
5833 {
5834 STRCPY(d, rtable[i]);
5835 break;
5836 }
5837
5838 if (i < 0) /* no match in table */
5839 {
5840 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5841 * Also replace "\%^" and "\%(", they match every tag too.
5842 * Also "\zs", "\z1", etc.
5843 * Also "\@<", "\@=", "\@<=", etc.
5844 * And also "\_$" and "\_^". */
5845 if (arg[0] == '\\'
5846 && ((arg[1] != NUL && arg[2] == NUL)
5847 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5848 && arg[2] != NUL)))
5849 {
5850 STRCPY(d, "/\\\\");
5851 STRCPY(d + 3, arg + 1);
5852 /* Check for "/\\_$", should be "/\\_\$" */
5853 if (d[3] == '_' && d[4] == '$')
5854 STRCPY(d + 4, "\\$");
5855 }
5856 else
5857 {
5858 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5859 if (arg[0] == '[' && (arg[1] == ':'
5860 || (arg[1] == '+' && arg[2] == '+')))
5861 *d++ = '\\';
5862
5863 for (s = arg; *s; ++s)
5864 {
5865 /*
5866 * Replace "|" with "bar" and '"' with "quote" to match the name of
5867 * the tags for these commands.
5868 * Replace "*" with ".*" and "?" with "." to match command line
5869 * completion.
5870 * Insert a backslash before '~', '$' and '.' to avoid their
5871 * special meaning.
5872 */
5873 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5874 break;
5875 switch (*s)
5876 {
5877 case '|': STRCPY(d, "bar");
5878 d += 3;
5879 continue;
5880 case '"': STRCPY(d, "quote");
5881 d += 5;
5882 continue;
5883 case '*': *d++ = '.';
5884 break;
5885 case '?': *d++ = '.';
5886 continue;
5887 case '$':
5888 case '.':
5889 case '~': *d++ = '\\';
5890 break;
5891 }
5892
5893 /*
5894 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5895 * ":help i_^_CTRL-D" work.
5896 * Insert '-' before and after "CTRL-X" when applicable.
5897 */
5898 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5899 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5900 {
5901 if (d > IObuff && d[-1] != '_')
5902 *d++ = '_'; /* prepend a '_' */
5903 STRCPY(d, "CTRL-");
5904 d += 5;
5905 if (*s < ' ')
5906 {
5907#ifdef EBCDIC
5908 *d++ = CtrlChar(*s);
5909#else
5910 *d++ = *s + '@';
5911#endif
5912 if (d[-1] == '\\')
5913 *d++ = '\\'; /* double a backslash */
5914 }
5915 else
5916 *d++ = *++s;
5917 if (s[1] != NUL && s[1] != '_')
5918 *d++ = '_'; /* append a '_' */
5919 continue;
5920 }
5921 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5922 *d++ = '\\';
5923
5924 /*
5925 * Insert a backslash before a backslash after a slash, for search
5926 * pattern tags: "/\|" --> "/\\|".
5927 */
5928 else if (s[0] == '\\' && s[1] != '\\'
5929 && *arg == '/' && s == arg + 1)
5930 *d++ = '\\';
5931
5932 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5933 * "CTRL-\_CTRL-N" */
5934 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5935 {
5936 STRCPY(d, "CTRL-\\\\");
5937 d += 7;
5938 s += 6;
5939 }
5940
5941 *d++ = *s;
5942
5943 /*
5944 * If tag starts with ', toss everything after a second '. Fixes
5945 * CTRL-] on 'option'. (would include the trailing '.').
5946 */
5947 if (*s == '\'' && s > arg && *arg == '\'')
5948 break;
5949 }
5950 *d = NUL;
5951 }
5952 }
5953
5954 *matches = (char_u **)"";
5955 *num_matches = 0;
5956 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5957 if (keep_lang)
5958 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005959 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005961 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 /* Sort the matches found on the heuristic number that is after the
5963 * tag name. */
5964 qsort((void *)*matches, (size_t)*num_matches,
5965 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005966 /* Delete more than TAG_MANY to reduce the size of the listing. */
5967 while (*num_matches > TAG_MANY)
5968 vim_free((*matches)[--*num_matches]);
5969 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 return OK;
5971}
5972
5973/*
5974 * After reading a help file: May cleanup a help buffer when syntax
5975 * highlighting is not used.
5976 */
5977 void
5978fix_help_buffer()
5979{
5980 linenr_T lnum;
5981 char_u *line;
5982 int in_example = FALSE;
5983 int len;
5984 char_u *p;
5985 char_u *rt;
5986 int mustfree;
5987
5988 /* set filetype to "help". */
5989 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5990
5991#ifdef FEAT_SYN_HL
Bram Moolenaar860cae12010-06-05 23:22:07 +02005992 if (!syntax_present(curwin))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993#endif
5994 {
5995 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5996 {
5997 line = ml_get_buf(curbuf, lnum, FALSE);
5998 len = (int)STRLEN(line);
5999 if (in_example && len > 0 && !vim_iswhite(line[0]))
6000 {
6001 /* End of example: non-white or '<' in first column. */
6002 if (line[0] == '<')
6003 {
6004 /* blank-out a '<' in the first column */
6005 line = ml_get_buf(curbuf, lnum, TRUE);
6006 line[0] = ' ';
6007 }
6008 in_example = FALSE;
6009 }
6010 if (!in_example && len > 0)
6011 {
6012 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
6013 {
6014 /* blank-out a '>' in the last column (start of example) */
6015 line = ml_get_buf(curbuf, lnum, TRUE);
6016 line[len - 1] = ' ';
6017 in_example = TRUE;
6018 }
6019 else if (line[len - 1] == '~')
6020 {
6021 /* blank-out a '~' at the end of line (header marker) */
6022 line = ml_get_buf(curbuf, lnum, TRUE);
6023 line[len - 1] = ' ';
6024 }
6025 }
6026 }
6027 }
6028
6029 /*
6030 * In the "help.txt" file, add the locally added help files.
6031 * This uses the very first line in the help file.
6032 */
6033 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
6034 {
6035 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6036 {
6037 line = ml_get_buf(curbuf, lnum, FALSE);
6038 if (strstr((char *)line, "*local-additions*") != NULL)
6039 {
6040 /* Go through all directories in 'runtimepath', skipping
6041 * $VIMRUNTIME. */
6042 p = p_rtp;
6043 while (*p != NUL)
6044 {
6045 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6046 mustfree = FALSE;
6047 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6048 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
6049 {
6050 int fcount;
6051 char_u **fnames;
6052 FILE *fd;
6053 char_u *s;
6054 int fi;
6055#ifdef FEAT_MBYTE
6056 vimconv_T vc;
6057 char_u *cp;
6058#endif
6059
6060 /* Find all "doc/ *.txt" files in this directory. */
6061 add_pathsep(NameBuff);
6062 STRCAT(NameBuff, "doc/*.txt");
6063 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6064 &fnames, EW_FILE|EW_SILENT) == OK
6065 && fcount > 0)
6066 {
6067 for (fi = 0; fi < fcount; ++fi)
6068 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006069 fd = mch_fopen((char *)fnames[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 if (fd != NULL)
6071 {
6072 vim_fgets(IObuff, IOSIZE, fd);
6073 if (IObuff[0] == '*'
6074 && (s = vim_strchr(IObuff + 1, '*'))
6075 != NULL)
6076 {
6077#ifdef FEAT_MBYTE
6078 int this_utf = MAYBE;
6079#endif
6080 /* Change tag definition to a
6081 * reference and remove <CR>/<NL>. */
6082 IObuff[0] = '|';
6083 *s = '|';
6084 while (*s != NUL)
6085 {
6086 if (*s == '\r' || *s == '\n')
6087 *s = NUL;
6088#ifdef FEAT_MBYTE
6089 /* The text is utf-8 when a byte
6090 * above 127 is found and no
6091 * illegal byte sequence is found.
6092 */
6093 if (*s >= 0x80 && this_utf != FALSE)
6094 {
6095 int l;
6096
6097 this_utf = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006098 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 if (l == 1)
6100 this_utf = FALSE;
6101 s += l - 1;
6102 }
6103#endif
6104 ++s;
6105 }
6106#ifdef FEAT_MBYTE
6107 /* The help file is latin1 or utf-8;
6108 * conversion to the current
6109 * 'encoding' may be required. */
6110 vc.vc_type = CONV_NONE;
6111 convert_setup(&vc, (char_u *)(
6112 this_utf == TRUE ? "utf-8"
6113 : "latin1"), p_enc);
6114 if (vc.vc_type == CONV_NONE)
6115 /* No conversion needed. */
6116 cp = IObuff;
6117 else
6118 {
6119 /* Do the conversion. If it fails
6120 * use the unconverted text. */
6121 cp = string_convert(&vc, IObuff,
6122 NULL);
6123 if (cp == NULL)
6124 cp = IObuff;
6125 }
6126 convert_setup(&vc, NULL, NULL);
6127
6128 ml_append(lnum, cp, (colnr_T)0, FALSE);
6129 if (cp != IObuff)
6130 vim_free(cp);
6131#else
6132 ml_append(lnum, IObuff, (colnr_T)0,
6133 FALSE);
6134#endif
6135 ++lnum;
6136 }
6137 fclose(fd);
6138 }
6139 }
6140 FreeWild(fcount, fnames);
6141 }
6142 }
6143 if (mustfree)
6144 vim_free(rt);
6145 }
6146 break;
6147 }
6148 }
6149 }
6150}
6151
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006152/*
6153 * ":exusage"
6154 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006155 void
6156ex_exusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006157 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006158{
6159 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6160}
6161
6162/*
6163 * ":viusage"
6164 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006165 void
6166ex_viusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006167 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006168{
6169 do_cmdline_cmd((char_u *)"help normal-index");
6170}
6171
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172#if defined(FEAT_EX_EXTRA) || defined(PROTO)
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006173static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174
6175/*
6176 * ":helptags"
6177 */
6178 void
6179ex_helptags(eap)
6180 exarg_T *eap;
6181{
6182 garray_T ga;
6183 int i, j;
6184 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006185#ifdef FEAT_MULTI_LANG
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 char_u lang[2];
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006187#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006188 expand_T xpc;
6189 char_u *dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 char_u ext[5];
6191 char_u fname[8];
6192 int filecount;
6193 char_u **files;
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006194 int add_help_tags = FALSE;
6195
6196 /* Check for ":helptags ++t {dir}". */
6197 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6198 {
6199 add_help_tags = TRUE;
6200 eap->arg = skipwhite(eap->arg + 3);
6201 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202
Bram Moolenaar0e253142008-01-13 12:31:34 +00006203 ExpandInit(&xpc);
6204 xpc.xp_context = EXPAND_DIRECTORIES;
6205 dirname = ExpandOne(&xpc, eap->arg, NULL,
6206 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6207 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 {
6209 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6210 return;
6211 }
6212
6213#ifdef FEAT_MULTI_LANG
6214 /* Get a list of all files in the directory. */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006215 STRCPY(NameBuff, dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 add_pathsep(NameBuff);
6217 STRCAT(NameBuff, "*");
6218 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6219 EW_FILE|EW_SILENT) == FAIL
6220 || filecount == 0)
6221 {
6222 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar0e253142008-01-13 12:31:34 +00006223 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 return;
6225 }
6226
6227 /* Go over all files in the directory to find out what languages are
6228 * present. */
6229 ga_init2(&ga, 1, 10);
6230 for (i = 0; i < filecount; ++i)
6231 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006232 len = (int)STRLEN(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 if (len > 4)
6234 {
6235 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6236 {
6237 /* ".txt" -> language "en" */
6238 lang[0] = 'e';
6239 lang[1] = 'n';
6240 }
6241 else if (files[i][len - 4] == '.'
6242 && ASCII_ISALPHA(files[i][len - 3])
6243 && ASCII_ISALPHA(files[i][len - 2])
6244 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6245 {
6246 /* ".abx" -> language "ab" */
6247 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6248 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6249 }
6250 else
6251 continue;
6252
6253 /* Did we find this language already? */
6254 for (j = 0; j < ga.ga_len; j += 2)
6255 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6256 break;
6257 if (j == ga.ga_len)
6258 {
6259 /* New language, add it. */
6260 if (ga_grow(&ga, 2) == FAIL)
6261 break;
6262 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6263 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 }
6265 }
6266 }
6267
6268 /*
6269 * Loop over the found languages to generate a tags file for each one.
6270 */
6271 for (j = 0; j < ga.ga_len; j += 2)
6272 {
6273 STRCPY(fname, "tags-xx");
6274 fname[5] = ((char_u *)ga.ga_data)[j];
6275 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6276 if (fname[5] == 'e' && fname[6] == 'n')
6277 {
6278 /* English is an exception: use ".txt" and "tags". */
6279 fname[4] = NUL;
6280 STRCPY(ext, ".txt");
6281 }
6282 else
6283 {
6284 /* Language "ab" uses ".abx" and "tags-ab". */
6285 STRCPY(ext, ".xxx");
6286 ext[1] = fname[5];
6287 ext[2] = fname[6];
6288 }
Bram Moolenaar0e253142008-01-13 12:31:34 +00006289 helptags_one(dirname, ext, fname, add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 }
6291
6292 ga_clear(&ga);
6293 FreeWild(filecount, files);
6294
6295#else
6296 /* No language support, just use "*.txt" and "tags". */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006297 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006299 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300}
6301
6302 static void
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006303helptags_one(dir, ext, tagfname, add_help_tags)
6304 char_u *dir; /* doc directory */
6305 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6306 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6307 int add_help_tags; /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308{
6309 FILE *fd_tags;
6310 FILE *fd;
6311 garray_T ga;
6312 int filecount;
6313 char_u **files;
6314 char_u *p1, *p2;
6315 int fi;
6316 char_u *s;
6317 int i;
6318 char_u *fname;
6319# ifdef FEAT_MBYTE
6320 int utf8 = MAYBE;
6321 int this_utf8;
6322 int firstline;
6323 int mix = FALSE; /* detected mixed encodings */
6324# endif
6325
6326 /*
6327 * Find all *.txt files.
6328 */
6329 STRCPY(NameBuff, dir);
6330 add_pathsep(NameBuff);
6331 STRCAT(NameBuff, "*");
6332 STRCAT(NameBuff, ext);
6333 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6334 EW_FILE|EW_SILENT) == FAIL
6335 || filecount == 0)
6336 {
6337 if (!got_int)
6338 EMSG2("E151: No match: %s", NameBuff);
6339 return;
6340 }
6341
6342 /*
6343 * Open the tags file for writing.
6344 * Do this before scanning through all the files.
6345 */
6346 STRCPY(NameBuff, dir);
6347 add_pathsep(NameBuff);
6348 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006349 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 if (fd_tags == NULL)
6351 {
6352 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6353 FreeWild(filecount, files);
6354 return;
6355 }
6356
6357 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006358 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6359 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 */
6361 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006362 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6363 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 {
6365 if (ga_grow(&ga, 1) == FAIL)
6366 got_int = TRUE;
6367 else
6368 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006369 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 if (s == NULL)
6371 got_int = TRUE;
6372 else
6373 {
6374 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6375 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6376 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 }
6378 }
6379 }
6380
6381 /*
6382 * Go over all the files and extract the tags.
6383 */
6384 for (fi = 0; fi < filecount && !got_int; ++fi)
6385 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006386 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 if (fd == NULL)
6388 {
6389 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6390 continue;
6391 }
6392 fname = gettail(files[fi]);
6393
6394# ifdef FEAT_MBYTE
6395 firstline = TRUE;
6396# endif
6397 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6398 {
6399# ifdef FEAT_MBYTE
6400 if (firstline)
6401 {
6402 /* Detect utf-8 file by a non-ASCII char in the first line. */
6403 this_utf8 = MAYBE;
6404 for (s = IObuff; *s != NUL; ++s)
6405 if (*s >= 0x80)
6406 {
6407 int l;
6408
6409 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006410 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 if (l == 1)
6412 {
6413 /* Illegal UTF-8 byte sequence. */
6414 this_utf8 = FALSE;
6415 break;
6416 }
6417 s += l - 1;
6418 }
6419 if (this_utf8 == MAYBE) /* only ASCII characters found */
6420 this_utf8 = FALSE;
6421 if (utf8 == MAYBE) /* first file */
6422 utf8 = this_utf8;
6423 else if (utf8 != this_utf8)
6424 {
6425 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6426 mix = !got_int;
6427 got_int = TRUE;
6428 }
6429 firstline = FALSE;
6430 }
6431# endif
6432 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6433 while (p1 != NULL)
6434 {
6435 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6436 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6437 {
6438 for (s = p1 + 1; s < p2; ++s)
6439 if (*s == ' ' || *s == '\t' || *s == '|')
6440 break;
6441
6442 /*
6443 * Only accept a *tag* when it consists of valid
6444 * characters, there is white space before it and is
6445 * followed by a white character or end-of-line.
6446 */
6447 if (s == p2
6448 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6449 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6450 || s[1] == '\0'))
6451 {
6452 *p2 = '\0';
6453 ++p1;
6454 if (ga_grow(&ga, 1) == FAIL)
6455 {
6456 got_int = TRUE;
6457 break;
6458 }
6459 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6460 if (s == NULL)
6461 {
6462 got_int = TRUE;
6463 break;
6464 }
6465 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6466 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 sprintf((char *)s, "%s\t%s", p1, fname);
6468
6469 /* find next '*' */
6470 p2 = vim_strchr(p2 + 1, '*');
6471 }
6472 }
6473 p1 = p2;
6474 }
6475 line_breakcheck();
6476 }
6477
6478 fclose(fd);
6479 }
6480
6481 FreeWild(filecount, files);
6482
6483 if (!got_int)
6484 {
6485 /*
6486 * Sort the tags.
6487 */
6488 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6489
6490 /*
6491 * Check for duplicates.
6492 */
6493 for (i = 1; i < ga.ga_len; ++i)
6494 {
6495 p1 = ((char_u **)ga.ga_data)[i - 1];
6496 p2 = ((char_u **)ga.ga_data)[i];
6497 while (*p1 == *p2)
6498 {
6499 if (*p2 == '\t')
6500 {
6501 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006502 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6504 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6505 EMSG(NameBuff);
6506 *p2 = '\t';
6507 break;
6508 }
6509 ++p1;
6510 ++p2;
6511 }
6512 }
6513
6514# ifdef FEAT_MBYTE
6515 if (utf8 == TRUE)
6516 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6517# endif
6518
6519 /*
6520 * Write the tags into the file.
6521 */
6522 for (i = 0; i < ga.ga_len; ++i)
6523 {
6524 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006525 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006527 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 else
6529 {
6530 fprintf(fd_tags, "%s\t/*", s);
6531 for (p1 = s; *p1 != '\t'; ++p1)
6532 {
6533 /* insert backslash before '\\' and '/' */
6534 if (*p1 == '\\' || *p1 == '/')
6535 putc('\\', fd_tags);
6536 putc(*p1, fd_tags);
6537 }
6538 fprintf(fd_tags, "*\n");
6539 }
6540 }
6541 }
6542#ifdef FEAT_MBYTE
6543 if (mix)
6544 got_int = FALSE; /* continue with other languages */
6545#endif
6546
6547 for (i = 0; i < ga.ga_len; ++i)
6548 vim_free(((char_u **)ga.ga_data)[i]);
6549 ga_clear(&ga);
6550 fclose(fd_tags); /* there is no check for an error... */
6551}
6552#endif
6553
6554#if defined(FEAT_SIGNS) || defined(PROTO)
6555
6556/*
6557 * Struct to hold the sign properties.
6558 */
6559typedef struct sign sign_T;
6560
6561struct sign
6562{
6563 sign_T *sn_next; /* next sign in list */
Bram Moolenaarf75d4982010-10-15 20:20:05 +02006564 int sn_typenr; /* type number of sign */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 char_u *sn_name; /* name of sign */
6566 char_u *sn_icon; /* name of pixmap */
6567#ifdef FEAT_SIGN_ICONS
6568 void *sn_image; /* icon image */
6569#endif
6570 char_u *sn_text; /* text used instead of pixmap */
6571 int sn_line_hl; /* highlight ID for line */
6572 int sn_text_hl; /* highlight ID for text */
6573};
6574
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575static sign_T *first_sign = NULL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006576static int next_sign_typenr = 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577
Bram Moolenaar985cb442009-05-14 19:51:46 +00006578static int sign_cmd_idx __ARGS((char_u *begin_cmd, char_u *end_cmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579static void sign_list_defined __ARGS((sign_T *sp));
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006580static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006582static char *cmds[] = {
6583 "define",
6584#define SIGNCMD_DEFINE 0
6585 "undefine",
6586#define SIGNCMD_UNDEFINE 1
6587 "list",
6588#define SIGNCMD_LIST 2
6589 "place",
6590#define SIGNCMD_PLACE 3
6591 "unplace",
6592#define SIGNCMD_UNPLACE 4
6593 "jump",
6594#define SIGNCMD_JUMP 5
6595 NULL
6596#define SIGNCMD_LAST 6
6597};
6598
6599/*
6600 * Find index of a ":sign" subcmd from its name.
6601 * "*end_cmd" must be writable.
6602 */
6603 static int
6604sign_cmd_idx(begin_cmd, end_cmd)
Bram Moolenaar985cb442009-05-14 19:51:46 +00006605 char_u *begin_cmd; /* begin of sign subcmd */
6606 char_u *end_cmd; /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006607{
6608 int idx;
6609 char save = *end_cmd;
6610
6611 *end_cmd = NUL;
6612 for (idx = 0; ; ++idx)
6613 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6614 break;
6615 *end_cmd = save;
6616 return idx;
6617}
6618
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619/*
6620 * ":sign" command
6621 */
6622 void
6623ex_sign(eap)
6624 exarg_T *eap;
6625{
6626 char_u *arg = eap->arg;
6627 char_u *p;
6628 int idx;
6629 sign_T *sp;
6630 sign_T *sp_prev;
6631 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632
6633 /* Parse the subcommand. */
6634 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006635 idx = sign_cmd_idx(arg, p);
6636 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006638 EMSG2(_("E160: Unknown sign command: %s"), arg);
6639 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 }
6641 arg = skipwhite(p);
6642
6643 if (idx <= SIGNCMD_LIST)
6644 {
6645 /*
6646 * Define, undefine or list signs.
6647 */
6648 if (idx == SIGNCMD_LIST && *arg == NUL)
6649 {
6650 /* ":sign list": list all defined signs */
6651 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6652 sign_list_defined(sp);
6653 }
6654 else if (*arg == NUL)
6655 EMSG(_("E156: Missing sign name"));
6656 else
6657 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006658 /* Isolate the sign name. If it's a number skip leading zeroes,
6659 * so that "099" and "99" are the same sign. But keep "0". */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 p = skiptowhite(arg);
6661 if (*p != NUL)
6662 *p++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006663 while (arg[0] == '0' && arg[1] != NUL)
6664 ++arg;
6665
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 sp_prev = NULL;
6667 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6668 {
6669 if (STRCMP(sp->sn_name, arg) == 0)
6670 break;
6671 sp_prev = sp;
6672 }
6673 if (idx == SIGNCMD_DEFINE)
6674 {
6675 /* ":sign define {name} ...": define a sign */
6676 if (sp == NULL)
6677 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006678 sign_T *lp;
6679 int start = next_sign_typenr;
6680
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 /* Allocate a new sign. */
6682 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6683 if (sp == NULL)
6684 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006686 /* Check that next_sign_typenr is not already being used.
6687 * This only happens after wrapping around. Hopefully
6688 * another one got deleted and we can use its number. */
6689 for (lp = first_sign; lp != NULL; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006691 if (lp->sn_typenr == next_sign_typenr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006693 ++next_sign_typenr;
6694 if (next_sign_typenr == MAX_TYPENR)
6695 next_sign_typenr = 1;
6696 if (next_sign_typenr == start)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 {
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006698 vim_free(sp);
6699 EMSG(_("E612: Too many signs defined"));
6700 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006702 lp = first_sign; /* start all over */
6703 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 }
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006705 lp = lp->sn_next;
6706 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006708 sp->sn_typenr = next_sign_typenr;
6709 if (++next_sign_typenr == MAX_TYPENR)
6710 next_sign_typenr = 1; /* wrap around */
6711
6712 sp->sn_name = vim_strsave(arg);
6713 if (sp->sn_name == NULL) /* out of memory */
6714 {
6715 vim_free(sp);
6716 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 }
Bram Moolenaara4f332b2010-10-13 16:44:23 +02006718
6719 /* add the new sign to the list of signs */
6720 if (sp_prev == NULL)
6721 first_sign = sp;
6722 else
6723 sp_prev->sn_next = sp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 }
6725
6726 /* set values for a defined sign. */
6727 for (;;)
6728 {
6729 arg = skipwhite(p);
6730 if (*arg == NUL)
6731 break;
6732 p = skiptowhite_esc(arg);
6733 if (STRNCMP(arg, "icon=", 5) == 0)
6734 {
6735 arg += 5;
6736 vim_free(sp->sn_icon);
6737 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6738 backslash_halve(sp->sn_icon);
6739#ifdef FEAT_SIGN_ICONS
6740 if (gui.in_use)
6741 {
6742 out_flush();
6743 if (sp->sn_image != NULL)
6744 gui_mch_destroy_sign(sp->sn_image);
6745 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6746 }
6747#endif
6748 }
6749 else if (STRNCMP(arg, "text=", 5) == 0)
6750 {
6751 char_u *s;
6752 int cells;
6753 int len;
6754
6755 arg += 5;
6756#ifdef FEAT_MBYTE
6757 /* Count cells and check for non-printable chars */
6758 if (has_mbyte)
6759 {
6760 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006761 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 {
6763 if (!vim_isprintc((*mb_ptr2char)(s)))
6764 break;
6765 cells += (*mb_ptr2cells)(s);
6766 }
6767 }
6768 else
6769#endif
6770 {
6771 for (s = arg; s < p; ++s)
6772 if (!vim_isprintc(*s))
6773 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006774 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 }
6776 /* Currently must be one or two display cells */
6777 if (s != p || cells < 1 || cells > 2)
6778 {
6779 *p = NUL;
6780 EMSG2(_("E239: Invalid sign text: %s"), arg);
6781 return;
6782 }
6783
6784 vim_free(sp->sn_text);
6785 /* Allocate one byte more if we need to pad up
6786 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006787 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 sp->sn_text = vim_strnsave(arg, len);
6789
6790 if (sp->sn_text != NULL && cells == 1)
6791 STRCPY(sp->sn_text + len - 1, " ");
6792 }
6793 else if (STRNCMP(arg, "linehl=", 7) == 0)
6794 {
6795 arg += 7;
6796 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6797 }
6798 else if (STRNCMP(arg, "texthl=", 7) == 0)
6799 {
6800 arg += 7;
6801 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6802 }
6803 else
6804 {
6805 EMSG2(_(e_invarg2), arg);
6806 return;
6807 }
6808 }
6809 }
6810 else if (sp == NULL)
6811 EMSG2(_("E155: Unknown sign: %s"), arg);
6812 else if (idx == SIGNCMD_LIST)
6813 /* ":sign list {name}" */
6814 sign_list_defined(sp);
6815 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006817 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 }
6819 }
6820 else
6821 {
6822 int id = -1;
6823 linenr_T lnum = -1;
6824 char_u *sign_name = NULL;
6825 char_u *arg1;
6826
6827 if (*arg == NUL)
6828 {
6829 if (idx == SIGNCMD_PLACE)
6830 {
6831 /* ":sign place": list placed signs in all buffers */
6832 sign_list_placed(NULL);
6833 }
6834 else if (idx == SIGNCMD_UNPLACE)
6835 {
6836 /* ":sign unplace": remove placed sign at cursor */
6837 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6838 if (id > 0)
6839 {
6840 buf_delsign(curwin->w_buffer, id);
6841 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6842 }
6843 else
6844 EMSG(_("E159: Missing sign number"));
6845 }
6846 else
6847 EMSG(_(e_argreq));
6848 return;
6849 }
6850
6851 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6852 {
6853 /* ":sign unplace *": remove all placed signs */
6854 buf_delete_all_signs();
6855 return;
6856 }
6857
6858 /* first arg could be placed sign id */
6859 arg1 = arg;
6860 if (VIM_ISDIGIT(*arg))
6861 {
6862 id = getdigits(&arg);
6863 if (!vim_iswhite(*arg) && *arg != NUL)
6864 {
6865 id = -1;
6866 arg = arg1;
6867 }
6868 else
6869 {
6870 arg = skipwhite(arg);
6871 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6872 {
6873 /* ":sign unplace {id}": remove placed sign by number */
6874 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6875 if ((lnum = buf_delsign(buf, id)) != 0)
6876 update_debug_sign(buf, lnum);
6877 return;
6878 }
6879 }
6880 }
6881
6882 /*
6883 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6884 * Leave "arg" pointing to {fname}.
6885 */
6886 for (;;)
6887 {
6888 if (STRNCMP(arg, "line=", 5) == 0)
6889 {
6890 arg += 5;
6891 lnum = atoi((char *)arg);
6892 arg = skiptowhite(arg);
6893 }
6894 else if (STRNCMP(arg, "name=", 5) == 0)
6895 {
6896 arg += 5;
6897 sign_name = arg;
6898 arg = skiptowhite(arg);
6899 if (*arg != NUL)
6900 *arg++ = NUL;
Bram Moolenaarb60574b2010-10-14 21:29:37 +02006901 while (sign_name[0] == '0' && sign_name[1] != NUL)
6902 ++sign_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 }
6904 else if (STRNCMP(arg, "file=", 5) == 0)
6905 {
6906 arg += 5;
6907 buf = buflist_findname(arg);
6908 break;
6909 }
6910 else if (STRNCMP(arg, "buffer=", 7) == 0)
6911 {
6912 arg += 7;
6913 buf = buflist_findnr((int)getdigits(&arg));
6914 if (*skipwhite(arg) != NUL)
6915 EMSG(_(e_trailing));
6916 break;
6917 }
6918 else
6919 {
6920 EMSG(_(e_invarg));
6921 return;
6922 }
6923 arg = skipwhite(arg);
6924 }
6925
6926 if (buf == NULL)
6927 {
6928 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6929 }
6930 else if (id <= 0)
6931 {
6932 if (lnum >= 0 || sign_name != NULL)
6933 EMSG(_(e_invarg));
6934 else
6935 /* ":sign place file={fname}": list placed signs in one file */
6936 sign_list_placed(buf);
6937 }
6938 else if (idx == SIGNCMD_JUMP)
6939 {
6940 /* ":sign jump {id} file={fname}" */
6941 if (lnum >= 0 || sign_name != NULL)
6942 EMSG(_(e_invarg));
6943 else if ((lnum = buf_findsign(buf, id)) > 0)
6944 { /* goto a sign ... */
6945 if (buf_jump_open_win(buf) != NULL)
6946 { /* ... in a current window */
6947 curwin->w_cursor.lnum = lnum;
6948 check_cursor_lnum();
6949 beginline(BL_WHITE);
6950 }
6951 else
6952 { /* ... not currently in a window */
6953 char_u *cmd;
6954
6955 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6956 if (cmd == NULL)
6957 return;
6958 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6959 do_cmdline_cmd(cmd);
6960 vim_free(cmd);
6961 }
6962#ifdef FEAT_FOLDING
6963 foldOpenCursor();
6964#endif
6965 }
6966 else
6967 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6968 }
6969 else if (idx == SIGNCMD_UNPLACE)
6970 {
6971 /* ":sign unplace {id} file={fname}" */
6972 if (lnum >= 0 || sign_name != NULL)
6973 EMSG(_(e_invarg));
6974 else
6975 {
6976 lnum = buf_delsign(buf, id);
6977 update_debug_sign(buf, lnum);
6978 }
6979 }
6980 /* idx == SIGNCMD_PLACE */
6981 else if (sign_name != NULL)
6982 {
6983 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6984 if (STRCMP(sp->sn_name, sign_name) == 0)
6985 break;
6986 if (sp == NULL)
6987 {
6988 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6989 return;
6990 }
6991 if (lnum > 0)
6992 /* ":sign place {id} line={lnum} name={name} file={fname}":
6993 * place a sign */
6994 buf_addsign(buf, id, lnum, sp->sn_typenr);
6995 else
6996 /* ":sign place {id} file={fname}": change sign type */
6997 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6998 update_debug_sign(buf, lnum);
6999 }
7000 else
7001 EMSG(_(e_invarg));
7002 }
7003}
7004
7005#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7006/*
7007 * Allocate the icons. Called when the GUI has started. Allows defining
7008 * signs before it starts.
7009 */
7010 void
7011sign_gui_started()
7012{
7013 sign_T *sp;
7014
7015 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7016 if (sp->sn_icon != NULL)
7017 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
7018}
7019#endif
7020
7021/*
7022 * List one sign.
7023 */
7024 static void
7025sign_list_defined(sp)
7026 sign_T *sp;
7027{
7028 char_u *p;
7029
Bram Moolenaar555b2802005-05-19 21:08:39 +00007030 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 if (sp->sn_icon != NULL)
7032 {
7033 MSG_PUTS(" icon=");
7034 msg_outtrans(sp->sn_icon);
7035#ifdef FEAT_SIGN_ICONS
7036 if (sp->sn_image == NULL)
7037 MSG_PUTS(_(" (NOT FOUND)"));
7038#else
7039 MSG_PUTS(_(" (not supported)"));
7040#endif
7041 }
7042 if (sp->sn_text != NULL)
7043 {
7044 MSG_PUTS(" text=");
7045 msg_outtrans(sp->sn_text);
7046 }
7047 if (sp->sn_line_hl > 0)
7048 {
7049 MSG_PUTS(" linehl=");
7050 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7051 if (p == NULL)
7052 MSG_PUTS("NONE");
7053 else
7054 msg_puts(p);
7055 }
7056 if (sp->sn_text_hl > 0)
7057 {
7058 MSG_PUTS(" texthl=");
7059 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7060 if (p == NULL)
7061 MSG_PUTS("NONE");
7062 else
7063 msg_puts(p);
7064 }
7065}
7066
7067/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007068 * Undefine a sign and free its memory.
7069 */
7070 static void
7071sign_undefine(sp, sp_prev)
7072 sign_T *sp;
7073 sign_T *sp_prev;
7074{
7075 vim_free(sp->sn_name);
7076 vim_free(sp->sn_icon);
7077#ifdef FEAT_SIGN_ICONS
7078 if (sp->sn_image != NULL)
7079 {
7080 out_flush();
7081 gui_mch_destroy_sign(sp->sn_image);
7082 }
7083#endif
7084 vim_free(sp->sn_text);
7085 if (sp_prev == NULL)
7086 first_sign = sp->sn_next;
7087 else
7088 sp_prev->sn_next = sp->sn_next;
7089 vim_free(sp);
7090}
7091
7092/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 * Get highlighting attribute for sign "typenr".
7094 * If "line" is TRUE: line highl, if FALSE: text highl.
7095 */
7096 int
7097sign_get_attr(typenr, line)
7098 int typenr;
7099 int line;
7100{
7101 sign_T *sp;
7102
7103 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7104 if (sp->sn_typenr == typenr)
7105 {
7106 if (line)
7107 {
7108 if (sp->sn_line_hl > 0)
7109 return syn_id2attr(sp->sn_line_hl);
7110 }
7111 else
7112 {
7113 if (sp->sn_text_hl > 0)
7114 return syn_id2attr(sp->sn_text_hl);
7115 }
7116 break;
7117 }
7118 return 0;
7119}
7120
7121/*
7122 * Get text mark for sign "typenr".
7123 * Returns NULL if there isn't one.
7124 */
7125 char_u *
7126sign_get_text(typenr)
7127 int typenr;
7128{
7129 sign_T *sp;
7130
7131 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7132 if (sp->sn_typenr == typenr)
7133 return sp->sn_text;
7134 return NULL;
7135}
7136
7137#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7138 void *
7139sign_get_image(typenr)
7140 int typenr; /* the attribute which may have a sign */
7141{
7142 sign_T *sp;
7143
7144 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7145 if (sp->sn_typenr == typenr)
7146 return sp->sn_image;
7147 return NULL;
7148}
7149#endif
7150
7151/*
7152 * Get the name of a sign by its typenr.
7153 */
7154 char_u *
7155sign_typenr2name(typenr)
7156 int typenr;
7157{
7158 sign_T *sp;
7159
7160 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7161 if (sp->sn_typenr == typenr)
7162 return sp->sn_name;
7163 return (char_u *)_("[Deleted]");
7164}
7165
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007166#if defined(EXITFREE) || defined(PROTO)
7167/*
7168 * Undefine/free all signs.
7169 */
7170 void
7171free_signs()
7172{
7173 while (first_sign != NULL)
7174 sign_undefine(first_sign, NULL);
7175}
7176#endif
7177
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007178#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7179static enum
7180{
7181 EXP_SUBCMD, /* expand :sign sub-commands */
7182 EXP_DEFINE, /* expand :sign define {name} args */
7183 EXP_PLACE, /* expand :sign place {id} args */
7184 EXP_UNPLACE, /* expand :sign unplace" */
7185 EXP_SIGN_NAMES /* expand with name of placed signs */
7186} expand_what;
7187
7188/*
7189 * Function given to ExpandGeneric() to obtain the sign command
7190 * expansion.
7191 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007192 char_u *
7193get_sign_name(xp, idx)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00007194 expand_T *xp UNUSED;
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007195 int idx;
7196{
7197 sign_T *sp;
7198 int current_idx;
7199
7200 switch (expand_what)
7201 {
7202 case EXP_SUBCMD:
7203 return (char_u *)cmds[idx];
7204 case EXP_DEFINE:
7205 {
7206 char *define_arg[] =
7207 {
7208 "icon=", "linehl=", "text=", "texthl=", NULL
7209 };
7210 return (char_u *)define_arg[idx];
7211 }
7212 case EXP_PLACE:
7213 {
7214 char *place_arg[] =
7215 {
7216 "line=", "name=", "file=", "buffer=", NULL
7217 };
7218 return (char_u *)place_arg[idx];
7219 }
7220 case EXP_UNPLACE:
7221 {
7222 char *unplace_arg[] = { "file=", "buffer=", NULL };
7223 return (char_u *)unplace_arg[idx];
7224 }
7225 case EXP_SIGN_NAMES:
7226 /* Complete with name of signs already defined */
7227 current_idx = 0;
7228 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7229 if (current_idx++ == idx)
7230 return sp->sn_name;
7231 return NULL;
7232 default:
7233 return NULL;
7234 }
7235}
7236
7237/*
7238 * Handle command line completion for :sign command.
7239 */
7240 void
7241set_context_in_sign_cmd(xp, arg)
7242 expand_T *xp;
7243 char_u *arg;
7244{
7245 char_u *p;
7246 char_u *end_subcmd;
7247 char_u *last;
7248 int cmd_idx;
7249 char_u *begin_subcmd_args;
7250
7251 /* Default: expand subcommands. */
7252 xp->xp_context = EXPAND_SIGN;
7253 expand_what = EXP_SUBCMD;
7254 xp->xp_pattern = arg;
7255
7256 end_subcmd = skiptowhite(arg);
7257 if (*end_subcmd == NUL)
7258 /* expand subcmd name
7259 * :sign {subcmd}<CTRL-D>*/
7260 return;
7261
7262 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7263
7264 /* :sign {subcmd} {subcmd_args}
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007265 * |
7266 * begin_subcmd_args */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007267 begin_subcmd_args = skipwhite(end_subcmd);
7268 p = skiptowhite(begin_subcmd_args);
7269 if (*p == NUL)
7270 {
7271 /*
7272 * Expand first argument of subcmd when possible.
7273 * For ":jump {id}" and ":unplace {id}", we could
7274 * possibly expand the ids of all signs already placed.
7275 */
7276 xp->xp_pattern = begin_subcmd_args;
7277 switch (cmd_idx)
7278 {
7279 case SIGNCMD_LIST:
7280 case SIGNCMD_UNDEFINE:
7281 /* :sign list <CTRL-D>
7282 * :sign undefine <CTRL-D> */
7283 expand_what = EXP_SIGN_NAMES;
7284 break;
7285 default:
7286 xp->xp_context = EXPAND_NOTHING;
7287 }
7288 return;
7289 }
7290
7291 /* expand last argument of subcmd */
7292
7293 /* :sign define {name} {args}...
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007294 * |
7295 * p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007296
7297 /* Loop until reaching last argument. */
7298 do
7299 {
7300 p = skipwhite(p);
7301 last = p;
7302 p = skiptowhite(p);
7303 } while (*p != NUL);
7304
7305 p = vim_strchr(last, '=');
7306
7307 /* :sign define {name} {args}... {last}=
Bram Moolenaarcc448b32010-07-14 16:52:17 +02007308 * | |
7309 * last p */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007310 if (p == NUL)
7311 {
7312 /* Expand last argument name (before equal sign). */
7313 xp->xp_pattern = last;
7314 switch (cmd_idx)
7315 {
7316 case SIGNCMD_DEFINE:
7317 expand_what = EXP_DEFINE;
7318 break;
7319 case SIGNCMD_PLACE:
7320 expand_what = EXP_PLACE;
7321 break;
7322 case SIGNCMD_JUMP:
7323 case SIGNCMD_UNPLACE:
7324 expand_what = EXP_UNPLACE;
7325 break;
7326 default:
7327 xp->xp_context = EXPAND_NOTHING;
7328 }
7329 }
7330 else
7331 {
7332 /* Expand last argument value (after equal sign). */
7333 xp->xp_pattern = p + 1;
7334 switch (cmd_idx)
7335 {
7336 case SIGNCMD_DEFINE:
7337 if (STRNCMP(last, "texthl", p - last) == 0 ||
7338 STRNCMP(last, "linehl", p - last) == 0)
7339 xp->xp_context = EXPAND_HIGHLIGHT;
7340 else if (STRNCMP(last, "icon", p - last) == 0)
7341 xp->xp_context = EXPAND_FILES;
7342 else
7343 xp->xp_context = EXPAND_NOTHING;
7344 break;
7345 case SIGNCMD_PLACE:
7346 if (STRNCMP(last, "name", p - last) == 0)
7347 expand_what = EXP_SIGN_NAMES;
7348 else
7349 xp->xp_context = EXPAND_NOTHING;
7350 break;
7351 default:
7352 xp->xp_context = EXPAND_NOTHING;
7353 }
7354 }
7355}
7356#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357#endif
7358
7359#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7360/*
7361 * ":drop"
7362 * Opens the first argument in a window. When there are two or more arguments
7363 * the argument list is redefined.
7364 */
7365 void
7366ex_drop(eap)
7367 exarg_T *eap;
7368{
7369 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 win_T *wp;
7371 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007372# ifdef FEAT_WINDOWS
7373 tabpage_T *tp;
7374# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375
7376 /*
7377 * Check if the first argument is already being edited in a window. If
7378 * so, jump to that window.
7379 * We would actually need to check all arguments, but that's complicated
7380 * and mostly only one file is dropped.
7381 * This also ignores wildcards, since it is very unlikely the user is
7382 * editing a file name with a wildcard character.
7383 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007384 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007386 /*
7387 * Expanding wildcards may result in an empty argument list. E.g. when
7388 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7389 * already did an error message for this.
7390 */
7391 if (ARGCOUNT == 0)
7392 return;
7393
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007394# ifdef FEAT_WINDOWS
7395 if (cmdmod.tab)
7396 {
7397 /* ":tab drop file ...": open a tab for each argument that isn't
7398 * edited in a window yet. It's like ":tab all" but without closing
7399 * windows or tabs. */
7400 ex_all(eap);
7401 }
7402 else
7403# endif
7404 {
7405 /* ":drop file ...": Edit the first argument. Jump to an existing
7406 * window if possible, edit in current window if the current buffer
7407 * can be abandoned, otherwise open a new window. */
7408 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7409
7410 FOR_ALL_TAB_WINDOWS(tp, wp)
7411 {
7412 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007414# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007415 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007416# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 return;
7419 }
7420 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007422 /*
7423 * Check whether the current buffer is changed. If so, we will need
7424 * to split the current window or data could be lost.
7425 * Skip the check if the 'hidden' option is set, as in this case the
7426 * buffer won't be lost.
7427 */
7428 if (!P_HID(curbuf))
7429 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007431 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007433 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007435 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007437 if (split)
7438 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007440 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007442 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7443 if (split)
7444 {
7445 eap->cmdidx = CMD_sfirst;
7446 eap->cmd[0] = 's';
7447 }
7448 else
7449 eap->cmdidx = CMD_first;
7450 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452}
7453#endif