blob: 8a0a9ec128e9c354d3ac3d50d4b74152b8c09695 [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 Moolenaar4c3f5362006-04-11 21:38:50 +0000326 result = l1.start_col_nr - l2.start_col_nr;
327 else
328 {
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000329 /* We need to copy one line into "sortbuf1", because there is no
330 * guarantee that the first pointer becomes invalid when obtaining the
331 * second one. */
332 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
333 l1.end_col_nr - l1.start_col_nr + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000334 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000335 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
336 l2.end_col_nr - l2.start_col_nr + 1);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000337 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000338
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000339 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
340 : STRCMP(sortbuf1, sortbuf2);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000341 }
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000342
343 /* If two lines have the same value, preserve the original line order. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000344 if (result == 0)
Bram Moolenaarb21e5842006-04-16 18:30:08 +0000345 return (int)(l1.lnum - l2.lnum);
346 return result;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000347}
348
349/*
350 * ":sort".
351 */
352 void
353ex_sort(eap)
354 exarg_T *eap;
355{
356 regmatch_T regmatch;
357 int len;
358 linenr_T lnum;
359 long maxlen = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000360 sorti_T *nrs;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000361 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000362 size_t i;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000363 char_u *p;
364 char_u *s;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000365 char_u *s2;
366 char_u c; /* temporary character storage */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000367 int unique = FALSE;
368 long deleted;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000369 colnr_T start_col;
370 colnr_T end_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000371 int sort_oct; /* sort on octal number */
372 int sort_hex; /* sort on hex number */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000373
Bram Moolenaar48c99162008-02-18 18:42:52 +0000374 /* Sorting one line is really quick! */
375 if (count <= 1)
376 return;
377
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000378 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
379 return;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000380 sortbuf1 = NULL;
381 sortbuf2 = NULL;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000382 regmatch.regprog = NULL;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000383 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000384 if (nrs == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000385 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000386
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000387 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000388
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000389 for (p = eap->arg; *p != NUL; ++p)
390 {
391 if (vim_iswhite(*p))
392 ;
393 else if (*p == 'i')
394 sort_ic = TRUE;
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000395 else if (*p == 'r')
396 sort_rx = TRUE;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000397 else if (*p == 'n')
398 sort_nr = 2;
399 else if (*p == 'o')
400 sort_oct = 2;
401 else if (*p == 'x')
402 sort_hex = 2;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000403 else if (*p == 'u')
404 unique = TRUE;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000405 else if (*p == '"') /* comment start */
406 break;
407 else if (check_nextcmd(p) != NULL)
408 {
409 eap->nextcmd = check_nextcmd(p);
410 break;
411 }
412 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000413 {
414 s = skip_regexp(p + 1, *p, TRUE, NULL);
415 if (*s != *p)
416 {
417 EMSG(_(e_invalpat));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000418 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000419 }
420 *s = NUL;
Bram Moolenaar1256e722007-07-10 15:26:20 +0000421 /* Use last search pattern if sort pattern is empty. */
422 if (s == p + 1 && last_search_pat() != NULL)
423 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
424 else
425 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000426 if (regmatch.regprog == NULL)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000427 goto sortend;
Bram Moolenaar0e6830e2005-05-27 20:23:44 +0000428 p = s; /* continue after the regexp */
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000429 regmatch.rm_ic = p_ic;
430 }
431 else
432 {
433 EMSG2(_(e_invarg2), p);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000434 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000435 }
436 }
437
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000438 /* Can only have one of 'n', 'o' and 'x'. */
439 if (sort_nr + sort_oct + sort_hex > 2)
440 {
441 EMSG(_(e_invarg));
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000442 goto sortend;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000443 }
444
445 /* From here on "sort_nr" is used as a flag for any number sorting. */
446 sort_nr += sort_oct + sort_hex;
447
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000448 /*
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000449 * Make an array with all line numbers. This avoids having to copy all
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000450 * the lines into allocated memory.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000451 * When sorting on strings "start_col_nr" is the offset in the line, for
452 * numbers sorting it's the number to sort on. This means the pattern
453 * matching and number conversion only has to be done once per line.
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000454 * Also get the longest line length for allocating "sortbuf".
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000455 */
456 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
457 {
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000458 s = ml_get(lnum);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000459 len = (int)STRLEN(s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000460 if (maxlen < len)
461 maxlen = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000462
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000463 start_col = 0;
464 end_col = len;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000465 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000466 {
467 if (sort_rx)
468 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000469 start_col = (colnr_T)(regmatch.startp[0] - s);
470 end_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000471 }
472 else
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000473 start_col = (colnr_T)(regmatch.endp[0] - s);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000474 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000475 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000476 if (regmatch.regprog != NULL)
477 end_col = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000478
479 if (sort_nr)
480 {
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000481 /* Make sure vim_str2nr doesn't read any digits past the end
482 * of the match, by temporarily terminating the string there */
483 s2 = s + end_col;
484 c = *s2;
485 (*s2) = 0;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000486 /* Sorting on number: Store the number itself. */
Bram Moolenaar1387a602008-07-24 19:31:11 +0000487 p = s + start_col;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000488 if (sort_hex)
Bram Moolenaar1387a602008-07-24 19:31:11 +0000489 s = skiptohex(p);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000490 else
Bram Moolenaar1387a602008-07-24 19:31:11 +0000491 s = skiptodigit(p);
492 if (s > p && s[-1] == '-')
493 --s; /* include preceding negative sign */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000494 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000495 &nrs[lnum - eap->line1].start_col_nr, NULL);
496 (*s2) = c;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000497 }
498 else
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000499 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000500 /* Store the column to sort at. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000501 nrs[lnum - eap->line1].start_col_nr = start_col;
502 nrs[lnum - eap->line1].end_col_nr = end_col;
503 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000504
505 nrs[lnum - eap->line1].lnum = lnum;
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000506
507 if (regmatch.regprog != NULL)
508 fast_breakcheck();
509 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000510 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000511 }
512
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000513 /* Allocate a buffer that can hold the longest line. */
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000514 sortbuf1 = alloc((unsigned)maxlen + 1);
515 if (sortbuf1 == NULL)
516 goto sortend;
517 sortbuf2 = alloc((unsigned)maxlen + 1);
518 if (sortbuf2 == NULL)
519 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000520
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000521 /* Sort the array of line numbers. Note: can't be interrupted! */
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000522 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000523
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000524 if (sort_abort)
525 goto sortend;
526
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000527 /* Insert the lines in the sorted order below the last one. */
528 lnum = eap->line2;
529 for (i = 0; i < count; ++i)
530 {
531 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
532 if (!unique || i == 0
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000533 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000534 {
535 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
536 break;
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000537 if (unique)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000538 STRCPY(sortbuf1, s);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000539 }
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000540 fast_breakcheck();
541 if (got_int)
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000542 goto sortend;
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000543 }
544
545 /* delete the original lines if appending worked */
546 if (i == count)
547 for (i = 0; i < count; ++i)
548 ml_delete(eap->line1, FALSE);
549 else
550 count = 0;
551
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000552 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000553 deleted = (long)(count - (lnum - eap->line2));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000554 if (deleted > 0)
555 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
556 else if (deleted < 0)
557 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
558 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
Bram Moolenaar54ee7752005-05-31 22:22:17 +0000559
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000560 curwin->w_cursor.lnum = eap->line1;
561 beginline(BL_WHITE | BL_FIX);
562
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000563sortend:
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000564 vim_free(nrs);
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000565 vim_free(sortbuf1);
566 vim_free(sortbuf2);
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000567 vim_free(regmatch.regprog);
Bram Moolenaarae5bce12005-08-15 21:41:48 +0000568 if (got_int)
569 EMSG(_(e_interr));
Bram Moolenaar67fe1a12005-05-22 22:12:58 +0000570}
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572/*
573 * ":retab".
574 */
575 void
576ex_retab(eap)
577 exarg_T *eap;
578{
579 linenr_T lnum;
580 int got_tab = FALSE;
581 long num_spaces = 0;
582 long num_tabs;
583 long len;
584 long col;
585 long vcol;
586 long start_col = 0; /* For start of white-space string */
587 long start_vcol = 0; /* For start of white-space string */
588 int temp;
589 long old_len;
590 char_u *ptr;
591 char_u *new_line = (char_u *)1; /* init to non-NULL */
592 int did_undo; /* called u_save for current line */
593 int new_ts;
594 int save_list;
595 linenr_T first_line = 0; /* first changed line */
596 linenr_T last_line = 0; /* last changed line */
597
598 save_list = curwin->w_p_list;
599 curwin->w_p_list = 0; /* don't want list mode here */
600
601 new_ts = getdigits(&(eap->arg));
602 if (new_ts < 0)
603 {
604 EMSG(_(e_positive));
605 return;
606 }
607 if (new_ts == 0)
608 new_ts = curbuf->b_p_ts;
609 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
610 {
611 ptr = ml_get(lnum);
612 col = 0;
613 vcol = 0;
614 did_undo = FALSE;
615 for (;;)
616 {
617 if (vim_iswhite(ptr[col]))
618 {
619 if (!got_tab && num_spaces == 0)
620 {
621 /* First consecutive white-space */
622 start_vcol = vcol;
623 start_col = col;
624 }
625 if (ptr[col] == ' ')
626 num_spaces++;
627 else
628 got_tab = TRUE;
629 }
630 else
631 {
632 if (got_tab || (eap->forceit && num_spaces > 1))
633 {
634 /* Retabulate this string of white-space */
635
636 /* len is virtual length of white string */
637 len = num_spaces = vcol - start_vcol;
638 num_tabs = 0;
639 if (!curbuf->b_p_et)
640 {
641 temp = new_ts - (start_vcol % new_ts);
642 if (num_spaces >= temp)
643 {
644 num_spaces -= temp;
645 num_tabs++;
646 }
647 num_tabs += num_spaces / new_ts;
648 num_spaces -= (num_spaces / new_ts) * new_ts;
649 }
650 if (curbuf->b_p_et || got_tab ||
651 (num_spaces + num_tabs < len))
652 {
653 if (did_undo == FALSE)
654 {
655 did_undo = TRUE;
656 if (u_save((linenr_T)(lnum - 1),
657 (linenr_T)(lnum + 1)) == FAIL)
658 {
659 new_line = NULL; /* flag out-of-memory */
660 break;
661 }
662 }
663
664 /* len is actual number of white characters used */
665 len = num_spaces + num_tabs;
666 old_len = (long)STRLEN(ptr);
667 new_line = lalloc(old_len - col + start_col + len + 1,
668 TRUE);
669 if (new_line == NULL)
670 break;
671 if (start_col > 0)
672 mch_memmove(new_line, ptr, (size_t)start_col);
673 mch_memmove(new_line + start_col + len,
674 ptr + col, (size_t)(old_len - col + 1));
675 ptr = new_line + start_col;
676 for (col = 0; col < len; col++)
677 ptr[col] = (col < num_tabs) ? '\t' : ' ';
678 ml_replace(lnum, new_line, FALSE);
679 if (first_line == 0)
680 first_line = lnum;
681 last_line = lnum;
682 ptr = new_line;
683 col = start_col + len;
684 }
685 }
686 got_tab = FALSE;
687 num_spaces = 0;
688 }
689 if (ptr[col] == NUL)
690 break;
691 vcol += chartabsize(ptr + col, (colnr_T)vcol);
692#ifdef FEAT_MBYTE
693 if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +0000694 col += (*mb_ptr2len)(ptr + col);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 else
696#endif
697 ++col;
698 }
699 if (new_line == NULL) /* out of memory */
700 break;
701 line_breakcheck();
702 }
703 if (got_int)
704 EMSG(_(e_interr));
705
706 if (curbuf->b_p_ts != new_ts)
707 redraw_curbuf_later(NOT_VALID);
708 if (first_line != 0)
709 changed_lines(first_line, 0, last_line + 1, 0L);
710
711 curwin->w_p_list = save_list; /* restore 'list' */
712
713 curbuf->b_p_ts = new_ts;
714 coladvance(curwin->w_curswant);
715
716 u_clearline();
717}
718#endif
719
720/*
721 * :move command - move lines line1-line2 to line dest
722 *
723 * return FAIL for failure, OK otherwise
724 */
725 int
726do_move(line1, line2, dest)
727 linenr_T line1;
728 linenr_T line2;
729 linenr_T dest;
730{
731 char_u *str;
732 linenr_T l;
733 linenr_T extra; /* Num lines added before line1 */
734 linenr_T num_lines; /* Num lines moved */
735 linenr_T last_line; /* Last line in file after adding new text */
736
737 if (dest >= line1 && dest < line2)
738 {
739 EMSG(_("E134: Move lines into themselves"));
740 return FAIL;
741 }
742
743 num_lines = line2 - line1 + 1;
744
745 /*
746 * First we copy the old text to its new location -- webb
747 * Also copy the flag that ":global" command uses.
748 */
749 if (u_save(dest, dest + 1) == FAIL)
750 return FAIL;
751 for (extra = 0, l = line1; l <= line2; l++)
752 {
753 str = vim_strsave(ml_get(l + extra));
754 if (str != NULL)
755 {
756 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
757 vim_free(str);
758 if (dest < line1)
759 extra++;
760 }
761 }
762
763 /*
764 * Now we must be careful adjusting our marks so that we don't overlap our
765 * mark_adjust() calls.
766 *
767 * We adjust the marks within the old text so that they refer to the
768 * last lines of the file (temporarily), because we know no other marks
769 * will be set there since these line numbers did not exist until we added
770 * our new lines.
771 *
772 * Then we adjust the marks on lines between the old and new text positions
773 * (either forwards or backwards).
774 *
775 * And Finally we adjust the marks we put at the end of the file back to
776 * their final destination at the new text position -- webb
777 */
778 last_line = curbuf->b_ml.ml_line_count;
779 mark_adjust(line1, line2, last_line - line2, 0L);
780 if (dest >= line2)
781 {
782 mark_adjust(line2 + 1, dest, -num_lines, 0L);
783 curbuf->b_op_start.lnum = dest - num_lines + 1;
784 curbuf->b_op_end.lnum = dest;
785 }
786 else
787 {
788 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
789 curbuf->b_op_start.lnum = dest + 1;
790 curbuf->b_op_end.lnum = dest + num_lines;
791 }
792 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
793 mark_adjust(last_line - num_lines + 1, last_line,
794 -(last_line - dest - extra), 0L);
795
796 /*
797 * Now we delete the original text -- webb
798 */
799 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
800 return FAIL;
801
802 for (l = line1; l <= line2; l++)
803 ml_delete(line1 + extra, TRUE);
804
805 if (!global_busy && num_lines > p_report)
806 {
807 if (num_lines == 1)
808 MSG(_("1 line moved"));
809 else
810 smsg((char_u *)_("%ld lines moved"), num_lines);
811 }
812
813 /*
814 * Leave the cursor on the last of the moved lines.
815 */
816 if (dest >= line1)
817 curwin->w_cursor.lnum = dest;
818 else
819 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
820
821 if (line1 < dest)
822 changed_lines(line1, 0, dest + num_lines + 1, 0L);
823 else
824 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
825
826 return OK;
827}
828
829/*
830 * ":copy"
831 */
832 void
833ex_copy(line1, line2, n)
834 linenr_T line1;
835 linenr_T line2;
836 linenr_T n;
837{
838 linenr_T count;
839 char_u *p;
840
841 count = line2 - line1 + 1;
842 curbuf->b_op_start.lnum = n + 1;
843 curbuf->b_op_end.lnum = n + count;
844 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
845
846 /*
847 * there are three situations:
848 * 1. destination is above line1
849 * 2. destination is between line1 and line2
850 * 3. destination is below line2
851 *
852 * n = destination (when starting)
853 * curwin->w_cursor.lnum = destination (while copying)
854 * line1 = start of source (while copying)
855 * line2 = end of source (while copying)
856 */
857 if (u_save(n, n + 1) == FAIL)
858 return;
859
860 curwin->w_cursor.lnum = n;
861 while (line1 <= line2)
862 {
863 /* need to use vim_strsave() because the line will be unlocked within
864 * ml_append() */
865 p = vim_strsave(ml_get(line1));
866 if (p != NULL)
867 {
868 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
869 vim_free(p);
870 }
871 /* situation 2: skip already copied lines */
872 if (line1 == n)
873 line1 = curwin->w_cursor.lnum;
874 ++line1;
875 if (curwin->w_cursor.lnum < line1)
876 ++line1;
877 if (curwin->w_cursor.lnum < line2)
878 ++line2;
879 ++curwin->w_cursor.lnum;
880 }
881
882 appended_lines_mark(n, count);
883
884 msgmore((long)count);
885}
886
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000887static char_u *prevcmd = NULL; /* the previous command */
888
889#if defined(EXITFREE) || defined(PROTO)
890 void
891free_prev_shellcmd()
892{
893 vim_free(prevcmd);
894}
895#endif
896
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897/*
898 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
899 * Bangs in the argument are replaced with the previously entered command.
900 * Remember the argument.
901 *
902 * RISCOS: Bangs only replaced when followed by a space, since many
903 * pathnames contain one.
904 */
905 void
906do_bang(addr_count, eap, forceit, do_in, do_out)
907 int addr_count;
908 exarg_T *eap;
909 int forceit;
910 int do_in, do_out;
911{
912 char_u *arg = eap->arg; /* command */
913 linenr_T line1 = eap->line1; /* start of range */
914 linenr_T line2 = eap->line2; /* end of range */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 char_u *newcmd = NULL; /* the new command */
916 int free_newcmd = FALSE; /* need to free() newcmd */
917 int ins_prevcmd;
918 char_u *t;
919 char_u *p;
920 char_u *trailarg;
921 int len;
922 int scroll_save = msg_scroll;
923
924 /*
925 * Disallow shell commands for "rvim".
926 * Disallow shell commands from .exrc and .vimrc in current directory for
927 * security reasons.
928 */
929 if (check_restricted() || check_secure())
930 return;
931
932 if (addr_count == 0) /* :! */
933 {
934 msg_scroll = FALSE; /* don't scroll here */
935 autowrite_all();
936 msg_scroll = scroll_save;
937 }
938
939 /*
940 * Try to find an embedded bang, like in :!<cmd> ! [args]
941 * (:!! is indicated by the 'forceit' variable)
942 */
943 ins_prevcmd = forceit;
944 trailarg = arg;
945 do
946 {
947 len = (int)STRLEN(trailarg) + 1;
948 if (newcmd != NULL)
949 len += (int)STRLEN(newcmd);
950 if (ins_prevcmd)
951 {
952 if (prevcmd == NULL)
953 {
954 EMSG(_(e_noprev));
955 vim_free(newcmd);
956 return;
957 }
958 len += (int)STRLEN(prevcmd);
959 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +0000960 if ((t = alloc((unsigned)len)) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961 {
962 vim_free(newcmd);
963 return;
964 }
965 *t = NUL;
966 if (newcmd != NULL)
967 STRCAT(t, newcmd);
968 if (ins_prevcmd)
969 STRCAT(t, prevcmd);
970 p = t + STRLEN(t);
971 STRCAT(t, trailarg);
972 vim_free(newcmd);
973 newcmd = t;
974
975 /*
976 * Scan the rest of the argument for '!', which is replaced by the
977 * previous command. "\!" is replaced by "!" (this is vi compatible).
978 */
979 trailarg = NULL;
980 while (*p)
981 {
982 if (*p == '!'
983#ifdef RISCOS
984 && (p[1] == ' ' || p[1] == NUL)
985#endif
986 )
987 {
988 if (p > newcmd && p[-1] == '\\')
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000989 STRMOVE(p - 1, p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 else
991 {
992 trailarg = p;
993 *trailarg++ = NUL;
994 ins_prevcmd = TRUE;
995 break;
996 }
997 }
998 ++p;
999 }
1000 } while (trailarg != NULL);
1001
1002 vim_free(prevcmd);
1003 prevcmd = newcmd;
1004
1005 if (bangredo) /* put cmd in redo buffer for ! command */
1006 {
Bram Moolenaarebefac62005-12-28 22:39:57 +00001007 AppendToRedobuffLit(prevcmd, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 AppendToRedobuff((char_u *)"\n");
1009 bangredo = FALSE;
1010 }
1011 /*
1012 * Add quotes around the command, for shells that need them.
1013 */
1014 if (*p_shq != NUL)
1015 {
1016 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1017 if (newcmd == NULL)
1018 return;
1019 STRCPY(newcmd, p_shq);
1020 STRCAT(newcmd, prevcmd);
1021 STRCAT(newcmd, p_shq);
1022 free_newcmd = TRUE;
1023 }
1024 if (addr_count == 0) /* :! */
1025 {
1026 /* echo the command */
1027 msg_start();
1028 msg_putchar(':');
1029 msg_putchar('!');
1030 msg_outtrans(newcmd);
1031 msg_clr_eos();
1032 windgoto(msg_row, msg_col);
1033
1034 do_shell(newcmd, 0);
1035 }
1036 else /* :range! */
Bram Moolenaarade00832006-03-10 21:46:58 +00001037 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 /* Careful: This may recursively call do_bang() again! (because of
1039 * autocommands) */
1040 do_filter(line1, line2, eap, newcmd, do_in, do_out);
Bram Moolenaarade00832006-03-10 21:46:58 +00001041#ifdef FEAT_AUTOCMD
1042 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1043#endif
1044 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 if (free_newcmd)
1046 vim_free(newcmd);
1047}
1048
1049/*
1050 * do_filter: filter lines through a command given by the user
1051 *
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001052 * We mostly use temp files and the call_shell() routine here. This would
1053 * normally be done using pipes on a UNIX machine, but this is more portable
1054 * to non-unix machines. The call_shell() routine needs to be able
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 * to deal with redirection somehow, and should handle things like looking
1056 * at the PATH env. variable, and adding reasonable extensions to the
1057 * command name given by the user. All reasonable versions of call_shell()
1058 * do this.
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001059 * Alternatively, if on Unix and redirecting input or output, but not both,
1060 * and the 'shelltemp' option isn't set, use pipes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 * We use input redirection if do_in is TRUE.
1062 * We use output redirection if do_out is TRUE.
1063 */
1064 static void
1065do_filter(line1, line2, eap, cmd, do_in, do_out)
1066 linenr_T line1, line2;
1067 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1068 char_u *cmd;
1069 int do_in, do_out;
1070{
1071 char_u *itmp = NULL;
1072 char_u *otmp = NULL;
1073 linenr_T linecount;
1074 linenr_T read_linecount;
1075 pos_T cursor_save;
1076 char_u *cmd_buf;
1077#ifdef FEAT_AUTOCMD
1078 buf_T *old_curbuf = curbuf;
1079#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001080 int shell_flags = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081
1082 if (*cmd == NUL) /* no filter command */
1083 return;
1084
1085#ifdef WIN3264
1086 /*
1087 * Check if external commands are allowed now.
1088 */
1089 if (can_end_termcap_mode(TRUE) == FALSE)
1090 return;
1091#endif
1092
1093 cursor_save = curwin->w_cursor;
1094 linecount = line2 - line1 + 1;
1095 curwin->w_cursor.lnum = line1;
1096 curwin->w_cursor.col = 0;
1097 changed_line_abv_curs();
1098 invalidate_botline();
1099
1100 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001101 * When using temp files:
1102 * 1. * Form temp file names
1103 * 2. * Write the lines to a temp file
1104 * 3. Run the filter command on the temp file
1105 * 4. * Read the output of the command into the buffer
1106 * 5. * Delete the original lines to be filtered
1107 * 6. * Remove the temp files
1108 *
1109 * When writing the input with a pipe or when catching the output with a
1110 * pipe only need to do 3.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 */
1112
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001113 if (do_out)
1114 shell_flags |= SHELL_DOOUT;
1115
1116#if !defined(USE_SYSTEM) && defined(UNIX)
1117 if (!do_in && do_out && !p_stmp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001119 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1120 shell_flags |= SHELL_READ;
1121 curwin->w_cursor.lnum = line2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001123 else if (do_in && !do_out && !p_stmp)
1124 {
1125 /* Use a pipe to write stdin of the command, do not use a temp file. */
1126 shell_flags |= SHELL_WRITE;
1127 curbuf->b_op_start.lnum = line1;
1128 curbuf->b_op_end.lnum = line2;
1129 }
1130 else if (do_in && do_out && !p_stmp)
1131 {
1132 /* Use a pipe to write stdin and fetch stdout of the command, do not
1133 * use a temp file. */
1134 shell_flags |= SHELL_READ|SHELL_WRITE;
1135 curbuf->b_op_start.lnum = line1;
1136 curbuf->b_op_end.lnum = line2;
1137 curwin->w_cursor.lnum = line2;
1138 }
1139 else
1140#endif
1141 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1142 || (do_out && (otmp = vim_tempname('o')) == NULL))
1143 {
1144 EMSG(_(e_notmp));
1145 goto filterend;
1146 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147
1148/*
1149 * The writing and reading of temp files will not be shown.
1150 * Vi also doesn't do this and the messages are not very informative.
1151 */
1152 ++no_wait_return; /* don't call wait_return() while busy */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001153 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 FALSE, FALSE, FALSE, TRUE) == FAIL)
1155 {
1156 msg_putchar('\n'); /* keep message from buf_write() */
1157 --no_wait_return;
1158#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1159 if (!aborting())
1160#endif
1161 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1162 goto filterend;
1163 }
1164#ifdef FEAT_AUTOCMD
1165 if (curbuf != old_curbuf)
1166 goto filterend;
1167#endif
1168
1169 if (!do_out)
1170 msg_putchar('\n');
1171
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001172 /* Create the shell command in allocated memory. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1174 if (cmd_buf == NULL)
1175 goto filterend;
1176
1177 windgoto((int)Rows - 1, 0);
1178 cursor_on();
1179
1180 /*
1181 * When not redirecting the output the command can write anything to the
1182 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1183 * stderr output of external command. Clear the screen later.
1184 * If do_in is FALSE, this could be something like ":r !cat", which may
1185 * also mess up the screen, clear it later.
1186 */
1187 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1188 redraw_later_clear();
1189
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001190 if (do_out)
1191 {
1192 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001193 {
1194 vim_free(cmd_buf);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001195 goto error;
Bram Moolenaara9aafe52008-05-07 11:10:28 +00001196 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001197 redraw_curbuf_later(VALID);
1198 }
1199 read_linecount = curbuf->b_ml.ml_line_count;
1200
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 /*
1202 * When call_shell() fails wait_return() is called to give the user a
1203 * chance to read the error messages. Otherwise errors are ignored, so you
1204 * can see the error messages from the command that appear on stdout; use
1205 * 'u' to fix the text
1206 * Switch to cooked mode when not redirecting stdin, avoids that something
1207 * like ":r !cat" hangs.
1208 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1209 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001210 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {
1212 redraw_later_clear();
1213 wait_return(FALSE);
1214 }
1215 vim_free(cmd_buf);
1216
1217 did_check_timestamps = FALSE;
1218 need_check_timestamps = TRUE;
1219
1220 /* When interrupting the shell command, it may still have produced some
1221 * useful output. Reset got_int here, so that readfile() won't cancel
1222 * reading. */
1223 ui_breakcheck();
1224 got_int = FALSE;
1225
1226 if (do_out)
1227 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001228 if (otmp != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001230 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1231 eap, READ_FILTER) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001233#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1234 if (!aborting())
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001236 {
1237 msg_putchar('\n');
1238 EMSG2(_(e_notread), otmp);
1239 }
1240 goto error;
1241 }
1242#ifdef FEAT_AUTOCMD
1243 if (curbuf != old_curbuf)
1244 goto filterend;
1245#endif
1246 }
1247
1248 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1249
1250 if (shell_flags & SHELL_READ)
1251 {
1252 curbuf->b_op_start.lnum = line2 + 1;
1253 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1254 appended_lines_mark(line2, read_linecount);
1255 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256
1257 if (do_in)
1258 {
1259 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1260 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 if (read_linecount >= linecount)
1262 /* move all marks from old lines to new lines */
1263 mark_adjust(line1, line2, linecount, 0L);
1264 else
1265 {
1266 /* move marks from old lines to new lines, delete marks
1267 * that are in deleted lines */
1268 mark_adjust(line1, line1 + read_linecount - 1,
1269 linecount, 0L);
1270 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1271 }
1272 }
1273
1274 /*
1275 * Put cursor on first filtered line for ":range!cmd".
1276 * Adjust '[ and '] (set by buf_write()).
1277 */
1278 curwin->w_cursor.lnum = line1;
1279 del_lines(linecount, TRUE);
1280 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1281 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1282 write_lnum_adjust(-linecount); /* adjust last line
1283 for next write */
Bram Moolenaar8c711452005-01-14 21:53:12 +00001284#ifdef FEAT_FOLDING
1285 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1286#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 }
1288 else
1289 {
1290 /*
1291 * Put cursor on last new line for ":r !cmd".
1292 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001294 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 }
Bram Moolenaar8c711452005-01-14 21:53:12 +00001296
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1298 --no_wait_return;
1299
1300 if (linecount > p_report)
1301 {
1302 if (do_in)
1303 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00001304 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1305 _("%ld lines filtered"), (long)linecount);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 if (msg(msg_buf) && !msg_scroll)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00001308 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 }
1310 else
1311 msgmore((long)linecount);
1312 }
1313 }
1314 else
1315 {
1316error:
1317 /* put cursor back in same position for ":w !cmd" */
1318 curwin->w_cursor = cursor_save;
1319 --no_wait_return;
1320 wait_return(FALSE);
1321 }
1322
1323filterend:
1324
1325#ifdef FEAT_AUTOCMD
1326 if (curbuf != old_curbuf)
1327 {
1328 --no_wait_return;
1329 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1330 }
1331#endif
1332 if (itmp != NULL)
1333 mch_remove(itmp);
1334 if (otmp != NULL)
1335 mch_remove(otmp);
1336 vim_free(itmp);
1337 vim_free(otmp);
1338}
1339
1340/*
1341 * Call a shell to execute a command.
1342 * When "cmd" is NULL start an interactive shell.
1343 */
1344 void
1345do_shell(cmd, flags)
1346 char_u *cmd;
1347 int flags; /* may be SHELL_DOOUT when output is redirected */
1348{
1349 buf_T *buf;
1350#ifndef FEAT_GUI_MSWIN
1351 int save_nwr;
1352#endif
1353#ifdef MSWIN
1354 int winstart = FALSE;
1355#endif
1356
1357 /*
1358 * Disallow shell commands for "rvim".
1359 * Disallow shell commands from .exrc and .vimrc in current directory for
1360 * security reasons.
1361 */
1362 if (check_restricted() || check_secure())
1363 {
1364 msg_end();
1365 return;
1366 }
1367
1368#ifdef MSWIN
1369 /*
1370 * Check if external commands are allowed now.
1371 */
1372 if (can_end_termcap_mode(TRUE) == FALSE)
1373 return;
1374
1375 /*
1376 * Check if ":!start" is used.
1377 */
1378 if (cmd != NULL)
1379 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1380#endif
1381
1382 /*
1383 * For autocommands we want to get the output on the current screen, to
1384 * avoid having to type return below.
1385 */
1386 msg_putchar('\r'); /* put cursor at start of line */
1387#ifdef FEAT_AUTOCMD
1388 if (!autocmd_busy)
1389#endif
1390 {
1391#ifdef MSWIN
1392 if (!winstart)
1393#endif
1394 stoptermcap();
1395 }
1396#ifdef MSWIN
1397 if (!winstart)
1398#endif
1399 msg_putchar('\n'); /* may shift screen one line up */
1400
1401 /* warning message before calling the shell */
1402 if (p_warn
1403#ifdef FEAT_AUTOCMD
1404 && !autocmd_busy
1405#endif
1406 && msg_silent == 0)
1407 for (buf = firstbuf; buf; buf = buf->b_next)
1408 if (bufIsChanged(buf))
1409 {
1410#ifdef FEAT_GUI_MSWIN
1411 if (!winstart)
1412 starttermcap(); /* don't want a message box here */
1413#endif
1414 MSG_PUTS(_("[No write since last change]\n"));
1415#ifdef FEAT_GUI_MSWIN
1416 if (!winstart)
1417 stoptermcap();
1418#endif
1419 break;
1420 }
1421
1422 /* This windgoto is required for when the '\n' resulted in a "delete line
1423 * 1" command to the terminal. */
1424 if (!swapping_screen())
1425 windgoto(msg_row, msg_col);
1426 cursor_on();
1427 (void)call_shell(cmd, SHELL_COOKED | flags);
1428 did_check_timestamps = FALSE;
1429 need_check_timestamps = TRUE;
1430
1431 /*
1432 * put the message cursor at the end of the screen, avoids wait_return()
1433 * to overwrite the text that the external command showed
1434 */
1435 if (!swapping_screen())
1436 {
1437 msg_row = Rows - 1;
1438 msg_col = 0;
1439 }
1440
1441#ifdef FEAT_AUTOCMD
1442 if (autocmd_busy)
1443 {
1444 if (msg_silent == 0)
1445 redraw_later_clear();
1446 }
1447 else
1448#endif
1449 {
1450 /*
1451 * For ":sh" there is no need to call wait_return(), just redraw.
1452 * Also for the Win32 GUI (the output is in a console window).
1453 * Otherwise there is probably text on the screen that the user wants
1454 * to read before redrawing, so call wait_return().
1455 */
1456#ifndef FEAT_GUI_MSWIN
1457 if (cmd == NULL
1458# ifdef WIN3264
1459 || (winstart && !need_wait_return)
1460# endif
1461 )
1462 {
1463 if (msg_silent == 0)
1464 redraw_later_clear();
1465 need_wait_return = FALSE;
1466 }
1467 else
1468 {
1469 /*
1470 * If we switch screens when starttermcap() is called, we really
1471 * want to wait for "hit return to continue".
1472 */
1473 save_nwr = no_wait_return;
1474 if (swapping_screen())
1475 no_wait_return = FALSE;
1476# ifdef AMIGA
1477 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1478# else
1479 wait_return(msg_silent == 0);
1480# endif
1481 no_wait_return = save_nwr;
1482 }
1483#endif /* FEAT_GUI_W32 */
1484
1485#ifdef MSWIN
1486 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1487#endif
1488 starttermcap(); /* start termcap if not done by wait_return() */
1489
1490 /*
1491 * In an Amiga window redrawing is caused by asking the window size.
1492 * If we got an interrupt this will not work. The chance that the
1493 * window size is wrong is very small, but we need to redraw the
1494 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1495 * but it saves an extra redraw.
1496 */
1497#ifdef AMIGA
1498 if (skip_redraw) /* ':' hit in wait_return() */
1499 {
1500 if (msg_silent == 0)
1501 redraw_later_clear();
1502 }
1503 else if (term_console)
1504 {
1505 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1506 if (got_int && msg_silent == 0)
1507 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1508 else
1509 must_redraw = 0; /* no extra redraw needed */
1510 }
1511#endif
1512 }
1513
1514 /* display any error messages now */
1515 display_errors();
Bram Moolenaarade00832006-03-10 21:46:58 +00001516
1517#ifdef FEAT_AUTOCMD
1518 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1519#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520}
1521
1522/*
1523 * Create a shell command from a command string, input redirection file and
1524 * output redirection file.
1525 * Returns an allocated string with the shell command, or NULL for failure.
1526 */
1527 char_u *
1528make_filter_cmd(cmd, itmp, otmp)
1529 char_u *cmd; /* command */
1530 char_u *itmp; /* NULL or name of input file */
1531 char_u *otmp; /* NULL or name of output file */
1532{
1533 char_u *buf;
1534 long_u len;
1535
1536 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1537 if (itmp != NULL)
1538 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1539 if (otmp != NULL)
1540 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1541 buf = lalloc(len, TRUE);
1542 if (buf == NULL)
1543 return NULL;
1544
1545#if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1546 /*
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001547 * Put braces around the command (for concatenated commands) when
1548 * redirecting input and/or output.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001550 if (itmp != NULL || otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001551 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00001552 else
1553 STRCPY(buf, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 if (itmp != NULL)
1555 {
1556 STRCAT(buf, " < ");
1557 STRCAT(buf, itmp);
1558 }
1559#else
1560 /*
1561 * for shells that don't understand braces around commands, at least allow
1562 * the use of commands in a pipe.
1563 */
1564 STRCPY(buf, cmd);
1565 if (itmp != NULL)
1566 {
1567 char_u *p;
1568
1569 /*
1570 * If there is a pipe, we have to put the '<' in front of it.
1571 * Don't do this when 'shellquote' is not empty, otherwise the
1572 * redirection would be inside the quotes.
1573 */
1574 if (*p_shq == NUL)
1575 {
1576 p = vim_strchr(buf, '|');
1577 if (p != NULL)
1578 *p = NUL;
1579 }
1580# ifdef RISCOS
1581 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1582 STRCAT(buf, itmp);
1583 STRCAT(buf, " } ");
1584# else
1585 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1586 STRCAT(buf, itmp);
1587# endif
1588 if (*p_shq == NUL)
1589 {
1590 p = vim_strchr(cmd, '|');
1591 if (p != NULL)
1592 {
1593 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1594 STRCAT(buf, p);
1595 }
1596 }
1597 }
1598#endif
1599 if (otmp != NULL)
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001600 append_redir(buf, (int)len, p_srr, otmp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601
1602 return buf;
1603}
1604
1605/*
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001606 * Append output redirection for file "fname" to the end of string buffer
1607 * "buf[buflen]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 * Works with the 'shellredir' and 'shellpipe' options.
1609 * The caller should make sure that there is enough room:
1610 * STRLEN(opt) + STRLEN(fname) + 3
1611 */
1612 void
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001613append_redir(buf, buflen, opt, fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 char_u *buf;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001615 int buflen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 char_u *opt;
1617 char_u *fname;
1618{
1619 char_u *p;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001620 char_u *end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001622 end = buf + STRLEN(buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623 /* find "%s", skipping "%%" */
1624 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1625 if (p[1] == 's')
1626 break;
1627 if (p != NULL)
1628 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001629 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1630 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1631 (char *)opt, (char *)fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 }
1633 else
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00001634 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635#ifdef FEAT_QUICKFIX
1636# ifndef RISCOS
1637 opt != p_sp ? " %s%s" :
1638# endif
1639 " %s %s",
1640#else
1641# ifndef RISCOS
1642 " %s%s", /* " > %s" causes problems on Amiga */
1643# else
1644 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1645# endif
1646#endif
1647 (char *)opt, (char *)fname);
1648}
1649
1650#ifdef FEAT_VIMINFO
1651
1652static int no_viminfo __ARGS((void));
1653static int viminfo_errcnt;
1654
1655 static int
1656no_viminfo()
1657{
1658 /* "vim -i NONE" does not read or write a viminfo file */
1659 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1660}
1661
1662/*
1663 * Report an error for reading a viminfo file.
1664 * Count the number of errors. When there are more than 10, return TRUE.
1665 */
1666 int
1667viminfo_error(errnum, message, line)
1668 char *errnum;
1669 char *message;
1670 char_u *line;
1671{
Bram Moolenaar555b2802005-05-19 21:08:39 +00001672 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1673 errnum, message);
Bram Moolenaar6c964832007-12-09 18:38:35 +00001674 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
Bram Moolenaar758711c2005-02-02 23:11:38 +00001675 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1676 IObuff[STRLEN(IObuff) - 1] = NUL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 emsg(IObuff);
1678 if (++viminfo_errcnt >= 10)
1679 {
1680 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1681 return TRUE;
1682 }
1683 return FALSE;
1684}
1685
1686/*
1687 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
Bram Moolenaard812df62008-11-09 12:46:09 +00001688 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 */
1690 int
Bram Moolenaard812df62008-11-09 12:46:09 +00001691read_viminfo(file, flags)
1692 char_u *file; /* file name or NULL to use default name */
1693 int flags; /* VIF_WANT_INFO et al. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694{
1695 FILE *fp;
1696 char_u *fname;
1697
1698 if (no_viminfo())
1699 return FAIL;
1700
Bram Moolenaard812df62008-11-09 12:46:09 +00001701 fname = viminfo_filename(file); /* get file name in allocated buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 if (fname == NULL)
1703 return FAIL;
1704 fp = mch_fopen((char *)fname, READBIN);
1705
1706 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001707 {
1708 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001709 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1710 fname,
Bram Moolenaard812df62008-11-09 12:46:09 +00001711 (flags & VIF_WANT_INFO) ? _(" info") : "",
1712 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1713 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
Bram Moolenaar555b2802005-05-19 21:08:39 +00001714 fp == NULL ? _(" FAILED") : "");
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001715 verbose_leave();
1716 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
1718 vim_free(fname);
1719 if (fp == NULL)
1720 return FAIL;
1721
1722 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001723 do_viminfo(fp, NULL, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
1725 fclose(fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 return OK;
1727}
1728
1729/*
1730 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1731 * that effectively a merge of current info and old info is done. This allows
1732 * multiple vims to run simultaneously, without losing any marks etc. If
1733 * forceit is TRUE, then the old file is not read in, and only internal info is
1734 * written to the file. -- webb
1735 */
1736 void
1737write_viminfo(file, forceit)
1738 char_u *file;
1739 int forceit;
1740{
1741 char_u *fname;
1742 FILE *fp_in = NULL; /* input viminfo file, if any */
1743 FILE *fp_out = NULL; /* output viminfo file */
1744 char_u *tempname = NULL; /* name of temp viminfo file */
1745 struct stat st_new; /* mch_stat() of potential new file */
1746 char_u *wp;
1747#if defined(UNIX) || defined(VMS)
1748 mode_t umask_save;
1749#endif
1750#ifdef UNIX
1751 int shortname = FALSE; /* use 8.3 file name */
1752 struct stat st_old; /* mch_stat() of existing viminfo file */
1753#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001754#ifdef WIN3264
1755 long perm = -1;
1756#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757
1758 if (no_viminfo())
1759 return;
1760
1761 fname = viminfo_filename(file); /* may set to default if NULL */
1762 if (fname == NULL)
1763 return;
1764
1765 fp_in = mch_fopen((char *)fname, READBIN);
1766 if (fp_in == NULL)
1767 {
1768 /* if it does exist, but we can't read it, don't try writing */
1769 if (mch_stat((char *)fname, &st_new) == 0)
1770 goto end;
1771#if defined(UNIX) || defined(VMS)
1772 /*
1773 * For Unix we create the .viminfo non-accessible for others,
1774 * because it may contain text from non-accessible documents.
1775 */
1776 umask_save = umask(077);
1777#endif
1778 fp_out = mch_fopen((char *)fname, WRITEBIN);
1779#if defined(UNIX) || defined(VMS)
1780 (void)umask(umask_save);
1781#endif
1782 }
1783 else
1784 {
1785 /*
1786 * There is an existing viminfo file. Create a temporary file to
1787 * write the new viminfo into, in the same directory as the
1788 * existing viminfo file, which will be renamed later.
1789 */
1790#ifdef UNIX
1791 /*
1792 * For Unix we check the owner of the file. It's not very nice to
1793 * overwrite a user's viminfo file after a "su root", with a
1794 * viminfo file that the user can't read.
1795 */
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00001796 st_old.st_dev = (dev_t)0;
Bram Moolenaar6f192452007-11-08 19:49:02 +00001797 st_old.st_ino = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 st_old.st_mode = 0600;
Bram Moolenaar311d9822007-02-27 15:48:28 +00001799 if (mch_stat((char *)fname, &st_old) == 0
1800 && getuid() != ROOT_UID
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001801 && !(st_old.st_uid == getuid()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 ? (st_old.st_mode & 0200)
1803 : (st_old.st_gid == getgid()
1804 ? (st_old.st_mode & 0020)
1805 : (st_old.st_mode & 0002))))
1806 {
Bram Moolenaar89d40322006-08-29 15:30:07 +00001807 int tt = msg_didany;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
1809 /* avoid a wait_return for this message, it's annoying */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1811 msg_didany = tt;
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001812 fclose(fp_in);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 goto end;
1814 }
1815#endif
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001816#ifdef WIN3264
1817 /* Get the file attributes of the existing viminfo file. */
1818 perm = mch_getperm(fname);
1819#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820
1821 /*
1822 * Make tempname.
1823 * May try twice: Once normal and once with shortname set, just in
1824 * case somebody puts his viminfo file in an 8.3 filesystem.
1825 */
1826 for (;;)
1827 {
1828 tempname = buf_modname(
1829#ifdef UNIX
1830 shortname,
1831#else
1832# ifdef SHORT_FNAME
1833 TRUE,
1834# else
1835# ifdef FEAT_GUI_W32
1836 gui_is_win32s(),
1837# else
1838 FALSE,
1839# endif
1840# endif
1841#endif
1842 fname,
1843#ifdef VMS
1844 (char_u *)"-tmp",
1845#else
1846# ifdef RISCOS
1847 (char_u *)"/tmp",
1848# else
1849 (char_u *)".tmp",
1850# endif
1851#endif
1852 FALSE);
1853 if (tempname == NULL) /* out of memory */
1854 break;
1855
1856 /*
1857 * Check if tempfile already exists. Never overwrite an
1858 * existing file!
1859 */
1860 if (mch_stat((char *)tempname, &st_new) == 0)
1861 {
1862#ifdef UNIX
1863 /*
1864 * Check if tempfile is same as original file. May happen
1865 * when modname() gave the same file back. E.g. silly
1866 * link, or file name-length reached. Try again with
1867 * shortname set.
1868 */
Bram Moolenaar12625ca2005-11-25 19:58:47 +00001869 if (!shortname && st_new.st_dev == st_old.st_dev
1870 && st_new.st_ino == st_old.st_ino)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 {
1872 vim_free(tempname);
1873 tempname = NULL;
1874 shortname = TRUE;
1875 continue;
1876 }
1877#endif
1878 /*
1879 * Try another name. Change one character, just before
1880 * the extension. This should also work for an 8.3
1881 * file name, when after adding the extension it still is
1882 * the same file as the original.
1883 */
1884 wp = tempname + STRLEN(tempname) - 5;
1885 if (wp < gettail(tempname)) /* empty file name? */
1886 wp = gettail(tempname);
1887 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1888 --*wp)
1889 {
1890 /*
1891 * They all exist? Must be something wrong! Don't
1892 * write the viminfo file then.
1893 */
1894 if (*wp == 'a')
1895 {
1896 vim_free(tempname);
1897 tempname = NULL;
1898 break;
1899 }
1900 }
1901 }
1902 break;
1903 }
1904
1905 if (tempname != NULL)
1906 {
Bram Moolenaar114216c2006-03-14 23:08:30 +00001907#ifdef VMS
1908 /* fdopen() fails for some reason */
Bram Moolenaarcf034472006-03-15 23:07:59 +00001909 umask_save = umask(077);
1910 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1911 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001912#else
Bram Moolenaara5792f52005-11-23 21:25:05 +00001913 int fd;
1914
1915 /* Use mch_open() to be able to use O_NOFOLLOW and set file
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001916 * protection:
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001917 * Unix: same as original file, but strip s-bit. Reset umask to
1918 * avoid it getting in the way.
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001919 * Others: r&w for user only. */
Bram Moolenaar114216c2006-03-14 23:08:30 +00001920# ifdef UNIX
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001921 umask_save = umask(0);
Bram Moolenaara5792f52005-11-23 21:25:05 +00001922 fd = mch_open((char *)tempname,
1923 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001924 (int)((st_old.st_mode & 0777) | 0600));
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001925 (void)umask(umask_save);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001926# else
Bram Moolenaarbba577a2005-11-28 23:05:55 +00001927 fd = mch_open((char *)tempname,
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00001928 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001929# endif
Bram Moolenaara5792f52005-11-23 21:25:05 +00001930 if (fd < 0)
1931 fp_out = NULL;
1932 else
1933 fp_out = fdopen(fd, WRITEBIN);
Bram Moolenaar114216c2006-03-14 23:08:30 +00001934#endif /* VMS */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935
1936 /*
1937 * If we can't create in the same directory, try creating a
1938 * "normal" temp file.
1939 */
1940 if (fp_out == NULL)
1941 {
1942 vim_free(tempname);
1943 if ((tempname = vim_tempname('o')) != NULL)
1944 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1945 }
Bram Moolenaara5792f52005-11-23 21:25:05 +00001946
1947#if defined(UNIX) && defined(HAVE_FCHOWN)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 /*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001949 * Make sure the owner can read/write it. This only works for
1950 * root.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 */
1952 if (fp_out != NULL)
Bram Moolenaarfe86f2d2008-11-28 20:29:07 +00001953 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954#endif
1955 }
1956 }
1957
1958 /*
1959 * Check if the new viminfo file can be written to.
1960 */
1961 if (fp_out == NULL)
1962 {
1963 EMSG2(_("E138: Can't write viminfo file %s!"),
Bram Moolenaar75c50c42005-06-04 22:06:24 +00001964 (fp_in == NULL || tempname == NULL) ? fname : tempname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 if (fp_in != NULL)
1966 fclose(fp_in);
1967 goto end;
1968 }
1969
1970 if (p_verbose > 0)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001971 {
1972 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00001973 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00001974 verbose_leave();
1975 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976
1977 viminfo_errcnt = 0;
Bram Moolenaard812df62008-11-09 12:46:09 +00001978 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979
1980 fclose(fp_out); /* errors are ignored !? */
1981 if (fp_in != NULL)
1982 {
1983 fclose(fp_in);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001984
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 /*
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001986 * In case of an error keep the original viminfo file.
1987 * Otherwise rename the newly written file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 */
1989 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1990 mch_remove(tempname);
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001991
1992#ifdef WIN3264
1993 /* If the viminfo file was hidden then also hide the new file. */
1994 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1995 mch_hide(fname);
1996#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 }
Bram Moolenaarbca84a12005-12-14 22:08:35 +00001998
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999end:
2000 vim_free(fname);
2001 vim_free(tempname);
2002}
2003
2004/*
2005 * Get the viminfo file name to use.
2006 * If "file" is given and not empty, use it (has already been expanded by
2007 * cmdline functions).
2008 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2009 * expand environment variables.
2010 * Returns an allocated string. NULL when out of memory.
2011 */
2012 static char_u *
2013viminfo_filename(file)
2014 char_u *file;
2015{
2016 if (file == NULL || *file == NUL)
2017 {
2018 if (use_viminfo != NULL)
2019 file = use_viminfo;
2020 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2021 {
2022#ifdef VIMINFO_FILE2
2023 /* don't use $HOME when not defined (turned into "c:/"!). */
2024# ifdef VMS
2025 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2026# else
2027 if (mch_getenv((char_u *)"HOME") == NULL)
2028# endif
2029 {
2030 /* don't use $VIM when not available. */
2031 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2032 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2033 file = (char_u *)VIMINFO_FILE2;
2034 else
2035 file = (char_u *)VIMINFO_FILE;
2036 }
2037 else
2038#endif
2039 file = (char_u *)VIMINFO_FILE;
2040 }
2041 expand_env(file, NameBuff, MAXPATHL);
2042 file = NameBuff;
2043 }
2044 return vim_strsave(file);
2045}
2046
2047/*
2048 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2049 */
2050 static void
Bram Moolenaard812df62008-11-09 12:46:09 +00002051do_viminfo(fp_in, fp_out, flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 FILE *fp_in;
2053 FILE *fp_out;
Bram Moolenaard812df62008-11-09 12:46:09 +00002054 int flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055{
2056 int count = 0;
2057 int eof = FALSE;
2058 vir_T vir;
2059
2060 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2061 return;
2062 vir.vir_fd = fp_in;
2063#ifdef FEAT_MBYTE
2064 vir.vir_conv.vc_type = CONV_NONE;
2065#endif
2066
2067 if (fp_in != NULL)
2068 {
Bram Moolenaard812df62008-11-09 12:46:09 +00002069 if (flags & VIF_WANT_INFO)
2070 eof = read_viminfo_up_to_marks(&vir,
2071 flags & VIF_FORCEIT, fp_out != NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 else
2073 /* Skip info, find start of marks */
2074 while (!(eof = viminfo_readline(&vir))
2075 && vir.vir_line[0] != '>')
2076 ;
2077 }
2078 if (fp_out != NULL)
2079 {
2080 /* Write the info: */
2081 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2082 VIM_VERSION_MEDIUM);
2083 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2084#ifdef FEAT_MBYTE
2085 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2086 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2087#endif
2088 write_viminfo_search_pattern(fp_out);
2089 write_viminfo_sub_string(fp_out);
2090#ifdef FEAT_CMDHIST
2091 write_viminfo_history(fp_out);
2092#endif
2093 write_viminfo_registers(fp_out);
2094#ifdef FEAT_EVAL
2095 write_viminfo_varlist(fp_out);
2096#endif
2097 write_viminfo_filemarks(fp_out);
2098 write_viminfo_bufferlist(fp_out);
2099 count = write_viminfo_marks(fp_out);
2100 }
Bram Moolenaard812df62008-11-09 12:46:09 +00002101 if (fp_in != NULL
2102 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2103 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104
2105 vim_free(vir.vir_line);
2106#ifdef FEAT_MBYTE
2107 if (vir.vir_conv.vc_type != CONV_NONE)
2108 convert_setup(&vir.vir_conv, NULL, NULL);
2109#endif
2110}
2111
2112/*
2113 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2114 * first part of the viminfo file which contains everything but the marks that
2115 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2116 */
2117 static int
2118read_viminfo_up_to_marks(virp, forceit, writing)
2119 vir_T *virp;
2120 int forceit;
2121 int writing;
2122{
2123 int eof;
2124 buf_T *buf;
2125
2126#ifdef FEAT_CMDHIST
2127 prepare_viminfo_history(forceit ? 9999 : 0);
2128#endif
2129 eof = viminfo_readline(virp);
2130 while (!eof && virp->vir_line[0] != '>')
2131 {
2132 switch (virp->vir_line[0])
2133 {
2134 /* Characters reserved for future expansion, ignored now */
2135 case '+': /* "+40 /path/dir file", for running vim without args */
2136 case '|': /* to be defined */
2137 case '^': /* to be defined */
2138 case '<': /* long line - ignored */
2139 /* A comment or empty line. */
2140 case NUL:
2141 case '\r':
2142 case '\n':
2143 case '#':
2144 eof = viminfo_readline(virp);
2145 break;
2146 case '*': /* "*encoding=value" */
2147 eof = viminfo_encoding(virp);
2148 break;
2149 case '!': /* global variable */
2150#ifdef FEAT_EVAL
2151 eof = read_viminfo_varlist(virp, writing);
2152#else
2153 eof = viminfo_readline(virp);
2154#endif
2155 break;
2156 case '%': /* entry for buffer list */
2157 eof = read_viminfo_bufferlist(virp, writing);
2158 break;
2159 case '"':
2160 eof = read_viminfo_register(virp, forceit);
2161 break;
2162 case '/': /* Search string */
2163 case '&': /* Substitute search string */
2164 case '~': /* Last search string, followed by '/' or '&' */
2165 eof = read_viminfo_search_pattern(virp, forceit);
2166 break;
2167 case '$':
2168 eof = read_viminfo_sub_string(virp, forceit);
2169 break;
2170 case ':':
2171 case '?':
2172 case '=':
2173 case '@':
2174#ifdef FEAT_CMDHIST
2175 eof = read_viminfo_history(virp);
2176#else
2177 eof = viminfo_readline(virp);
2178#endif
2179 break;
2180 case '-':
2181 case '\'':
2182 eof = read_viminfo_filemark(virp, forceit);
2183 break;
2184 default:
2185 if (viminfo_error("E575: ", _("Illegal starting char"),
2186 virp->vir_line))
2187 eof = TRUE;
2188 else
2189 eof = viminfo_readline(virp);
2190 break;
2191 }
2192 }
2193
2194#ifdef FEAT_CMDHIST
2195 /* Finish reading history items. */
2196 finish_viminfo_history();
2197#endif
2198
2199 /* Change file names to buffer numbers for fmarks. */
2200 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2201 fmarks_check_names(buf);
2202
2203 return eof;
2204}
2205
2206/*
2207 * Compare the 'encoding' value in the viminfo file with the current value of
2208 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2209 * conversion of text with iconv() in viminfo_readstring().
2210 */
2211 static int
2212viminfo_encoding(virp)
2213 vir_T *virp;
2214{
2215#ifdef FEAT_MBYTE
2216 char_u *p;
2217 int i;
2218
2219 if (get_viminfo_parameter('c') != 0)
2220 {
2221 p = vim_strchr(virp->vir_line, '=');
2222 if (p != NULL)
2223 {
2224 /* remove trailing newline */
2225 ++p;
2226 for (i = 0; vim_isprintc(p[i]); ++i)
2227 ;
2228 p[i] = NUL;
2229
2230 convert_setup(&virp->vir_conv, p, p_enc);
2231 }
2232 }
2233#endif
2234 return viminfo_readline(virp);
2235}
2236
2237/*
2238 * Read a line from the viminfo file.
2239 * Returns TRUE for end-of-file;
2240 */
2241 int
2242viminfo_readline(virp)
2243 vir_T *virp;
2244{
2245 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2246}
2247
2248/*
2249 * check string read from viminfo file
2250 * remove '\n' at the end of the line
2251 * - replace CTRL-V CTRL-V with CTRL-V
2252 * - replace CTRL-V 'n' with '\n'
2253 *
2254 * Check for a long line as written by viminfo_writestring().
2255 *
2256 * Return the string in allocated memory (NULL when out of memory).
2257 */
2258/*ARGSUSED*/
2259 char_u *
2260viminfo_readstring(virp, off, convert)
2261 vir_T *virp;
2262 int off; /* offset for virp->vir_line */
2263 int convert; /* convert the string */
2264{
2265 char_u *retval;
2266 char_u *s, *d;
2267 long len;
2268
2269 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2270 {
2271 len = atol((char *)virp->vir_line + off + 1);
2272 retval = lalloc(len, TRUE);
2273 if (retval == NULL)
2274 {
2275 /* Line too long? File messed up? Skip next line. */
2276 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2277 return NULL;
2278 }
2279 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2280 s = retval + 1; /* Skip the leading '<' */
2281 }
2282 else
2283 {
2284 retval = vim_strsave(virp->vir_line + off);
2285 if (retval == NULL)
2286 return NULL;
2287 s = retval;
2288 }
2289
2290 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2291 d = retval;
2292 while (*s != NUL && *s != '\n')
2293 {
2294 if (s[0] == Ctrl_V && s[1] != NUL)
2295 {
2296 if (s[1] == 'n')
2297 *d++ = '\n';
2298 else
2299 *d++ = Ctrl_V;
2300 s += 2;
2301 }
2302 else
2303 *d++ = *s++;
2304 }
2305 *d = NUL;
2306
2307#ifdef FEAT_MBYTE
2308 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2309 {
2310 d = string_convert(&virp->vir_conv, retval, NULL);
2311 if (d != NULL)
2312 {
2313 vim_free(retval);
2314 retval = d;
2315 }
2316 }
2317#endif
2318
2319 return retval;
2320}
2321
2322/*
2323 * write string to viminfo file
2324 * - replace CTRL-V with CTRL-V CTRL-V
2325 * - replace '\n' with CTRL-V 'n'
2326 * - add a '\n' at the end
2327 *
2328 * For a long line:
2329 * - write " CTRL-V <length> \n " in first line
2330 * - write " < <string> \n " in second line
2331 */
2332 void
2333viminfo_writestring(fd, p)
2334 FILE *fd;
2335 char_u *p;
2336{
2337 int c;
2338 char_u *s;
2339 int len = 0;
2340
2341 for (s = p; *s != NUL; ++s)
2342 {
2343 if (*s == Ctrl_V || *s == '\n')
2344 ++len;
2345 ++len;
2346 }
2347
2348 /* If the string will be too long, write its length and put it in the next
2349 * line. Take into account that some room is needed for what comes before
2350 * the string (e.g., variable name). Add something to the length for the
2351 * '<', NL and trailing NUL. */
2352 if (len > LSIZE / 2)
2353 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2354
2355 while ((c = *p++) != NUL)
2356 {
2357 if (c == Ctrl_V || c == '\n')
2358 {
2359 putc(Ctrl_V, fd);
2360 if (c == '\n')
2361 c = 'n';
2362 }
2363 putc(c, fd);
2364 }
2365 putc('\n', fd);
2366}
2367#endif /* FEAT_VIMINFO */
2368
2369/*
2370 * Implementation of ":fixdel", also used by get_stty().
2371 * <BS> resulting <Del>
2372 * ^? ^H
2373 * not ^? ^?
2374 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 void
2376do_fixdel(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00002377 exarg_T *eap UNUSED;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378{
2379 char_u *p;
2380
2381 p = find_termcode((char_u *)"kb");
2382 add_termcode((char_u *)"kD", p != NULL
2383 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2384}
2385
2386 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002387print_line_no_prefix(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 linenr_T lnum;
2389 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002390 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391{
Bram Moolenaar592e0a22004-07-03 16:05:59 +00002392 char_u numbuf[30];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393
2394 if (curwin->w_p_nu || use_number)
2395 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00002396 vim_snprintf((char *)numbuf, sizeof(numbuf),
2397 "%*ld ", number_width(curwin), (long)lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2399 }
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002400 msg_prt_line(ml_get(lnum), list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401}
2402
2403/*
2404 * Print a text line. Also in silent mode ("ex -s").
2405 */
2406 void
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002407print_line(lnum, use_number, list)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 linenr_T lnum;
2409 int use_number;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002410 int list;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411{
2412 int save_silent = silent_mode;
2413
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 msg_start();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00002415 silent_mode = FALSE;
2416 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2417 print_line_no_prefix(lnum, use_number, list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 if (save_silent)
2419 {
2420 msg_putchar('\n');
2421 cursor_on(); /* msg_start() switches it off */
2422 out_flush();
2423 silent_mode = save_silent;
2424 }
Bram Moolenaar65b9a6a2009-02-04 12:14:51 +00002425 info_message = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426}
2427
2428/*
2429 * ":file[!] [fname]".
2430 */
2431 void
2432ex_file(eap)
2433 exarg_T *eap;
2434{
2435 char_u *fname, *sfname, *xfname;
2436 buf_T *buf;
2437
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002438 /* ":0file" removes the file name. Check for illegal uses ":3file",
2439 * "0file name", etc. */
2440 if (eap->addr_count > 0
2441 && (*eap->arg != NUL
2442 || eap->line2 > 0
2443 || eap->addr_count > 1))
2444 {
2445 EMSG(_(e_invarg));
2446 return;
2447 }
2448
2449 if (*eap->arg != NUL || eap->addr_count == 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 {
2451#ifdef FEAT_AUTOCMD
2452 buf = curbuf;
2453 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2454 /* buffer changed, don't change name now */
2455 if (buf != curbuf)
2456 return;
2457# ifdef FEAT_EVAL
2458 if (aborting()) /* autocmds may abort script processing */
2459 return;
2460# endif
2461#endif
2462 /*
2463 * The name of the current buffer will be changed.
2464 * A new (unlisted) buffer entry needs to be made to hold the old file
2465 * name, which will become the alternate file name.
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002466 * But don't set the alternate file name if the buffer didn't have a
2467 * name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 */
2469 fname = curbuf->b_ffname;
2470 sfname = curbuf->b_sfname;
2471 xfname = curbuf->b_fname;
2472 curbuf->b_ffname = NULL;
2473 curbuf->b_sfname = NULL;
2474 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2475 {
2476 curbuf->b_ffname = fname;
2477 curbuf->b_sfname = sfname;
2478 return;
2479 }
2480 curbuf->b_flags |= BF_NOTEDITED;
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002481 if (xfname != NULL && *xfname != NUL)
2482 {
2483 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2484 if (buf != NULL && !cmdmod.keepalt)
2485 curwin->w_alt_fnum = buf->b_fnum;
2486 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 vim_free(fname);
2488 vim_free(sfname);
2489#ifdef FEAT_AUTOCMD
2490 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2491#endif
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002492 /* Change directories when the 'acd' option is set. */
2493 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 }
2495 /* print full file name if :cd used */
2496 fileinfo(FALSE, FALSE, eap->forceit);
2497}
2498
2499/*
2500 * ":update".
2501 */
2502 void
2503ex_update(eap)
2504 exarg_T *eap;
2505{
2506 if (curbufIsChanged())
2507 (void)do_write(eap);
2508}
2509
2510/*
2511 * ":write" and ":saveas".
2512 */
2513 void
2514ex_write(eap)
2515 exarg_T *eap;
2516{
2517 if (eap->usefilter) /* input lines to shell command */
2518 do_bang(1, eap, FALSE, TRUE, FALSE);
2519 else
2520 (void)do_write(eap);
2521}
2522
2523/*
2524 * write current buffer to file 'eap->arg'
2525 * if 'eap->append' is TRUE, append to the file
2526 *
2527 * if *eap->arg == NUL write to current file
2528 *
2529 * return FAIL for failure, OK otherwise
2530 */
2531 int
2532do_write(eap)
2533 exarg_T *eap;
2534{
2535 int other;
2536 char_u *fname = NULL; /* init to shut up gcc */
2537 char_u *ffname;
2538 int retval = FAIL;
2539 char_u *free_fname = NULL;
2540#ifdef FEAT_BROWSE
2541 char_u *browse_file = NULL;
2542#endif
2543 buf_T *alt_buf = NULL;
2544
2545 if (not_writing()) /* check 'write' option */
2546 return FAIL;
2547
2548 ffname = eap->arg;
2549#ifdef FEAT_BROWSE
2550 if (cmdmod.browse)
2551 {
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002552 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 NULL, NULL, NULL, curbuf);
2554 if (browse_file == NULL)
2555 goto theend;
2556 ffname = browse_file;
2557 }
2558#endif
2559 if (*ffname == NUL)
2560 {
2561 if (eap->cmdidx == CMD_saveas)
2562 {
2563 EMSG(_(e_argreq));
2564 goto theend;
2565 }
2566 other = FALSE;
2567 }
2568 else
2569 {
2570 fname = ffname;
2571 free_fname = fix_fname(ffname);
2572 /*
2573 * When out-of-memory, keep unexpanded file name, because we MUST be
2574 * able to write the file in this situation.
2575 */
2576 if (free_fname != NULL)
2577 ffname = free_fname;
2578 other = otherfile(ffname);
2579 }
2580
2581 /*
2582 * If we have a new file, put its name in the list of alternate file names.
2583 */
2584 if (other)
2585 {
2586 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2587 || eap->cmdidx == CMD_saveas)
2588 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2589 else
2590 alt_buf = buflist_findname(ffname);
2591 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2592 {
2593 /* Overwriting a file that is loaded in another buffer is not a
2594 * good idea. */
Bram Moolenaar0e4d8772005-06-07 21:12:49 +00002595 EMSG(_(e_bufloaded));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 goto theend;
2597 }
2598 }
2599
2600 /*
2601 * Writing to the current file is not allowed in readonly mode
2602 * and a file name is required.
2603 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2604 */
2605 if (!other && (
2606#ifdef FEAT_QUICKFIX
2607 bt_dontwrite_msg(curbuf) ||
2608#endif
2609 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2610 goto theend;
2611
2612 if (!other)
2613 {
2614 ffname = curbuf->b_ffname;
2615 fname = curbuf->b_fname;
2616 /*
2617 * Not writing the whole file is only allowed with '!'.
2618 */
2619 if ( (eap->line1 != 1
2620 || eap->line2 != curbuf->b_ml.ml_line_count)
2621 && !eap->forceit
2622 && !eap->append
2623 && !p_wa)
2624 {
2625#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2626 if (p_confirm || cmdmod.confirm)
2627 {
2628 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2629 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2630 goto theend;
2631 eap->forceit = TRUE;
2632 }
2633 else
2634#endif
2635 {
2636 EMSG(_("E140: Use ! to write partial buffer"));
2637 goto theend;
2638 }
2639 }
2640 }
2641
2642 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2643 {
2644 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2645 {
2646#ifdef FEAT_AUTOCMD
2647 buf_T *was_curbuf = curbuf;
2648
2649 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002650 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651# ifdef FEAT_EVAL
2652 if (curbuf != was_curbuf || aborting())
2653# else
2654 if (curbuf != was_curbuf)
2655# endif
2656 {
2657 /* buffer changed, don't change name now */
2658 retval = FAIL;
2659 goto theend;
2660 }
2661#endif
2662 /* Exchange the file names for the current and the alternate
2663 * buffer. This makes it look like we are now editing the buffer
2664 * under the new name. Must be done before buf_write(), because
2665 * if there is no file name and 'cpo' contains 'F', it will set
2666 * the file name. */
2667 fname = alt_buf->b_fname;
2668 alt_buf->b_fname = curbuf->b_fname;
2669 curbuf->b_fname = fname;
2670 fname = alt_buf->b_ffname;
2671 alt_buf->b_ffname = curbuf->b_ffname;
2672 curbuf->b_ffname = fname;
2673 fname = alt_buf->b_sfname;
2674 alt_buf->b_sfname = curbuf->b_sfname;
2675 curbuf->b_sfname = fname;
2676 buf_name_changed(curbuf);
2677#ifdef FEAT_AUTOCMD
2678 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
Bram Moolenaar269ec652004-07-29 08:43:53 +00002679 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 if (!alt_buf->b_p_bl)
2681 {
2682 alt_buf->b_p_bl = TRUE;
2683 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2684 }
2685# ifdef FEAT_EVAL
2686 if (curbuf != was_curbuf || aborting())
2687# else
2688 if (curbuf != was_curbuf)
2689# endif
2690 {
2691 /* buffer changed, don't write the file */
2692 retval = FAIL;
2693 goto theend;
2694 }
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002695
2696 /* If 'filetype' was empty try detecting it now. */
2697 if (*curbuf->b_p_ft == NUL)
2698 {
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002699 if (au_has_group((char_u *)"filetypedetect"))
2700 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2701 TRUE);
Bram Moolenaara3227e22006-03-08 21:32:40 +00002702 do_modelines(0);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002703 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704#endif
2705 }
2706
2707 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2708 eap, eap->append, eap->forceit, TRUE, FALSE);
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002709
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002710 /* After ":saveas fname" reset 'readonly'. */
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002711 if (eap->cmdidx == CMD_saveas)
2712 {
2713 if (retval == OK)
Bram Moolenaar4352f132009-02-11 15:03:45 +00002714 {
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002715 curbuf->b_p_ro = FALSE;
Bram Moolenaar4352f132009-02-11 15:03:45 +00002716#ifdef FEAT_WINDOWS
2717 redraw_tabline = TRUE;
2718#endif
2719 }
Bram Moolenaar498efdb2006-09-05 14:31:54 +00002720 /* Change directories when the 'acd' option is set. */
2721 DO_AUTOCHDIR
2722 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 }
2724
2725theend:
2726#ifdef FEAT_BROWSE
2727 vim_free(browse_file);
2728#endif
2729 vim_free(free_fname);
2730 return retval;
2731}
2732
2733/*
2734 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2735 * BF_NEW or BF_READERR, check for overwriting current file.
2736 * May set eap->forceit if a dialog says it's OK to overwrite.
2737 * Return OK if it's OK, FAIL if it is not.
2738 */
2739/*ARGSUSED*/
2740 static int
2741check_overwrite(eap, buf, fname, ffname, other)
2742 exarg_T *eap;
2743 buf_T *buf;
2744 char_u *fname; /* file name to be used (can differ from
2745 buf->ffname) */
2746 char_u *ffname; /* full path version of fname */
2747 int other; /* writing under other name */
2748{
2749 /*
2750 * write to other file or b_flags set or not writing the whole file:
2751 * overwriting only allowed with '!'
2752 */
2753 if ( (other
2754 || (buf->b_flags & BF_NOTEDITED)
2755 || ((buf->b_flags & BF_NEW)
2756 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2757 || (buf->b_flags & BF_READERR))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 && !p_wa
Bram Moolenaar11717bb2007-12-08 21:21:18 +00002759#ifdef FEAT_QUICKFIX
2760 && !bt_nofile(buf)
2761#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 && vim_fexists(ffname))
2763 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002764 if (!eap->forceit && !eap->append)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002766#ifdef UNIX
Bram Moolenaar0ac93792006-01-21 22:16:51 +00002767 /* with UNIX it is possible to open a directory */
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002768 if (mch_isdir(ffname))
2769 {
2770 EMSG2(_(e_isadir2), ffname);
2771 return FAIL;
2772 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773#endif
2774#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002775 if (p_confirm || cmdmod.confirm)
2776 {
2777 char_u buff[IOSIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002779 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2780 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2781 return FAIL;
2782 eap->forceit = TRUE;
2783 }
2784 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785#endif
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002786 {
2787 EMSG(_(e_exists));
2788 return FAIL;
2789 }
2790 }
2791
2792 /* For ":w! filename" check that no swap file exists for "filename". */
2793 if (other && !emsg_silent)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 {
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002795 char_u dir[MAXPATHL];
2796 char_u *p;
2797 int r;
2798 char_u *swapname;
2799
2800 /* We only try the first entry in 'directory', without checking if
2801 * it's writable. If the "." directory is not writable the write
2802 * will probably fail anyway.
2803 * Use 'shortname' of the current buffer, since there is no buffer
2804 * for the written file. */
2805 if (*p_dir == NUL)
2806 STRCPY(dir, ".");
2807 else
2808 {
2809 p = p_dir;
2810 copy_option_part(&p, dir, MAXPATHL, ",");
2811 }
2812 swapname = makeswapname(fname, ffname, curbuf, dir);
2813 r = vim_fexists(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002814 if (r)
2815 {
2816#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2817 if (p_confirm || cmdmod.confirm)
2818 {
2819 char_u buff[IOSIZE];
2820
2821 dialog_msg(buff,
2822 _("Swap file \"%s\" exists, overwrite anyway?"),
2823 swapname);
2824 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2825 != VIM_YES)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002826 {
2827 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002828 return FAIL;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002829 }
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002830 eap->forceit = TRUE;
2831 }
2832 else
2833#endif
2834 {
2835 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2836 swapname);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002837 vim_free(swapname);
Bram Moolenaar04a09c12005-08-01 22:02:32 +00002838 return FAIL;
2839 }
2840 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002841 vim_free(swapname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 }
2843 }
2844 return OK;
2845}
2846
2847/*
2848 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2849 */
2850 void
2851ex_wnext(eap)
2852 exarg_T *eap;
2853{
2854 int i;
2855
2856 if (eap->cmd[1] == 'n')
2857 i = curwin->w_arg_idx + (int)eap->line2;
2858 else
2859 i = curwin->w_arg_idx - (int)eap->line2;
2860 eap->line1 = 1;
2861 eap->line2 = curbuf->b_ml.ml_line_count;
2862 if (do_write(eap) != FAIL)
2863 do_argfile(eap, i);
2864}
2865
2866/*
2867 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2868 */
2869 void
2870do_wqall(eap)
2871 exarg_T *eap;
2872{
2873 buf_T *buf;
2874 int error = 0;
2875 int save_forceit = eap->forceit;
2876
2877 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2878 exiting = TRUE;
2879
2880 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2881 {
2882 if (bufIsChanged(buf))
2883 {
2884 /*
2885 * Check if there is a reason the buffer cannot be written:
2886 * 1. if the 'write' option is set
2887 * 2. if there is no file name (even after browsing)
2888 * 3. if the 'readonly' is set (even after a dialog)
2889 * 4. if overwriting is allowed (even after a dialog)
2890 */
2891 if (not_writing())
2892 {
2893 ++error;
2894 break;
2895 }
2896#ifdef FEAT_BROWSE
2897 /* ":browse wall": ask for file name if there isn't one */
2898 if (buf->b_ffname == NULL && cmdmod.browse)
2899 browse_save_fname(buf);
2900#endif
2901 if (buf->b_ffname == NULL)
2902 {
2903 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2904 ++error;
2905 }
2906 else if (check_readonly(&eap->forceit, buf)
2907 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2908 FALSE) == FAIL)
2909 {
2910 ++error;
2911 }
2912 else
2913 {
2914 if (buf_write_all(buf, eap->forceit) == FAIL)
2915 ++error;
2916#ifdef FEAT_AUTOCMD
2917 /* an autocommand may have deleted the buffer */
2918 if (!buf_valid(buf))
2919 buf = firstbuf;
2920#endif
2921 }
2922 eap->forceit = save_forceit; /* check_overwrite() may set it */
2923 }
2924 }
2925 if (exiting)
2926 {
2927 if (!error)
2928 getout(0); /* exit Vim */
2929 not_exiting();
2930 }
2931}
2932
2933/*
2934 * Check the 'write' option.
2935 * Return TRUE and give a message when it's not st.
2936 */
2937 int
2938not_writing()
2939{
2940 if (p_write)
2941 return FALSE;
2942 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2943 return TRUE;
2944}
2945
2946/*
Bram Moolenaar5386a122007-06-28 20:02:32 +00002947 * Check if a buffer is read-only (either 'readonly' option is set or file is
2948 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2949 * message when the buffer is readonly.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 */
2951 static int
2952check_readonly(forceit, buf)
2953 int *forceit;
2954 buf_T *buf;
2955{
Bram Moolenaar5386a122007-06-28 20:02:32 +00002956 struct stat st;
2957
2958 /* Handle a file being readonly when the 'readonly' option is set or when
2959 * the file exists and permissions are read-only.
2960 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2961 * important for device checks but not here. */
2962 if (!*forceit && (buf->b_p_ro
2963 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2964 && check_file_readonly(buf->b_ffname, 0777))))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 {
2966#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2967 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2968 {
2969 char_u buff[IOSIZE];
2970
Bram Moolenaar5386a122007-06-28 20:02:32 +00002971 if (buf->b_p_ro)
2972 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2973 buf->b_fname);
2974 else
2975 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 +00002976 buf->b_fname);
2977
2978 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2979 {
2980 /* Set forceit, to force the writing of a readonly file */
2981 *forceit = TRUE;
2982 return FALSE;
2983 }
2984 else
2985 return TRUE;
2986 }
2987 else
2988#endif
Bram Moolenaar5386a122007-06-28 20:02:32 +00002989 if (buf->b_p_ro)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 EMSG(_(e_readonly));
Bram Moolenaar5386a122007-06-28 20:02:32 +00002991 else
2992 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2993 buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 return TRUE;
2995 }
Bram Moolenaar5386a122007-06-28 20:02:32 +00002996
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 return FALSE;
2998}
2999
3000/*
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003001 * Try to abandon current file and edit a new or existing file.
3002 * 'fnum' is the number of the file, if zero use ffname/sfname.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 *
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00003004 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003005 * -1 for successfully opening another file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3007 */
3008 int
3009getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3010 int fnum;
3011 char_u *ffname;
3012 char_u *sfname;
3013 int setpm;
3014 linenr_T lnum;
3015 int forceit;
3016{
3017 int other;
3018 int retval;
3019 char_u *free_me = NULL;
3020
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003021 if (text_locked())
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 return 1;
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003023#ifdef FEAT_AUTOCMD
3024 if (curbuf_locked())
3025 return 1;
3026#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027
3028 if (fnum == 0)
3029 {
3030 /* make ffname full path, set sfname */
3031 fname_expand(curbuf, &ffname, &sfname);
3032 other = otherfile(ffname);
3033 free_me = ffname; /* has been allocated, free() later */
3034 }
3035 else
3036 other = (fnum != curbuf->b_fnum);
3037
3038 if (other)
3039 ++no_wait_return; /* don't wait for autowrite message */
3040 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3041 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3042 {
3043#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3044 if (p_confirm && p_write)
3045 dialog_changed(curbuf, FALSE);
3046 if (curbufIsChanged())
3047#endif
3048 {
3049 if (other)
3050 --no_wait_return;
3051 EMSG(_(e_nowrtmsg));
3052 retval = 2; /* file has been changed */
3053 goto theend;
3054 }
3055 }
3056 if (other)
3057 --no_wait_return;
3058 if (setpm)
3059 setpcmark();
3060 if (!other)
3061 {
3062 if (lnum != 0)
3063 curwin->w_cursor.lnum = lnum;
3064 check_cursor_lnum();
3065 beginline(BL_SOL | BL_FIX);
3066 retval = 0; /* it's in the same file */
3067 }
3068 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003069 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3070 curwin) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 retval = -1; /* opened another file */
3072 else
3073 retval = 1; /* error encountered */
3074
3075theend:
3076 vim_free(free_me);
3077 return retval;
3078}
3079
3080/*
3081 * start editing a new file
3082 *
3083 * fnum: file number; if zero use ffname/sfname
3084 * ffname: the file name
3085 * - full path if sfname used,
3086 * - any file name if sfname is NULL
3087 * - empty string to re-edit with the same file name (but may be
3088 * in a different directory)
3089 * - NULL to start an empty buffer
3090 * sfname: the short file name (or NULL)
3091 * eap: contains the command to be executed after loading the file and
3092 * forced 'ff' and 'fenc'
3093 * newlnum: if > 0: put cursor on this line number (if possible)
3094 * if ECMD_LASTL: use last position in loaded file
3095 * if ECMD_LAST: use last position in all files
3096 * if ECMD_ONE: use first line
3097 * flags:
3098 * ECMD_HIDE: if TRUE don't free the current buffer
3099 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3100 * ECMD_OLDBUF: use existing buffer if it exists
3101 * ECMD_FORCEIT: ! used for Ex command
3102 * ECMD_ADDBUF: don't edit, just add to buffer list
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003103 * oldwin: Should be "curwin" when editing a new buffer in the current
3104 * window, NULL when splitting the window first. When not NULL info
3105 * of the previous buffer for "oldwin" is stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 *
3107 * return FAIL for failure, OK otherwise
3108 */
3109 int
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003110do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 int fnum;
3112 char_u *ffname;
3113 char_u *sfname;
3114 exarg_T *eap; /* can be NULL! */
3115 linenr_T newlnum;
3116 int flags;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003117 win_T *oldwin;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118{
3119 int other_file; /* TRUE if editing another file */
3120 int oldbuf; /* TRUE if using existing buffer */
3121#ifdef FEAT_AUTOCMD
3122 int auto_buf = FALSE; /* TRUE if autocommands brought us
3123 into the buffer unexpectedly */
3124 char_u *new_name = NULL;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003125 int did_set_swapcommand = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126#endif
3127 buf_T *buf;
3128#if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3129 buf_T *old_curbuf = curbuf;
3130#endif
3131 char_u *free_fname = NULL;
3132#ifdef FEAT_BROWSE
3133 char_u *browse_file = NULL;
3134#endif
3135 int retval = FAIL;
3136 long n;
3137 linenr_T lnum;
3138 linenr_T topline = 0;
3139 int newcol = -1;
3140 int solcol = -1;
3141 pos_T *pos;
3142#ifdef FEAT_SUN_WORKSHOP
3143 char_u *cp;
3144#endif
3145 char_u *command = NULL;
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003146#ifdef FEAT_SPELL
3147 int did_get_winopts = FALSE;
3148#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149
3150 if (eap != NULL)
3151 command = eap->do_ecmd_cmd;
3152
3153 if (fnum != 0)
3154 {
3155 if (fnum == curbuf->b_fnum) /* file is already being edited */
3156 return OK; /* nothing to do */
3157 other_file = TRUE;
3158 }
3159 else
3160 {
3161#ifdef FEAT_BROWSE
3162 if (cmdmod.browse)
3163 {
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003164# ifdef FEAT_AUTOCMD
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003165 if (
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003166# ifdef FEAT_GUI
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003167 !gui.in_use &&
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003168# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003169 au_has_group((char_u *)"FileExplorer"))
3170 {
3171 /* No browsing supported but we do have the file explorer:
3172 * Edit the directory. */
3173 if (ffname == NULL || !mch_isdir(ffname))
3174 ffname = (char_u *)".";
3175 }
3176 else
Bram Moolenaar15bfa092008-07-24 16:45:38 +00003177# endif
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003178 {
3179 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 NULL, NULL, NULL, curbuf);
Bram Moolenaar0be6e642005-08-04 21:32:22 +00003181 if (browse_file == NULL)
3182 goto theend;
3183 ffname = browse_file;
3184 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 }
3186#endif
3187 /* if no short name given, use ffname for short name */
3188 if (sfname == NULL)
3189 sfname = ffname;
3190#ifdef USE_FNAME_CASE
3191# ifdef USE_LONG_FNAME
3192 if (USE_LONG_FNAME)
3193# endif
Bram Moolenaar342337a2005-07-21 21:11:17 +00003194 if (sfname != NULL)
3195 fname_case(sfname, 0); /* set correct case for sfname */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196#endif
3197
3198#ifdef FEAT_LISTCMDS
3199 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3200 goto theend;
3201#endif
3202
3203 if (ffname == NULL)
3204 other_file = TRUE;
3205 /* there is no file name */
3206 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3207 other_file = FALSE;
3208 else
3209 {
3210 if (*ffname == NUL) /* re-edit with same file name */
3211 {
3212 ffname = curbuf->b_ffname;
3213 sfname = curbuf->b_fname;
3214 }
3215 free_fname = fix_fname(ffname); /* may expand to full path name */
3216 if (free_fname != NULL)
3217 ffname = free_fname;
3218 other_file = otherfile(ffname);
3219#ifdef FEAT_SUN_WORKSHOP
3220 if (usingSunWorkShop && p_acd
3221 && (cp = vim_strrchr(sfname, '/')) != NULL)
3222 sfname = ++cp;
3223#endif
3224 }
3225 }
3226
3227 /*
3228 * if the file was changed we may not be allowed to abandon it
3229 * - if we are going to re-edit the same file
3230 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3231 */
3232 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3233 || (curbuf->b_nwindows == 1
3234 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3235 && check_changed(curbuf, p_awa, !other_file,
3236 (flags & ECMD_FORCEIT), FALSE))
3237 {
3238 if (fnum == 0 && other_file && ffname != NULL)
3239 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3240 goto theend;
3241 }
3242
3243#ifdef FEAT_VISUAL
3244 /*
3245 * End Visual mode before switching to another buffer, so the text can be
3246 * copied into the GUI selection buffer.
3247 */
3248 reset_VIsual();
3249#endif
3250
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003251#ifdef FEAT_AUTOCMD
3252 if ((command != NULL || newlnum > (linenr_T)0)
3253 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3254 {
3255 int len;
3256 char_u *p;
3257
3258 /* Set v:swapcommand for the SwapExists autocommands. */
3259 if (command != NULL)
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00003260 len = (int)STRLEN(command) + 3;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003261 else
3262 len = 30;
3263 p = alloc((unsigned)len);
3264 if (p != NULL)
3265 {
3266 if (command != NULL)
3267 vim_snprintf((char *)p, len, ":%s\r", command);
3268 else
3269 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3270 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3271 did_set_swapcommand = TRUE;
3272 vim_free(p);
3273 }
3274 }
3275#endif
3276
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 /*
3278 * If we are starting to edit another file, open a (new) buffer.
3279 * Otherwise we re-use the current buffer.
3280 */
3281 if (other_file)
3282 {
3283#ifdef FEAT_LISTCMDS
3284 if (!(flags & ECMD_ADDBUF))
3285#endif
3286 {
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003287 if (!cmdmod.keepalt)
3288 curwin->w_alt_fnum = curbuf->b_fnum;
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003289 if (oldwin != NULL)
3290 buflist_altfpos(oldwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 }
3292
3293 if (fnum)
3294 buf = buflist_findnr(fnum);
3295 else
3296 {
3297#ifdef FEAT_LISTCMDS
3298 if (flags & ECMD_ADDBUF)
3299 {
3300 linenr_T tlnum = 1L;
3301
3302 if (command != NULL)
3303 {
3304 tlnum = atol((char *)command);
3305 if (tlnum <= 0)
3306 tlnum = 1L;
3307 }
3308 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3309 goto theend;
3310 }
3311#endif
3312 buf = buflist_new(ffname, sfname, 0L,
3313 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3314 }
3315 if (buf == NULL)
3316 goto theend;
3317 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3318 {
3319 oldbuf = FALSE;
3320 buf->b_nwindows = 0;
3321 }
3322 else /* existing memfile */
3323 {
3324 oldbuf = TRUE;
3325 (void)buf_check_timestamp(buf, FALSE);
3326 /* Check if autocommands made buffer invalid or changed the current
3327 * buffer. */
3328 if (!buf_valid(buf)
3329#ifdef FEAT_AUTOCMD
3330 || curbuf != old_curbuf
3331#endif
3332 )
3333 goto theend;
3334#ifdef FEAT_EVAL
3335 if (aborting()) /* autocmds may abort script processing */
3336 goto theend;
3337#endif
3338 }
3339
3340 /* May jump to last used line number for a loaded buffer or when asked
3341 * for explicitly */
3342 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3343 {
3344 pos = buflist_findfpos(buf);
3345 newlnum = pos->lnum;
3346 solcol = pos->col;
3347 }
3348
3349 /*
3350 * Make the (new) buffer the one used by the current window.
3351 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3352 * If the current buffer was empty and has no file name, curbuf
3353 * is returned by buflist_new().
3354 */
3355 if (buf != curbuf)
3356 {
3357#ifdef FEAT_AUTOCMD
3358 /*
3359 * Be careful: The autocommands may delete any buffer and change
3360 * the current buffer.
3361 * - If the buffer we are going to edit is deleted, give up.
3362 * - If the current buffer is deleted, prefer to load the new
3363 * buffer when loading a buffer is required. This avoids
3364 * loading another buffer which then must be closed again.
3365 * - If we ended up in the new buffer already, need to skip a few
3366 * things, set auto_buf.
3367 */
3368 if (buf->b_fname != NULL)
3369 new_name = vim_strsave(buf->b_fname);
3370 au_new_curbuf = buf;
3371 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3372 if (!buf_valid(buf)) /* new buffer has been deleted */
3373 {
3374 delbuf_msg(new_name); /* frees new_name */
3375 goto theend;
3376 }
3377# ifdef FEAT_EVAL
3378 if (aborting()) /* autocmds may abort script processing */
3379 {
3380 vim_free(new_name);
3381 goto theend;
3382 }
3383# endif
3384 if (buf == curbuf) /* already in new buffer */
3385 auto_buf = TRUE;
3386 else
3387 {
3388 if (curbuf == old_curbuf)
3389#endif
3390 buf_copy_options(buf, BCO_ENTER);
3391
3392 /* close the link to the current buffer */
Bram Moolenaar779b74b2006-04-10 14:55:34 +00003393 u_sync(FALSE);
Bram Moolenaar701f7af2008-11-15 13:12:07 +00003394 close_buffer(oldwin, curbuf,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3396
3397#ifdef FEAT_AUTOCMD
3398# ifdef FEAT_EVAL
3399 if (aborting()) /* autocmds may abort script processing */
3400 {
3401 vim_free(new_name);
3402 goto theend;
3403 }
3404# endif
3405 /* Be careful again, like above. */
3406 if (!buf_valid(buf)) /* new buffer has been deleted */
3407 {
3408 delbuf_msg(new_name); /* frees new_name */
3409 goto theend;
3410 }
3411 if (buf == curbuf) /* already in new buffer */
3412 auto_buf = TRUE;
3413 else
3414#endif
3415 {
3416 curwin->w_buffer = buf;
3417 curbuf = buf;
3418 ++curbuf->b_nwindows;
3419 /* set 'fileformat' */
3420 if (*p_ffs && !oldbuf)
3421 set_fileformat(default_fileformat(), OPT_LOCAL);
3422 }
3423
3424 /* May get the window options from the last time this buffer
3425 * was in this window (or another window). If not used
3426 * before, reset the local window options to the global
3427 * values. Also restores old folding stuff. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003428 get_winopts(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003429#ifdef FEAT_SPELL
3430 did_get_winopts = TRUE;
3431#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432
3433#ifdef FEAT_AUTOCMD
3434 }
3435 vim_free(new_name);
3436 au_new_curbuf = NULL;
3437#endif
3438 }
3439 else
3440 ++curbuf->b_nwindows;
3441
3442 curwin->w_pcmark.lnum = 1;
3443 curwin->w_pcmark.col = 0;
3444 }
3445 else /* !other_file */
3446 {
3447 if (
3448#ifdef FEAT_LISTCMDS
3449 (flags & ECMD_ADDBUF) ||
3450#endif
3451 check_fname() == FAIL)
3452 goto theend;
3453 oldbuf = (flags & ECMD_OLDBUF);
3454 }
3455
3456 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3457 {
3458 char_u *p;
3459
3460 curbuf->b_help = TRUE;
3461#ifdef FEAT_QUICKFIX
3462 set_string_option_direct((char_u *)"buftype", -1,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003463 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464#endif
3465
3466 /*
3467 * Always set these options after jumping to a help tag, because the
3468 * user may have an autocommand that gets in the way.
3469 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3470 * latin1 word characters (for translated help files).
3471 * Only set it when needed, buf_init_chartab() is some work.
3472 */
3473 p =
3474#ifdef EBCDIC
3475 (char_u *)"65-255,^*,^|,^\"";
3476#else
3477 (char_u *)"!-~,^*,^|,^\",192-255";
3478#endif
3479 if (STRCMP(curbuf->b_p_isk, p) != 0)
3480 {
3481 set_string_option_direct((char_u *)"isk", -1, p,
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00003482 OPT_FREE|OPT_LOCAL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 check_buf_options(curbuf);
3484 (void)buf_init_chartab(curbuf, FALSE);
3485 }
3486
3487 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3488 curwin->w_p_list = FALSE; /* no list mode */
3489
3490 curbuf->b_p_ma = FALSE; /* not modifiable */
3491 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3492 curwin->w_p_nu = 0; /* no line numbers */
3493#ifdef FEAT_SCROLLBIND
3494 curwin->w_p_scb = FALSE; /* no scroll binding */
3495#endif
3496#ifdef FEAT_ARABIC
3497 curwin->w_p_arab = FALSE; /* no arabic mode */
3498#endif
3499#ifdef FEAT_RIGHTLEFT
3500 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3501#endif
3502#ifdef FEAT_FOLDING
3503 curwin->w_p_fen = FALSE; /* No folding in the help window */
3504#endif
3505#ifdef FEAT_DIFF
3506 curwin->w_p_diff = FALSE; /* No 'diff' */
3507#endif
Bram Moolenaara1956f62006-03-12 22:18:00 +00003508#ifdef FEAT_SPELL
Bram Moolenaar9a50b1b2005-06-27 22:48:21 +00003509 curwin->w_p_spell = FALSE; /* No spell checking */
3510#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511
3512#ifdef FEAT_AUTOCMD
3513 buf = curbuf;
3514#endif
3515 set_buflisted(FALSE);
3516 }
3517 else
3518 {
3519#ifdef FEAT_AUTOCMD
3520 buf = curbuf;
3521#endif
3522 /* Don't make a buffer listed if it's a help buffer. Useful when
3523 * using CTRL-O to go back to a help file. */
3524 if (!curbuf->b_help)
3525 set_buflisted(TRUE);
3526 }
3527
3528#ifdef FEAT_AUTOCMD
3529 /* If autocommands change buffers under our fingers, forget about
3530 * editing the file. */
3531 if (buf != curbuf)
3532 goto theend;
3533# ifdef FEAT_EVAL
3534 if (aborting()) /* autocmds may abort script processing */
3535 goto theend;
3536# endif
3537
3538 /* Since we are starting to edit a file, consider the filetype to be
3539 * unset. Helps for when an autocommand changes files and expects syntax
3540 * highlighting to work in the other file. */
3541 did_filetype = FALSE;
3542#endif
3543
3544/*
3545 * other_file oldbuf
3546 * FALSE FALSE re-edit same file, buffer is re-used
3547 * FALSE TRUE re-edit same file, nothing changes
3548 * TRUE FALSE start editing new file, new buffer
3549 * TRUE TRUE start editing in existing buffer (nothing to do)
3550 */
3551 if (!other_file && !oldbuf) /* re-use the buffer */
3552 {
3553 set_last_cursor(curwin); /* may set b_last_cursor */
3554 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3555 {
3556 newlnum = curwin->w_cursor.lnum;
3557 solcol = curwin->w_cursor.col;
3558 }
3559#ifdef FEAT_AUTOCMD
3560 buf = curbuf;
3561 if (buf->b_fname != NULL)
3562 new_name = vim_strsave(buf->b_fname);
3563 else
3564 new_name = NULL;
3565#endif
3566 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3567#ifdef FEAT_AUTOCMD
3568 /* If autocommands deleted the buffer we were going to re-edit, give
3569 * up and jump to the end. */
3570 if (!buf_valid(buf))
3571 {
3572 delbuf_msg(new_name); /* frees new_name */
3573 goto theend;
3574 }
3575 vim_free(new_name);
3576
3577 /* If autocommands change buffers under our fingers, forget about
3578 * re-editing the file. Should do the buf_clear_file(), but perhaps
3579 * the autocommands changed the buffer... */
3580 if (buf != curbuf)
3581 goto theend;
3582# ifdef FEAT_EVAL
3583 if (aborting()) /* autocmds may abort script processing */
3584 goto theend;
3585# endif
3586#endif
3587 buf_clear_file(curbuf);
3588 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3589 curbuf->b_op_end.lnum = 0;
3590 }
3591
3592/*
3593 * If we get here we are sure to start editing
3594 */
3595 /* don't redraw until the cursor is in the right line */
3596 ++RedrawingDisabled;
3597
3598 /* Assume success now */
3599 retval = OK;
3600
3601 /*
3602 * Reset cursor position, could be used by autocommands.
3603 */
3604 check_cursor();
3605
3606 /*
3607 * Check if we are editing the w_arg_idx file in the argument list.
3608 */
3609 check_arg_idx(curwin);
3610
3611#ifdef FEAT_AUTOCMD
3612 if (!auto_buf)
3613#endif
3614 {
3615 /*
3616 * Set cursor and init window before reading the file and executing
3617 * autocommands. This allows for the autocommands to position the
3618 * cursor.
3619 */
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00003620 curwin_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621
3622#ifdef FEAT_FOLDING
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003623 /* It's possible that all lines in the buffer changed. Need to update
3624 * automatic folding for all windows where it's used. */
3625# ifdef FEAT_WINDOWS
3626 {
3627 win_T *win;
3628 tabpage_T *tp;
3629
3630 FOR_ALL_TAB_WINDOWS(tp, win)
3631 if (win->w_buffer == curbuf)
3632 foldUpdateAll(win);
3633 }
3634# else
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 foldUpdateAll(curwin);
Bram Moolenaareb1b6792007-08-21 13:29:28 +00003636# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637#endif
3638
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003639 /* Change directories when the 'acd' option is set. */
3640 DO_AUTOCHDIR
3641
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 /*
3643 * Careful: open_buffer() and apply_autocmds() may change the current
3644 * buffer and window.
3645 */
3646 lnum = curwin->w_cursor.lnum;
3647 topline = curwin->w_topline;
3648 if (!oldbuf) /* need to read the file */
3649 {
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003650#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 swap_exists_action = SEA_DIALOG;
3652#endif
3653 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3654
3655 /*
3656 * Open the buffer and read the file.
3657 */
3658#if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3659 if (should_abort(open_buffer(FALSE, eap)))
3660 retval = FAIL;
3661#else
3662 (void)open_buffer(FALSE, eap);
3663#endif
3664
Bram Moolenaard5bc83f2005-12-07 21:07:59 +00003665#if defined(HAS_SWAP_EXISTS_ACTION)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 if (swap_exists_action == SEA_QUIT)
3667 retval = FAIL;
3668 handle_swap_exists(old_curbuf);
3669#endif
3670 }
3671#ifdef FEAT_AUTOCMD
3672 else
3673 {
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003674 /* Read the modelines, but only to set window-local options. Any
3675 * buffer-local options have already been set and may have been
3676 * changed by the user. */
Bram Moolenaara3227e22006-03-08 21:32:40 +00003677 do_modelines(OPT_WINONLY);
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00003678
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3680 &retval);
3681 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3682 &retval);
3683 }
3684 check_arg_idx(curwin);
3685#endif
3686
3687 /*
3688 * If autocommands change the cursor position or topline, we should
3689 * keep it.
3690 */
3691 if (curwin->w_cursor.lnum != lnum)
3692 {
3693 newlnum = curwin->w_cursor.lnum;
3694 newcol = curwin->w_cursor.col;
3695 }
3696 if (curwin->w_topline == topline)
3697 topline = 0;
3698
3699 /* Even when cursor didn't move we need to recompute topline. */
3700 changed_line_abv_curs();
3701
3702#ifdef FEAT_TITLE
3703 maketitle();
3704#endif
3705 }
3706
3707#ifdef FEAT_DIFF
3708 /* Tell the diff stuff that this buffer is new and/or needs updating.
3709 * Also needed when re-editing the same buffer, because unloading will
3710 * have removed it as a diff buffer. */
Bram Moolenaar997fb4b2006-02-17 21:53:23 +00003711 if (curwin->w_p_diff)
3712 {
3713 diff_buf_add(curbuf);
3714 diff_invalidate(curbuf);
3715 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716#endif
3717
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003718#ifdef FEAT_SPELL
3719 /* If the window options were changed may need to set the spell language.
3720 * Can only do this after the buffer has been properly setup. */
Bram Moolenaarb1269f12007-06-19 09:51:25 +00003721 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003722 (void)did_set_spelllang(curbuf);
Bram Moolenaar706cdeb2007-05-06 21:55:31 +00003723#endif
3724
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 if (command == NULL)
3726 {
3727 if (newcol >= 0) /* position set by autocommands */
3728 {
3729 curwin->w_cursor.lnum = newlnum;
3730 curwin->w_cursor.col = newcol;
3731 check_cursor();
3732 }
3733 else if (newlnum > 0) /* line number from caller or old position */
3734 {
3735 curwin->w_cursor.lnum = newlnum;
3736 check_cursor_lnum();
3737 if (solcol >= 0 && !p_sol)
3738 {
3739 /* 'sol' is off: Use last known column. */
3740 curwin->w_cursor.col = solcol;
3741 check_cursor_col();
3742#ifdef FEAT_VIRTUALEDIT
3743 curwin->w_cursor.coladd = 0;
3744#endif
3745 curwin->w_set_curswant = TRUE;
3746 }
3747 else
3748 beginline(BL_SOL | BL_FIX);
3749 }
3750 else /* no line number, go to last line in Ex mode */
3751 {
3752 if (exmode_active)
3753 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3754 beginline(BL_WHITE | BL_FIX);
3755 }
3756 }
3757
3758#ifdef FEAT_WINDOWS
3759 /* Check if cursors in other windows on the same buffer are still valid */
3760 check_lnums(FALSE);
3761#endif
3762
3763 /*
3764 * Did not read the file, need to show some info about the file.
3765 * Do this after setting the cursor.
3766 */
3767 if (oldbuf
3768#ifdef FEAT_AUTOCMD
3769 && !auto_buf
3770#endif
3771 )
3772 {
3773 int msg_scroll_save = msg_scroll;
3774
3775 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3776 * message. */
3777 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3778 msg_scroll = FALSE;
3779 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3780 check_for_delay(FALSE);
3781 msg_start();
3782 msg_scroll = msg_scroll_save;
3783 msg_scrolled_ign = TRUE;
3784
3785 fileinfo(FALSE, TRUE, FALSE);
3786
3787 msg_scrolled_ign = FALSE;
3788 }
3789
3790 if (command != NULL)
3791 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3792
3793#ifdef FEAT_KEYMAP
3794 if (curbuf->b_kmap_state & KEYMAP_INIT)
Bram Moolenaar0ab2a882009-05-13 10:51:08 +00003795 (void)keymap_init();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796#endif
3797
3798 --RedrawingDisabled;
3799 if (!skip_redraw)
3800 {
3801 n = p_so;
3802 if (topline == 0 && command == NULL)
3803 p_so = 999; /* force cursor halfway the window */
3804 update_topline();
3805#ifdef FEAT_SCROLLBIND
3806 curwin->w_scbind_pos = curwin->w_topline;
3807#endif
3808 p_so = n;
3809 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3810 }
3811
3812 if (p_im)
3813 need_start_insertmode = TRUE;
3814
Bram Moolenaar498efdb2006-09-05 14:31:54 +00003815 /* Change directories when the 'acd' option is set. */
3816 DO_AUTOCHDIR
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817
Bram Moolenaar7b89edc2006-04-06 20:21:51 +00003818#if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 if (gui.in_use && curbuf->b_ffname != NULL)
3820 {
3821# ifdef FEAT_SUN_WORKSHOP
3822 if (usingSunWorkShop)
3823 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3824# endif
3825# ifdef FEAT_NETBEANS_INTG
Bram Moolenaardd87969c2007-08-21 13:07:12 +00003826 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
Bram Moolenaar35a9aaa2004-10-24 19:23:07 +00003827 netbeans_file_opened(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828# endif
3829 }
3830#endif
3831
3832theend:
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003833#ifdef FEAT_AUTOCMD
3834 if (did_set_swapcommand)
3835 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3836#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837#ifdef FEAT_BROWSE
3838 vim_free(browse_file);
3839#endif
3840 vim_free(free_fname);
3841 return retval;
3842}
3843
3844#ifdef FEAT_AUTOCMD
3845 static void
3846delbuf_msg(name)
3847 char_u *name;
3848{
3849 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3850 name == NULL ? (char_u *)"" : name);
3851 vim_free(name);
3852 au_new_curbuf = NULL;
3853}
3854#endif
3855
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003856static int append_indent = 0; /* autoindent for first line */
3857
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858/*
3859 * ":insert" and ":append", also used by ":change"
3860 */
3861 void
3862ex_append(eap)
3863 exarg_T *eap;
3864{
3865 char_u *theline;
3866 int did_undo = FALSE;
3867 linenr_T lnum = eap->line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003868 int indent = 0;
3869 char_u *p;
3870 int vcol;
3871 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003873 /* the ! flag toggles autoindent */
3874 if (eap->forceit)
3875 curbuf->b_p_ai = !curbuf->b_p_ai;
3876
3877 /* First autoindent comes from the line we start on */
3878 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3879 append_indent = get_indent_lnum(lnum);
3880
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 if (eap->cmdidx != CMD_append)
3882 --lnum;
3883
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003884 /* when the buffer is empty append to line 0 and delete the dummy line */
3885 if (empty && lnum == 1)
3886 lnum = 0;
3887
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 State = INSERT; /* behave like in Insert mode */
3889 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3890 State |= LANGMAP;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003891
Bram Moolenaard8e9bb22005-07-09 21:14:46 +00003892 for (;;)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 {
3894 msg_scroll = TRUE;
3895 need_wait_return = FALSE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003896 if (curbuf->b_p_ai)
3897 {
3898 if (append_indent >= 0)
3899 {
3900 indent = append_indent;
3901 append_indent = -1;
3902 }
3903 else if (lnum > 0)
3904 indent = get_indent_lnum(lnum);
3905 }
3906 ex_keep_indent = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 if (eap->getline == NULL)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003908 {
3909 /* No getline() function, use the lines that follow. This ends
3910 * when there is no more. */
3911 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3912 break;
3913 p = vim_strchr(eap->nextcmd, NL);
3914 if (p == NULL)
3915 p = eap->nextcmd + STRLEN(eap->nextcmd);
3916 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3917 if (*p != NUL)
3918 ++p;
3919 eap->nextcmd = p;
3920 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 else
3922 theline = eap->getline(
3923#ifdef FEAT_EVAL
Bram Moolenaar3d60ec22005-01-05 22:19:46 +00003924 eap->cstack->cs_looplevel > 0 ? -1 :
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925#endif
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003926 NUL, eap->cookie, indent);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 lines_left = Rows - 1;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003928 if (theline == NULL)
3929 break;
3930
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003931 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3932 if (ex_keep_indent)
3933 append_indent = indent;
3934
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003935 /* Look for the "." after automatic indent. */
3936 vcol = 0;
3937 for (p = theline; indent > vcol; ++p)
3938 {
3939 if (*p == ' ')
3940 ++vcol;
3941 else if (*p == TAB)
3942 vcol += 8 - vcol % 8;
3943 else
3944 break;
3945 }
3946 if ((p[0] == '.' && p[1] == NUL)
Bram Moolenaareaa48e72005-06-08 22:07:37 +00003947 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3948 == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 {
3950 vim_free(theline);
3951 break;
3952 }
3953
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003954 /* don't use autoindent if nothing was typed. */
3955 if (p[0] == NUL)
3956 theline[0] = NUL;
3957
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 did_undo = TRUE;
3959 ml_append(lnum, theline, (colnr_T)0, FALSE);
3960 appended_lines_mark(lnum, 1L);
3961
3962 vim_free(theline);
3963 ++lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00003964
3965 if (empty)
3966 {
3967 ml_delete(2L, FALSE);
3968 empty = FALSE;
3969 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 }
3971 State = NORMAL;
3972
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00003973 if (eap->forceit)
3974 curbuf->b_p_ai = !curbuf->b_p_ai;
3975
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 /* "start" is set to eap->line2+1 unless that position is invalid (when
Bram Moolenaar45667512007-05-10 19:24:43 +00003977 * eap->line2 pointed to the end of the buffer and nothing was appended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 * "end" is set to lnum when something has been appended, otherwise
3979 * it is the same than "start" -- Acevedo */
3980 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3981 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3982 if (eap->cmdidx != CMD_append)
3983 --curbuf->b_op_start.lnum;
3984 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3985 ? lnum : curbuf->b_op_start.lnum;
3986 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3987 curwin->w_cursor.lnum = lnum;
3988 check_cursor_lnum();
3989 beginline(BL_SOL | BL_FIX);
3990
3991 need_wait_return = FALSE; /* don't use wait_return() now */
3992 ex_no_reprint = TRUE;
3993}
3994
3995/*
3996 * ":change"
3997 */
3998 void
3999ex_change(eap)
4000 exarg_T *eap;
4001{
4002 linenr_T lnum;
4003
4004 if (eap->line2 >= eap->line1
4005 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4006 return;
4007
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004008 /* the ! flag toggles autoindent */
4009 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4010 append_indent = get_indent_lnum(eap->line1);
4011
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4013 {
4014 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4015 break;
4016 ml_delete(eap->line1, FALSE);
4017 }
4018 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4019
4020 /* ":append" on the line above the deleted lines. */
4021 eap->line2 = eap->line1;
4022 ex_append(eap);
4023}
4024
4025 void
4026ex_z(eap)
4027 exarg_T *eap;
4028{
4029 char_u *x;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004030 int bigness;
4031 char_u *kind;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 int minus = 0;
4033 linenr_T start, end, curs, i;
4034 int j;
4035 linenr_T lnum = eap->line2;
4036
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004037 /* Vi compatible: ":z!" uses display height, without a count uses
4038 * 'scroll' */
4039 if (eap->forceit)
4040 bigness = curwin->w_height;
4041 else if (firstwin == lastwin)
4042 bigness = curwin->w_p_scr * 2;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004043#ifdef FEAT_WINDOWS
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004044 else
4045 bigness = curwin->w_height - 3;
Bram Moolenaar78a15312009-05-15 19:33:18 +00004046#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 if (bigness < 1)
4048 bigness = 1;
4049
4050 x = eap->arg;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004051 kind = x;
4052 if (*kind == '-' || *kind == '+' || *kind == '='
4053 || *kind == '^' || *kind == '.')
4054 ++x;
4055 while (*x == '-' || *x == '+')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 ++x;
4057
4058 if (*x != 0)
4059 {
4060 if (!VIM_ISDIGIT(*x))
4061 {
4062 EMSG(_("E144: non-numeric argument to :z"));
4063 return;
4064 }
4065 else
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004066 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 bigness = atoi((char *)x);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004068 p_window = bigness;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004069 if (*kind == '=')
4070 bigness += 2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004071 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 }
4073
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004074 /* the number of '-' and '+' multiplies the distance */
4075 if (*kind == '-' || *kind == '+')
4076 for (x = kind + 1; *x == *kind; ++x)
4077 ;
4078
4079 switch (*kind)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 {
4081 case '-':
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004082 start = lnum - bigness * (linenr_T)(x - kind);
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004083 end = start + bigness;
4084 curs = end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 break;
4086
4087 case '=':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004088 start = lnum - (bigness + 1) / 2 + 1;
4089 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 curs = lnum;
4091 minus = 1;
4092 break;
4093
4094 case '^':
4095 start = lnum - bigness * 2;
4096 end = lnum - bigness;
4097 curs = lnum - bigness;
4098 break;
4099
4100 case '.':
Bram Moolenaar2a8d1f82005-02-05 21:43:56 +00004101 start = lnum - (bigness + 1) / 2 + 1;
4102 end = lnum + (bigness + 1) / 2 - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 curs = end;
4104 break;
4105
4106 default: /* '+' */
4107 start = lnum;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004108 if (*kind == '+')
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004109 start += bigness * (linenr_T)(x - kind - 1) + 1;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004110 else if (eap->addr_count == 0)
4111 ++start;
4112 end = start + bigness - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 curs = end;
4114 break;
4115 }
4116
4117 if (start < 1)
4118 start = 1;
4119
4120 if (end > curbuf->b_ml.ml_line_count)
4121 end = curbuf->b_ml.ml_line_count;
4122
4123 if (curs > curbuf->b_ml.ml_line_count)
4124 curs = curbuf->b_ml.ml_line_count;
4125
4126 for (i = start; i <= end; i++)
4127 {
4128 if (minus && i == lnum)
4129 {
4130 msg_putchar('\n');
4131
4132 for (j = 1; j < Columns; j++)
4133 msg_putchar('-');
4134 }
4135
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004136 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137
4138 if (minus && i == lnum)
4139 {
4140 msg_putchar('\n');
4141
4142 for (j = 1; j < Columns; j++)
4143 msg_putchar('-');
4144 }
4145 }
4146
4147 curwin->w_cursor.lnum = curs;
4148 ex_no_reprint = TRUE;
4149}
4150
4151/*
4152 * Check if the restricted flag is set.
4153 * If so, give an error message and return TRUE.
4154 * Otherwise, return FALSE.
4155 */
4156 int
4157check_restricted()
4158{
4159 if (restricted)
4160 {
4161 EMSG(_("E145: Shell commands not allowed in rvim"));
4162 return TRUE;
4163 }
4164 return FALSE;
4165}
4166
4167/*
4168 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4169 * If so, give an error message and return TRUE.
4170 * Otherwise, return FALSE.
4171 */
4172 int
4173check_secure()
4174{
4175 if (secure)
4176 {
4177 secure = 2;
4178 EMSG(_(e_curdir));
4179 return TRUE;
4180 }
4181#ifdef HAVE_SANDBOX
4182 /*
4183 * In the sandbox more things are not allowed, including the things
4184 * disallowed in secure mode.
4185 */
4186 if (sandbox != 0)
4187 {
4188 EMSG(_(e_sandbox));
4189 return TRUE;
4190 }
4191#endif
4192 return FALSE;
4193}
4194
4195static char_u *old_sub = NULL; /* previous substitute pattern */
4196static int global_need_beginline; /* call beginline() after ":g" */
4197
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198/* do_sub()
4199 *
4200 * Perform a substitution from line eap->line1 to line eap->line2 using the
4201 * command pointed to by eap->arg which should be of the form:
4202 *
4203 * /pattern/substitution/{flags}
4204 *
4205 * The usual escapes are supported as described in the regexp docs.
4206 */
4207 void
4208do_sub(eap)
4209 exarg_T *eap;
4210{
4211 linenr_T lnum;
4212 long i = 0;
4213 regmmatch_T regmatch;
4214 static int do_all = FALSE; /* do multiple substitutions per line */
4215 static int do_ask = FALSE; /* ask for confirmation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004216 static int do_count = FALSE; /* count only */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 static int do_error = TRUE; /* if false, ignore errors */
4218 static int do_print = FALSE; /* print last line with subs. */
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004219 static int do_list = FALSE; /* list last line with subs. */
4220 static int do_number = FALSE; /* list last line with line nr*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 static int do_ic = 0; /* ignore case flag */
4222 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4223 int delimiter;
4224 int sublen;
4225 int got_quit = FALSE;
4226 int got_match = FALSE;
4227 int temp;
4228 int which_pat;
4229 char_u *cmd;
4230 int save_State;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004231 linenr_T first_line = 0; /* first changed line */
4232 linenr_T last_line= 0; /* below last changed line AFTER the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 * change */
4234 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4235 linenr_T line2;
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004236 long nmatch; /* number of lines in match */
Bram Moolenaar81bf7082005-02-12 14:31:42 +00004237 char_u *sub_firstline; /* allocated copy of first sub line */
4238 int endcolumn = FALSE; /* cursor in last column when done */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004239 pos_T old_cursor = curwin->w_cursor;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240
4241 cmd = eap->arg;
4242 if (!global_busy)
4243 {
4244 sub_nsubs = 0;
4245 sub_nlines = 0;
4246 }
4247
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 if (eap->cmdidx == CMD_tilde)
4249 which_pat = RE_LAST; /* use last used regexp */
4250 else
4251 which_pat = RE_SUBST; /* use last substitute regexp */
4252
4253 /* new pattern and substitution */
4254 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4255 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4256 {
4257 /* don't accept alphanumeric for separator */
4258 if (isalpha(*cmd))
4259 {
4260 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4261 return;
4262 }
4263 /*
4264 * undocumented vi feature:
4265 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4266 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4267 */
4268 if (*cmd == '\\')
4269 {
4270 ++cmd;
4271 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4272 {
4273 EMSG(_(e_backslash));
4274 return;
4275 }
4276 if (*cmd != '&')
4277 which_pat = RE_SEARCH; /* use last '/' pattern */
4278 pat = (char_u *)""; /* empty search pattern */
4279 delimiter = *cmd++; /* remember delimiter character */
4280 }
4281 else /* find the end of the regexp */
4282 {
Bram Moolenaar3a169c32008-01-02 12:59:21 +00004283#ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4284 if (p_altkeymap && curwin->w_p_rl)
4285 lrF_sub(cmd);
4286#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 which_pat = RE_LAST; /* use last used regexp */
4288 delimiter = *cmd++; /* remember delimiter character */
4289 pat = cmd; /* remember start of search pat */
4290 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4291 if (cmd[0] == delimiter) /* end delimiter found */
4292 *cmd++ = NUL; /* replace it with a NUL */
4293 }
4294
4295 /*
4296 * Small incompatibility: vi sees '\n' as end of the command, but in
4297 * Vim we want to use '\n' to find/substitute a NUL.
4298 */
4299 sub = cmd; /* remember the start of the substitution */
4300
4301 while (cmd[0])
4302 {
4303 if (cmd[0] == delimiter) /* end delimiter found */
4304 {
4305 *cmd++ = NUL; /* replace it with a NUL */
4306 break;
4307 }
4308 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4309 ++cmd;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00004310 mb_ptr_adv(cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 }
4312
4313 if (!eap->skip)
4314 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004315 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4316 if (STRCMP(sub, "%") == 0
4317 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4318 {
4319 if (old_sub == NULL) /* there is no previous command */
4320 {
4321 EMSG(_(e_nopresub));
4322 return;
4323 }
4324 sub = old_sub;
4325 }
4326 else
4327 {
4328 vim_free(old_sub);
4329 old_sub = vim_strsave(sub);
4330 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 }
4332 }
4333 else if (!eap->skip) /* use previous pattern and substitution */
4334 {
4335 if (old_sub == NULL) /* there is no previous command */
4336 {
4337 EMSG(_(e_nopresub));
4338 return;
4339 }
4340 pat = NULL; /* search_regcomp() will use previous pattern */
4341 sub = old_sub;
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00004342
4343 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4344 * last column after using "$". */
4345 endcolumn = (curwin->w_curswant == MAXCOL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 }
4347
4348 /*
4349 * Find trailing options. When '&' is used, keep old options.
4350 */
4351 if (*cmd == '&')
4352 ++cmd;
4353 else
4354 {
4355 if (!p_ed)
4356 {
4357 if (p_gd) /* default is global on */
4358 do_all = TRUE;
4359 else
4360 do_all = FALSE;
4361 do_ask = FALSE;
4362 }
4363 do_error = TRUE;
4364 do_print = FALSE;
Bram Moolenaarcc016f52005-12-10 20:23:46 +00004365 do_count = FALSE;
Bram Moolenaarfe40d1a2007-07-24 09:16:38 +00004366 do_number = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 do_ic = 0;
4368 }
4369 while (*cmd)
4370 {
4371 /*
4372 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4373 * 'r' is never inverted.
4374 */
4375 if (*cmd == 'g')
4376 do_all = !do_all;
4377 else if (*cmd == 'c')
4378 do_ask = !do_ask;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004379 else if (*cmd == 'n')
4380 do_count = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 else if (*cmd == 'e')
4382 do_error = !do_error;
4383 else if (*cmd == 'r') /* use last used regexp */
4384 which_pat = RE_LAST;
4385 else if (*cmd == 'p')
4386 do_print = TRUE;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004387 else if (*cmd == '#')
4388 {
4389 do_print = TRUE;
4390 do_number = TRUE;
4391 }
4392 else if (*cmd == 'l')
4393 {
4394 do_print = TRUE;
4395 do_list = TRUE;
4396 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 else if (*cmd == 'i') /* ignore case */
4398 do_ic = 'i';
4399 else if (*cmd == 'I') /* don't ignore case */
4400 do_ic = 'I';
4401 else
4402 break;
4403 ++cmd;
4404 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004405 if (do_count)
4406 do_ask = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407
4408 /*
4409 * check for a trailing count
4410 */
4411 cmd = skipwhite(cmd);
4412 if (VIM_ISDIGIT(*cmd))
4413 {
4414 i = getdigits(&cmd);
4415 if (i <= 0 && !eap->skip && do_error)
4416 {
4417 EMSG(_(e_zerocount));
4418 return;
4419 }
4420 eap->line1 = eap->line2;
4421 eap->line2 += i - 1;
4422 if (eap->line2 > curbuf->b_ml.ml_line_count)
4423 eap->line2 = curbuf->b_ml.ml_line_count;
4424 }
4425
4426 /*
4427 * check for trailing command or garbage
4428 */
4429 cmd = skipwhite(cmd);
4430 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4431 {
4432 eap->nextcmd = check_nextcmd(cmd);
4433 if (eap->nextcmd == NULL)
4434 {
4435 EMSG(_(e_trailing));
4436 return;
4437 }
4438 }
4439
4440 if (eap->skip) /* not executing commands, only parsing */
4441 return;
4442
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004443 if (!do_count && !curbuf->b_p_ma)
4444 {
Bram Moolenaar779b74b2006-04-10 14:55:34 +00004445 /* Substitution is not allowed in non-'modifiable' buffer */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004446 EMSG(_(e_modifiable));
4447 return;
4448 }
4449
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4451 {
4452 if (do_error)
4453 EMSG(_(e_invcmd));
4454 return;
4455 }
4456
4457 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4458 if (do_ic == 'i')
4459 regmatch.rmm_ic = TRUE;
4460 else if (do_ic == 'I')
4461 regmatch.rmm_ic = FALSE;
4462
4463 sub_firstline = NULL;
4464
4465 /*
4466 * ~ in the substitute pattern is replaced with the old pattern.
4467 * We do it here once to avoid it to be replaced over and over again.
4468 * But don't do it when it starts with "\=", then it's an expression.
4469 */
4470 if (!(sub[0] == '\\' && sub[1] == '='))
4471 sub = regtilde(sub, p_magic);
4472
4473 /*
4474 * Check for a match on each line.
4475 */
4476 line2 = eap->line2;
4477 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4478#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4479 || aborting()
4480#endif
4481 ); ++lnum)
4482 {
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004483 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4484 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 if (nmatch)
4486 {
4487 colnr_T copycol;
4488 colnr_T matchcol;
4489 colnr_T prev_matchcol = MAXCOL;
4490 char_u *new_end, *new_start = NULL;
4491 unsigned new_start_len = 0;
4492 char_u *p1;
4493 int did_sub = FALSE;
4494 int lastone;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004495 int len, copy_len, needed_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 long nmatch_tl = 0; /* nr of lines matched below lnum */
4497 int do_again; /* do it again after joining lines */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004498 int skip_match = FALSE;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004499 linenr_T sub_firstlnum; /* nr of first sub line */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500
4501 /*
4502 * The new text is build up step by step, to avoid too much
4503 * copying. There are these pieces:
Bram Moolenaara9aafe52008-05-07 11:10:28 +00004504 * sub_firstline The old text, unmodified.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 * copycol Column in the old text where we started
4506 * looking for a match; from here old text still
4507 * needs to be copied to the new text.
4508 * matchcol Column number of the old text where to look
4509 * for the next match. It's just after the
4510 * previous match or one further.
4511 * prev_matchcol Column just after the previous match (if any).
4512 * Mostly equal to matchcol, except for the first
4513 * match and after skipping an empty match.
4514 * regmatch.*pos Where the pattern matched in the old text.
4515 * new_start The new text, all that has been produced so
4516 * far.
4517 * new_end The new text, where to append new text.
4518 *
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004519 * lnum The line number where we found the start of
4520 * the match. Can be below the line we searched
4521 * when there is a \n before a \zs in the
4522 * pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 * sub_firstlnum The line number in the buffer where to look
4524 * for a match. Can be different from "lnum"
4525 * when the pattern or substitute string contains
4526 * line breaks.
4527 *
4528 * Special situations:
4529 * - When the substitute string contains a line break, the part up
4530 * to the line break is inserted in the text, but the copy of
4531 * the original line is kept. "sub_firstlnum" is adjusted for
4532 * the inserted lines.
4533 * - When the matched pattern contains a line break, the old line
4534 * is taken from the line at the end of the pattern. The lines
4535 * in the match are deleted later, "sub_firstlnum" is adjusted
4536 * accordingly.
4537 *
4538 * The new text is built up in new_start[]. It has some extra
4539 * room to avoid using alloc()/free() too often. new_start_len is
Bram Moolenaar61abfd12007-09-13 16:26:47 +00004540 * the length of the allocated memory at new_start.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 *
4542 * Make a copy of the old line, so it won't be taken away when
4543 * updating the screen or handling a multi-line match. The "old_"
4544 * pointers point into this copy.
4545 */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004546 sub_firstlnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 copycol = 0;
4548 matchcol = 0;
4549
4550 /* At first match, remember current cursor position. */
4551 if (!got_match)
4552 {
4553 setpcmark();
4554 got_match = TRUE;
4555 }
4556
4557 /*
4558 * Loop until nothing more to replace in this line.
4559 * 1. Handle match with empty string.
4560 * 2. If do_ask is set, ask for confirmation.
4561 * 3. substitute the string.
4562 * 4. if do_all is set, find next match
4563 * 5. break if there isn't another match in this line
4564 */
4565 for (;;)
4566 {
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004567 /* Advance "lnum" to the line where the match starts. The
4568 * match does not start in the first line when there is a line
4569 * break before \zs. */
4570 if (regmatch.startpos[0].lnum > 0)
4571 {
4572 lnum += regmatch.startpos[0].lnum;
4573 sub_firstlnum += regmatch.startpos[0].lnum;
4574 nmatch -= regmatch.startpos[0].lnum;
4575 vim_free(sub_firstline);
4576 sub_firstline = NULL;
4577 }
4578
4579 if (sub_firstline == NULL)
4580 {
4581 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4582 if (sub_firstline == NULL)
4583 {
4584 vim_free(new_start);
4585 goto outofmem;
4586 }
4587 }
4588
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 /* Save the line number of the last change for the final
4590 * cursor position (just like Vi). */
4591 curwin->w_cursor.lnum = lnum;
4592 do_again = FALSE;
4593
4594 /*
4595 * 1. Match empty string does not count, except for first
4596 * match. This reproduces the strange vi behaviour.
4597 * This also catches endless loops.
4598 */
4599 if (matchcol == prev_matchcol
4600 && regmatch.endpos[0].lnum == 0
4601 && matchcol == regmatch.endpos[0].col)
4602 {
Bram Moolenaar8299df92004-07-10 09:47:34 +00004603 if (sub_firstline[matchcol] == NUL)
4604 /* We already were at the end of the line. Don't look
4605 * for a match in this line again. */
4606 skip_match = TRUE;
4607 else
4608 ++matchcol; /* search for a match at next column */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 goto skip;
4610 }
4611
4612 /* Normally we continue searching for a match just after the
4613 * previous match. */
4614 matchcol = regmatch.endpos[0].col;
4615 prev_matchcol = matchcol;
4616
4617 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +00004618 * 2. If do_count is set only increase the counter.
4619 * If do_ask is set, ask for confirmation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00004621 if (do_count)
4622 {
4623 /* For a multi-line match, put matchcol at the NUL at
4624 * the end of the line and set nmatch to one, so that
4625 * we continue looking for a match on the next line.
4626 * Avoids that ":s/\nB\@=//gc" get stuck. */
4627 if (nmatch > 1)
4628 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004629 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004630 nmatch = 1;
Bram Moolenaar12ddc3e2008-01-04 13:53:09 +00004631 skip_match = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004632 }
4633 sub_nsubs++;
4634 did_sub = TRUE;
4635 goto skip;
4636 }
4637
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 if (do_ask)
4639 {
Bram Moolenaar985cb442009-05-14 19:51:46 +00004640 int typed = 0;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004641
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 /* change State to CONFIRM, so that the mouse works
4643 * properly */
4644 save_State = State;
4645 State = CONFIRM;
4646#ifdef FEAT_MOUSE
4647 setmouse(); /* disable mouse in xterm */
4648#endif
4649 curwin->w_cursor.col = regmatch.startpos[0].col;
4650
4651 /* When 'cpoptions' contains "u" don't sync undo when
4652 * asking for confirmation. */
4653 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4654 ++no_u_sync;
4655
4656 /*
4657 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4658 */
4659 while (do_ask)
4660 {
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004661 if (exmode_active)
4662 {
4663 char_u *resp;
4664 colnr_T sc, ec;
4665
4666 print_line_no_prefix(lnum, FALSE, FALSE);
4667
4668 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4669 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4670 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4671 msg_start();
Bram Moolenaar05159a02005-02-26 23:04:13 +00004672 for (i = 0; i < (long)sc; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004673 msg_putchar(' ');
Bram Moolenaar05159a02005-02-26 23:04:13 +00004674 for ( ; i <= (long)ec; ++i)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004675 msg_putchar('^');
4676
4677 resp = getexmodeline('?', NULL, 0);
4678 if (resp != NULL)
4679 {
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004680 typed = *resp;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004681 vim_free(resp);
4682 }
4683 }
4684 else
4685 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004687 int save_p_fen = curwin->w_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004689 curwin->w_p_fen = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004691 /* Invert the matched string.
4692 * Remove the inversion afterwards. */
4693 temp = RedrawingDisabled;
4694 RedrawingDisabled = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004696 search_match_lines = regmatch.endpos[0].lnum
4697 - regmatch.startpos[0].lnum;
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004698 search_match_endcol = regmatch.endpos[0].col;
4699 highlight_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004701 update_topline();
4702 validate_cursor();
Bram Moolenaara1956f62006-03-12 22:18:00 +00004703 update_screen(SOME_VALID);
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004704 highlight_match = FALSE;
Bram Moolenaara1956f62006-03-12 22:18:00 +00004705 redraw_later(SOME_VALID);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706
4707#ifdef FEAT_FOLDING
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004708 curwin->w_p_fen = save_p_fen;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004710 if (msg_row == Rows - 1)
4711 msg_didout = FALSE; /* avoid a scroll-up */
4712 msg_starthere();
4713 i = msg_scroll;
4714 msg_scroll = 0; /* truncate msg when
4715 needed */
4716 msg_no_more = TRUE;
4717 /* write message same highlighting as for
4718 * wait_return */
4719 smsg_attr(hl_attr(HLF_R),
4720 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4721 msg_no_more = FALSE;
4722 msg_scroll = i;
4723 showruler(TRUE);
4724 windgoto(msg_row, msg_col);
4725 RedrawingDisabled = temp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726
4727#ifdef USE_ON_FLY_SCROLL
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004728 dont_scroll = FALSE; /* allow scrolling here */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729#endif
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004730 ++no_mapping; /* don't map this key */
4731 ++allow_keys; /* allow special keys */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004732 typed = plain_vgetc();
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004733 --allow_keys;
4734 --no_mapping;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00004736 /* clear the question */
4737 msg_didout = FALSE; /* don't scroll up */
4738 msg_col = 0;
4739 gotocmdline(TRUE);
4740 }
4741
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 need_wait_return = FALSE; /* no hit-return prompt */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004743 if (typed == 'q' || typed == ESC || typed == Ctrl_C
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744#ifdef UNIX
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004745 || typed == intr_char
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746#endif
4747 )
4748 {
4749 got_quit = TRUE;
4750 break;
4751 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004752 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004754 if (typed == 'y')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 break;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004756 if (typed == 'l')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 {
4758 /* last: replace and then stop */
4759 do_all = FALSE;
4760 line2 = lnum;
4761 break;
4762 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004763 if (typed == 'a')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 {
4765 do_ask = FALSE;
4766 break;
4767 }
4768#ifdef FEAT_INS_EXPAND
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004769 if (typed == Ctrl_E)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 scrollup_clamp();
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004771 else if (typed == Ctrl_Y)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 scrolldown_clamp();
4773#endif
4774 }
4775 State = save_State;
4776#ifdef FEAT_MOUSE
4777 setmouse();
4778#endif
4779 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4780 --no_u_sync;
4781
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004782 if (typed == 'n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 {
4784 /* For a multi-line match, put matchcol at the NUL at
4785 * the end of the line and set nmatch to one, so that
4786 * we continue looking for a match on the next line.
Bram Moolenaarc432b502007-03-15 20:38:26 +00004787 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4788 * get stuck when pressing 'n'. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 if (nmatch > 1)
4790 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00004791 matchcol = (colnr_T)STRLEN(sub_firstline);
Bram Moolenaarc432b502007-03-15 20:38:26 +00004792 skip_match = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 }
4794 goto skip;
4795 }
4796 if (got_quit)
4797 break;
4798 }
4799
4800 /* Move the cursor to the start of the match, so that we can
4801 * use "\=col("."). */
4802 curwin->w_cursor.col = regmatch.startpos[0].col;
4803
4804 /*
4805 * 3. substitute the string.
4806 */
4807 /* get length of substitution part */
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004808 sublen = vim_regsub_multi(&regmatch,
4809 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 sub, sub_firstline, FALSE, p_magic, TRUE);
4811
Bram Moolenaar4463f292005-09-25 22:20:24 +00004812 /* When the match included the "$" of the last line it may
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004813 * go beyond the last line of the buffer. */
Bram Moolenaar4463f292005-09-25 22:20:24 +00004814 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4815 {
4816 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4817 skip_match = TRUE;
4818 }
4819
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 /* Need room for:
4821 * - result so far in new_start (not for first sub in line)
4822 * - original text up to match
4823 * - length of substituted part
4824 * - original text after match
4825 */
4826 if (nmatch == 1)
4827 p1 = sub_firstline;
4828 else
4829 {
4830 p1 = ml_get(sub_firstlnum + nmatch - 1);
4831 nmatch_tl += nmatch - 1;
4832 }
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004833 copy_len = regmatch.startpos[0].col - copycol;
4834 needed_len = copy_len + ((unsigned)STRLEN(p1)
4835 - regmatch.endpos[0].col) + sublen + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 if (new_start == NULL)
4837 {
4838 /*
4839 * Get some space for a temporary buffer to do the
4840 * substitution into (and some extra space to avoid
4841 * too many calls to alloc()/free()).
4842 */
4843 new_start_len = needed_len + 50;
4844 if ((new_start = alloc_check(new_start_len)) == NULL)
4845 goto outofmem;
4846 *new_start = NUL;
4847 new_end = new_start;
4848 }
4849 else
4850 {
4851 /*
4852 * Check if the temporary buffer is long enough to do the
4853 * substitution into. If not, make it larger (with a bit
4854 * extra to avoid too many calls to alloc()/free()).
4855 */
4856 len = (unsigned)STRLEN(new_start);
4857 needed_len += len;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004858 if (needed_len > (int)new_start_len)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 {
4860 new_start_len = needed_len + 50;
4861 if ((p1 = alloc_check(new_start_len)) == NULL)
4862 {
4863 vim_free(new_start);
4864 goto outofmem;
4865 }
4866 mch_memmove(p1, new_start, (size_t)(len + 1));
4867 vim_free(new_start);
4868 new_start = p1;
4869 }
4870 new_end = new_start + len;
4871 }
4872
4873 /*
4874 * copy the text up to the part that matched
4875 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00004876 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4877 new_end += copy_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004879 (void)vim_regsub_multi(&regmatch,
4880 sub_firstlnum - regmatch.startpos[0].lnum,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 sub, new_end, TRUE, p_magic, TRUE);
4882 sub_nsubs++;
4883 did_sub = TRUE;
4884
4885 /* Move the cursor to the start of the line, to avoid that it
4886 * is beyond the end of the line after the substitution. */
4887 curwin->w_cursor.col = 0;
4888
4889 /* For a multi-line match, make a copy of the last matched
4890 * line and continue in that one. */
4891 if (nmatch > 1)
4892 {
4893 sub_firstlnum += nmatch - 1;
4894 vim_free(sub_firstline);
4895 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4896 /* When going beyond the last line, stop substituting. */
4897 if (sub_firstlnum <= line2)
4898 do_again = TRUE;
4899 else
4900 do_all = FALSE;
4901 }
4902
4903 /* Remember next character to be copied. */
4904 copycol = regmatch.endpos[0].col;
4905
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004906 if (skip_match)
4907 {
4908 /* Already hit end of the buffer, sub_firstlnum is one
4909 * less than what it ought to be. */
4910 vim_free(sub_firstline);
4911 sub_firstline = vim_strsave((char_u *)"");
4912 copycol = 0;
4913 }
4914
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 /*
4916 * Now the trick is to replace CTRL-M chars with a real line
4917 * break. This would make it impossible to insert a CTRL-M in
4918 * the text. The line break can be avoided by preceding the
4919 * CTRL-M with a backslash. To be able to insert a backslash,
4920 * they must be doubled in the string and are halved here.
4921 * That is Vi compatible.
4922 */
4923 for (p1 = new_end; *p1; ++p1)
4924 {
4925 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004926 STRMOVE(p1, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 else if (*p1 == CAR)
4928 {
4929 if (u_inssub(lnum) == OK) /* prepare for undo */
4930 {
4931 *p1 = NUL; /* truncate up to the CR */
4932 ml_append(lnum - 1, new_start,
4933 (colnr_T)(p1 - new_start + 1), FALSE);
4934 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4935 if (do_ask)
4936 appended_lines(lnum - 1, 1L);
4937 else
4938 {
4939 if (first_line == 0)
4940 first_line = lnum;
4941 last_line = lnum + 1;
4942 }
4943 /* All line numbers increase. */
4944 ++sub_firstlnum;
4945 ++lnum;
4946 ++line2;
4947 /* move the cursor to the new line, like Vi */
4948 ++curwin->w_cursor.lnum;
Bram Moolenaarf9ffd182007-11-20 17:04:29 +00004949 /* copy the rest */
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004950 STRMOVE(new_start, p1 + 1);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 p1 = new_start - 1;
4952 }
4953 }
4954#ifdef FEAT_MBYTE
4955 else if (has_mbyte)
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00004956 p1 += (*mb_ptr2len)(p1) - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957#endif
4958 }
4959
4960 /*
4961 * 4. If do_all is set, find next match.
4962 * Prevent endless loop with patterns that match empty
4963 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4964 * But ":s/\n/#/" is OK.
4965 */
4966skip:
4967 /* We already know that we did the last subst when we are at
4968 * the end of the line, except that a pattern like
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004969 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4970 * "line2" when there is a \zs in the pattern after a line
4971 * break. */
Bram Moolenaar8299df92004-07-10 09:47:34 +00004972 lastone = (skip_match
4973 || got_int
4974 || got_quit
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004975 || lnum > line2
Bram Moolenaar8299df92004-07-10 09:47:34 +00004976 || !(do_all || do_again)
4977 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4978 && !re_multiline(regmatch.regprog)));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 nmatch = -1;
4980
4981 /*
4982 * Replace the line in the buffer when needed. This is
4983 * skipped when there are more matches.
4984 * The check for nmatch_tl is needed for when multi-line
4985 * matching must replace the lines before trying to do another
4986 * match, otherwise "\@<=" won't work.
4987 * When asking the user we like to show the already replaced
4988 * text, but don't do it when "\<@=" or "\<@!" is used, it
4989 * changes what matches.
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004990 * When the match starts below where we start searching also
4991 * need to replace the line first (using \zs after \n).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 */
4993 if (lastone
4994 || (do_ask && !re_lookbehind(regmatch.regprog))
4995 || nmatch_tl > 0
4996 || (nmatch = vim_regexec_multi(&regmatch, curwin,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004997 curbuf, sub_firstlnum,
4998 matchcol, NULL)) == 0
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00004999 || regmatch.startpos[0].lnum > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 {
5001 if (new_start != NULL)
5002 {
5003 /*
5004 * Copy the rest of the line, that didn't match.
5005 * "matchcol" has to be adjusted, we use the end of
5006 * the line as reference, because the substitute may
5007 * have changed the number of characters. Same for
5008 * "prev_matchcol".
5009 */
5010 STRCAT(new_start, sub_firstline + copycol);
5011 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5012 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5013 - prev_matchcol;
5014
5015 if (u_savesub(lnum) != OK)
5016 break;
5017 ml_replace(lnum, new_start, TRUE);
5018
5019 if (nmatch_tl > 0)
5020 {
5021 /*
5022 * Matched lines have now been substituted and are
5023 * useless, delete them. The part after the match
5024 * has been appended to new_start, we don't need
5025 * it in the buffer.
5026 */
5027 ++lnum;
5028 if (u_savedel(lnum, nmatch_tl) != OK)
5029 break;
5030 for (i = 0; i < nmatch_tl; ++i)
5031 ml_delete(lnum, (int)FALSE);
5032 mark_adjust(lnum, lnum + nmatch_tl - 1,
5033 (long)MAXLNUM, -nmatch_tl);
5034 if (do_ask)
5035 deleted_lines(lnum, nmatch_tl);
5036 --lnum;
5037 line2 -= nmatch_tl; /* nr of lines decreases */
5038 nmatch_tl = 0;
5039 }
5040
5041 /* When asking, undo is saved each time, must also set
5042 * changed flag each time. */
5043 if (do_ask)
5044 changed_bytes(lnum, 0);
5045 else
5046 {
5047 if (first_line == 0)
5048 first_line = lnum;
5049 last_line = lnum + 1;
5050 }
5051
5052 sub_firstlnum = lnum;
5053 vim_free(sub_firstline); /* free the temp buffer */
5054 sub_firstline = new_start;
5055 new_start = NULL;
5056 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5057 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5058 - prev_matchcol;
5059 copycol = 0;
5060 }
5061 if (nmatch == -1 && !lastone)
5062 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005063 sub_firstlnum, matchcol, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064
5065 /*
5066 * 5. break if there isn't another match in this line
5067 */
5068 if (nmatch <= 0)
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005069 {
5070 /* If the match found didn't start where we were
5071 * searching, do the next search in the line where we
5072 * found the match. */
5073 if (nmatch == -1)
5074 lnum -= regmatch.startpos[0].lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 break;
Bram Moolenaarbd7cc032008-01-09 21:40:50 +00005076 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 }
5078
5079 line_breakcheck();
5080 }
5081
5082 if (did_sub)
5083 ++sub_nlines;
Bram Moolenaarda2bd6f2008-09-14 19:41:30 +00005084 vim_free(new_start); /* for when substitute was cancelled */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 vim_free(sub_firstline); /* free the copy of the original line */
5086 sub_firstline = NULL;
5087 }
5088
5089 line_breakcheck();
5090 }
5091
5092 if (first_line != 0)
5093 {
5094 /* Need to subtract the number of added lines from "last_line" to get
5095 * the line number before the change (same as adding the number of
5096 * deleted lines). */
5097 i = curbuf->b_ml.ml_line_count - old_line_count;
5098 changed_lines(first_line, 0, last_line - i, i);
5099 }
5100
5101outofmem:
5102 vim_free(sub_firstline); /* may have to free allocated copy of the line */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005103
5104 /* ":s/pat//n" doesn't move the cursor */
5105 if (do_count)
5106 curwin->w_cursor = old_cursor;
5107
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 if (sub_nsubs)
5109 {
5110 /* Set the '[ and '] marks. */
5111 curbuf->b_op_start.lnum = eap->line1;
5112 curbuf->b_op_end.lnum = line2;
5113 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5114
5115 if (!global_busy)
5116 {
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +00005117 if (endcolumn)
5118 coladvance((colnr_T)MAXCOL);
5119 else
5120 beginline(BL_WHITE | BL_FIX);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005121 if (!do_sub_msg(do_count) && do_ask)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 MSG("");
5123 }
5124 else
5125 global_need_beginline = TRUE;
5126 if (do_print)
Bram Moolenaar5313dcb2005-02-22 08:56:13 +00005127 print_line(curwin->w_cursor.lnum, do_number, do_list);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 }
5129 else if (!global_busy)
5130 {
5131 if (got_int) /* interrupted */
5132 EMSG(_(e_interr));
5133 else if (got_match) /* did find something but nothing substituted */
5134 MSG("");
5135 else if (do_error) /* nothing found */
5136 EMSG2(_(e_patnotf2), get_search_pat());
5137 }
5138
5139 vim_free(regmatch.regprog);
5140}
5141
5142/*
5143 * Give message for number of substitutions.
5144 * Can also be used after a ":global" command.
5145 * Return TRUE if a message was given.
5146 */
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005147 int
Bram Moolenaar05159a02005-02-26 23:04:13 +00005148do_sub_msg(count_only)
5149 int count_only; /* used 'n' flag for ":s" */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150{
Bram Moolenaar555b2802005-05-19 21:08:39 +00005151 int len = 0;
5152
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 /*
5154 * Only report substitutions when:
5155 * - more than 'report' substitutions
5156 * - command was typed by user, or number of changed lines > 'report'
5157 * - giving messages is not disabled by 'lazyredraw'
5158 */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005159 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5160 || count_only)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 && messaging())
5162 {
5163 if (got_int)
Bram Moolenaar555b2802005-05-19 21:08:39 +00005164 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 STRCPY(msg_buf, _("(Interrupted) "));
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005166 len = (int)STRLEN(msg_buf);
Bram Moolenaar555b2802005-05-19 21:08:39 +00005167 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 if (sub_nsubs == 1)
Bram Moolenaar555b2802005-05-19 21:08:39 +00005169 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5170 "%s", count_only ? _("1 match") : _("1 substitution"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 else
Bram Moolenaar555b2802005-05-19 21:08:39 +00005172 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
Bram Moolenaar05159a02005-02-26 23:04:13 +00005173 count_only ? _("%ld matches") : _("%ld substitutions"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 sub_nsubs);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005175 len = (int)STRLEN(msg_buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 if (sub_nlines == 1)
Bram Moolenaar555b2802005-05-19 21:08:39 +00005177 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5178 "%s", _(" on 1 line"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 else
Bram Moolenaar555b2802005-05-19 21:08:39 +00005180 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5181 _(" on %ld lines"), (long)sub_nlines);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 if (msg(msg_buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 /* save message to display it after redraw */
Bram Moolenaar238a5642006-02-21 22:12:05 +00005184 set_keep_msg(msg_buf, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 return TRUE;
5186 }
5187 if (got_int)
5188 {
5189 EMSG(_(e_interr));
5190 return TRUE;
5191 }
5192 return FALSE;
5193}
5194
5195/*
5196 * Execute a global command of the form:
5197 *
5198 * g/pattern/X : execute X on all lines where pattern matches
5199 * v/pattern/X : execute X on all lines where pattern does not match
5200 *
5201 * where 'X' is an EX command
5202 *
5203 * The command character (as well as the trailing slash) is optional, and
5204 * is assumed to be 'p' if missing.
5205 *
5206 * This is implemented in two passes: first we scan the file for the pattern and
5207 * set a mark for each line that (not) matches. secondly we execute the command
5208 * for each line that has a mark. This is required because after deleting
5209 * lines we do not know where to search for the next match.
5210 */
5211 void
5212ex_global(eap)
5213 exarg_T *eap;
5214{
5215 linenr_T lnum; /* line number according to old situation */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005216 int ndone = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 int type; /* first char of cmd: 'v' or 'g' */
5218 char_u *cmd; /* command argument */
5219
5220 char_u delim; /* delimiter, normally '/' */
5221 char_u *pat;
5222 regmmatch_T regmatch;
5223 int match;
5224 int which_pat;
5225
5226 if (global_busy)
5227 {
5228 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5229 return;
5230 }
5231
5232 if (eap->forceit) /* ":global!" is like ":vglobal" */
5233 type = 'v';
5234 else
5235 type = *eap->cmd;
5236 cmd = eap->arg;
5237 which_pat = RE_LAST; /* default: use last used regexp */
5238 sub_nsubs = 0;
5239 sub_nlines = 0;
5240
5241 /*
5242 * undocumented vi feature:
5243 * "\/" and "\?": use previous search pattern.
5244 * "\&": use previous substitute pattern.
5245 */
5246 if (*cmd == '\\')
5247 {
5248 ++cmd;
5249 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5250 {
5251 EMSG(_(e_backslash));
5252 return;
5253 }
5254 if (*cmd == '&')
5255 which_pat = RE_SUBST; /* use previous substitute pattern */
5256 else
5257 which_pat = RE_SEARCH; /* use previous search pattern */
5258 ++cmd;
5259 pat = (char_u *)"";
5260 }
5261 else if (*cmd == NUL)
5262 {
5263 EMSG(_("E148: Regular expression missing from global"));
5264 return;
5265 }
5266 else
5267 {
5268 delim = *cmd; /* get the delimiter */
5269 if (delim)
5270 ++cmd; /* skip delimiter if there is one */
5271 pat = cmd; /* remember start of pattern */
5272 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5273 if (cmd[0] == delim) /* end delimiter found */
5274 *cmd++ = NUL; /* replace it with a NUL */
5275 }
5276
5277#ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5278 if (p_altkeymap && curwin->w_p_rl)
5279 lrFswap(pat,0);
5280#endif
5281
5282 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5283 {
5284 EMSG(_(e_invcmd));
5285 return;
5286 }
5287
5288 /*
5289 * pass 1: set marks for each (not) matching line
5290 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5292 {
5293 /* a match on this line? */
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005294 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5295 (colnr_T)0, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 if ((type == 'g' && match) || (type == 'v' && !match))
5297 {
5298 ml_setmarked(lnum);
5299 ndone++;
5300 }
5301 line_breakcheck();
5302 }
5303
5304 /*
5305 * pass 2: execute the command for each line that has been marked
5306 */
5307 if (got_int)
5308 MSG(_(e_interr));
5309 else if (ndone == 0)
5310 {
5311 if (type == 'v')
Bram Moolenaar555b2802005-05-19 21:08:39 +00005312 smsg((char_u *)_("Pattern found in every line: %s"), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 else
Bram Moolenaar555b2802005-05-19 21:08:39 +00005314 smsg((char_u *)_(e_patnotf2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 }
5316 else
5317 global_exe(cmd);
5318
5319 ml_clearmarked(); /* clear rest of the marks */
5320 vim_free(regmatch.regprog);
5321}
5322
5323/*
5324 * Execute "cmd" on lines marked with ml_setmarked().
5325 */
5326 void
5327global_exe(cmd)
5328 char_u *cmd;
5329{
5330 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5331 linenr_T lnum; /* line number according to old situation */
5332
5333 /*
5334 * Set current position only once for a global command.
5335 * If global_busy is set, setpcmark() will not do anything.
5336 * If there is an error, global_busy will be incremented.
5337 */
5338 setpcmark();
5339
5340 /* When the command writes a message, don't overwrite the command. */
5341 msg_didout = TRUE;
5342
5343 global_need_beginline = FALSE;
5344 global_busy = 1;
5345 old_lcount = curbuf->b_ml.ml_line_count;
5346 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5347 {
5348 curwin->w_cursor.lnum = lnum;
5349 curwin->w_cursor.col = 0;
5350 if (*cmd == NUL || *cmd == '\n')
5351 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5352 else
5353 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5354 ui_breakcheck();
5355 }
5356
5357 global_busy = 0;
5358 if (global_need_beginline)
5359 beginline(BL_WHITE | BL_FIX);
5360 else
5361 check_cursor(); /* cursor may be beyond the end of the line */
5362
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00005363 /* the cursor may not have moved in the text but a change in a previous
5364 * line may move it on the screen */
5365 changed_line_abv_curs();
5366
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 /* If it looks like no message was written, allow overwriting the
5368 * command with the report for number of changes. */
5369 if (msg_col == 0 && msg_scrolled == 0)
5370 msg_didout = FALSE;
5371
Bram Moolenaar45667512007-05-10 19:24:43 +00005372 /* If substitutes done, report number of substitutes, otherwise report
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 * number of extra or deleted lines. */
Bram Moolenaar05159a02005-02-26 23:04:13 +00005374 if (!do_sub_msg(FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5376}
5377
5378#ifdef FEAT_VIMINFO
5379 int
5380read_viminfo_sub_string(virp, force)
5381 vir_T *virp;
5382 int force;
5383{
5384 if (old_sub != NULL && force)
5385 vim_free(old_sub);
5386 if (force || old_sub == NULL)
5387 old_sub = viminfo_readstring(virp, 1, TRUE);
5388 return viminfo_readline(virp);
5389}
5390
5391 void
5392write_viminfo_sub_string(fp)
5393 FILE *fp;
5394{
5395 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5396 {
5397 fprintf(fp, _("\n# Last Substitute String:\n$"));
5398 viminfo_writestring(fp, old_sub);
5399 }
5400}
5401#endif /* FEAT_VIMINFO */
5402
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00005403#if defined(EXITFREE) || defined(PROTO)
5404 void
5405free_old_sub()
5406{
5407 vim_free(old_sub);
5408}
5409#endif
5410
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411#if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5412/*
5413 * Set up for a tagpreview.
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005414 * Return TRUE when it was created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005416 int
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005417prepare_tagpreview(undo_sync)
5418 int undo_sync; /* sync undo when leaving the window */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419{
5420 win_T *wp;
5421
5422# ifdef FEAT_GUI
5423 need_mouse_correct = TRUE;
5424# endif
5425
5426 /*
5427 * If there is already a preview window open, use that one.
5428 */
5429 if (!curwin->w_p_pvw)
5430 {
5431 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5432 if (wp->w_p_pvw)
5433 break;
5434 if (wp != NULL)
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00005435 win_enter(wp, undo_sync);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 else
5437 {
5438 /*
5439 * There is no preview window open yet. Create one.
5440 */
5441 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5442 == FAIL)
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005443 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 curwin->w_p_pvw = TRUE;
5445 curwin->w_p_wfh = TRUE;
5446# ifdef FEAT_SCROLLBIND
5447 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5448# endif
5449# ifdef FEAT_DIFF
5450 curwin->w_p_diff = FALSE; /* no 'diff' */
5451# endif
5452# ifdef FEAT_FOLDING
5453 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5454# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005455 return TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 }
5457 }
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00005458 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459}
5460
5461#endif
5462
5463
5464/*
5465 * ":help": open a read-only window on a help file
5466 */
5467 void
5468ex_help(eap)
5469 exarg_T *eap;
5470{
5471 char_u *arg;
5472 char_u *tag;
5473 FILE *helpfd; /* file descriptor of help file */
5474 int n;
5475 int i;
5476#ifdef FEAT_WINDOWS
5477 win_T *wp;
5478#endif
5479 int num_matches;
5480 char_u **matches;
5481 char_u *p;
5482 int empty_fnum = 0;
5483 int alt_fnum = 0;
5484 buf_T *buf;
5485#ifdef FEAT_MULTI_LANG
5486 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005487 char_u *lang;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488#endif
5489
5490 if (eap != NULL)
5491 {
5492 /*
5493 * A ":help" command ends at the first LF, or at a '|' that is
5494 * followed by some text. Set nextcmd to the following command.
5495 */
5496 for (arg = eap->arg; *arg; ++arg)
5497 {
5498 if (*arg == '\n' || *arg == '\r'
5499 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5500 {
5501 *arg++ = NUL;
5502 eap->nextcmd = arg;
5503 break;
5504 }
5505 }
5506 arg = eap->arg;
5507
5508 if (eap->forceit && *arg == NUL)
5509 {
5510 EMSG(_("E478: Don't panic!"));
5511 return;
5512 }
5513
5514 if (eap->skip) /* not executing commands */
5515 return;
5516 }
5517 else
5518 arg = (char_u *)"";
5519
5520 /* remove trailing blanks */
5521 p = arg + STRLEN(arg) - 1;
5522 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5523 *p-- = NUL;
5524
5525#ifdef FEAT_MULTI_LANG
5526 /* Check for a specified language */
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005527 lang = check_help_lang(arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528#endif
5529
5530 /* When no argument given go to the index. */
5531 if (*arg == NUL)
5532 arg = (char_u *)"help.txt";
5533
5534 /*
5535 * Check if there is a match for the argument.
5536 */
5537 n = find_help_tags(arg, &num_matches, &matches,
5538 eap != NULL && eap->forceit);
5539
5540 i = 0;
5541#ifdef FEAT_MULTI_LANG
5542 if (n != FAIL && lang != NULL)
5543 /* Find first item with the requested language. */
5544 for (i = 0; i < num_matches; ++i)
5545 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005546 len = (int)STRLEN(matches[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 if (len > 3 && matches[i][len - 3] == '@'
5548 && STRICMP(matches[i] + len - 2, lang) == 0)
5549 break;
5550 }
5551#endif
5552 if (i >= num_matches || n == FAIL)
5553 {
5554#ifdef FEAT_MULTI_LANG
5555 if (lang != NULL)
5556 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5557 else
5558#endif
5559 EMSG2(_("E149: Sorry, no help for %s"), arg);
5560 if (n != FAIL)
5561 FreeWild(num_matches, matches);
5562 return;
5563 }
5564
5565 /* The first match (in the requested language) is the best match. */
5566 tag = vim_strsave(matches[i]);
5567 FreeWild(num_matches, matches);
5568
5569#ifdef FEAT_GUI
5570 need_mouse_correct = TRUE;
5571#endif
5572
5573 /*
5574 * Re-use an existing help window or open a new one.
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005575 * Always open a new one for ":tab help".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 */
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005577 if (!curwin->w_buffer->b_help
5578#ifdef FEAT_WINDOWS
5579 || cmdmod.tab != 0
5580#endif
5581 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 {
5583#ifdef FEAT_WINDOWS
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005584 if (cmdmod.tab != 0)
5585 wp = NULL;
5586 else
5587 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5588 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5589 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5591 win_enter(wp, TRUE);
5592 else
5593#endif
5594 {
5595 /*
5596 * There is no help window yet.
5597 * Try to open the file specified by the "helpfile" option.
5598 */
5599 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5600 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00005601 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 goto erret;
5603 }
5604 fclose(helpfd);
5605
5606#ifdef FEAT_WINDOWS
5607 /* Split off help window; put it at far top if no position
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005608 * specified, the current window is vertically split and
5609 * narrow. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 n = WSP_HELP;
5611# ifdef FEAT_VERTSPLIT
5612 if (cmdmod.split == 0 && curwin->w_width != Columns
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005613 && curwin->w_width < 80)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 n |= WSP_TOP;
5615# endif
5616 if (win_split(0, n) == FAIL)
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005617 goto erret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618#else
5619 /* use current window */
5620 if (!can_abandon(curbuf, FALSE))
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 goto erret;
Bram Moolenaar2a3f7ee2006-02-23 21:34:44 +00005622#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623
5624#ifdef FEAT_WINDOWS
5625 if (curwin->w_height < p_hh)
5626 win_setheight((int)p_hh);
5627#endif
5628
5629 /*
5630 * Open help file (do_ecmd() will set b_help flag, readfile() will
5631 * set b_p_ro flag).
5632 * Set the alternate file to the previously edited file.
5633 */
5634 alt_fnum = curbuf->b_fnum;
5635 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00005636 ECMD_HIDE + ECMD_SET_HELP,
5637#ifdef FEAT_WINDOWS
5638 NULL /* buffer is still open, don't store info */
5639#else
5640 curwin
5641#endif
5642 );
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005643 if (!cmdmod.keepalt)
5644 curwin->w_alt_fnum = alt_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 empty_fnum = curbuf->b_fnum;
5646 }
5647 }
5648
5649 if (!p_im)
5650 restart_edit = 0; /* don't want insert mode in help file */
5651
5652 if (tag != NULL)
5653 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5654
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005655 /* Delete the empty buffer if we're not using it. Careful: autocommands
5656 * may have jumped to another window, check that the buffer is not in a
5657 * window. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5659 {
5660 buf = buflist_findnr(empty_fnum);
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005661 if (buf != NULL && buf->b_nwindows == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 wipe_buffer(buf, TRUE);
5663 }
5664
5665 /* keep the previous alternate file */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005666 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 curwin->w_alt_fnum = alt_fnum;
5668
5669erret:
5670 vim_free(tag);
5671}
5672
5673
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005674#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5675/*
5676 * In an argument search for a language specifiers in the form "@xx".
5677 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5678 * Returns NULL if not found.
5679 */
5680 char_u *
5681check_help_lang(arg)
5682 char_u *arg;
5683{
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00005684 int len = (int)STRLEN(arg);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00005685
5686 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5687 && ASCII_ISALPHA(arg[len - 1]))
5688 {
5689 arg[len - 3] = NUL; /* remove the '@' */
5690 return arg + len - 2;
5691 }
5692 return NULL;
5693}
5694#endif
5695
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696/*
5697 * Return a heuristic indicating how well the given string matches. The
5698 * smaller the number, the better the match. This is the order of priorities,
5699 * from best match to worst match:
5700 * - Match with least alpha-numeric characters is better.
5701 * - Match with least total characters is better.
5702 * - Match towards the start is better.
5703 * - Match starting with "+" is worse (feature instead of command)
5704 * Assumption is made that the matched_string passed has already been found to
5705 * match some string for which help is requested. webb.
5706 */
5707 int
5708help_heuristic(matched_string, offset, wrong_case)
5709 char_u *matched_string;
5710 int offset; /* offset for match */
5711 int wrong_case; /* no matching case */
5712{
5713 int num_letters;
5714 char_u *p;
5715
5716 num_letters = 0;
5717 for (p = matched_string; *p; p++)
5718 if (ASCII_ISALNUM(*p))
5719 num_letters++;
5720
5721 /*
5722 * Multiply the number of letters by 100 to give it a much bigger
5723 * weighting than the number of characters.
5724 * If there only is a match while ignoring case, add 5000.
5725 * If the match starts in the middle of a word, add 10000 to put it
5726 * somewhere in the last half.
5727 * If the match is more than 2 chars from the start, multiply by 200 to
5728 * put it after matches at the start.
5729 */
5730 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5731 && ASCII_ISALNUM(matched_string[offset - 1]))
5732 offset += 10000;
5733 else if (offset > 2)
5734 offset *= 200;
5735 if (wrong_case)
5736 offset += 5000;
5737 /* Features are less interesting than the subjects themselves, but "+"
5738 * alone is not a feature. */
5739 if (matched_string[0] == '+' && matched_string[1] != NUL)
5740 offset += 100;
5741 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5742}
5743
5744/*
5745 * Compare functions for qsort() below, that checks the help heuristics number
5746 * that has been put after the tagname by find_tags().
5747 */
5748 static int
5749#ifdef __BORLANDC__
5750_RTLENTRYF
5751#endif
5752help_compare(s1, s2)
5753 const void *s1;
5754 const void *s2;
5755{
5756 char *p1;
5757 char *p2;
5758
5759 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5760 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5761 return strcmp(p1, p2);
5762}
5763
5764/*
5765 * Find all help tags matching "arg", sort them and return in matches[], with
5766 * the number of matches in num_matches.
5767 * The matches will be sorted with a "best" match algorithm.
5768 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5769 */
5770 int
5771find_help_tags(arg, num_matches, matches, keep_lang)
5772 char_u *arg;
5773 int *num_matches;
5774 char_u ***matches;
5775 int keep_lang;
5776{
5777 char_u *s, *d;
5778 int i;
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005779#ifdef S_SPLINT_S /* splint doesn't understand array of pointers */
5780 static char **mtable;
5781 static char **rtable;
5782#else
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005784 "/*", "/\\*", "\"*", "**",
5785 "/\\(\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005786 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005787 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 "[count]", "[quotex]", "[range]",
5789 "[pattern]", "\\|", "\\%$"};
5790 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
Bram Moolenaar231334e2005-07-25 20:46:57 +00005791 "/star", "/\\\\star", "quotestar", "starstar",
5792 "/\\\\(\\\\)",
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00005793 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
Bram Moolenaarf4630b62005-05-20 21:31:17 +00005794 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 "\\[count]", "\\[quotex]", "\\[range]",
5796 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005797#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 int flags;
5799
5800 d = IObuff; /* assume IObuff is long enough! */
5801
5802 /*
5803 * Recognize a few exceptions to the rule. Some strings that contain '*'
5804 * with "star". Otherwise '*' is recognized as a wildcard.
5805 */
Bram Moolenaar5fd0ca72009-05-13 16:56:33 +00005806 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 if (STRCMP(arg, mtable[i]) == 0)
5808 {
5809 STRCPY(d, rtable[i]);
5810 break;
5811 }
5812
5813 if (i < 0) /* no match in table */
5814 {
5815 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5816 * Also replace "\%^" and "\%(", they match every tag too.
5817 * Also "\zs", "\z1", etc.
5818 * Also "\@<", "\@=", "\@<=", etc.
5819 * And also "\_$" and "\_^". */
5820 if (arg[0] == '\\'
5821 && ((arg[1] != NUL && arg[2] == NUL)
5822 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5823 && arg[2] != NUL)))
5824 {
5825 STRCPY(d, "/\\\\");
5826 STRCPY(d + 3, arg + 1);
5827 /* Check for "/\\_$", should be "/\\_\$" */
5828 if (d[3] == '_' && d[4] == '$')
5829 STRCPY(d + 4, "\\$");
5830 }
5831 else
5832 {
5833 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5834 if (arg[0] == '[' && (arg[1] == ':'
5835 || (arg[1] == '+' && arg[2] == '+')))
5836 *d++ = '\\';
5837
5838 for (s = arg; *s; ++s)
5839 {
5840 /*
5841 * Replace "|" with "bar" and '"' with "quote" to match the name of
5842 * the tags for these commands.
5843 * Replace "*" with ".*" and "?" with "." to match command line
5844 * completion.
5845 * Insert a backslash before '~', '$' and '.' to avoid their
5846 * special meaning.
5847 */
5848 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5849 break;
5850 switch (*s)
5851 {
5852 case '|': STRCPY(d, "bar");
5853 d += 3;
5854 continue;
5855 case '"': STRCPY(d, "quote");
5856 d += 5;
5857 continue;
5858 case '*': *d++ = '.';
5859 break;
5860 case '?': *d++ = '.';
5861 continue;
5862 case '$':
5863 case '.':
5864 case '~': *d++ = '\\';
5865 break;
5866 }
5867
5868 /*
5869 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5870 * ":help i_^_CTRL-D" work.
5871 * Insert '-' before and after "CTRL-X" when applicable.
5872 */
5873 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5874 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5875 {
5876 if (d > IObuff && d[-1] != '_')
5877 *d++ = '_'; /* prepend a '_' */
5878 STRCPY(d, "CTRL-");
5879 d += 5;
5880 if (*s < ' ')
5881 {
5882#ifdef EBCDIC
5883 *d++ = CtrlChar(*s);
5884#else
5885 *d++ = *s + '@';
5886#endif
5887 if (d[-1] == '\\')
5888 *d++ = '\\'; /* double a backslash */
5889 }
5890 else
5891 *d++ = *++s;
5892 if (s[1] != NUL && s[1] != '_')
5893 *d++ = '_'; /* append a '_' */
5894 continue;
5895 }
5896 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5897 *d++ = '\\';
5898
5899 /*
5900 * Insert a backslash before a backslash after a slash, for search
5901 * pattern tags: "/\|" --> "/\\|".
5902 */
5903 else if (s[0] == '\\' && s[1] != '\\'
5904 && *arg == '/' && s == arg + 1)
5905 *d++ = '\\';
5906
5907 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5908 * "CTRL-\_CTRL-N" */
5909 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5910 {
5911 STRCPY(d, "CTRL-\\\\");
5912 d += 7;
5913 s += 6;
5914 }
5915
5916 *d++ = *s;
5917
5918 /*
5919 * If tag starts with ', toss everything after a second '. Fixes
5920 * CTRL-] on 'option'. (would include the trailing '.').
5921 */
5922 if (*s == '\'' && s > arg && *arg == '\'')
5923 break;
5924 }
5925 *d = NUL;
5926 }
5927 }
5928
5929 *matches = (char_u **)"";
5930 *num_matches = 0;
5931 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5932 if (keep_lang)
5933 flags |= TAG_KEEP_LANG;
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005934 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 && *num_matches > 0)
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005936 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 /* Sort the matches found on the heuristic number that is after the
5938 * tag name. */
5939 qsort((void *)*matches, (size_t)*num_matches,
5940 sizeof(char_u *), help_compare);
Bram Moolenaarc62e2fe2008-08-06 13:03:07 +00005941 /* Delete more than TAG_MANY to reduce the size of the listing. */
5942 while (*num_matches > TAG_MANY)
5943 vim_free((*matches)[--*num_matches]);
5944 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 return OK;
5946}
5947
5948/*
5949 * After reading a help file: May cleanup a help buffer when syntax
5950 * highlighting is not used.
5951 */
5952 void
5953fix_help_buffer()
5954{
5955 linenr_T lnum;
5956 char_u *line;
5957 int in_example = FALSE;
5958 int len;
5959 char_u *p;
5960 char_u *rt;
5961 int mustfree;
5962
5963 /* set filetype to "help". */
5964 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5965
5966#ifdef FEAT_SYN_HL
5967 if (!syntax_present(curbuf))
5968#endif
5969 {
5970 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5971 {
5972 line = ml_get_buf(curbuf, lnum, FALSE);
5973 len = (int)STRLEN(line);
5974 if (in_example && len > 0 && !vim_iswhite(line[0]))
5975 {
5976 /* End of example: non-white or '<' in first column. */
5977 if (line[0] == '<')
5978 {
5979 /* blank-out a '<' in the first column */
5980 line = ml_get_buf(curbuf, lnum, TRUE);
5981 line[0] = ' ';
5982 }
5983 in_example = FALSE;
5984 }
5985 if (!in_example && len > 0)
5986 {
5987 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5988 {
5989 /* blank-out a '>' in the last column (start of example) */
5990 line = ml_get_buf(curbuf, lnum, TRUE);
5991 line[len - 1] = ' ';
5992 in_example = TRUE;
5993 }
5994 else if (line[len - 1] == '~')
5995 {
5996 /* blank-out a '~' at the end of line (header marker) */
5997 line = ml_get_buf(curbuf, lnum, TRUE);
5998 line[len - 1] = ' ';
5999 }
6000 }
6001 }
6002 }
6003
6004 /*
6005 * In the "help.txt" file, add the locally added help files.
6006 * This uses the very first line in the help file.
6007 */
6008 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
6009 {
6010 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6011 {
6012 line = ml_get_buf(curbuf, lnum, FALSE);
6013 if (strstr((char *)line, "*local-additions*") != NULL)
6014 {
6015 /* Go through all directories in 'runtimepath', skipping
6016 * $VIMRUNTIME. */
6017 p = p_rtp;
6018 while (*p != NUL)
6019 {
6020 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6021 mustfree = FALSE;
6022 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6023 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
6024 {
6025 int fcount;
6026 char_u **fnames;
6027 FILE *fd;
6028 char_u *s;
6029 int fi;
6030#ifdef FEAT_MBYTE
6031 vimconv_T vc;
6032 char_u *cp;
6033#endif
6034
6035 /* Find all "doc/ *.txt" files in this directory. */
6036 add_pathsep(NameBuff);
6037 STRCAT(NameBuff, "doc/*.txt");
6038 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6039 &fnames, EW_FILE|EW_SILENT) == OK
6040 && fcount > 0)
6041 {
6042 for (fi = 0; fi < fcount; ++fi)
6043 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006044 fd = mch_fopen((char *)fnames[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 if (fd != NULL)
6046 {
6047 vim_fgets(IObuff, IOSIZE, fd);
6048 if (IObuff[0] == '*'
6049 && (s = vim_strchr(IObuff + 1, '*'))
6050 != NULL)
6051 {
6052#ifdef FEAT_MBYTE
6053 int this_utf = MAYBE;
6054#endif
6055 /* Change tag definition to a
6056 * reference and remove <CR>/<NL>. */
6057 IObuff[0] = '|';
6058 *s = '|';
6059 while (*s != NUL)
6060 {
6061 if (*s == '\r' || *s == '\n')
6062 *s = NUL;
6063#ifdef FEAT_MBYTE
6064 /* The text is utf-8 when a byte
6065 * above 127 is found and no
6066 * illegal byte sequence is found.
6067 */
6068 if (*s >= 0x80 && this_utf != FALSE)
6069 {
6070 int l;
6071
6072 this_utf = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006073 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 if (l == 1)
6075 this_utf = FALSE;
6076 s += l - 1;
6077 }
6078#endif
6079 ++s;
6080 }
6081#ifdef FEAT_MBYTE
6082 /* The help file is latin1 or utf-8;
6083 * conversion to the current
6084 * 'encoding' may be required. */
6085 vc.vc_type = CONV_NONE;
6086 convert_setup(&vc, (char_u *)(
6087 this_utf == TRUE ? "utf-8"
6088 : "latin1"), p_enc);
6089 if (vc.vc_type == CONV_NONE)
6090 /* No conversion needed. */
6091 cp = IObuff;
6092 else
6093 {
6094 /* Do the conversion. If it fails
6095 * use the unconverted text. */
6096 cp = string_convert(&vc, IObuff,
6097 NULL);
6098 if (cp == NULL)
6099 cp = IObuff;
6100 }
6101 convert_setup(&vc, NULL, NULL);
6102
6103 ml_append(lnum, cp, (colnr_T)0, FALSE);
6104 if (cp != IObuff)
6105 vim_free(cp);
6106#else
6107 ml_append(lnum, IObuff, (colnr_T)0,
6108 FALSE);
6109#endif
6110 ++lnum;
6111 }
6112 fclose(fd);
6113 }
6114 }
6115 FreeWild(fcount, fnames);
6116 }
6117 }
6118 if (mustfree)
6119 vim_free(rt);
6120 }
6121 break;
6122 }
6123 }
6124 }
6125}
6126
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006127/*
6128 * ":exusage"
6129 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006130 void
6131ex_exusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006132 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006133{
6134 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6135}
6136
6137/*
6138 * ":viusage"
6139 */
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006140 void
6141ex_viusage(eap)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00006142 exarg_T *eap UNUSED;
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006143{
6144 do_cmdline_cmd((char_u *)"help normal-index");
6145}
6146
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147#if defined(FEAT_EX_EXTRA) || defined(PROTO)
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006148static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149
6150/*
6151 * ":helptags"
6152 */
6153 void
6154ex_helptags(eap)
6155 exarg_T *eap;
6156{
6157 garray_T ga;
6158 int i, j;
6159 int len;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006160#ifdef FEAT_MULTI_LANG
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 char_u lang[2];
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00006162#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006163 expand_T xpc;
6164 char_u *dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 char_u ext[5];
6166 char_u fname[8];
6167 int filecount;
6168 char_u **files;
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006169 int add_help_tags = FALSE;
6170
6171 /* Check for ":helptags ++t {dir}". */
6172 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6173 {
6174 add_help_tags = TRUE;
6175 eap->arg = skipwhite(eap->arg + 3);
6176 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177
Bram Moolenaar0e253142008-01-13 12:31:34 +00006178 ExpandInit(&xpc);
6179 xpc.xp_context = EXPAND_DIRECTORIES;
6180 dirname = ExpandOne(&xpc, eap->arg, NULL,
6181 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6182 if (dirname == NULL || !mch_isdir(dirname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 {
6184 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6185 return;
6186 }
6187
6188#ifdef FEAT_MULTI_LANG
6189 /* Get a list of all files in the directory. */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006190 STRCPY(NameBuff, dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 add_pathsep(NameBuff);
6192 STRCAT(NameBuff, "*");
6193 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6194 EW_FILE|EW_SILENT) == FAIL
6195 || filecount == 0)
6196 {
6197 EMSG2("E151: No match: %s", NameBuff);
Bram Moolenaar0e253142008-01-13 12:31:34 +00006198 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 return;
6200 }
6201
6202 /* Go over all files in the directory to find out what languages are
6203 * present. */
6204 ga_init2(&ga, 1, 10);
6205 for (i = 0; i < filecount; ++i)
6206 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006207 len = (int)STRLEN(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 if (len > 4)
6209 {
6210 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6211 {
6212 /* ".txt" -> language "en" */
6213 lang[0] = 'e';
6214 lang[1] = 'n';
6215 }
6216 else if (files[i][len - 4] == '.'
6217 && ASCII_ISALPHA(files[i][len - 3])
6218 && ASCII_ISALPHA(files[i][len - 2])
6219 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6220 {
6221 /* ".abx" -> language "ab" */
6222 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6223 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6224 }
6225 else
6226 continue;
6227
6228 /* Did we find this language already? */
6229 for (j = 0; j < ga.ga_len; j += 2)
6230 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6231 break;
6232 if (j == ga.ga_len)
6233 {
6234 /* New language, add it. */
6235 if (ga_grow(&ga, 2) == FAIL)
6236 break;
6237 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6238 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 }
6240 }
6241 }
6242
6243 /*
6244 * Loop over the found languages to generate a tags file for each one.
6245 */
6246 for (j = 0; j < ga.ga_len; j += 2)
6247 {
6248 STRCPY(fname, "tags-xx");
6249 fname[5] = ((char_u *)ga.ga_data)[j];
6250 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6251 if (fname[5] == 'e' && fname[6] == 'n')
6252 {
6253 /* English is an exception: use ".txt" and "tags". */
6254 fname[4] = NUL;
6255 STRCPY(ext, ".txt");
6256 }
6257 else
6258 {
6259 /* Language "ab" uses ".abx" and "tags-ab". */
6260 STRCPY(ext, ".xxx");
6261 ext[1] = fname[5];
6262 ext[2] = fname[6];
6263 }
Bram Moolenaar0e253142008-01-13 12:31:34 +00006264 helptags_one(dirname, ext, fname, add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 }
6266
6267 ga_clear(&ga);
6268 FreeWild(filecount, files);
6269
6270#else
6271 /* No language support, just use "*.txt" and "tags". */
Bram Moolenaar0e253142008-01-13 12:31:34 +00006272 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273#endif
Bram Moolenaar0e253142008-01-13 12:31:34 +00006274 vim_free(dirname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275}
6276
6277 static void
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006278helptags_one(dir, ext, tagfname, add_help_tags)
6279 char_u *dir; /* doc directory */
6280 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6281 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6282 int add_help_tags; /* add "help-tags" tag */
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283{
6284 FILE *fd_tags;
6285 FILE *fd;
6286 garray_T ga;
6287 int filecount;
6288 char_u **files;
6289 char_u *p1, *p2;
6290 int fi;
6291 char_u *s;
6292 int i;
6293 char_u *fname;
6294# ifdef FEAT_MBYTE
6295 int utf8 = MAYBE;
6296 int this_utf8;
6297 int firstline;
6298 int mix = FALSE; /* detected mixed encodings */
6299# endif
6300
6301 /*
6302 * Find all *.txt files.
6303 */
6304 STRCPY(NameBuff, dir);
6305 add_pathsep(NameBuff);
6306 STRCAT(NameBuff, "*");
6307 STRCAT(NameBuff, ext);
6308 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6309 EW_FILE|EW_SILENT) == FAIL
6310 || filecount == 0)
6311 {
6312 if (!got_int)
6313 EMSG2("E151: No match: %s", NameBuff);
6314 return;
6315 }
6316
6317 /*
6318 * Open the tags file for writing.
6319 * Do this before scanning through all the files.
6320 */
6321 STRCPY(NameBuff, dir);
6322 add_pathsep(NameBuff);
6323 STRCAT(NameBuff, tagfname);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006324 fd_tags = mch_fopen((char *)NameBuff, "w");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 if (fd_tags == NULL)
6326 {
6327 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6328 FreeWild(filecount, files);
6329 return;
6330 }
6331
6332 /*
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006333 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6334 * add the "help-tags" tag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 */
6336 ga_init2(&ga, (int)sizeof(char_u *), 100);
Bram Moolenaar426e5c92008-01-11 20:02:02 +00006337 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6338 dir, FALSE) == FPC_SAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 {
6340 if (ga_grow(&ga, 1) == FAIL)
6341 got_int = TRUE;
6342 else
6343 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006344 s = alloc(18 + (unsigned)STRLEN(tagfname));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 if (s == NULL)
6346 got_int = TRUE;
6347 else
6348 {
6349 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6350 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6351 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 }
6353 }
6354 }
6355
6356 /*
6357 * Go over all the files and extract the tags.
6358 */
6359 for (fi = 0; fi < filecount && !got_int; ++fi)
6360 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00006361 fd = mch_fopen((char *)files[fi], "r");
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 if (fd == NULL)
6363 {
6364 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6365 continue;
6366 }
6367 fname = gettail(files[fi]);
6368
6369# ifdef FEAT_MBYTE
6370 firstline = TRUE;
6371# endif
6372 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6373 {
6374# ifdef FEAT_MBYTE
6375 if (firstline)
6376 {
6377 /* Detect utf-8 file by a non-ASCII char in the first line. */
6378 this_utf8 = MAYBE;
6379 for (s = IObuff; *s != NUL; ++s)
6380 if (*s >= 0x80)
6381 {
6382 int l;
6383
6384 this_utf8 = TRUE;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006385 l = utf_ptr2len(s);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 if (l == 1)
6387 {
6388 /* Illegal UTF-8 byte sequence. */
6389 this_utf8 = FALSE;
6390 break;
6391 }
6392 s += l - 1;
6393 }
6394 if (this_utf8 == MAYBE) /* only ASCII characters found */
6395 this_utf8 = FALSE;
6396 if (utf8 == MAYBE) /* first file */
6397 utf8 = this_utf8;
6398 else if (utf8 != this_utf8)
6399 {
6400 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6401 mix = !got_int;
6402 got_int = TRUE;
6403 }
6404 firstline = FALSE;
6405 }
6406# endif
6407 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6408 while (p1 != NULL)
6409 {
6410 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6411 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6412 {
6413 for (s = p1 + 1; s < p2; ++s)
6414 if (*s == ' ' || *s == '\t' || *s == '|')
6415 break;
6416
6417 /*
6418 * Only accept a *tag* when it consists of valid
6419 * characters, there is white space before it and is
6420 * followed by a white character or end-of-line.
6421 */
6422 if (s == p2
6423 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6424 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6425 || s[1] == '\0'))
6426 {
6427 *p2 = '\0';
6428 ++p1;
6429 if (ga_grow(&ga, 1) == FAIL)
6430 {
6431 got_int = TRUE;
6432 break;
6433 }
6434 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6435 if (s == NULL)
6436 {
6437 got_int = TRUE;
6438 break;
6439 }
6440 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6441 ++ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 sprintf((char *)s, "%s\t%s", p1, fname);
6443
6444 /* find next '*' */
6445 p2 = vim_strchr(p2 + 1, '*');
6446 }
6447 }
6448 p1 = p2;
6449 }
6450 line_breakcheck();
6451 }
6452
6453 fclose(fd);
6454 }
6455
6456 FreeWild(filecount, files);
6457
6458 if (!got_int)
6459 {
6460 /*
6461 * Sort the tags.
6462 */
6463 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6464
6465 /*
6466 * Check for duplicates.
6467 */
6468 for (i = 1; i < ga.ga_len; ++i)
6469 {
6470 p1 = ((char_u **)ga.ga_data)[i - 1];
6471 p2 = ((char_u **)ga.ga_data)[i];
6472 while (*p1 == *p2)
6473 {
6474 if (*p2 == '\t')
6475 {
6476 *p2 = NUL;
Bram Moolenaar555b2802005-05-19 21:08:39 +00006477 vim_snprintf((char *)NameBuff, MAXPATHL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6479 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6480 EMSG(NameBuff);
6481 *p2 = '\t';
6482 break;
6483 }
6484 ++p1;
6485 ++p2;
6486 }
6487 }
6488
6489# ifdef FEAT_MBYTE
6490 if (utf8 == TRUE)
6491 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6492# endif
6493
6494 /*
6495 * Write the tags into the file.
6496 */
6497 for (i = 0; i < ga.ga_len; ++i)
6498 {
6499 s = ((char_u **)ga.ga_data)[i];
Bram Moolenaarf6210482007-07-25 20:56:39 +00006500 if (STRNCMP(s, "help-tags\t", 10) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 /* help-tags entry was added in formatted form */
Bram Moolenaarf6210482007-07-25 20:56:39 +00006502 fputs((char *)s, fd_tags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 else
6504 {
6505 fprintf(fd_tags, "%s\t/*", s);
6506 for (p1 = s; *p1 != '\t'; ++p1)
6507 {
6508 /* insert backslash before '\\' and '/' */
6509 if (*p1 == '\\' || *p1 == '/')
6510 putc('\\', fd_tags);
6511 putc(*p1, fd_tags);
6512 }
6513 fprintf(fd_tags, "*\n");
6514 }
6515 }
6516 }
6517#ifdef FEAT_MBYTE
6518 if (mix)
6519 got_int = FALSE; /* continue with other languages */
6520#endif
6521
6522 for (i = 0; i < ga.ga_len; ++i)
6523 vim_free(((char_u **)ga.ga_data)[i]);
6524 ga_clear(&ga);
6525 fclose(fd_tags); /* there is no check for an error... */
6526}
6527#endif
6528
6529#if defined(FEAT_SIGNS) || defined(PROTO)
6530
6531/*
6532 * Struct to hold the sign properties.
6533 */
6534typedef struct sign sign_T;
6535
6536struct sign
6537{
6538 sign_T *sn_next; /* next sign in list */
6539 int sn_typenr; /* type number of sign (negative if not equal
6540 to name) */
6541 char_u *sn_name; /* name of sign */
6542 char_u *sn_icon; /* name of pixmap */
6543#ifdef FEAT_SIGN_ICONS
6544 void *sn_image; /* icon image */
6545#endif
6546 char_u *sn_text; /* text used instead of pixmap */
6547 int sn_line_hl; /* highlight ID for line */
6548 int sn_text_hl; /* highlight ID for text */
6549};
6550
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551static sign_T *first_sign = NULL;
6552static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6553
Bram Moolenaar985cb442009-05-14 19:51:46 +00006554static int sign_cmd_idx __ARGS((char_u *begin_cmd, char_u *end_cmd));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555static void sign_list_defined __ARGS((sign_T *sp));
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006556static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006558static char *cmds[] = {
6559 "define",
6560#define SIGNCMD_DEFINE 0
6561 "undefine",
6562#define SIGNCMD_UNDEFINE 1
6563 "list",
6564#define SIGNCMD_LIST 2
6565 "place",
6566#define SIGNCMD_PLACE 3
6567 "unplace",
6568#define SIGNCMD_UNPLACE 4
6569 "jump",
6570#define SIGNCMD_JUMP 5
6571 NULL
6572#define SIGNCMD_LAST 6
6573};
6574
6575/*
6576 * Find index of a ":sign" subcmd from its name.
6577 * "*end_cmd" must be writable.
6578 */
6579 static int
6580sign_cmd_idx(begin_cmd, end_cmd)
Bram Moolenaar985cb442009-05-14 19:51:46 +00006581 char_u *begin_cmd; /* begin of sign subcmd */
6582 char_u *end_cmd; /* just after sign subcmd */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006583{
6584 int idx;
6585 char save = *end_cmd;
6586
6587 *end_cmd = NUL;
6588 for (idx = 0; ; ++idx)
6589 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6590 break;
6591 *end_cmd = save;
6592 return idx;
6593}
6594
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595/*
6596 * ":sign" command
6597 */
6598 void
6599ex_sign(eap)
6600 exarg_T *eap;
6601{
6602 char_u *arg = eap->arg;
6603 char_u *p;
6604 int idx;
6605 sign_T *sp;
6606 sign_T *sp_prev;
6607 buf_T *buf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608
6609 /* Parse the subcommand. */
6610 p = skiptowhite(arg);
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006611 idx = sign_cmd_idx(arg, p);
6612 if (idx == SIGNCMD_LAST)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 {
Bram Moolenaar3c65e312009-04-29 16:47:23 +00006614 EMSG2(_("E160: Unknown sign command: %s"), arg);
6615 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 }
6617 arg = skipwhite(p);
6618
6619 if (idx <= SIGNCMD_LIST)
6620 {
6621 /*
6622 * Define, undefine or list signs.
6623 */
6624 if (idx == SIGNCMD_LIST && *arg == NUL)
6625 {
6626 /* ":sign list": list all defined signs */
6627 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6628 sign_list_defined(sp);
6629 }
6630 else if (*arg == NUL)
6631 EMSG(_("E156: Missing sign name"));
6632 else
6633 {
6634 p = skiptowhite(arg);
6635 if (*p != NUL)
6636 *p++ = NUL;
6637 sp_prev = NULL;
6638 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6639 {
6640 if (STRCMP(sp->sn_name, arg) == 0)
6641 break;
6642 sp_prev = sp;
6643 }
6644 if (idx == SIGNCMD_DEFINE)
6645 {
6646 /* ":sign define {name} ...": define a sign */
6647 if (sp == NULL)
6648 {
6649 /* Allocate a new sign. */
6650 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6651 if (sp == NULL)
6652 return;
6653 if (sp_prev == NULL)
6654 first_sign = sp;
6655 else
6656 sp_prev->sn_next = sp;
6657 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6658
6659 /* If the name is a number use that for the typenr,
6660 * otherwise use a negative number. */
6661 if (VIM_ISDIGIT(*arg))
6662 sp->sn_typenr = atoi((char *)arg);
6663 else
6664 {
6665 sign_T *lp;
6666 int start = last_sign_typenr;
6667
6668 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6669 {
6670 if (lp->sn_typenr == last_sign_typenr)
6671 {
6672 --last_sign_typenr;
6673 if (last_sign_typenr == 0)
6674 last_sign_typenr = MAX_TYPENR;
6675 if (last_sign_typenr == start)
6676 {
6677 EMSG(_("E612: Too many signs defined"));
6678 return;
6679 }
6680 lp = first_sign;
6681 continue;
6682 }
6683 }
6684
6685 sp->sn_typenr = last_sign_typenr--;
6686 if (last_sign_typenr == 0)
6687 last_sign_typenr = MAX_TYPENR; /* wrap around */
6688 }
6689 }
6690
6691 /* set values for a defined sign. */
6692 for (;;)
6693 {
6694 arg = skipwhite(p);
6695 if (*arg == NUL)
6696 break;
6697 p = skiptowhite_esc(arg);
6698 if (STRNCMP(arg, "icon=", 5) == 0)
6699 {
6700 arg += 5;
6701 vim_free(sp->sn_icon);
6702 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6703 backslash_halve(sp->sn_icon);
6704#ifdef FEAT_SIGN_ICONS
6705 if (gui.in_use)
6706 {
6707 out_flush();
6708 if (sp->sn_image != NULL)
6709 gui_mch_destroy_sign(sp->sn_image);
6710 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6711 }
6712#endif
6713 }
6714 else if (STRNCMP(arg, "text=", 5) == 0)
6715 {
6716 char_u *s;
6717 int cells;
6718 int len;
6719
6720 arg += 5;
6721#ifdef FEAT_MBYTE
6722 /* Count cells and check for non-printable chars */
6723 if (has_mbyte)
6724 {
6725 cells = 0;
Bram Moolenaar0fa313a2005-08-10 21:07:57 +00006726 for (s = arg; s < p; s += (*mb_ptr2len)(s))
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 {
6728 if (!vim_isprintc((*mb_ptr2char)(s)))
6729 break;
6730 cells += (*mb_ptr2cells)(s);
6731 }
6732 }
6733 else
6734#endif
6735 {
6736 for (s = arg; s < p; ++s)
6737 if (!vim_isprintc(*s))
6738 break;
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006739 cells = (int)(s - arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 }
6741 /* Currently must be one or two display cells */
6742 if (s != p || cells < 1 || cells > 2)
6743 {
6744 *p = NUL;
6745 EMSG2(_("E239: Invalid sign text: %s"), arg);
6746 return;
6747 }
6748
6749 vim_free(sp->sn_text);
6750 /* Allocate one byte more if we need to pad up
6751 * with a space. */
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00006752 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 sp->sn_text = vim_strnsave(arg, len);
6754
6755 if (sp->sn_text != NULL && cells == 1)
6756 STRCPY(sp->sn_text + len - 1, " ");
6757 }
6758 else if (STRNCMP(arg, "linehl=", 7) == 0)
6759 {
6760 arg += 7;
6761 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6762 }
6763 else if (STRNCMP(arg, "texthl=", 7) == 0)
6764 {
6765 arg += 7;
6766 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6767 }
6768 else
6769 {
6770 EMSG2(_(e_invarg2), arg);
6771 return;
6772 }
6773 }
6774 }
6775 else if (sp == NULL)
6776 EMSG2(_("E155: Unknown sign: %s"), arg);
6777 else if (idx == SIGNCMD_LIST)
6778 /* ":sign list {name}" */
6779 sign_list_defined(sp);
6780 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 /* ":sign undefine {name}" */
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00006782 sign_undefine(sp, sp_prev);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 }
6784 }
6785 else
6786 {
6787 int id = -1;
6788 linenr_T lnum = -1;
6789 char_u *sign_name = NULL;
6790 char_u *arg1;
6791
6792 if (*arg == NUL)
6793 {
6794 if (idx == SIGNCMD_PLACE)
6795 {
6796 /* ":sign place": list placed signs in all buffers */
6797 sign_list_placed(NULL);
6798 }
6799 else if (idx == SIGNCMD_UNPLACE)
6800 {
6801 /* ":sign unplace": remove placed sign at cursor */
6802 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6803 if (id > 0)
6804 {
6805 buf_delsign(curwin->w_buffer, id);
6806 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6807 }
6808 else
6809 EMSG(_("E159: Missing sign number"));
6810 }
6811 else
6812 EMSG(_(e_argreq));
6813 return;
6814 }
6815
6816 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6817 {
6818 /* ":sign unplace *": remove all placed signs */
6819 buf_delete_all_signs();
6820 return;
6821 }
6822
6823 /* first arg could be placed sign id */
6824 arg1 = arg;
6825 if (VIM_ISDIGIT(*arg))
6826 {
6827 id = getdigits(&arg);
6828 if (!vim_iswhite(*arg) && *arg != NUL)
6829 {
6830 id = -1;
6831 arg = arg1;
6832 }
6833 else
6834 {
6835 arg = skipwhite(arg);
6836 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6837 {
6838 /* ":sign unplace {id}": remove placed sign by number */
6839 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6840 if ((lnum = buf_delsign(buf, id)) != 0)
6841 update_debug_sign(buf, lnum);
6842 return;
6843 }
6844 }
6845 }
6846
6847 /*
6848 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6849 * Leave "arg" pointing to {fname}.
6850 */
6851 for (;;)
6852 {
6853 if (STRNCMP(arg, "line=", 5) == 0)
6854 {
6855 arg += 5;
6856 lnum = atoi((char *)arg);
6857 arg = skiptowhite(arg);
6858 }
6859 else if (STRNCMP(arg, "name=", 5) == 0)
6860 {
6861 arg += 5;
6862 sign_name = arg;
6863 arg = skiptowhite(arg);
6864 if (*arg != NUL)
6865 *arg++ = NUL;
6866 }
6867 else if (STRNCMP(arg, "file=", 5) == 0)
6868 {
6869 arg += 5;
6870 buf = buflist_findname(arg);
6871 break;
6872 }
6873 else if (STRNCMP(arg, "buffer=", 7) == 0)
6874 {
6875 arg += 7;
6876 buf = buflist_findnr((int)getdigits(&arg));
6877 if (*skipwhite(arg) != NUL)
6878 EMSG(_(e_trailing));
6879 break;
6880 }
6881 else
6882 {
6883 EMSG(_(e_invarg));
6884 return;
6885 }
6886 arg = skipwhite(arg);
6887 }
6888
6889 if (buf == NULL)
6890 {
6891 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6892 }
6893 else if (id <= 0)
6894 {
6895 if (lnum >= 0 || sign_name != NULL)
6896 EMSG(_(e_invarg));
6897 else
6898 /* ":sign place file={fname}": list placed signs in one file */
6899 sign_list_placed(buf);
6900 }
6901 else if (idx == SIGNCMD_JUMP)
6902 {
6903 /* ":sign jump {id} file={fname}" */
6904 if (lnum >= 0 || sign_name != NULL)
6905 EMSG(_(e_invarg));
6906 else if ((lnum = buf_findsign(buf, id)) > 0)
6907 { /* goto a sign ... */
6908 if (buf_jump_open_win(buf) != NULL)
6909 { /* ... in a current window */
6910 curwin->w_cursor.lnum = lnum;
6911 check_cursor_lnum();
6912 beginline(BL_WHITE);
6913 }
6914 else
6915 { /* ... not currently in a window */
6916 char_u *cmd;
6917
6918 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6919 if (cmd == NULL)
6920 return;
6921 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6922 do_cmdline_cmd(cmd);
6923 vim_free(cmd);
6924 }
6925#ifdef FEAT_FOLDING
6926 foldOpenCursor();
6927#endif
6928 }
6929 else
6930 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6931 }
6932 else if (idx == SIGNCMD_UNPLACE)
6933 {
6934 /* ":sign unplace {id} file={fname}" */
6935 if (lnum >= 0 || sign_name != NULL)
6936 EMSG(_(e_invarg));
6937 else
6938 {
6939 lnum = buf_delsign(buf, id);
6940 update_debug_sign(buf, lnum);
6941 }
6942 }
6943 /* idx == SIGNCMD_PLACE */
6944 else if (sign_name != NULL)
6945 {
6946 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6947 if (STRCMP(sp->sn_name, sign_name) == 0)
6948 break;
6949 if (sp == NULL)
6950 {
6951 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6952 return;
6953 }
6954 if (lnum > 0)
6955 /* ":sign place {id} line={lnum} name={name} file={fname}":
6956 * place a sign */
6957 buf_addsign(buf, id, lnum, sp->sn_typenr);
6958 else
6959 /* ":sign place {id} file={fname}": change sign type */
6960 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6961 update_debug_sign(buf, lnum);
6962 }
6963 else
6964 EMSG(_(e_invarg));
6965 }
6966}
6967
6968#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6969/*
6970 * Allocate the icons. Called when the GUI has started. Allows defining
6971 * signs before it starts.
6972 */
6973 void
6974sign_gui_started()
6975{
6976 sign_T *sp;
6977
6978 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6979 if (sp->sn_icon != NULL)
6980 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6981}
6982#endif
6983
6984/*
6985 * List one sign.
6986 */
6987 static void
6988sign_list_defined(sp)
6989 sign_T *sp;
6990{
6991 char_u *p;
6992
Bram Moolenaar555b2802005-05-19 21:08:39 +00006993 smsg((char_u *)"sign %s", sp->sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 if (sp->sn_icon != NULL)
6995 {
6996 MSG_PUTS(" icon=");
6997 msg_outtrans(sp->sn_icon);
6998#ifdef FEAT_SIGN_ICONS
6999 if (sp->sn_image == NULL)
7000 MSG_PUTS(_(" (NOT FOUND)"));
7001#else
7002 MSG_PUTS(_(" (not supported)"));
7003#endif
7004 }
7005 if (sp->sn_text != NULL)
7006 {
7007 MSG_PUTS(" text=");
7008 msg_outtrans(sp->sn_text);
7009 }
7010 if (sp->sn_line_hl > 0)
7011 {
7012 MSG_PUTS(" linehl=");
7013 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7014 if (p == NULL)
7015 MSG_PUTS("NONE");
7016 else
7017 msg_puts(p);
7018 }
7019 if (sp->sn_text_hl > 0)
7020 {
7021 MSG_PUTS(" texthl=");
7022 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7023 if (p == NULL)
7024 MSG_PUTS("NONE");
7025 else
7026 msg_puts(p);
7027 }
7028}
7029
7030/*
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007031 * Undefine a sign and free its memory.
7032 */
7033 static void
7034sign_undefine(sp, sp_prev)
7035 sign_T *sp;
7036 sign_T *sp_prev;
7037{
7038 vim_free(sp->sn_name);
7039 vim_free(sp->sn_icon);
7040#ifdef FEAT_SIGN_ICONS
7041 if (sp->sn_image != NULL)
7042 {
7043 out_flush();
7044 gui_mch_destroy_sign(sp->sn_image);
7045 }
7046#endif
7047 vim_free(sp->sn_text);
7048 if (sp_prev == NULL)
7049 first_sign = sp->sn_next;
7050 else
7051 sp_prev->sn_next = sp->sn_next;
7052 vim_free(sp);
7053}
7054
7055/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 * Get highlighting attribute for sign "typenr".
7057 * If "line" is TRUE: line highl, if FALSE: text highl.
7058 */
7059 int
7060sign_get_attr(typenr, line)
7061 int typenr;
7062 int line;
7063{
7064 sign_T *sp;
7065
7066 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7067 if (sp->sn_typenr == typenr)
7068 {
7069 if (line)
7070 {
7071 if (sp->sn_line_hl > 0)
7072 return syn_id2attr(sp->sn_line_hl);
7073 }
7074 else
7075 {
7076 if (sp->sn_text_hl > 0)
7077 return syn_id2attr(sp->sn_text_hl);
7078 }
7079 break;
7080 }
7081 return 0;
7082}
7083
7084/*
7085 * Get text mark for sign "typenr".
7086 * Returns NULL if there isn't one.
7087 */
7088 char_u *
7089sign_get_text(typenr)
7090 int typenr;
7091{
7092 sign_T *sp;
7093
7094 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7095 if (sp->sn_typenr == typenr)
7096 return sp->sn_text;
7097 return NULL;
7098}
7099
7100#if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7101 void *
7102sign_get_image(typenr)
7103 int typenr; /* the attribute which may have a sign */
7104{
7105 sign_T *sp;
7106
7107 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7108 if (sp->sn_typenr == typenr)
7109 return sp->sn_image;
7110 return NULL;
7111}
7112#endif
7113
7114/*
7115 * Get the name of a sign by its typenr.
7116 */
7117 char_u *
7118sign_typenr2name(typenr)
7119 int typenr;
7120{
7121 sign_T *sp;
7122
7123 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7124 if (sp->sn_typenr == typenr)
7125 return sp->sn_name;
7126 return (char_u *)_("[Deleted]");
7127}
7128
Bram Moolenaarde0dfed2009-02-24 03:30:14 +00007129#if defined(EXITFREE) || defined(PROTO)
7130/*
7131 * Undefine/free all signs.
7132 */
7133 void
7134free_signs()
7135{
7136 while (first_sign != NULL)
7137 sign_undefine(first_sign, NULL);
7138}
7139#endif
7140
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007141#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7142static enum
7143{
7144 EXP_SUBCMD, /* expand :sign sub-commands */
7145 EXP_DEFINE, /* expand :sign define {name} args */
7146 EXP_PLACE, /* expand :sign place {id} args */
7147 EXP_UNPLACE, /* expand :sign unplace" */
7148 EXP_SIGN_NAMES /* expand with name of placed signs */
7149} expand_what;
7150
7151/*
7152 * Function given to ExpandGeneric() to obtain the sign command
7153 * expansion.
7154 */
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007155 char_u *
7156get_sign_name(xp, idx)
Bram Moolenaar0c094b92009-05-14 20:20:33 +00007157 expand_T *xp UNUSED;
Bram Moolenaar3c65e312009-04-29 16:47:23 +00007158 int idx;
7159{
7160 sign_T *sp;
7161 int current_idx;
7162
7163 switch (expand_what)
7164 {
7165 case EXP_SUBCMD:
7166 return (char_u *)cmds[idx];
7167 case EXP_DEFINE:
7168 {
7169 char *define_arg[] =
7170 {
7171 "icon=", "linehl=", "text=", "texthl=", NULL
7172 };
7173 return (char_u *)define_arg[idx];
7174 }
7175 case EXP_PLACE:
7176 {
7177 char *place_arg[] =
7178 {
7179 "line=", "name=", "file=", "buffer=", NULL
7180 };
7181 return (char_u *)place_arg[idx];
7182 }
7183 case EXP_UNPLACE:
7184 {
7185 char *unplace_arg[] = { "file=", "buffer=", NULL };
7186 return (char_u *)unplace_arg[idx];
7187 }
7188 case EXP_SIGN_NAMES:
7189 /* Complete with name of signs already defined */
7190 current_idx = 0;
7191 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7192 if (current_idx++ == idx)
7193 return sp->sn_name;
7194 return NULL;
7195 default:
7196 return NULL;
7197 }
7198}
7199
7200/*
7201 * Handle command line completion for :sign command.
7202 */
7203 void
7204set_context_in_sign_cmd(xp, arg)
7205 expand_T *xp;
7206 char_u *arg;
7207{
7208 char_u *p;
7209 char_u *end_subcmd;
7210 char_u *last;
7211 int cmd_idx;
7212 char_u *begin_subcmd_args;
7213
7214 /* Default: expand subcommands. */
7215 xp->xp_context = EXPAND_SIGN;
7216 expand_what = EXP_SUBCMD;
7217 xp->xp_pattern = arg;
7218
7219 end_subcmd = skiptowhite(arg);
7220 if (*end_subcmd == NUL)
7221 /* expand subcmd name
7222 * :sign {subcmd}<CTRL-D>*/
7223 return;
7224
7225 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7226
7227 /* :sign {subcmd} {subcmd_args}
7228 * |
7229 * begin_subcmd_args */
7230 begin_subcmd_args = skipwhite(end_subcmd);
7231 p = skiptowhite(begin_subcmd_args);
7232 if (*p == NUL)
7233 {
7234 /*
7235 * Expand first argument of subcmd when possible.
7236 * For ":jump {id}" and ":unplace {id}", we could
7237 * possibly expand the ids of all signs already placed.
7238 */
7239 xp->xp_pattern = begin_subcmd_args;
7240 switch (cmd_idx)
7241 {
7242 case SIGNCMD_LIST:
7243 case SIGNCMD_UNDEFINE:
7244 /* :sign list <CTRL-D>
7245 * :sign undefine <CTRL-D> */
7246 expand_what = EXP_SIGN_NAMES;
7247 break;
7248 default:
7249 xp->xp_context = EXPAND_NOTHING;
7250 }
7251 return;
7252 }
7253
7254 /* expand last argument of subcmd */
7255
7256 /* :sign define {name} {args}...
7257 * |
7258 * p */
7259
7260 /* Loop until reaching last argument. */
7261 do
7262 {
7263 p = skipwhite(p);
7264 last = p;
7265 p = skiptowhite(p);
7266 } while (*p != NUL);
7267
7268 p = vim_strchr(last, '=');
7269
7270 /* :sign define {name} {args}... {last}=
7271 * | |
7272 * last p */
7273 if (p == NUL)
7274 {
7275 /* Expand last argument name (before equal sign). */
7276 xp->xp_pattern = last;
7277 switch (cmd_idx)
7278 {
7279 case SIGNCMD_DEFINE:
7280 expand_what = EXP_DEFINE;
7281 break;
7282 case SIGNCMD_PLACE:
7283 expand_what = EXP_PLACE;
7284 break;
7285 case SIGNCMD_JUMP:
7286 case SIGNCMD_UNPLACE:
7287 expand_what = EXP_UNPLACE;
7288 break;
7289 default:
7290 xp->xp_context = EXPAND_NOTHING;
7291 }
7292 }
7293 else
7294 {
7295 /* Expand last argument value (after equal sign). */
7296 xp->xp_pattern = p + 1;
7297 switch (cmd_idx)
7298 {
7299 case SIGNCMD_DEFINE:
7300 if (STRNCMP(last, "texthl", p - last) == 0 ||
7301 STRNCMP(last, "linehl", p - last) == 0)
7302 xp->xp_context = EXPAND_HIGHLIGHT;
7303 else if (STRNCMP(last, "icon", p - last) == 0)
7304 xp->xp_context = EXPAND_FILES;
7305 else
7306 xp->xp_context = EXPAND_NOTHING;
7307 break;
7308 case SIGNCMD_PLACE:
7309 if (STRNCMP(last, "name", p - last) == 0)
7310 expand_what = EXP_SIGN_NAMES;
7311 else
7312 xp->xp_context = EXPAND_NOTHING;
7313 break;
7314 default:
7315 xp->xp_context = EXPAND_NOTHING;
7316 }
7317 }
7318}
7319#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320#endif
7321
7322#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7323/*
7324 * ":drop"
7325 * Opens the first argument in a window. When there are two or more arguments
7326 * the argument list is redefined.
7327 */
7328 void
7329ex_drop(eap)
7330 exarg_T *eap;
7331{
7332 int split = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 win_T *wp;
7334 buf_T *buf;
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007335# ifdef FEAT_WINDOWS
7336 tabpage_T *tp;
7337# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338
7339 /*
7340 * Check if the first argument is already being edited in a window. If
7341 * so, jump to that window.
7342 * We would actually need to check all arguments, but that's complicated
7343 * and mostly only one file is dropped.
7344 * This also ignores wildcards, since it is very unlikely the user is
7345 * editing a file name with a wildcard character.
7346 */
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007347 set_arglist(eap->arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348
Bram Moolenaarb01a8b72007-02-13 02:47:22 +00007349 /*
7350 * Expanding wildcards may result in an empty argument list. E.g. when
7351 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7352 * already did an error message for this.
7353 */
7354 if (ARGCOUNT == 0)
7355 return;
7356
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007357# ifdef FEAT_WINDOWS
7358 if (cmdmod.tab)
7359 {
7360 /* ":tab drop file ...": open a tab for each argument that isn't
7361 * edited in a window yet. It's like ":tab all" but without closing
7362 * windows or tabs. */
7363 ex_all(eap);
7364 }
7365 else
7366# endif
7367 {
7368 /* ":drop file ...": Edit the first argument. Jump to an existing
7369 * window if possible, edit in current window if the current buffer
7370 * can be abandoned, otherwise open a new window. */
7371 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7372
7373 FOR_ALL_TAB_WINDOWS(tp, wp)
7374 {
7375 if (wp->w_buffer == buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 {
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007377# ifdef FEAT_WINDOWS
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007378 goto_tabpage_win(tp, wp);
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007379# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 curwin->w_arg_idx = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 return;
7382 }
7383 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007385 /*
7386 * Check whether the current buffer is changed. If so, we will need
7387 * to split the current window or data could be lost.
7388 * Skip the check if the 'hidden' option is set, as in this case the
7389 * buffer won't be lost.
7390 */
7391 if (!P_HID(curbuf))
7392 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007394 ++emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007396 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397# ifdef FEAT_WINDOWS
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007398 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399# else
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007400 if (split)
7401 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402# endif
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007403 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404
Bram Moolenaara5b6ad12006-03-11 21:36:59 +00007405 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7406 if (split)
7407 {
7408 eap->cmdidx = CMD_sfirst;
7409 eap->cmd[0] = 's';
7410 }
7411 else
7412 eap->cmdidx = CMD_first;
7413 ex_rewind(eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415}
7416#endif