Vim 7.2b ready for testing.
[MacVim/KaoriYa.git] / src / ex_cmds.c
blob760533d7a441115c20f8fafdbc20de57b3b2ea69
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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 */
11 * ex_cmds.c: some functions for command line commands
14 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for mch_open(), must be before vim.h */
16 #endif
18 #include "vim.h"
19 #include "version.h"
21 #ifdef FEAT_EX_EXTRA
22 static int linelen __ARGS((int *has_tab));
23 #endif
24 static 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
26 static char_u *viminfo_filename __ARGS((char_u *));
27 static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int want_info, int want_marks, int force_read));
28 static int viminfo_encoding __ARGS((vir_T *virp));
29 static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
30 #endif
32 static int check_overwrite __ARGS((exarg_T *eap, buf_T *buf, char_u *fname, char_u *ffname, int other));
33 static int check_readonly __ARGS((int *forceit, buf_T *buf));
34 #ifdef FEAT_AUTOCMD
35 static void delbuf_msg __ARGS((char_u *name));
36 #endif
37 static int
38 #ifdef __BORLANDC__
39 _RTLENTRYF
40 #endif
41 help_compare __ARGS((const void *s1, const void *s2));
44 * ":ascii" and "ga".
46 /*ARGSUSED*/
47 void
48 do_ascii(eap)
49 exarg_T *eap;
51 int c;
52 char buf1[20];
53 char buf2[20];
54 char_u buf3[7];
55 #ifdef FEAT_MBYTE
56 int cc[MAX_MCO];
57 int ci = 0;
58 int len;
60 if (enc_utf8)
61 c = utfc_ptr2char(ml_get_cursor(), cc);
62 else
63 #endif
64 c = gchar_cursor();
65 if (c == NUL)
67 MSG("NUL");
68 return;
71 #ifdef FEAT_MBYTE
72 IObuff[0] = NUL;
73 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
74 #endif
76 if (c == NL) /* NUL is stored as NL */
77 c = NUL;
78 if (vim_isprintc_strict(c) && (c < ' '
79 #ifndef EBCDIC
80 || c > '~'
81 #endif
84 transchar_nonprint(buf3, c);
85 sprintf(buf1, " <%s>", (char *)buf3);
87 else
88 buf1[0] = NUL;
89 #ifndef EBCDIC
90 if (c >= 0x80)
91 sprintf(buf2, " <M-%s>", transchar(c & 0x7f));
92 else
93 #endif
94 buf2[0] = NUL;
95 vim_snprintf((char *)IObuff, IOSIZE,
96 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
97 transchar(c), buf1, buf2, c, c, c);
98 #ifdef FEAT_MBYTE
99 if (enc_utf8)
100 c = cc[ci++];
101 else
102 c = 0;
103 #endif
106 #ifdef FEAT_MBYTE
107 /* Repeat for combining characters. */
108 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
110 len = (int)STRLEN(IObuff);
111 /* This assumes every multi-byte char is printable... */
112 if (len > 0)
113 IObuff[len++] = ' ';
114 IObuff[len++] = '<';
115 if (enc_utf8 && utf_iscomposing(c)
116 # ifdef USE_GUI
117 && !gui.in_use
118 # endif
120 IObuff[len++] = ' '; /* draw composing char on top of a space */
121 len += (*mb_char2bytes)(c, IObuff + len);
122 vim_snprintf((char *)IObuff + len, IOSIZE - len,
123 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
124 : _("> %d, Hex %08x, Octal %o"), c, c, c);
125 if (ci == MAX_MCO)
126 break;
127 if (enc_utf8)
128 c = cc[ci++];
129 else
130 c = 0;
132 #endif
134 msg(IObuff);
137 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
139 * ":left", ":center" and ":right": align text.
141 void
142 ex_align(eap)
143 exarg_T *eap;
145 pos_T save_curpos;
146 int len;
147 int indent = 0;
148 int new_indent;
149 int has_tab;
150 int width;
152 #ifdef FEAT_RIGHTLEFT
153 if (curwin->w_p_rl)
155 /* switch left and right aligning */
156 if (eap->cmdidx == CMD_right)
157 eap->cmdidx = CMD_left;
158 else if (eap->cmdidx == CMD_left)
159 eap->cmdidx = CMD_right;
161 #endif
163 width = atoi((char *)eap->arg);
164 save_curpos = curwin->w_cursor;
165 if (eap->cmdidx == CMD_left) /* width is used for new indent */
167 if (width >= 0)
168 indent = width;
170 else
173 * if 'textwidth' set, use it
174 * else if 'wrapmargin' set, use it
175 * if invalid value, use 80
177 if (width <= 0)
178 width = curbuf->b_p_tw;
179 if (width == 0 && curbuf->b_p_wm > 0)
180 width = W_WIDTH(curwin) - curbuf->b_p_wm;
181 if (width <= 0)
182 width = 80;
185 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
186 return;
188 for (curwin->w_cursor.lnum = eap->line1;
189 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
191 if (eap->cmdidx == CMD_left) /* left align */
192 new_indent = indent;
193 else
195 has_tab = FALSE; /* avoid uninit warnings */
196 len = linelen(eap->cmdidx == CMD_right ? &has_tab
197 : NULL) - get_indent();
199 if (len <= 0) /* skip blank lines */
200 continue;
202 if (eap->cmdidx == CMD_center)
203 new_indent = (width - len) / 2;
204 else
206 new_indent = width - len; /* right align */
209 * Make sure that embedded TABs don't make the text go too far
210 * to the right.
212 if (has_tab)
213 while (new_indent > 0)
215 (void)set_indent(new_indent, 0);
216 if (linelen(NULL) <= width)
219 * Now try to move the line as much as possible to
220 * the right. Stop when it moves too far.
223 (void)set_indent(++new_indent, 0);
224 while (linelen(NULL) <= width);
225 --new_indent;
226 break;
228 --new_indent;
232 if (new_indent < 0)
233 new_indent = 0;
234 (void)set_indent(new_indent, 0); /* set indent */
236 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
237 curwin->w_cursor = save_curpos;
238 beginline(BL_WHITE | BL_FIX);
242 * Get the length of the current line, excluding trailing white space.
244 static int
245 linelen(has_tab)
246 int *has_tab;
248 char_u *line;
249 char_u *first;
250 char_u *last;
251 int save;
252 int len;
254 /* find the first non-blank character */
255 line = ml_get_curline();
256 first = skipwhite(line);
258 /* find the character after the last non-blank character */
259 for (last = first + STRLEN(first);
260 last > first && vim_iswhite(last[-1]); --last)
262 save = *last;
263 *last = NUL;
264 len = linetabsize(line); /* get line length */
265 if (has_tab != NULL) /* check for embedded TAB */
266 *has_tab = (vim_strrchr(first, TAB) != NULL);
267 *last = save;
269 return len;
272 /* Buffer for two lines used during sorting. They are allocated to
273 * contain the longest line being sorted. */
274 static char_u *sortbuf1;
275 static char_u *sortbuf2;
277 static int sort_ic; /* ignore case */
278 static int sort_nr; /* sort on number */
279 static int sort_rx; /* sort on regex instead of skipping it */
281 static int sort_abort; /* flag to indicate if sorting has been interrupted */
283 /* Struct to store info to be sorted. */
284 typedef struct
286 linenr_T lnum; /* line number */
287 long start_col_nr; /* starting column number or number */
288 long end_col_nr; /* ending column number */
289 } sorti_T;
291 static int
292 #ifdef __BORLANDC__
293 _RTLENTRYF
294 #endif
295 sort_compare __ARGS((const void *s1, const void *s2));
297 static int
298 #ifdef __BORLANDC__
299 _RTLENTRYF
300 #endif
301 sort_compare(s1, s2)
302 const void *s1;
303 const void *s2;
305 sorti_T l1 = *(sorti_T *)s1;
306 sorti_T l2 = *(sorti_T *)s2;
307 int result = 0;
309 /* If the user interrupts, there's no way to stop qsort() immediately, but
310 * if we return 0 every time, qsort will assume it's done sorting and
311 * exit. */
312 if (sort_abort)
313 return 0;
314 fast_breakcheck();
315 if (got_int)
316 sort_abort = TRUE;
318 /* When sorting numbers "start_col_nr" is the number, not the column
319 * number. */
320 if (sort_nr)
321 result = l1.start_col_nr - l2.start_col_nr;
322 else
324 /* We need to copy one line into "sortbuf1", because there is no
325 * guarantee that the first pointer becomes invalid when obtaining the
326 * second one. */
327 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
328 l1.end_col_nr - l1.start_col_nr + 1);
329 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
330 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
331 l2.end_col_nr - l2.start_col_nr + 1);
332 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
334 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
335 : STRCMP(sortbuf1, sortbuf2);
338 /* If two lines have the same value, preserve the original line order. */
339 if (result == 0)
340 return (int)(l1.lnum - l2.lnum);
341 return result;
345 * ":sort".
347 void
348 ex_sort(eap)
349 exarg_T *eap;
351 regmatch_T regmatch;
352 int len;
353 linenr_T lnum;
354 long maxlen = 0;
355 sorti_T *nrs;
356 size_t count = eap->line2 - eap->line1 + 1;
357 size_t i;
358 char_u *p;
359 char_u *s;
360 char_u *s2;
361 char_u c; /* temporary character storage */
362 int unique = FALSE;
363 long deleted;
364 colnr_T start_col;
365 colnr_T end_col;
366 int sort_oct; /* sort on octal number */
367 int sort_hex; /* sort on hex number */
369 /* Sorting one line is really quick! */
370 if (count <= 1)
371 return;
373 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
374 return;
375 sortbuf1 = NULL;
376 sortbuf2 = NULL;
377 regmatch.regprog = NULL;
378 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
379 if (nrs == NULL)
380 goto sortend;
382 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
384 for (p = eap->arg; *p != NUL; ++p)
386 if (vim_iswhite(*p))
388 else if (*p == 'i')
389 sort_ic = TRUE;
390 else if (*p == 'r')
391 sort_rx = TRUE;
392 else if (*p == 'n')
393 sort_nr = 2;
394 else if (*p == 'o')
395 sort_oct = 2;
396 else if (*p == 'x')
397 sort_hex = 2;
398 else if (*p == 'u')
399 unique = TRUE;
400 else if (*p == '"') /* comment start */
401 break;
402 else if (check_nextcmd(p) != NULL)
404 eap->nextcmd = check_nextcmd(p);
405 break;
407 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
409 s = skip_regexp(p + 1, *p, TRUE, NULL);
410 if (*s != *p)
412 EMSG(_(e_invalpat));
413 goto sortend;
415 *s = NUL;
416 /* Use last search pattern if sort pattern is empty. */
417 if (s == p + 1 && last_search_pat() != NULL)
418 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
419 else
420 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
421 if (regmatch.regprog == NULL)
422 goto sortend;
423 p = s; /* continue after the regexp */
424 regmatch.rm_ic = p_ic;
426 else
428 EMSG2(_(e_invarg2), p);
429 goto sortend;
433 /* Can only have one of 'n', 'o' and 'x'. */
434 if (sort_nr + sort_oct + sort_hex > 2)
436 EMSG(_(e_invarg));
437 goto sortend;
440 /* From here on "sort_nr" is used as a flag for any number sorting. */
441 sort_nr += sort_oct + sort_hex;
444 * Make an array with all line numbers. This avoids having to copy all
445 * the lines into allocated memory.
446 * When sorting on strings "start_col_nr" is the offset in the line, for
447 * numbers sorting it's the number to sort on. This means the pattern
448 * matching and number conversion only has to be done once per line.
449 * Also get the longest line length for allocating "sortbuf".
451 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
453 s = ml_get(lnum);
454 len = (int)STRLEN(s);
455 if (maxlen < len)
456 maxlen = len;
458 start_col = 0;
459 end_col = len;
460 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
462 if (sort_rx)
464 start_col = (colnr_T)(regmatch.startp[0] - s);
465 end_col = (colnr_T)(regmatch.endp[0] - s);
467 else
468 start_col = (colnr_T)(regmatch.endp[0] - s);
470 else
471 if (regmatch.regprog != NULL)
472 end_col = 0;
474 if (sort_nr)
476 /* Make sure vim_str2nr doesn't read any digits past the end
477 * of the match, by temporarily terminating the string there */
478 s2 = s + end_col;
479 c = *s2;
480 (*s2) = 0;
481 /* Sorting on number: Store the number itself. */
482 if (sort_hex)
483 s = skiptohex(s + start_col);
484 else
485 s = skiptodigit(s + start_col);
486 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
487 &nrs[lnum - eap->line1].start_col_nr, NULL);
488 (*s2) = c;
490 else
492 /* Store the column to sort at. */
493 nrs[lnum - eap->line1].start_col_nr = start_col;
494 nrs[lnum - eap->line1].end_col_nr = end_col;
497 nrs[lnum - eap->line1].lnum = lnum;
499 if (regmatch.regprog != NULL)
500 fast_breakcheck();
501 if (got_int)
502 goto sortend;
505 /* Allocate a buffer that can hold the longest line. */
506 sortbuf1 = alloc((unsigned)maxlen + 1);
507 if (sortbuf1 == NULL)
508 goto sortend;
509 sortbuf2 = alloc((unsigned)maxlen + 1);
510 if (sortbuf2 == NULL)
511 goto sortend;
513 /* Sort the array of line numbers. Note: can't be interrupted! */
514 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
516 if (sort_abort)
517 goto sortend;
519 /* Insert the lines in the sorted order below the last one. */
520 lnum = eap->line2;
521 for (i = 0; i < count; ++i)
523 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
524 if (!unique || i == 0
525 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
527 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
528 break;
529 if (unique)
530 STRCPY(sortbuf1, s);
532 fast_breakcheck();
533 if (got_int)
534 goto sortend;
537 /* delete the original lines if appending worked */
538 if (i == count)
539 for (i = 0; i < count; ++i)
540 ml_delete(eap->line1, FALSE);
541 else
542 count = 0;
544 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
545 deleted = (long)(count - (lnum - eap->line2));
546 if (deleted > 0)
547 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
548 else if (deleted < 0)
549 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
550 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
552 curwin->w_cursor.lnum = eap->line1;
553 beginline(BL_WHITE | BL_FIX);
555 sortend:
556 vim_free(nrs);
557 vim_free(sortbuf1);
558 vim_free(sortbuf2);
559 vim_free(regmatch.regprog);
560 if (got_int)
561 EMSG(_(e_interr));
565 * ":retab".
567 void
568 ex_retab(eap)
569 exarg_T *eap;
571 linenr_T lnum;
572 int got_tab = FALSE;
573 long num_spaces = 0;
574 long num_tabs;
575 long len;
576 long col;
577 long vcol;
578 long start_col = 0; /* For start of white-space string */
579 long start_vcol = 0; /* For start of white-space string */
580 int temp;
581 long old_len;
582 char_u *ptr;
583 char_u *new_line = (char_u *)1; /* init to non-NULL */
584 int did_undo; /* called u_save for current line */
585 int new_ts;
586 int save_list;
587 linenr_T first_line = 0; /* first changed line */
588 linenr_T last_line = 0; /* last changed line */
590 save_list = curwin->w_p_list;
591 curwin->w_p_list = 0; /* don't want list mode here */
593 new_ts = getdigits(&(eap->arg));
594 if (new_ts < 0)
596 EMSG(_(e_positive));
597 return;
599 if (new_ts == 0)
600 new_ts = curbuf->b_p_ts;
601 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
603 ptr = ml_get(lnum);
604 col = 0;
605 vcol = 0;
606 did_undo = FALSE;
607 for (;;)
609 if (vim_iswhite(ptr[col]))
611 if (!got_tab && num_spaces == 0)
613 /* First consecutive white-space */
614 start_vcol = vcol;
615 start_col = col;
617 if (ptr[col] == ' ')
618 num_spaces++;
619 else
620 got_tab = TRUE;
622 else
624 if (got_tab || (eap->forceit && num_spaces > 1))
626 /* Retabulate this string of white-space */
628 /* len is virtual length of white string */
629 len = num_spaces = vcol - start_vcol;
630 num_tabs = 0;
631 if (!curbuf->b_p_et)
633 temp = new_ts - (start_vcol % new_ts);
634 if (num_spaces >= temp)
636 num_spaces -= temp;
637 num_tabs++;
639 num_tabs += num_spaces / new_ts;
640 num_spaces -= (num_spaces / new_ts) * new_ts;
642 if (curbuf->b_p_et || got_tab ||
643 (num_spaces + num_tabs < len))
645 if (did_undo == FALSE)
647 did_undo = TRUE;
648 if (u_save((linenr_T)(lnum - 1),
649 (linenr_T)(lnum + 1)) == FAIL)
651 new_line = NULL; /* flag out-of-memory */
652 break;
656 /* len is actual number of white characters used */
657 len = num_spaces + num_tabs;
658 old_len = (long)STRLEN(ptr);
659 new_line = lalloc(old_len - col + start_col + len + 1,
660 TRUE);
661 if (new_line == NULL)
662 break;
663 if (start_col > 0)
664 mch_memmove(new_line, ptr, (size_t)start_col);
665 mch_memmove(new_line + start_col + len,
666 ptr + col, (size_t)(old_len - col + 1));
667 ptr = new_line + start_col;
668 for (col = 0; col < len; col++)
669 ptr[col] = (col < num_tabs) ? '\t' : ' ';
670 ml_replace(lnum, new_line, FALSE);
671 if (first_line == 0)
672 first_line = lnum;
673 last_line = lnum;
674 ptr = new_line;
675 col = start_col + len;
678 got_tab = FALSE;
679 num_spaces = 0;
681 if (ptr[col] == NUL)
682 break;
683 vcol += chartabsize(ptr + col, (colnr_T)vcol);
684 #ifdef FEAT_MBYTE
685 if (has_mbyte)
686 col += (*mb_ptr2len)(ptr + col);
687 else
688 #endif
689 ++col;
691 if (new_line == NULL) /* out of memory */
692 break;
693 line_breakcheck();
695 if (got_int)
696 EMSG(_(e_interr));
698 if (curbuf->b_p_ts != new_ts)
699 redraw_curbuf_later(NOT_VALID);
700 if (first_line != 0)
701 changed_lines(first_line, 0, last_line + 1, 0L);
703 curwin->w_p_list = save_list; /* restore 'list' */
705 curbuf->b_p_ts = new_ts;
706 coladvance(curwin->w_curswant);
708 u_clearline();
710 #endif
713 * :move command - move lines line1-line2 to line dest
715 * return FAIL for failure, OK otherwise
718 do_move(line1, line2, dest)
719 linenr_T line1;
720 linenr_T line2;
721 linenr_T dest;
723 char_u *str;
724 linenr_T l;
725 linenr_T extra; /* Num lines added before line1 */
726 linenr_T num_lines; /* Num lines moved */
727 linenr_T last_line; /* Last line in file after adding new text */
729 if (dest >= line1 && dest < line2)
731 EMSG(_("E134: Move lines into themselves"));
732 return FAIL;
735 num_lines = line2 - line1 + 1;
738 * First we copy the old text to its new location -- webb
739 * Also copy the flag that ":global" command uses.
741 if (u_save(dest, dest + 1) == FAIL)
742 return FAIL;
743 for (extra = 0, l = line1; l <= line2; l++)
745 str = vim_strsave(ml_get(l + extra));
746 if (str != NULL)
748 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
749 vim_free(str);
750 if (dest < line1)
751 extra++;
756 * Now we must be careful adjusting our marks so that we don't overlap our
757 * mark_adjust() calls.
759 * We adjust the marks within the old text so that they refer to the
760 * last lines of the file (temporarily), because we know no other marks
761 * will be set there since these line numbers did not exist until we added
762 * our new lines.
764 * Then we adjust the marks on lines between the old and new text positions
765 * (either forwards or backwards).
767 * And Finally we adjust the marks we put at the end of the file back to
768 * their final destination at the new text position -- webb
770 last_line = curbuf->b_ml.ml_line_count;
771 mark_adjust(line1, line2, last_line - line2, 0L);
772 if (dest >= line2)
774 mark_adjust(line2 + 1, dest, -num_lines, 0L);
775 curbuf->b_op_start.lnum = dest - num_lines + 1;
776 curbuf->b_op_end.lnum = dest;
778 else
780 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
781 curbuf->b_op_start.lnum = dest + 1;
782 curbuf->b_op_end.lnum = dest + num_lines;
784 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
785 mark_adjust(last_line - num_lines + 1, last_line,
786 -(last_line - dest - extra), 0L);
789 * Now we delete the original text -- webb
791 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
792 return FAIL;
794 for (l = line1; l <= line2; l++)
795 ml_delete(line1 + extra, TRUE);
797 if (!global_busy && num_lines > p_report)
799 if (num_lines == 1)
800 MSG(_("1 line moved"));
801 else
802 smsg((char_u *)_("%ld lines moved"), num_lines);
806 * Leave the cursor on the last of the moved lines.
808 if (dest >= line1)
809 curwin->w_cursor.lnum = dest;
810 else
811 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
813 if (line1 < dest)
814 changed_lines(line1, 0, dest + num_lines + 1, 0L);
815 else
816 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
818 return OK;
822 * ":copy"
824 void
825 ex_copy(line1, line2, n)
826 linenr_T line1;
827 linenr_T line2;
828 linenr_T n;
830 linenr_T count;
831 char_u *p;
833 count = line2 - line1 + 1;
834 curbuf->b_op_start.lnum = n + 1;
835 curbuf->b_op_end.lnum = n + count;
836 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
839 * there are three situations:
840 * 1. destination is above line1
841 * 2. destination is between line1 and line2
842 * 3. destination is below line2
844 * n = destination (when starting)
845 * curwin->w_cursor.lnum = destination (while copying)
846 * line1 = start of source (while copying)
847 * line2 = end of source (while copying)
849 if (u_save(n, n + 1) == FAIL)
850 return;
852 curwin->w_cursor.lnum = n;
853 while (line1 <= line2)
855 /* need to use vim_strsave() because the line will be unlocked within
856 * ml_append() */
857 p = vim_strsave(ml_get(line1));
858 if (p != NULL)
860 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
861 vim_free(p);
863 /* situation 2: skip already copied lines */
864 if (line1 == n)
865 line1 = curwin->w_cursor.lnum;
866 ++line1;
867 if (curwin->w_cursor.lnum < line1)
868 ++line1;
869 if (curwin->w_cursor.lnum < line2)
870 ++line2;
871 ++curwin->w_cursor.lnum;
874 appended_lines_mark(n, count);
876 msgmore((long)count);
879 static char_u *prevcmd = NULL; /* the previous command */
881 #if defined(EXITFREE) || defined(PROTO)
882 void
883 free_prev_shellcmd()
885 vim_free(prevcmd);
887 #endif
890 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
891 * Bangs in the argument are replaced with the previously entered command.
892 * Remember the argument.
894 * RISCOS: Bangs only replaced when followed by a space, since many
895 * pathnames contain one.
897 void
898 do_bang(addr_count, eap, forceit, do_in, do_out)
899 int addr_count;
900 exarg_T *eap;
901 int forceit;
902 int do_in, do_out;
904 char_u *arg = eap->arg; /* command */
905 linenr_T line1 = eap->line1; /* start of range */
906 linenr_T line2 = eap->line2; /* end of range */
907 char_u *newcmd = NULL; /* the new command */
908 int free_newcmd = FALSE; /* need to free() newcmd */
909 int ins_prevcmd;
910 char_u *t;
911 char_u *p;
912 char_u *trailarg;
913 int len;
914 int scroll_save = msg_scroll;
917 * Disallow shell commands for "rvim".
918 * Disallow shell commands from .exrc and .vimrc in current directory for
919 * security reasons.
921 if (check_restricted() || check_secure())
922 return;
924 if (addr_count == 0) /* :! */
926 msg_scroll = FALSE; /* don't scroll here */
927 autowrite_all();
928 msg_scroll = scroll_save;
932 * Try to find an embedded bang, like in :!<cmd> ! [args]
933 * (:!! is indicated by the 'forceit' variable)
935 ins_prevcmd = forceit;
936 trailarg = arg;
939 len = (int)STRLEN(trailarg) + 1;
940 if (newcmd != NULL)
941 len += (int)STRLEN(newcmd);
942 if (ins_prevcmd)
944 if (prevcmd == NULL)
946 EMSG(_(e_noprev));
947 vim_free(newcmd);
948 return;
950 len += (int)STRLEN(prevcmd);
952 if ((t = alloc(len)) == NULL)
954 vim_free(newcmd);
955 return;
957 *t = NUL;
958 if (newcmd != NULL)
959 STRCAT(t, newcmd);
960 if (ins_prevcmd)
961 STRCAT(t, prevcmd);
962 p = t + STRLEN(t);
963 STRCAT(t, trailarg);
964 vim_free(newcmd);
965 newcmd = t;
968 * Scan the rest of the argument for '!', which is replaced by the
969 * previous command. "\!" is replaced by "!" (this is vi compatible).
971 trailarg = NULL;
972 while (*p)
974 if (*p == '!'
975 #ifdef RISCOS
976 && (p[1] == ' ' || p[1] == NUL)
977 #endif
980 if (p > newcmd && p[-1] == '\\')
981 STRMOVE(p - 1, p);
982 else
984 trailarg = p;
985 *trailarg++ = NUL;
986 ins_prevcmd = TRUE;
987 break;
990 ++p;
992 } while (trailarg != NULL);
994 vim_free(prevcmd);
995 prevcmd = newcmd;
997 if (bangredo) /* put cmd in redo buffer for ! command */
999 AppendToRedobuffLit(prevcmd, -1);
1000 AppendToRedobuff((char_u *)"\n");
1001 bangredo = FALSE;
1004 * Add quotes around the command, for shells that need them.
1006 if (*p_shq != NUL)
1008 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1009 if (newcmd == NULL)
1010 return;
1011 STRCPY(newcmd, p_shq);
1012 STRCAT(newcmd, prevcmd);
1013 STRCAT(newcmd, p_shq);
1014 free_newcmd = TRUE;
1016 if (addr_count == 0) /* :! */
1018 /* echo the command */
1019 msg_start();
1020 msg_putchar(':');
1021 msg_putchar('!');
1022 msg_outtrans(newcmd);
1023 msg_clr_eos();
1024 windgoto(msg_row, msg_col);
1026 do_shell(newcmd, 0);
1028 else /* :range! */
1030 /* Careful: This may recursively call do_bang() again! (because of
1031 * autocommands) */
1032 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1033 #ifdef FEAT_AUTOCMD
1034 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1035 #endif
1037 if (free_newcmd)
1038 vim_free(newcmd);
1042 * do_filter: filter lines through a command given by the user
1044 * We mostly use temp files and the call_shell() routine here. This would
1045 * normally be done using pipes on a UNIX machine, but this is more portable
1046 * to non-unix machines. The call_shell() routine needs to be able
1047 * to deal with redirection somehow, and should handle things like looking
1048 * at the PATH env. variable, and adding reasonable extensions to the
1049 * command name given by the user. All reasonable versions of call_shell()
1050 * do this.
1051 * Alternatively, if on Unix and redirecting input or output, but not both,
1052 * and the 'shelltemp' option isn't set, use pipes.
1053 * We use input redirection if do_in is TRUE.
1054 * We use output redirection if do_out is TRUE.
1056 static void
1057 do_filter(line1, line2, eap, cmd, do_in, do_out)
1058 linenr_T line1, line2;
1059 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1060 char_u *cmd;
1061 int do_in, do_out;
1063 char_u *itmp = NULL;
1064 char_u *otmp = NULL;
1065 linenr_T linecount;
1066 linenr_T read_linecount;
1067 pos_T cursor_save;
1068 char_u *cmd_buf;
1069 #ifdef FEAT_AUTOCMD
1070 buf_T *old_curbuf = curbuf;
1071 #endif
1072 int shell_flags = 0;
1074 if (*cmd == NUL) /* no filter command */
1075 return;
1077 #ifdef WIN3264
1079 * Check if external commands are allowed now.
1081 if (can_end_termcap_mode(TRUE) == FALSE)
1082 return;
1083 #endif
1085 cursor_save = curwin->w_cursor;
1086 linecount = line2 - line1 + 1;
1087 curwin->w_cursor.lnum = line1;
1088 curwin->w_cursor.col = 0;
1089 changed_line_abv_curs();
1090 invalidate_botline();
1093 * When using temp files:
1094 * 1. * Form temp file names
1095 * 2. * Write the lines to a temp file
1096 * 3. Run the filter command on the temp file
1097 * 4. * Read the output of the command into the buffer
1098 * 5. * Delete the original lines to be filtered
1099 * 6. * Remove the temp files
1101 * When writing the input with a pipe or when catching the output with a
1102 * pipe only need to do 3.
1105 if (do_out)
1106 shell_flags |= SHELL_DOOUT;
1108 #if !defined(USE_SYSTEM) && defined(UNIX)
1109 if (!do_in && do_out && !p_stmp)
1111 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1112 shell_flags |= SHELL_READ;
1113 curwin->w_cursor.lnum = line2;
1115 else if (do_in && !do_out && !p_stmp)
1117 /* Use a pipe to write stdin of the command, do not use a temp file. */
1118 shell_flags |= SHELL_WRITE;
1119 curbuf->b_op_start.lnum = line1;
1120 curbuf->b_op_end.lnum = line2;
1122 else if (do_in && do_out && !p_stmp)
1124 /* Use a pipe to write stdin and fetch stdout of the command, do not
1125 * use a temp file. */
1126 shell_flags |= SHELL_READ|SHELL_WRITE;
1127 curbuf->b_op_start.lnum = line1;
1128 curbuf->b_op_end.lnum = line2;
1129 curwin->w_cursor.lnum = line2;
1131 else
1132 #endif
1133 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1134 || (do_out && (otmp = vim_tempname('o')) == NULL))
1136 EMSG(_(e_notmp));
1137 goto filterend;
1141 * The writing and reading of temp files will not be shown.
1142 * Vi also doesn't do this and the messages are not very informative.
1144 ++no_wait_return; /* don't call wait_return() while busy */
1145 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1146 FALSE, FALSE, FALSE, TRUE) == FAIL)
1148 msg_putchar('\n'); /* keep message from buf_write() */
1149 --no_wait_return;
1150 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1151 if (!aborting())
1152 #endif
1153 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1154 goto filterend;
1156 #ifdef FEAT_AUTOCMD
1157 if (curbuf != old_curbuf)
1158 goto filterend;
1159 #endif
1161 if (!do_out)
1162 msg_putchar('\n');
1164 /* Create the shell command in allocated memory. */
1165 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1166 if (cmd_buf == NULL)
1167 goto filterend;
1169 windgoto((int)Rows - 1, 0);
1170 cursor_on();
1173 * When not redirecting the output the command can write anything to the
1174 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1175 * stderr output of external command. Clear the screen later.
1176 * If do_in is FALSE, this could be something like ":r !cat", which may
1177 * also mess up the screen, clear it later.
1179 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1180 redraw_later_clear();
1182 if (do_out)
1184 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1186 vim_free(cmd_buf);
1187 goto error;
1189 redraw_curbuf_later(VALID);
1191 read_linecount = curbuf->b_ml.ml_line_count;
1194 * When call_shell() fails wait_return() is called to give the user a
1195 * chance to read the error messages. Otherwise errors are ignored, so you
1196 * can see the error messages from the command that appear on stdout; use
1197 * 'u' to fix the text
1198 * Switch to cooked mode when not redirecting stdin, avoids that something
1199 * like ":r !cat" hangs.
1200 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1202 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1204 redraw_later_clear();
1205 wait_return(FALSE);
1207 vim_free(cmd_buf);
1209 did_check_timestamps = FALSE;
1210 need_check_timestamps = TRUE;
1212 /* When interrupting the shell command, it may still have produced some
1213 * useful output. Reset got_int here, so that readfile() won't cancel
1214 * reading. */
1215 ui_breakcheck();
1216 got_int = FALSE;
1218 if (do_out)
1220 if (otmp != NULL)
1222 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1223 eap, READ_FILTER) == FAIL)
1225 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1226 if (!aborting())
1227 #endif
1229 msg_putchar('\n');
1230 EMSG2(_(e_notread), otmp);
1232 goto error;
1234 #ifdef FEAT_AUTOCMD
1235 if (curbuf != old_curbuf)
1236 goto filterend;
1237 #endif
1240 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1242 if (shell_flags & SHELL_READ)
1244 curbuf->b_op_start.lnum = line2 + 1;
1245 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1246 appended_lines_mark(line2, read_linecount);
1249 if (do_in)
1251 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1253 if (read_linecount >= linecount)
1254 /* move all marks from old lines to new lines */
1255 mark_adjust(line1, line2, linecount, 0L);
1256 else
1258 /* move marks from old lines to new lines, delete marks
1259 * that are in deleted lines */
1260 mark_adjust(line1, line1 + read_linecount - 1,
1261 linecount, 0L);
1262 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1267 * Put cursor on first filtered line for ":range!cmd".
1268 * Adjust '[ and '] (set by buf_write()).
1270 curwin->w_cursor.lnum = line1;
1271 del_lines(linecount, TRUE);
1272 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1273 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1274 write_lnum_adjust(-linecount); /* adjust last line
1275 for next write */
1276 #ifdef FEAT_FOLDING
1277 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1278 #endif
1280 else
1283 * Put cursor on last new line for ":r !cmd".
1285 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1286 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1289 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1290 --no_wait_return;
1292 if (linecount > p_report)
1294 if (do_in)
1296 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1297 _("%ld lines filtered"), (long)linecount);
1298 if (msg(msg_buf) && !msg_scroll)
1299 /* save message to display it after redraw */
1300 set_keep_msg(msg_buf, 0);
1302 else
1303 msgmore((long)linecount);
1306 else
1308 error:
1309 /* put cursor back in same position for ":w !cmd" */
1310 curwin->w_cursor = cursor_save;
1311 --no_wait_return;
1312 wait_return(FALSE);
1315 filterend:
1317 #ifdef FEAT_AUTOCMD
1318 if (curbuf != old_curbuf)
1320 --no_wait_return;
1321 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1323 #endif
1324 if (itmp != NULL)
1325 mch_remove(itmp);
1326 if (otmp != NULL)
1327 mch_remove(otmp);
1328 vim_free(itmp);
1329 vim_free(otmp);
1333 * Call a shell to execute a command.
1334 * When "cmd" is NULL start an interactive shell.
1336 void
1337 do_shell(cmd, flags)
1338 char_u *cmd;
1339 int flags; /* may be SHELL_DOOUT when output is redirected */
1341 buf_T *buf;
1342 #ifndef FEAT_GUI_MSWIN
1343 int save_nwr;
1344 #endif
1345 #ifdef MSWIN
1346 int winstart = FALSE;
1347 #endif
1350 * Disallow shell commands for "rvim".
1351 * Disallow shell commands from .exrc and .vimrc in current directory for
1352 * security reasons.
1354 if (check_restricted() || check_secure())
1356 msg_end();
1357 return;
1360 #ifdef MSWIN
1362 * Check if external commands are allowed now.
1364 if (can_end_termcap_mode(TRUE) == FALSE)
1365 return;
1368 * Check if ":!start" is used.
1370 if (cmd != NULL)
1371 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1372 #endif
1375 * For autocommands we want to get the output on the current screen, to
1376 * avoid having to type return below.
1378 msg_putchar('\r'); /* put cursor at start of line */
1379 #ifdef FEAT_AUTOCMD
1380 if (!autocmd_busy)
1381 #endif
1383 #ifdef MSWIN
1384 if (!winstart)
1385 #endif
1386 stoptermcap();
1388 #ifdef MSWIN
1389 if (!winstart)
1390 #endif
1391 msg_putchar('\n'); /* may shift screen one line up */
1393 /* warning message before calling the shell */
1394 if (p_warn
1395 #ifdef FEAT_AUTOCMD
1396 && !autocmd_busy
1397 #endif
1398 && msg_silent == 0)
1399 for (buf = firstbuf; buf; buf = buf->b_next)
1400 if (bufIsChanged(buf))
1402 #ifdef FEAT_GUI_MSWIN
1403 if (!winstart)
1404 starttermcap(); /* don't want a message box here */
1405 #endif
1406 MSG_PUTS(_("[No write since last change]\n"));
1407 #ifdef FEAT_GUI_MSWIN
1408 if (!winstart)
1409 stoptermcap();
1410 #endif
1411 break;
1414 /* This windgoto is required for when the '\n' resulted in a "delete line
1415 * 1" command to the terminal. */
1416 if (!swapping_screen())
1417 windgoto(msg_row, msg_col);
1418 cursor_on();
1419 (void)call_shell(cmd, SHELL_COOKED | flags);
1420 did_check_timestamps = FALSE;
1421 need_check_timestamps = TRUE;
1424 * put the message cursor at the end of the screen, avoids wait_return()
1425 * to overwrite the text that the external command showed
1427 if (!swapping_screen())
1429 msg_row = Rows - 1;
1430 msg_col = 0;
1433 #ifdef FEAT_AUTOCMD
1434 if (autocmd_busy)
1436 if (msg_silent == 0)
1437 redraw_later_clear();
1439 else
1440 #endif
1443 * For ":sh" there is no need to call wait_return(), just redraw.
1444 * Also for the Win32 GUI (the output is in a console window).
1445 * Otherwise there is probably text on the screen that the user wants
1446 * to read before redrawing, so call wait_return().
1448 #ifndef FEAT_GUI_MSWIN
1449 if (cmd == NULL
1450 # ifdef WIN3264
1451 || (winstart && !need_wait_return)
1452 # endif
1455 if (msg_silent == 0)
1456 redraw_later_clear();
1457 need_wait_return = FALSE;
1459 else
1462 * If we switch screens when starttermcap() is called, we really
1463 * want to wait for "hit return to continue".
1465 save_nwr = no_wait_return;
1466 if (swapping_screen())
1467 no_wait_return = FALSE;
1468 # ifdef AMIGA
1469 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1470 # else
1471 wait_return(msg_silent == 0);
1472 # endif
1473 no_wait_return = save_nwr;
1475 #endif /* FEAT_GUI_W32 */
1477 #ifdef MSWIN
1478 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1479 #endif
1480 starttermcap(); /* start termcap if not done by wait_return() */
1483 * In an Amiga window redrawing is caused by asking the window size.
1484 * If we got an interrupt this will not work. The chance that the
1485 * window size is wrong is very small, but we need to redraw the
1486 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1487 * but it saves an extra redraw.
1489 #ifdef AMIGA
1490 if (skip_redraw) /* ':' hit in wait_return() */
1492 if (msg_silent == 0)
1493 redraw_later_clear();
1495 else if (term_console)
1497 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1498 if (got_int && msg_silent == 0)
1499 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1500 else
1501 must_redraw = 0; /* no extra redraw needed */
1503 #endif
1506 /* display any error messages now */
1507 display_errors();
1509 #ifdef FEAT_AUTOCMD
1510 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1511 #endif
1515 * Create a shell command from a command string, input redirection file and
1516 * output redirection file.
1517 * Returns an allocated string with the shell command, or NULL for failure.
1519 char_u *
1520 make_filter_cmd(cmd, itmp, otmp)
1521 char_u *cmd; /* command */
1522 char_u *itmp; /* NULL or name of input file */
1523 char_u *otmp; /* NULL or name of output file */
1525 char_u *buf;
1526 long_u len;
1528 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1529 if (itmp != NULL)
1530 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1531 if (otmp != NULL)
1532 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1533 buf = lalloc(len, TRUE);
1534 if (buf == NULL)
1535 return NULL;
1537 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1539 * Put braces around the command (for concatenated commands) when
1540 * redirecting input and/or output.
1542 if (itmp != NULL || otmp != NULL)
1543 sprintf((char *)buf, "(%s)", (char *)cmd);
1544 else
1545 STRCPY(buf, cmd);
1546 if (itmp != NULL)
1548 STRCAT(buf, " < ");
1549 STRCAT(buf, itmp);
1551 #else
1553 * for shells that don't understand braces around commands, at least allow
1554 * the use of commands in a pipe.
1556 STRCPY(buf, cmd);
1557 if (itmp != NULL)
1559 char_u *p;
1562 * If there is a pipe, we have to put the '<' in front of it.
1563 * Don't do this when 'shellquote' is not empty, otherwise the
1564 * redirection would be inside the quotes.
1566 if (*p_shq == NUL)
1568 p = vim_strchr(buf, '|');
1569 if (p != NULL)
1570 *p = NUL;
1572 # ifdef RISCOS
1573 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1574 STRCAT(buf, itmp);
1575 STRCAT(buf, " } ");
1576 # else
1577 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1578 STRCAT(buf, itmp);
1579 # endif
1580 if (*p_shq == NUL)
1582 p = vim_strchr(cmd, '|');
1583 if (p != NULL)
1585 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1586 STRCAT(buf, p);
1590 #endif
1591 if (otmp != NULL)
1592 append_redir(buf, p_srr, otmp);
1594 return buf;
1598 * Append output redirection for file "fname" to the end of string buffer "buf"
1599 * Works with the 'shellredir' and 'shellpipe' options.
1600 * The caller should make sure that there is enough room:
1601 * STRLEN(opt) + STRLEN(fname) + 3
1603 void
1604 append_redir(buf, opt, fname)
1605 char_u *buf;
1606 char_u *opt;
1607 char_u *fname;
1609 char_u *p;
1611 buf += STRLEN(buf);
1612 /* find "%s", skipping "%%" */
1613 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1614 if (p[1] == 's')
1615 break;
1616 if (p != NULL)
1618 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1619 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1621 else
1622 sprintf((char *)buf,
1623 #ifdef FEAT_QUICKFIX
1624 # ifndef RISCOS
1625 opt != p_sp ? " %s%s" :
1626 # endif
1627 " %s %s",
1628 #else
1629 # ifndef RISCOS
1630 " %s%s", /* " > %s" causes problems on Amiga */
1631 # else
1632 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1633 # endif
1634 #endif
1635 (char *)opt, (char *)fname);
1638 #ifdef FEAT_VIMINFO
1640 static int no_viminfo __ARGS((void));
1641 static int viminfo_errcnt;
1643 static int
1644 no_viminfo()
1646 /* "vim -i NONE" does not read or write a viminfo file */
1647 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1651 * Report an error for reading a viminfo file.
1652 * Count the number of errors. When there are more than 10, return TRUE.
1655 viminfo_error(errnum, message, line)
1656 char *errnum;
1657 char *message;
1658 char_u *line;
1660 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1661 errnum, message);
1662 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1663 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1664 IObuff[STRLEN(IObuff) - 1] = NUL;
1665 emsg(IObuff);
1666 if (++viminfo_errcnt >= 10)
1668 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1669 return TRUE;
1671 return FALSE;
1675 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1676 * set are not over-written unless force is TRUE. -- webb
1679 read_viminfo(file, want_info, want_marks, forceit)
1680 char_u *file;
1681 int want_info;
1682 int want_marks;
1683 int forceit;
1685 FILE *fp;
1686 char_u *fname;
1688 if (no_viminfo())
1689 return FAIL;
1691 fname = viminfo_filename(file); /* may set to default if NULL */
1692 if (fname == NULL)
1693 return FAIL;
1694 fp = mch_fopen((char *)fname, READBIN);
1696 if (p_verbose > 0)
1698 verbose_enter();
1699 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1700 fname,
1701 want_info ? _(" info") : "",
1702 want_marks ? _(" marks") : "",
1703 fp == NULL ? _(" FAILED") : "");
1704 verbose_leave();
1707 vim_free(fname);
1708 if (fp == NULL)
1709 return FAIL;
1711 viminfo_errcnt = 0;
1712 do_viminfo(fp, NULL, want_info, want_marks, forceit);
1714 fclose(fp);
1716 return OK;
1720 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1721 * that effectively a merge of current info and old info is done. This allows
1722 * multiple vims to run simultaneously, without losing any marks etc. If
1723 * forceit is TRUE, then the old file is not read in, and only internal info is
1724 * written to the file. -- webb
1726 void
1727 write_viminfo(file, forceit)
1728 char_u *file;
1729 int forceit;
1731 char_u *fname;
1732 FILE *fp_in = NULL; /* input viminfo file, if any */
1733 FILE *fp_out = NULL; /* output viminfo file */
1734 char_u *tempname = NULL; /* name of temp viminfo file */
1735 struct stat st_new; /* mch_stat() of potential new file */
1736 char_u *wp;
1737 #if defined(UNIX) || defined(VMS)
1738 mode_t umask_save;
1739 #endif
1740 #ifdef UNIX
1741 int shortname = FALSE; /* use 8.3 file name */
1742 struct stat st_old; /* mch_stat() of existing viminfo file */
1743 #endif
1744 #ifdef WIN3264
1745 long perm = -1;
1746 #endif
1748 if (no_viminfo())
1749 return;
1751 fname = viminfo_filename(file); /* may set to default if NULL */
1752 if (fname == NULL)
1753 return;
1755 fp_in = mch_fopen((char *)fname, READBIN);
1756 if (fp_in == NULL)
1758 /* if it does exist, but we can't read it, don't try writing */
1759 if (mch_stat((char *)fname, &st_new) == 0)
1760 goto end;
1761 #if defined(UNIX) || defined(VMS)
1763 * For Unix we create the .viminfo non-accessible for others,
1764 * because it may contain text from non-accessible documents.
1766 umask_save = umask(077);
1767 #endif
1768 fp_out = mch_fopen((char *)fname, WRITEBIN);
1769 #if defined(UNIX) || defined(VMS)
1770 (void)umask(umask_save);
1771 #endif
1773 else
1776 * There is an existing viminfo file. Create a temporary file to
1777 * write the new viminfo into, in the same directory as the
1778 * existing viminfo file, which will be renamed later.
1780 #ifdef UNIX
1782 * For Unix we check the owner of the file. It's not very nice to
1783 * overwrite a user's viminfo file after a "su root", with a
1784 * viminfo file that the user can't read.
1786 st_old.st_dev = 0;
1787 st_old.st_ino = 0;
1788 st_old.st_mode = 0600;
1789 if (mch_stat((char *)fname, &st_old) == 0
1790 && getuid() != ROOT_UID
1791 && !(st_old.st_uid == getuid()
1792 ? (st_old.st_mode & 0200)
1793 : (st_old.st_gid == getgid()
1794 ? (st_old.st_mode & 0020)
1795 : (st_old.st_mode & 0002))))
1797 int tt = msg_didany;
1799 /* avoid a wait_return for this message, it's annoying */
1800 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1801 msg_didany = tt;
1802 fclose(fp_in);
1803 goto end;
1805 #endif
1806 #ifdef WIN3264
1807 /* Get the file attributes of the existing viminfo file. */
1808 perm = mch_getperm(fname);
1809 #endif
1812 * Make tempname.
1813 * May try twice: Once normal and once with shortname set, just in
1814 * case somebody puts his viminfo file in an 8.3 filesystem.
1816 for (;;)
1818 tempname = buf_modname(
1819 #ifdef UNIX
1820 shortname,
1821 #else
1822 # ifdef SHORT_FNAME
1823 TRUE,
1824 # else
1825 # ifdef FEAT_GUI_W32
1826 gui_is_win32s(),
1827 # else
1828 FALSE,
1829 # endif
1830 # endif
1831 #endif
1832 fname,
1833 #ifdef VMS
1834 (char_u *)"-tmp",
1835 #else
1836 # ifdef RISCOS
1837 (char_u *)"/tmp",
1838 # else
1839 (char_u *)".tmp",
1840 # endif
1841 #endif
1842 FALSE);
1843 if (tempname == NULL) /* out of memory */
1844 break;
1847 * Check if tempfile already exists. Never overwrite an
1848 * existing file!
1850 if (mch_stat((char *)tempname, &st_new) == 0)
1852 #ifdef UNIX
1854 * Check if tempfile is same as original file. May happen
1855 * when modname() gave the same file back. E.g. silly
1856 * link, or file name-length reached. Try again with
1857 * shortname set.
1859 if (!shortname && st_new.st_dev == st_old.st_dev
1860 && st_new.st_ino == st_old.st_ino)
1862 vim_free(tempname);
1863 tempname = NULL;
1864 shortname = TRUE;
1865 continue;
1867 #endif
1869 * Try another name. Change one character, just before
1870 * the extension. This should also work for an 8.3
1871 * file name, when after adding the extension it still is
1872 * the same file as the original.
1874 wp = tempname + STRLEN(tempname) - 5;
1875 if (wp < gettail(tempname)) /* empty file name? */
1876 wp = gettail(tempname);
1877 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1878 --*wp)
1881 * They all exist? Must be something wrong! Don't
1882 * write the viminfo file then.
1884 if (*wp == 'a')
1886 vim_free(tempname);
1887 tempname = NULL;
1888 break;
1892 break;
1895 if (tempname != NULL)
1897 #ifdef VMS
1898 /* fdopen() fails for some reason */
1899 umask_save = umask(077);
1900 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1901 (void)umask(umask_save);
1902 #else
1903 int fd;
1905 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1906 * protection:
1907 * Unix: same as original file, but strip s-bit. Reset umask to
1908 * avoid it getting in the way.
1909 * Others: r&w for user only. */
1910 # ifdef UNIX
1911 umask_save = umask(0);
1912 fd = mch_open((char *)tempname,
1913 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1914 (int)((st_old.st_mode & 0777) | 0600));
1915 (void)umask(umask_save);
1916 # else
1917 fd = mch_open((char *)tempname,
1918 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1919 # endif
1920 if (fd < 0)
1921 fp_out = NULL;
1922 else
1923 fp_out = fdopen(fd, WRITEBIN);
1924 #endif /* VMS */
1927 * If we can't create in the same directory, try creating a
1928 * "normal" temp file.
1930 if (fp_out == NULL)
1932 vim_free(tempname);
1933 if ((tempname = vim_tempname('o')) != NULL)
1934 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1937 #if defined(UNIX) && defined(HAVE_FCHOWN)
1939 * Make sure the owner can read/write it. This only works for
1940 * root.
1942 if (fp_out != NULL)
1943 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1944 #endif
1949 * Check if the new viminfo file can be written to.
1951 if (fp_out == NULL)
1953 EMSG2(_("E138: Can't write viminfo file %s!"),
1954 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1955 if (fp_in != NULL)
1956 fclose(fp_in);
1957 goto end;
1960 if (p_verbose > 0)
1962 verbose_enter();
1963 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1964 verbose_leave();
1967 viminfo_errcnt = 0;
1968 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1970 fclose(fp_out); /* errors are ignored !? */
1971 if (fp_in != NULL)
1973 fclose(fp_in);
1976 * In case of an error keep the original viminfo file.
1977 * Otherwise rename the newly written file.
1979 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1980 mch_remove(tempname);
1982 #ifdef WIN3264
1983 /* If the viminfo file was hidden then also hide the new file. */
1984 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1985 mch_hide(fname);
1986 #endif
1989 end:
1990 vim_free(fname);
1991 vim_free(tempname);
1995 * Get the viminfo file name to use.
1996 * If "file" is given and not empty, use it (has already been expanded by
1997 * cmdline functions).
1998 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1999 * expand environment variables.
2000 * Returns an allocated string. NULL when out of memory.
2002 static char_u *
2003 viminfo_filename(file)
2004 char_u *file;
2006 if (file == NULL || *file == NUL)
2008 if (use_viminfo != NULL)
2009 file = use_viminfo;
2010 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2012 #ifdef VIMINFO_FILE2
2013 /* don't use $HOME when not defined (turned into "c:/"!). */
2014 # ifdef VMS
2015 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2016 # else
2017 if (mch_getenv((char_u *)"HOME") == NULL)
2018 # endif
2020 /* don't use $VIM when not available. */
2021 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2022 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2023 file = (char_u *)VIMINFO_FILE2;
2024 else
2025 file = (char_u *)VIMINFO_FILE;
2027 else
2028 #endif
2029 file = (char_u *)VIMINFO_FILE;
2031 expand_env(file, NameBuff, MAXPATHL);
2032 file = NameBuff;
2034 return vim_strsave(file);
2038 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2040 static void
2041 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2042 FILE *fp_in;
2043 FILE *fp_out;
2044 int want_info;
2045 int want_marks;
2046 int force_read;
2048 int count = 0;
2049 int eof = FALSE;
2050 vir_T vir;
2052 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2053 return;
2054 vir.vir_fd = fp_in;
2055 #ifdef FEAT_MBYTE
2056 vir.vir_conv.vc_type = CONV_NONE;
2057 #endif
2059 if (fp_in != NULL)
2061 if (want_info)
2062 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2063 else
2064 /* Skip info, find start of marks */
2065 while (!(eof = viminfo_readline(&vir))
2066 && vir.vir_line[0] != '>')
2069 if (fp_out != NULL)
2071 /* Write the info: */
2072 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2073 VIM_VERSION_MEDIUM);
2074 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2075 #ifdef FEAT_MBYTE
2076 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2077 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2078 #endif
2079 write_viminfo_search_pattern(fp_out);
2080 write_viminfo_sub_string(fp_out);
2081 #ifdef FEAT_CMDHIST
2082 write_viminfo_history(fp_out);
2083 #endif
2084 write_viminfo_registers(fp_out);
2085 #ifdef FEAT_EVAL
2086 write_viminfo_varlist(fp_out);
2087 #endif
2088 write_viminfo_filemarks(fp_out);
2089 write_viminfo_bufferlist(fp_out);
2090 count = write_viminfo_marks(fp_out);
2092 if (fp_in != NULL && want_marks)
2093 copy_viminfo_marks(&vir, fp_out, count, eof);
2095 vim_free(vir.vir_line);
2096 #ifdef FEAT_MBYTE
2097 if (vir.vir_conv.vc_type != CONV_NONE)
2098 convert_setup(&vir.vir_conv, NULL, NULL);
2099 #endif
2103 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2104 * first part of the viminfo file which contains everything but the marks that
2105 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2107 static int
2108 read_viminfo_up_to_marks(virp, forceit, writing)
2109 vir_T *virp;
2110 int forceit;
2111 int writing;
2113 int eof;
2114 buf_T *buf;
2116 #ifdef FEAT_CMDHIST
2117 prepare_viminfo_history(forceit ? 9999 : 0);
2118 #endif
2119 eof = viminfo_readline(virp);
2120 while (!eof && virp->vir_line[0] != '>')
2122 switch (virp->vir_line[0])
2124 /* Characters reserved for future expansion, ignored now */
2125 case '+': /* "+40 /path/dir file", for running vim without args */
2126 case '|': /* to be defined */
2127 case '^': /* to be defined */
2128 case '<': /* long line - ignored */
2129 /* A comment or empty line. */
2130 case NUL:
2131 case '\r':
2132 case '\n':
2133 case '#':
2134 eof = viminfo_readline(virp);
2135 break;
2136 case '*': /* "*encoding=value" */
2137 eof = viminfo_encoding(virp);
2138 break;
2139 case '!': /* global variable */
2140 #ifdef FEAT_EVAL
2141 eof = read_viminfo_varlist(virp, writing);
2142 #else
2143 eof = viminfo_readline(virp);
2144 #endif
2145 break;
2146 case '%': /* entry for buffer list */
2147 eof = read_viminfo_bufferlist(virp, writing);
2148 break;
2149 case '"':
2150 eof = read_viminfo_register(virp, forceit);
2151 break;
2152 case '/': /* Search string */
2153 case '&': /* Substitute search string */
2154 case '~': /* Last search string, followed by '/' or '&' */
2155 eof = read_viminfo_search_pattern(virp, forceit);
2156 break;
2157 case '$':
2158 eof = read_viminfo_sub_string(virp, forceit);
2159 break;
2160 case ':':
2161 case '?':
2162 case '=':
2163 case '@':
2164 #ifdef FEAT_CMDHIST
2165 eof = read_viminfo_history(virp);
2166 #else
2167 eof = viminfo_readline(virp);
2168 #endif
2169 break;
2170 case '-':
2171 case '\'':
2172 eof = read_viminfo_filemark(virp, forceit);
2173 break;
2174 default:
2175 if (viminfo_error("E575: ", _("Illegal starting char"),
2176 virp->vir_line))
2177 eof = TRUE;
2178 else
2179 eof = viminfo_readline(virp);
2180 break;
2184 #ifdef FEAT_CMDHIST
2185 /* Finish reading history items. */
2186 finish_viminfo_history();
2187 #endif
2189 /* Change file names to buffer numbers for fmarks. */
2190 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2191 fmarks_check_names(buf);
2193 return eof;
2197 * Compare the 'encoding' value in the viminfo file with the current value of
2198 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2199 * conversion of text with iconv() in viminfo_readstring().
2201 static int
2202 viminfo_encoding(virp)
2203 vir_T *virp;
2205 #ifdef FEAT_MBYTE
2206 char_u *p;
2207 int i;
2209 if (get_viminfo_parameter('c') != 0)
2211 p = vim_strchr(virp->vir_line, '=');
2212 if (p != NULL)
2214 /* remove trailing newline */
2215 ++p;
2216 for (i = 0; vim_isprintc(p[i]); ++i)
2218 p[i] = NUL;
2220 convert_setup(&virp->vir_conv, p, p_enc);
2223 #endif
2224 return viminfo_readline(virp);
2228 * Read a line from the viminfo file.
2229 * Returns TRUE for end-of-file;
2232 viminfo_readline(virp)
2233 vir_T *virp;
2235 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2239 * check string read from viminfo file
2240 * remove '\n' at the end of the line
2241 * - replace CTRL-V CTRL-V with CTRL-V
2242 * - replace CTRL-V 'n' with '\n'
2244 * Check for a long line as written by viminfo_writestring().
2246 * Return the string in allocated memory (NULL when out of memory).
2248 /*ARGSUSED*/
2249 char_u *
2250 viminfo_readstring(virp, off, convert)
2251 vir_T *virp;
2252 int off; /* offset for virp->vir_line */
2253 int convert; /* convert the string */
2255 char_u *retval;
2256 char_u *s, *d;
2257 long len;
2259 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2261 len = atol((char *)virp->vir_line + off + 1);
2262 retval = lalloc(len, TRUE);
2263 if (retval == NULL)
2265 /* Line too long? File messed up? Skip next line. */
2266 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2267 return NULL;
2269 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2270 s = retval + 1; /* Skip the leading '<' */
2272 else
2274 retval = vim_strsave(virp->vir_line + off);
2275 if (retval == NULL)
2276 return NULL;
2277 s = retval;
2280 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2281 d = retval;
2282 while (*s != NUL && *s != '\n')
2284 if (s[0] == Ctrl_V && s[1] != NUL)
2286 if (s[1] == 'n')
2287 *d++ = '\n';
2288 else
2289 *d++ = Ctrl_V;
2290 s += 2;
2292 else
2293 *d++ = *s++;
2295 *d = NUL;
2297 #ifdef FEAT_MBYTE
2298 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2300 d = string_convert(&virp->vir_conv, retval, NULL);
2301 if (d != NULL)
2303 vim_free(retval);
2304 retval = d;
2307 #endif
2309 return retval;
2313 * write string to viminfo file
2314 * - replace CTRL-V with CTRL-V CTRL-V
2315 * - replace '\n' with CTRL-V 'n'
2316 * - add a '\n' at the end
2318 * For a long line:
2319 * - write " CTRL-V <length> \n " in first line
2320 * - write " < <string> \n " in second line
2322 void
2323 viminfo_writestring(fd, p)
2324 FILE *fd;
2325 char_u *p;
2327 int c;
2328 char_u *s;
2329 int len = 0;
2331 for (s = p; *s != NUL; ++s)
2333 if (*s == Ctrl_V || *s == '\n')
2334 ++len;
2335 ++len;
2338 /* If the string will be too long, write its length and put it in the next
2339 * line. Take into account that some room is needed for what comes before
2340 * the string (e.g., variable name). Add something to the length for the
2341 * '<', NL and trailing NUL. */
2342 if (len > LSIZE / 2)
2343 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2345 while ((c = *p++) != NUL)
2347 if (c == Ctrl_V || c == '\n')
2349 putc(Ctrl_V, fd);
2350 if (c == '\n')
2351 c = 'n';
2353 putc(c, fd);
2355 putc('\n', fd);
2357 #endif /* FEAT_VIMINFO */
2360 * Implementation of ":fixdel", also used by get_stty().
2361 * <BS> resulting <Del>
2362 * ^? ^H
2363 * not ^? ^?
2365 /*ARGSUSED*/
2366 void
2367 do_fixdel(eap)
2368 exarg_T *eap;
2370 char_u *p;
2372 p = find_termcode((char_u *)"kb");
2373 add_termcode((char_u *)"kD", p != NULL
2374 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2377 void
2378 print_line_no_prefix(lnum, use_number, list)
2379 linenr_T lnum;
2380 int use_number;
2381 int list;
2383 char_u numbuf[30];
2385 if (curwin->w_p_nu || use_number)
2387 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2388 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2390 msg_prt_line(ml_get(lnum), list);
2394 * Print a text line. Also in silent mode ("ex -s").
2396 void
2397 print_line(lnum, use_number, list)
2398 linenr_T lnum;
2399 int use_number;
2400 int list;
2402 int save_silent = silent_mode;
2404 msg_start();
2405 silent_mode = FALSE;
2406 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2407 print_line_no_prefix(lnum, use_number, list);
2408 if (save_silent)
2410 msg_putchar('\n');
2411 cursor_on(); /* msg_start() switches it off */
2412 out_flush();
2413 silent_mode = save_silent;
2414 info_message = FALSE;
2419 * ":file[!] [fname]".
2421 void
2422 ex_file(eap)
2423 exarg_T *eap;
2425 char_u *fname, *sfname, *xfname;
2426 buf_T *buf;
2428 /* ":0file" removes the file name. Check for illegal uses ":3file",
2429 * "0file name", etc. */
2430 if (eap->addr_count > 0
2431 && (*eap->arg != NUL
2432 || eap->line2 > 0
2433 || eap->addr_count > 1))
2435 EMSG(_(e_invarg));
2436 return;
2439 if (*eap->arg != NUL || eap->addr_count == 1)
2441 #ifdef FEAT_AUTOCMD
2442 buf = curbuf;
2443 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2444 /* buffer changed, don't change name now */
2445 if (buf != curbuf)
2446 return;
2447 # ifdef FEAT_EVAL
2448 if (aborting()) /* autocmds may abort script processing */
2449 return;
2450 # endif
2451 #endif
2453 * The name of the current buffer will be changed.
2454 * A new (unlisted) buffer entry needs to be made to hold the old file
2455 * name, which will become the alternate file name.
2456 * But don't set the alternate file name if the buffer didn't have a
2457 * name.
2459 fname = curbuf->b_ffname;
2460 sfname = curbuf->b_sfname;
2461 xfname = curbuf->b_fname;
2462 curbuf->b_ffname = NULL;
2463 curbuf->b_sfname = NULL;
2464 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2466 curbuf->b_ffname = fname;
2467 curbuf->b_sfname = sfname;
2468 return;
2470 curbuf->b_flags |= BF_NOTEDITED;
2471 if (xfname != NULL && *xfname != NUL)
2473 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2474 if (buf != NULL && !cmdmod.keepalt)
2475 curwin->w_alt_fnum = buf->b_fnum;
2477 vim_free(fname);
2478 vim_free(sfname);
2479 #ifdef FEAT_AUTOCMD
2480 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2481 #endif
2482 /* Change directories when the 'acd' option is set. */
2483 DO_AUTOCHDIR
2485 /* print full file name if :cd used */
2486 fileinfo(FALSE, FALSE, eap->forceit);
2490 * ":update".
2492 void
2493 ex_update(eap)
2494 exarg_T *eap;
2496 if (curbufIsChanged())
2497 (void)do_write(eap);
2501 * ":write" and ":saveas".
2503 void
2504 ex_write(eap)
2505 exarg_T *eap;
2507 if (eap->usefilter) /* input lines to shell command */
2508 do_bang(1, eap, FALSE, TRUE, FALSE);
2509 else
2510 (void)do_write(eap);
2514 * write current buffer to file 'eap->arg'
2515 * if 'eap->append' is TRUE, append to the file
2517 * if *eap->arg == NUL write to current file
2519 * return FAIL for failure, OK otherwise
2522 do_write(eap)
2523 exarg_T *eap;
2525 int other;
2526 char_u *fname = NULL; /* init to shut up gcc */
2527 char_u *ffname;
2528 int retval = FAIL;
2529 char_u *free_fname = NULL;
2530 #ifdef FEAT_BROWSE
2531 char_u *browse_file = NULL;
2532 #endif
2533 buf_T *alt_buf = NULL;
2535 if (not_writing()) /* check 'write' option */
2536 return FAIL;
2538 ffname = eap->arg;
2539 #ifdef FEAT_BROWSE
2540 if (cmdmod.browse)
2542 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2543 NULL, NULL, NULL, curbuf);
2544 if (browse_file == NULL)
2545 goto theend;
2546 ffname = browse_file;
2548 #endif
2549 if (*ffname == NUL)
2551 if (eap->cmdidx == CMD_saveas)
2553 EMSG(_(e_argreq));
2554 goto theend;
2556 other = FALSE;
2558 else
2560 fname = ffname;
2561 free_fname = fix_fname(ffname);
2563 * When out-of-memory, keep unexpanded file name, because we MUST be
2564 * able to write the file in this situation.
2566 if (free_fname != NULL)
2567 ffname = free_fname;
2568 other = otherfile(ffname);
2572 * If we have a new file, put its name in the list of alternate file names.
2574 if (other)
2576 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2577 || eap->cmdidx == CMD_saveas)
2578 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2579 else
2580 alt_buf = buflist_findname(ffname);
2581 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2583 /* Overwriting a file that is loaded in another buffer is not a
2584 * good idea. */
2585 EMSG(_(e_bufloaded));
2586 goto theend;
2591 * Writing to the current file is not allowed in readonly mode
2592 * and a file name is required.
2593 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2595 if (!other && (
2596 #ifdef FEAT_QUICKFIX
2597 bt_dontwrite_msg(curbuf) ||
2598 #endif
2599 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2600 goto theend;
2602 if (!other)
2604 ffname = curbuf->b_ffname;
2605 fname = curbuf->b_fname;
2607 * Not writing the whole file is only allowed with '!'.
2609 if ( (eap->line1 != 1
2610 || eap->line2 != curbuf->b_ml.ml_line_count)
2611 && !eap->forceit
2612 && !eap->append
2613 && !p_wa)
2615 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2616 if (p_confirm || cmdmod.confirm)
2618 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2619 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2620 goto theend;
2621 eap->forceit = TRUE;
2623 else
2624 #endif
2626 EMSG(_("E140: Use ! to write partial buffer"));
2627 goto theend;
2632 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2634 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2636 #ifdef FEAT_AUTOCMD
2637 buf_T *was_curbuf = curbuf;
2639 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2640 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2641 # ifdef FEAT_EVAL
2642 if (curbuf != was_curbuf || aborting())
2643 # else
2644 if (curbuf != was_curbuf)
2645 # endif
2647 /* buffer changed, don't change name now */
2648 retval = FAIL;
2649 goto theend;
2651 #endif
2652 /* Exchange the file names for the current and the alternate
2653 * buffer. This makes it look like we are now editing the buffer
2654 * under the new name. Must be done before buf_write(), because
2655 * if there is no file name and 'cpo' contains 'F', it will set
2656 * the file name. */
2657 fname = alt_buf->b_fname;
2658 alt_buf->b_fname = curbuf->b_fname;
2659 curbuf->b_fname = fname;
2660 fname = alt_buf->b_ffname;
2661 alt_buf->b_ffname = curbuf->b_ffname;
2662 curbuf->b_ffname = fname;
2663 fname = alt_buf->b_sfname;
2664 alt_buf->b_sfname = curbuf->b_sfname;
2665 curbuf->b_sfname = fname;
2666 buf_name_changed(curbuf);
2667 #ifdef FEAT_AUTOCMD
2668 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2669 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2670 if (!alt_buf->b_p_bl)
2672 alt_buf->b_p_bl = TRUE;
2673 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2675 # ifdef FEAT_EVAL
2676 if (curbuf != was_curbuf || aborting())
2677 # else
2678 if (curbuf != was_curbuf)
2679 # endif
2681 /* buffer changed, don't write the file */
2682 retval = FAIL;
2683 goto theend;
2686 /* If 'filetype' was empty try detecting it now. */
2687 if (*curbuf->b_p_ft == NUL)
2689 if (au_has_group((char_u *)"filetypedetect"))
2690 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2691 TRUE);
2692 do_modelines(0);
2694 #endif
2697 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2698 eap, eap->append, eap->forceit, TRUE, FALSE);
2700 /* After ":saveas fname" reset 'readonly'. */
2701 if (eap->cmdidx == CMD_saveas)
2703 if (retval == OK)
2704 curbuf->b_p_ro = FALSE;
2705 /* Change directories when the 'acd' option is set. */
2706 DO_AUTOCHDIR
2710 theend:
2711 #ifdef FEAT_BROWSE
2712 vim_free(browse_file);
2713 #endif
2714 vim_free(free_fname);
2715 return retval;
2719 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2720 * BF_NEW or BF_READERR, check for overwriting current file.
2721 * May set eap->forceit if a dialog says it's OK to overwrite.
2722 * Return OK if it's OK, FAIL if it is not.
2724 /*ARGSUSED*/
2725 static int
2726 check_overwrite(eap, buf, fname, ffname, other)
2727 exarg_T *eap;
2728 buf_T *buf;
2729 char_u *fname; /* file name to be used (can differ from
2730 buf->ffname) */
2731 char_u *ffname; /* full path version of fname */
2732 int other; /* writing under other name */
2735 * write to other file or b_flags set or not writing the whole file:
2736 * overwriting only allowed with '!'
2738 if ( (other
2739 || (buf->b_flags & BF_NOTEDITED)
2740 || ((buf->b_flags & BF_NEW)
2741 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2742 || (buf->b_flags & BF_READERR))
2743 && !p_wa
2744 #ifdef FEAT_QUICKFIX
2745 && !bt_nofile(buf)
2746 #endif
2747 && vim_fexists(ffname))
2749 if (!eap->forceit && !eap->append)
2751 #ifdef UNIX
2752 /* with UNIX it is possible to open a directory */
2753 if (mch_isdir(ffname))
2755 EMSG2(_(e_isadir2), ffname);
2756 return FAIL;
2758 #endif
2759 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2760 if (p_confirm || cmdmod.confirm)
2762 char_u buff[IOSIZE];
2764 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2765 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2766 return FAIL;
2767 eap->forceit = TRUE;
2769 else
2770 #endif
2772 EMSG(_(e_exists));
2773 return FAIL;
2777 /* For ":w! filename" check that no swap file exists for "filename". */
2778 if (other && !emsg_silent)
2780 char_u dir[MAXPATHL];
2781 char_u *p;
2782 int r;
2783 char_u *swapname;
2785 /* We only try the first entry in 'directory', without checking if
2786 * it's writable. If the "." directory is not writable the write
2787 * will probably fail anyway.
2788 * Use 'shortname' of the current buffer, since there is no buffer
2789 * for the written file. */
2790 if (*p_dir == NUL)
2791 STRCPY(dir, ".");
2792 else
2794 p = p_dir;
2795 copy_option_part(&p, dir, MAXPATHL, ",");
2797 swapname = makeswapname(fname, ffname, curbuf, dir);
2798 r = vim_fexists(swapname);
2799 if (r)
2801 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2802 if (p_confirm || cmdmod.confirm)
2804 char_u buff[IOSIZE];
2806 dialog_msg(buff,
2807 _("Swap file \"%s\" exists, overwrite anyway?"),
2808 swapname);
2809 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2810 != VIM_YES)
2812 vim_free(swapname);
2813 return FAIL;
2815 eap->forceit = TRUE;
2817 else
2818 #endif
2820 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2821 swapname);
2822 vim_free(swapname);
2823 return FAIL;
2826 vim_free(swapname);
2829 return OK;
2833 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2835 void
2836 ex_wnext(eap)
2837 exarg_T *eap;
2839 int i;
2841 if (eap->cmd[1] == 'n')
2842 i = curwin->w_arg_idx + (int)eap->line2;
2843 else
2844 i = curwin->w_arg_idx - (int)eap->line2;
2845 eap->line1 = 1;
2846 eap->line2 = curbuf->b_ml.ml_line_count;
2847 if (do_write(eap) != FAIL)
2848 do_argfile(eap, i);
2852 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2854 void
2855 do_wqall(eap)
2856 exarg_T *eap;
2858 buf_T *buf;
2859 int error = 0;
2860 int save_forceit = eap->forceit;
2862 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2863 exiting = TRUE;
2865 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2867 if (bufIsChanged(buf))
2870 * Check if there is a reason the buffer cannot be written:
2871 * 1. if the 'write' option is set
2872 * 2. if there is no file name (even after browsing)
2873 * 3. if the 'readonly' is set (even after a dialog)
2874 * 4. if overwriting is allowed (even after a dialog)
2876 if (not_writing())
2878 ++error;
2879 break;
2881 #ifdef FEAT_BROWSE
2882 /* ":browse wall": ask for file name if there isn't one */
2883 if (buf->b_ffname == NULL && cmdmod.browse)
2884 browse_save_fname(buf);
2885 #endif
2886 if (buf->b_ffname == NULL)
2888 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2889 ++error;
2891 else if (check_readonly(&eap->forceit, buf)
2892 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2893 FALSE) == FAIL)
2895 ++error;
2897 else
2899 if (buf_write_all(buf, eap->forceit) == FAIL)
2900 ++error;
2901 #ifdef FEAT_AUTOCMD
2902 /* an autocommand may have deleted the buffer */
2903 if (!buf_valid(buf))
2904 buf = firstbuf;
2905 #endif
2907 eap->forceit = save_forceit; /* check_overwrite() may set it */
2910 if (exiting)
2912 if (!error)
2913 getout(0); /* exit Vim */
2914 not_exiting();
2919 * Check the 'write' option.
2920 * Return TRUE and give a message when it's not st.
2923 not_writing()
2925 if (p_write)
2926 return FALSE;
2927 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2928 return TRUE;
2932 * Check if a buffer is read-only (either 'readonly' option is set or file is
2933 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2934 * message when the buffer is readonly.
2936 static int
2937 check_readonly(forceit, buf)
2938 int *forceit;
2939 buf_T *buf;
2941 struct stat st;
2943 /* Handle a file being readonly when the 'readonly' option is set or when
2944 * the file exists and permissions are read-only.
2945 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2946 * important for device checks but not here. */
2947 if (!*forceit && (buf->b_p_ro
2948 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2949 && check_file_readonly(buf->b_ffname, 0777))))
2951 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2952 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2954 char_u buff[IOSIZE];
2956 if (buf->b_p_ro)
2957 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2958 buf->b_fname);
2959 else
2960 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2961 buf->b_fname);
2963 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2965 /* Set forceit, to force the writing of a readonly file */
2966 *forceit = TRUE;
2967 return FALSE;
2969 else
2970 return TRUE;
2972 else
2973 #endif
2974 if (buf->b_p_ro)
2975 EMSG(_(e_readonly));
2976 else
2977 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2978 buf->b_fname);
2979 return TRUE;
2982 return FALSE;
2986 * Try to abandon current file and edit a new or existing file.
2987 * 'fnum' is the number of the file, if zero use ffname/sfname.
2989 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2990 * -1 for successfully opening another file.
2991 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2994 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2995 int fnum;
2996 char_u *ffname;
2997 char_u *sfname;
2998 int setpm;
2999 linenr_T lnum;
3000 int forceit;
3002 int other;
3003 int retval;
3004 char_u *free_me = NULL;
3006 if (text_locked())
3007 return 1;
3008 #ifdef FEAT_AUTOCMD
3009 if (curbuf_locked())
3010 return 1;
3011 #endif
3013 if (fnum == 0)
3015 /* make ffname full path, set sfname */
3016 fname_expand(curbuf, &ffname, &sfname);
3017 other = otherfile(ffname);
3018 free_me = ffname; /* has been allocated, free() later */
3020 else
3021 other = (fnum != curbuf->b_fnum);
3023 if (other)
3024 ++no_wait_return; /* don't wait for autowrite message */
3025 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3026 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3028 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3029 if (p_confirm && p_write)
3030 dialog_changed(curbuf, FALSE);
3031 if (curbufIsChanged())
3032 #endif
3034 if (other)
3035 --no_wait_return;
3036 EMSG(_(e_nowrtmsg));
3037 retval = 2; /* file has been changed */
3038 goto theend;
3041 if (other)
3042 --no_wait_return;
3043 if (setpm)
3044 setpcmark();
3045 if (!other)
3047 if (lnum != 0)
3048 curwin->w_cursor.lnum = lnum;
3049 check_cursor_lnum();
3050 beginline(BL_SOL | BL_FIX);
3051 retval = 0; /* it's in the same file */
3053 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3054 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3055 retval = -1; /* opened another file */
3056 else
3057 retval = 1; /* error encountered */
3059 theend:
3060 vim_free(free_me);
3061 return retval;
3065 * start editing a new file
3067 * fnum: file number; if zero use ffname/sfname
3068 * ffname: the file name
3069 * - full path if sfname used,
3070 * - any file name if sfname is NULL
3071 * - empty string to re-edit with the same file name (but may be
3072 * in a different directory)
3073 * - NULL to start an empty buffer
3074 * sfname: the short file name (or NULL)
3075 * eap: contains the command to be executed after loading the file and
3076 * forced 'ff' and 'fenc'
3077 * newlnum: if > 0: put cursor on this line number (if possible)
3078 * if ECMD_LASTL: use last position in loaded file
3079 * if ECMD_LAST: use last position in all files
3080 * if ECMD_ONE: use first line
3081 * flags:
3082 * ECMD_HIDE: if TRUE don't free the current buffer
3083 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3084 * ECMD_OLDBUF: use existing buffer if it exists
3085 * ECMD_FORCEIT: ! used for Ex command
3086 * ECMD_ADDBUF: don't edit, just add to buffer list
3088 * return FAIL for failure, OK otherwise
3091 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3092 int fnum;
3093 char_u *ffname;
3094 char_u *sfname;
3095 exarg_T *eap; /* can be NULL! */
3096 linenr_T newlnum;
3097 int flags;
3099 int other_file; /* TRUE if editing another file */
3100 int oldbuf; /* TRUE if using existing buffer */
3101 #ifdef FEAT_AUTOCMD
3102 int auto_buf = FALSE; /* TRUE if autocommands brought us
3103 into the buffer unexpectedly */
3104 char_u *new_name = NULL;
3105 int did_set_swapcommand = FALSE;
3106 #endif
3107 buf_T *buf;
3108 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3109 buf_T *old_curbuf = curbuf;
3110 #endif
3111 char_u *free_fname = NULL;
3112 #ifdef FEAT_BROWSE
3113 char_u *browse_file = NULL;
3114 #endif
3115 int retval = FAIL;
3116 long n;
3117 linenr_T lnum;
3118 linenr_T topline = 0;
3119 int newcol = -1;
3120 int solcol = -1;
3121 pos_T *pos;
3122 #ifdef FEAT_SUN_WORKSHOP
3123 char_u *cp;
3124 #endif
3125 char_u *command = NULL;
3126 #ifdef FEAT_SPELL
3127 int did_get_winopts = FALSE;
3128 #endif
3130 if (eap != NULL)
3131 command = eap->do_ecmd_cmd;
3133 if (fnum != 0)
3135 if (fnum == curbuf->b_fnum) /* file is already being edited */
3136 return OK; /* nothing to do */
3137 other_file = TRUE;
3139 else
3141 #ifdef FEAT_BROWSE
3142 if (cmdmod.browse)
3144 if (
3145 # ifdef FEAT_GUI
3146 !gui.in_use &&
3147 # endif
3148 au_has_group((char_u *)"FileExplorer"))
3150 /* No browsing supported but we do have the file explorer:
3151 * Edit the directory. */
3152 if (ffname == NULL || !mch_isdir(ffname))
3153 ffname = (char_u *)".";
3155 else
3157 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3158 NULL, NULL, NULL, curbuf);
3159 if (browse_file == NULL)
3160 goto theend;
3161 ffname = browse_file;
3164 #endif
3165 /* if no short name given, use ffname for short name */
3166 if (sfname == NULL)
3167 sfname = ffname;
3168 #ifdef USE_FNAME_CASE
3169 # ifdef USE_LONG_FNAME
3170 if (USE_LONG_FNAME)
3171 # endif
3172 if (sfname != NULL)
3173 fname_case(sfname, 0); /* set correct case for sfname */
3174 #endif
3176 #ifdef FEAT_LISTCMDS
3177 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3178 goto theend;
3179 #endif
3181 if (ffname == NULL)
3182 other_file = TRUE;
3183 /* there is no file name */
3184 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3185 other_file = FALSE;
3186 else
3188 if (*ffname == NUL) /* re-edit with same file name */
3190 ffname = curbuf->b_ffname;
3191 sfname = curbuf->b_fname;
3193 free_fname = fix_fname(ffname); /* may expand to full path name */
3194 if (free_fname != NULL)
3195 ffname = free_fname;
3196 other_file = otherfile(ffname);
3197 #ifdef FEAT_SUN_WORKSHOP
3198 if (usingSunWorkShop && p_acd
3199 && (cp = vim_strrchr(sfname, '/')) != NULL)
3200 sfname = ++cp;
3201 #endif
3206 * if the file was changed we may not be allowed to abandon it
3207 * - if we are going to re-edit the same file
3208 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3210 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3211 || (curbuf->b_nwindows == 1
3212 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3213 && check_changed(curbuf, p_awa, !other_file,
3214 (flags & ECMD_FORCEIT), FALSE))
3216 if (fnum == 0 && other_file && ffname != NULL)
3217 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3218 goto theend;
3221 #ifdef FEAT_VISUAL
3223 * End Visual mode before switching to another buffer, so the text can be
3224 * copied into the GUI selection buffer.
3226 reset_VIsual();
3227 #endif
3229 #ifdef FEAT_AUTOCMD
3230 if ((command != NULL || newlnum > (linenr_T)0)
3231 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3233 int len;
3234 char_u *p;
3236 /* Set v:swapcommand for the SwapExists autocommands. */
3237 if (command != NULL)
3238 len = (int)STRLEN(command) + 3;
3239 else
3240 len = 30;
3241 p = alloc((unsigned)len);
3242 if (p != NULL)
3244 if (command != NULL)
3245 vim_snprintf((char *)p, len, ":%s\r", command);
3246 else
3247 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3248 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3249 did_set_swapcommand = TRUE;
3250 vim_free(p);
3253 #endif
3256 * If we are starting to edit another file, open a (new) buffer.
3257 * Otherwise we re-use the current buffer.
3259 if (other_file)
3261 #ifdef FEAT_LISTCMDS
3262 if (!(flags & ECMD_ADDBUF))
3263 #endif
3265 if (!cmdmod.keepalt)
3266 curwin->w_alt_fnum = curbuf->b_fnum;
3267 buflist_altfpos();
3270 if (fnum)
3271 buf = buflist_findnr(fnum);
3272 else
3274 #ifdef FEAT_LISTCMDS
3275 if (flags & ECMD_ADDBUF)
3277 linenr_T tlnum = 1L;
3279 if (command != NULL)
3281 tlnum = atol((char *)command);
3282 if (tlnum <= 0)
3283 tlnum = 1L;
3285 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3286 goto theend;
3288 #endif
3289 buf = buflist_new(ffname, sfname, 0L,
3290 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3292 if (buf == NULL)
3293 goto theend;
3294 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3296 oldbuf = FALSE;
3297 buf->b_nwindows = 0;
3299 else /* existing memfile */
3301 oldbuf = TRUE;
3302 (void)buf_check_timestamp(buf, FALSE);
3303 /* Check if autocommands made buffer invalid or changed the current
3304 * buffer. */
3305 if (!buf_valid(buf)
3306 #ifdef FEAT_AUTOCMD
3307 || curbuf != old_curbuf
3308 #endif
3310 goto theend;
3311 #ifdef FEAT_EVAL
3312 if (aborting()) /* autocmds may abort script processing */
3313 goto theend;
3314 #endif
3317 /* May jump to last used line number for a loaded buffer or when asked
3318 * for explicitly */
3319 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3321 pos = buflist_findfpos(buf);
3322 newlnum = pos->lnum;
3323 solcol = pos->col;
3327 * Make the (new) buffer the one used by the current window.
3328 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3329 * If the current buffer was empty and has no file name, curbuf
3330 * is returned by buflist_new().
3332 if (buf != curbuf)
3334 #ifdef FEAT_AUTOCMD
3336 * Be careful: The autocommands may delete any buffer and change
3337 * the current buffer.
3338 * - If the buffer we are going to edit is deleted, give up.
3339 * - If the current buffer is deleted, prefer to load the new
3340 * buffer when loading a buffer is required. This avoids
3341 * loading another buffer which then must be closed again.
3342 * - If we ended up in the new buffer already, need to skip a few
3343 * things, set auto_buf.
3345 if (buf->b_fname != NULL)
3346 new_name = vim_strsave(buf->b_fname);
3347 au_new_curbuf = buf;
3348 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3349 if (!buf_valid(buf)) /* new buffer has been deleted */
3351 delbuf_msg(new_name); /* frees new_name */
3352 goto theend;
3354 # ifdef FEAT_EVAL
3355 if (aborting()) /* autocmds may abort script processing */
3357 vim_free(new_name);
3358 goto theend;
3360 # endif
3361 if (buf == curbuf) /* already in new buffer */
3362 auto_buf = TRUE;
3363 else
3365 if (curbuf == old_curbuf)
3366 #endif
3367 buf_copy_options(buf, BCO_ENTER);
3369 /* close the link to the current buffer */
3370 u_sync(FALSE);
3371 close_buffer(curwin, curbuf,
3372 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3374 #ifdef FEAT_AUTOCMD
3375 # ifdef FEAT_EVAL
3376 if (aborting()) /* autocmds may abort script processing */
3378 vim_free(new_name);
3379 goto theend;
3381 # endif
3382 /* Be careful again, like above. */
3383 if (!buf_valid(buf)) /* new buffer has been deleted */
3385 delbuf_msg(new_name); /* frees new_name */
3386 goto theend;
3388 if (buf == curbuf) /* already in new buffer */
3389 auto_buf = TRUE;
3390 else
3391 #endif
3393 curwin->w_buffer = buf;
3394 curbuf = buf;
3395 ++curbuf->b_nwindows;
3396 /* set 'fileformat' */
3397 if (*p_ffs && !oldbuf)
3398 set_fileformat(default_fileformat(), OPT_LOCAL);
3401 /* May get the window options from the last time this buffer
3402 * was in this window (or another window). If not used
3403 * before, reset the local window options to the global
3404 * values. Also restores old folding stuff. */
3405 get_winopts(curbuf);
3406 #ifdef FEAT_SPELL
3407 did_get_winopts = TRUE;
3408 #endif
3410 #ifdef FEAT_AUTOCMD
3412 vim_free(new_name);
3413 au_new_curbuf = NULL;
3414 #endif
3416 else
3417 ++curbuf->b_nwindows;
3419 curwin->w_pcmark.lnum = 1;
3420 curwin->w_pcmark.col = 0;
3422 else /* !other_file */
3424 if (
3425 #ifdef FEAT_LISTCMDS
3426 (flags & ECMD_ADDBUF) ||
3427 #endif
3428 check_fname() == FAIL)
3429 goto theend;
3430 oldbuf = (flags & ECMD_OLDBUF);
3433 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3435 char_u *p;
3437 curbuf->b_help = TRUE;
3438 #ifdef FEAT_QUICKFIX
3439 set_string_option_direct((char_u *)"buftype", -1,
3440 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3441 #endif
3444 * Always set these options after jumping to a help tag, because the
3445 * user may have an autocommand that gets in the way.
3446 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3447 * latin1 word characters (for translated help files).
3448 * Only set it when needed, buf_init_chartab() is some work.
3451 #ifdef EBCDIC
3452 (char_u *)"65-255,^*,^|,^\"";
3453 #else
3454 (char_u *)"!-~,^*,^|,^\",192-255";
3455 #endif
3456 if (STRCMP(curbuf->b_p_isk, p) != 0)
3458 set_string_option_direct((char_u *)"isk", -1, p,
3459 OPT_FREE|OPT_LOCAL, 0);
3460 check_buf_options(curbuf);
3461 (void)buf_init_chartab(curbuf, FALSE);
3464 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3465 curwin->w_p_list = FALSE; /* no list mode */
3467 curbuf->b_p_ma = FALSE; /* not modifiable */
3468 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3469 curwin->w_p_nu = 0; /* no line numbers */
3470 #ifdef FEAT_SCROLLBIND
3471 curwin->w_p_scb = FALSE; /* no scroll binding */
3472 #endif
3473 #ifdef FEAT_ARABIC
3474 curwin->w_p_arab = FALSE; /* no arabic mode */
3475 #endif
3476 #ifdef FEAT_RIGHTLEFT
3477 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3478 #endif
3479 #ifdef FEAT_FOLDING
3480 curwin->w_p_fen = FALSE; /* No folding in the help window */
3481 #endif
3482 #ifdef FEAT_DIFF
3483 curwin->w_p_diff = FALSE; /* No 'diff' */
3484 #endif
3485 #ifdef FEAT_SPELL
3486 curwin->w_p_spell = FALSE; /* No spell checking */
3487 #endif
3489 #ifdef FEAT_AUTOCMD
3490 buf = curbuf;
3491 #endif
3492 set_buflisted(FALSE);
3494 else
3496 #ifdef FEAT_AUTOCMD
3497 buf = curbuf;
3498 #endif
3499 /* Don't make a buffer listed if it's a help buffer. Useful when
3500 * using CTRL-O to go back to a help file. */
3501 if (!curbuf->b_help)
3502 set_buflisted(TRUE);
3505 #ifdef FEAT_AUTOCMD
3506 /* If autocommands change buffers under our fingers, forget about
3507 * editing the file. */
3508 if (buf != curbuf)
3509 goto theend;
3510 # ifdef FEAT_EVAL
3511 if (aborting()) /* autocmds may abort script processing */
3512 goto theend;
3513 # endif
3515 /* Since we are starting to edit a file, consider the filetype to be
3516 * unset. Helps for when an autocommand changes files and expects syntax
3517 * highlighting to work in the other file. */
3518 did_filetype = FALSE;
3519 #endif
3522 * other_file oldbuf
3523 * FALSE FALSE re-edit same file, buffer is re-used
3524 * FALSE TRUE re-edit same file, nothing changes
3525 * TRUE FALSE start editing new file, new buffer
3526 * TRUE TRUE start editing in existing buffer (nothing to do)
3528 if (!other_file && !oldbuf) /* re-use the buffer */
3530 set_last_cursor(curwin); /* may set b_last_cursor */
3531 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3533 newlnum = curwin->w_cursor.lnum;
3534 solcol = curwin->w_cursor.col;
3536 #ifdef FEAT_AUTOCMD
3537 buf = curbuf;
3538 if (buf->b_fname != NULL)
3539 new_name = vim_strsave(buf->b_fname);
3540 else
3541 new_name = NULL;
3542 #endif
3543 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3544 #ifdef FEAT_AUTOCMD
3545 /* If autocommands deleted the buffer we were going to re-edit, give
3546 * up and jump to the end. */
3547 if (!buf_valid(buf))
3549 delbuf_msg(new_name); /* frees new_name */
3550 goto theend;
3552 vim_free(new_name);
3554 /* If autocommands change buffers under our fingers, forget about
3555 * re-editing the file. Should do the buf_clear_file(), but perhaps
3556 * the autocommands changed the buffer... */
3557 if (buf != curbuf)
3558 goto theend;
3559 # ifdef FEAT_EVAL
3560 if (aborting()) /* autocmds may abort script processing */
3561 goto theend;
3562 # endif
3563 #endif
3564 buf_clear_file(curbuf);
3565 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3566 curbuf->b_op_end.lnum = 0;
3570 * If we get here we are sure to start editing
3572 /* don't redraw until the cursor is in the right line */
3573 ++RedrawingDisabled;
3575 /* Assume success now */
3576 retval = OK;
3579 * Reset cursor position, could be used by autocommands.
3581 check_cursor();
3584 * Check if we are editing the w_arg_idx file in the argument list.
3586 check_arg_idx(curwin);
3588 #ifdef FEAT_AUTOCMD
3589 if (!auto_buf)
3590 #endif
3593 * Set cursor and init window before reading the file and executing
3594 * autocommands. This allows for the autocommands to position the
3595 * cursor.
3597 curwin_init();
3599 #ifdef FEAT_FOLDING
3600 /* It's possible that all lines in the buffer changed. Need to update
3601 * automatic folding for all windows where it's used. */
3602 # ifdef FEAT_WINDOWS
3604 win_T *win;
3605 tabpage_T *tp;
3607 FOR_ALL_TAB_WINDOWS(tp, win)
3608 if (win->w_buffer == curbuf)
3609 foldUpdateAll(win);
3611 # else
3612 foldUpdateAll(curwin);
3613 # endif
3614 #endif
3616 /* Change directories when the 'acd' option is set. */
3617 DO_AUTOCHDIR
3620 * Careful: open_buffer() and apply_autocmds() may change the current
3621 * buffer and window.
3623 lnum = curwin->w_cursor.lnum;
3624 topline = curwin->w_topline;
3625 if (!oldbuf) /* need to read the file */
3627 #if defined(HAS_SWAP_EXISTS_ACTION)
3628 swap_exists_action = SEA_DIALOG;
3629 #endif
3630 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3633 * Open the buffer and read the file.
3635 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3636 if (should_abort(open_buffer(FALSE, eap)))
3637 retval = FAIL;
3638 #else
3639 (void)open_buffer(FALSE, eap);
3640 #endif
3642 #if defined(HAS_SWAP_EXISTS_ACTION)
3643 if (swap_exists_action == SEA_QUIT)
3644 retval = FAIL;
3645 handle_swap_exists(old_curbuf);
3646 #endif
3648 #ifdef FEAT_AUTOCMD
3649 else
3651 /* Read the modelines, but only to set window-local options. Any
3652 * buffer-local options have already been set and may have been
3653 * changed by the user. */
3654 do_modelines(OPT_WINONLY);
3656 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3657 &retval);
3658 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3659 &retval);
3661 check_arg_idx(curwin);
3662 #endif
3665 * If autocommands change the cursor position or topline, we should
3666 * keep it.
3668 if (curwin->w_cursor.lnum != lnum)
3670 newlnum = curwin->w_cursor.lnum;
3671 newcol = curwin->w_cursor.col;
3673 if (curwin->w_topline == topline)
3674 topline = 0;
3676 /* Even when cursor didn't move we need to recompute topline. */
3677 changed_line_abv_curs();
3679 #ifdef FEAT_TITLE
3680 maketitle();
3681 #endif
3684 #ifdef FEAT_DIFF
3685 /* Tell the diff stuff that this buffer is new and/or needs updating.
3686 * Also needed when re-editing the same buffer, because unloading will
3687 * have removed it as a diff buffer. */
3688 if (curwin->w_p_diff)
3690 diff_buf_add(curbuf);
3691 diff_invalidate(curbuf);
3693 #endif
3695 #ifdef FEAT_SPELL
3696 /* If the window options were changed may need to set the spell language.
3697 * Can only do this after the buffer has been properly setup. */
3698 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3699 did_set_spelllang(curbuf);
3700 #endif
3702 if (command == NULL)
3704 if (newcol >= 0) /* position set by autocommands */
3706 curwin->w_cursor.lnum = newlnum;
3707 curwin->w_cursor.col = newcol;
3708 check_cursor();
3710 else if (newlnum > 0) /* line number from caller or old position */
3712 curwin->w_cursor.lnum = newlnum;
3713 check_cursor_lnum();
3714 if (solcol >= 0 && !p_sol)
3716 /* 'sol' is off: Use last known column. */
3717 curwin->w_cursor.col = solcol;
3718 check_cursor_col();
3719 #ifdef FEAT_VIRTUALEDIT
3720 curwin->w_cursor.coladd = 0;
3721 #endif
3722 curwin->w_set_curswant = TRUE;
3724 else
3725 beginline(BL_SOL | BL_FIX);
3727 else /* no line number, go to last line in Ex mode */
3729 if (exmode_active)
3730 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3731 beginline(BL_WHITE | BL_FIX);
3735 #ifdef FEAT_WINDOWS
3736 /* Check if cursors in other windows on the same buffer are still valid */
3737 check_lnums(FALSE);
3738 #endif
3741 * Did not read the file, need to show some info about the file.
3742 * Do this after setting the cursor.
3744 if (oldbuf
3745 #ifdef FEAT_AUTOCMD
3746 && !auto_buf
3747 #endif
3750 int msg_scroll_save = msg_scroll;
3752 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3753 * message. */
3754 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3755 msg_scroll = FALSE;
3756 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3757 check_for_delay(FALSE);
3758 msg_start();
3759 msg_scroll = msg_scroll_save;
3760 msg_scrolled_ign = TRUE;
3762 fileinfo(FALSE, TRUE, FALSE);
3764 msg_scrolled_ign = FALSE;
3767 if (command != NULL)
3768 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3770 #ifdef FEAT_KEYMAP
3771 if (curbuf->b_kmap_state & KEYMAP_INIT)
3772 keymap_init();
3773 #endif
3775 --RedrawingDisabled;
3776 if (!skip_redraw)
3778 n = p_so;
3779 if (topline == 0 && command == NULL)
3780 p_so = 999; /* force cursor halfway the window */
3781 update_topline();
3782 #ifdef FEAT_SCROLLBIND
3783 curwin->w_scbind_pos = curwin->w_topline;
3784 #endif
3785 p_so = n;
3786 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3789 if (p_im)
3790 need_start_insertmode = TRUE;
3792 /* Change directories when the 'acd' option is set. */
3793 DO_AUTOCHDIR
3795 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3796 if (gui.in_use && curbuf->b_ffname != NULL)
3798 # ifdef FEAT_SUN_WORKSHOP
3799 if (usingSunWorkShop)
3800 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3801 # endif
3802 # ifdef FEAT_NETBEANS_INTG
3803 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3804 netbeans_file_opened(curbuf);
3805 # endif
3807 #endif
3809 theend:
3810 #ifdef FEAT_AUTOCMD
3811 if (did_set_swapcommand)
3812 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3813 #endif
3814 #ifdef FEAT_BROWSE
3815 vim_free(browse_file);
3816 #endif
3817 vim_free(free_fname);
3818 return retval;
3821 #ifdef FEAT_AUTOCMD
3822 static void
3823 delbuf_msg(name)
3824 char_u *name;
3826 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3827 name == NULL ? (char_u *)"" : name);
3828 vim_free(name);
3829 au_new_curbuf = NULL;
3831 #endif
3833 static int append_indent = 0; /* autoindent for first line */
3836 * ":insert" and ":append", also used by ":change"
3838 void
3839 ex_append(eap)
3840 exarg_T *eap;
3842 char_u *theline;
3843 int did_undo = FALSE;
3844 linenr_T lnum = eap->line2;
3845 int indent = 0;
3846 char_u *p;
3847 int vcol;
3848 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3850 /* the ! flag toggles autoindent */
3851 if (eap->forceit)
3852 curbuf->b_p_ai = !curbuf->b_p_ai;
3854 /* First autoindent comes from the line we start on */
3855 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3856 append_indent = get_indent_lnum(lnum);
3858 if (eap->cmdidx != CMD_append)
3859 --lnum;
3861 /* when the buffer is empty append to line 0 and delete the dummy line */
3862 if (empty && lnum == 1)
3863 lnum = 0;
3865 State = INSERT; /* behave like in Insert mode */
3866 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3867 State |= LANGMAP;
3869 for (;;)
3871 msg_scroll = TRUE;
3872 need_wait_return = FALSE;
3873 if (curbuf->b_p_ai)
3875 if (append_indent >= 0)
3877 indent = append_indent;
3878 append_indent = -1;
3880 else if (lnum > 0)
3881 indent = get_indent_lnum(lnum);
3883 ex_keep_indent = FALSE;
3884 if (eap->getline == NULL)
3886 /* No getline() function, use the lines that follow. This ends
3887 * when there is no more. */
3888 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3889 break;
3890 p = vim_strchr(eap->nextcmd, NL);
3891 if (p == NULL)
3892 p = eap->nextcmd + STRLEN(eap->nextcmd);
3893 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3894 if (*p != NUL)
3895 ++p;
3896 eap->nextcmd = p;
3898 else
3899 theline = eap->getline(
3900 #ifdef FEAT_EVAL
3901 eap->cstack->cs_looplevel > 0 ? -1 :
3902 #endif
3903 NUL, eap->cookie, indent);
3904 lines_left = Rows - 1;
3905 if (theline == NULL)
3906 break;
3908 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3909 if (ex_keep_indent)
3910 append_indent = indent;
3912 /* Look for the "." after automatic indent. */
3913 vcol = 0;
3914 for (p = theline; indent > vcol; ++p)
3916 if (*p == ' ')
3917 ++vcol;
3918 else if (*p == TAB)
3919 vcol += 8 - vcol % 8;
3920 else
3921 break;
3923 if ((p[0] == '.' && p[1] == NUL)
3924 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3925 == FAIL))
3927 vim_free(theline);
3928 break;
3931 /* don't use autoindent if nothing was typed. */
3932 if (p[0] == NUL)
3933 theline[0] = NUL;
3935 did_undo = TRUE;
3936 ml_append(lnum, theline, (colnr_T)0, FALSE);
3937 appended_lines_mark(lnum, 1L);
3939 vim_free(theline);
3940 ++lnum;
3942 if (empty)
3944 ml_delete(2L, FALSE);
3945 empty = FALSE;
3948 State = NORMAL;
3950 if (eap->forceit)
3951 curbuf->b_p_ai = !curbuf->b_p_ai;
3953 /* "start" is set to eap->line2+1 unless that position is invalid (when
3954 * eap->line2 pointed to the end of the buffer and nothing was appended)
3955 * "end" is set to lnum when something has been appended, otherwise
3956 * it is the same than "start" -- Acevedo */
3957 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3958 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3959 if (eap->cmdidx != CMD_append)
3960 --curbuf->b_op_start.lnum;
3961 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3962 ? lnum : curbuf->b_op_start.lnum;
3963 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3964 curwin->w_cursor.lnum = lnum;
3965 check_cursor_lnum();
3966 beginline(BL_SOL | BL_FIX);
3968 need_wait_return = FALSE; /* don't use wait_return() now */
3969 ex_no_reprint = TRUE;
3973 * ":change"
3975 void
3976 ex_change(eap)
3977 exarg_T *eap;
3979 linenr_T lnum;
3981 if (eap->line2 >= eap->line1
3982 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3983 return;
3985 /* the ! flag toggles autoindent */
3986 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3987 append_indent = get_indent_lnum(eap->line1);
3989 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3991 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3992 break;
3993 ml_delete(eap->line1, FALSE);
3995 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3997 /* ":append" on the line above the deleted lines. */
3998 eap->line2 = eap->line1;
3999 ex_append(eap);
4002 void
4003 ex_z(eap)
4004 exarg_T *eap;
4006 char_u *x;
4007 int bigness;
4008 char_u *kind;
4009 int minus = 0;
4010 linenr_T start, end, curs, i;
4011 int j;
4012 linenr_T lnum = eap->line2;
4014 /* Vi compatible: ":z!" uses display height, without a count uses
4015 * 'scroll' */
4016 if (eap->forceit)
4017 bigness = curwin->w_height;
4018 else if (firstwin == lastwin)
4019 bigness = curwin->w_p_scr * 2;
4020 else
4021 bigness = curwin->w_height - 3;
4022 if (bigness < 1)
4023 bigness = 1;
4025 x = eap->arg;
4026 kind = x;
4027 if (*kind == '-' || *kind == '+' || *kind == '='
4028 || *kind == '^' || *kind == '.')
4029 ++x;
4030 while (*x == '-' || *x == '+')
4031 ++x;
4033 if (*x != 0)
4035 if (!VIM_ISDIGIT(*x))
4037 EMSG(_("E144: non-numeric argument to :z"));
4038 return;
4040 else
4042 bigness = atoi((char *)x);
4043 p_window = bigness;
4044 if (*kind == '=')
4045 bigness += 2;
4049 /* the number of '-' and '+' multiplies the distance */
4050 if (*kind == '-' || *kind == '+')
4051 for (x = kind + 1; *x == *kind; ++x)
4054 switch (*kind)
4056 case '-':
4057 start = lnum - bigness * (linenr_T)(x - kind);
4058 end = start + bigness;
4059 curs = end;
4060 break;
4062 case '=':
4063 start = lnum - (bigness + 1) / 2 + 1;
4064 end = lnum + (bigness + 1) / 2 - 1;
4065 curs = lnum;
4066 minus = 1;
4067 break;
4069 case '^':
4070 start = lnum - bigness * 2;
4071 end = lnum - bigness;
4072 curs = lnum - bigness;
4073 break;
4075 case '.':
4076 start = lnum - (bigness + 1) / 2 + 1;
4077 end = lnum + (bigness + 1) / 2 - 1;
4078 curs = end;
4079 break;
4081 default: /* '+' */
4082 start = lnum;
4083 if (*kind == '+')
4084 start += bigness * (linenr_T)(x - kind - 1) + 1;
4085 else if (eap->addr_count == 0)
4086 ++start;
4087 end = start + bigness - 1;
4088 curs = end;
4089 break;
4092 if (start < 1)
4093 start = 1;
4095 if (end > curbuf->b_ml.ml_line_count)
4096 end = curbuf->b_ml.ml_line_count;
4098 if (curs > curbuf->b_ml.ml_line_count)
4099 curs = curbuf->b_ml.ml_line_count;
4101 for (i = start; i <= end; i++)
4103 if (minus && i == lnum)
4105 msg_putchar('\n');
4107 for (j = 1; j < Columns; j++)
4108 msg_putchar('-');
4111 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4113 if (minus && i == lnum)
4115 msg_putchar('\n');
4117 for (j = 1; j < Columns; j++)
4118 msg_putchar('-');
4122 curwin->w_cursor.lnum = curs;
4123 ex_no_reprint = TRUE;
4127 * Check if the restricted flag is set.
4128 * If so, give an error message and return TRUE.
4129 * Otherwise, return FALSE.
4132 check_restricted()
4134 if (restricted)
4136 EMSG(_("E145: Shell commands not allowed in rvim"));
4137 return TRUE;
4139 return FALSE;
4143 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4144 * If so, give an error message and return TRUE.
4145 * Otherwise, return FALSE.
4148 check_secure()
4150 if (secure)
4152 secure = 2;
4153 EMSG(_(e_curdir));
4154 return TRUE;
4156 #ifdef HAVE_SANDBOX
4158 * In the sandbox more things are not allowed, including the things
4159 * disallowed in secure mode.
4161 if (sandbox != 0)
4163 EMSG(_(e_sandbox));
4164 return TRUE;
4166 #endif
4167 return FALSE;
4170 static char_u *old_sub = NULL; /* previous substitute pattern */
4171 static int global_need_beginline; /* call beginline() after ":g" */
4173 /* do_sub()
4175 * Perform a substitution from line eap->line1 to line eap->line2 using the
4176 * command pointed to by eap->arg which should be of the form:
4178 * /pattern/substitution/{flags}
4180 * The usual escapes are supported as described in the regexp docs.
4182 void
4183 do_sub(eap)
4184 exarg_T *eap;
4186 linenr_T lnum;
4187 long i = 0;
4188 regmmatch_T regmatch;
4189 static int do_all = FALSE; /* do multiple substitutions per line */
4190 static int do_ask = FALSE; /* ask for confirmation */
4191 static int do_count = FALSE; /* count only */
4192 static int do_error = TRUE; /* if false, ignore errors */
4193 static int do_print = FALSE; /* print last line with subs. */
4194 static int do_list = FALSE; /* list last line with subs. */
4195 static int do_number = FALSE; /* list last line with line nr*/
4196 static int do_ic = 0; /* ignore case flag */
4197 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4198 int delimiter;
4199 int sublen;
4200 int got_quit = FALSE;
4201 int got_match = FALSE;
4202 int temp;
4203 int which_pat;
4204 char_u *cmd;
4205 int save_State;
4206 linenr_T first_line = 0; /* first changed line */
4207 linenr_T last_line= 0; /* below last changed line AFTER the
4208 * change */
4209 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4210 linenr_T line2;
4211 long nmatch; /* number of lines in match */
4212 char_u *sub_firstline; /* allocated copy of first sub line */
4213 int endcolumn = FALSE; /* cursor in last column when done */
4214 pos_T old_cursor = curwin->w_cursor;
4216 cmd = eap->arg;
4217 if (!global_busy)
4219 sub_nsubs = 0;
4220 sub_nlines = 0;
4223 if (eap->cmdidx == CMD_tilde)
4224 which_pat = RE_LAST; /* use last used regexp */
4225 else
4226 which_pat = RE_SUBST; /* use last substitute regexp */
4228 /* new pattern and substitution */
4229 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4230 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4232 /* don't accept alphanumeric for separator */
4233 if (isalpha(*cmd))
4235 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4236 return;
4239 * undocumented vi feature:
4240 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4241 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4243 if (*cmd == '\\')
4245 ++cmd;
4246 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4248 EMSG(_(e_backslash));
4249 return;
4251 if (*cmd != '&')
4252 which_pat = RE_SEARCH; /* use last '/' pattern */
4253 pat = (char_u *)""; /* empty search pattern */
4254 delimiter = *cmd++; /* remember delimiter character */
4256 else /* find the end of the regexp */
4258 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4259 if (p_altkeymap && curwin->w_p_rl)
4260 lrF_sub(cmd);
4261 #endif
4262 which_pat = RE_LAST; /* use last used regexp */
4263 delimiter = *cmd++; /* remember delimiter character */
4264 pat = cmd; /* remember start of search pat */
4265 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4266 if (cmd[0] == delimiter) /* end delimiter found */
4267 *cmd++ = NUL; /* replace it with a NUL */
4271 * Small incompatibility: vi sees '\n' as end of the command, but in
4272 * Vim we want to use '\n' to find/substitute a NUL.
4274 sub = cmd; /* remember the start of the substitution */
4276 while (cmd[0])
4278 if (cmd[0] == delimiter) /* end delimiter found */
4280 *cmd++ = NUL; /* replace it with a NUL */
4281 break;
4283 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4284 ++cmd;
4285 mb_ptr_adv(cmd);
4288 if (!eap->skip)
4290 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4291 if (STRCMP(sub, "%") == 0
4292 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4294 if (old_sub == NULL) /* there is no previous command */
4296 EMSG(_(e_nopresub));
4297 return;
4299 sub = old_sub;
4301 else
4303 vim_free(old_sub);
4304 old_sub = vim_strsave(sub);
4308 else if (!eap->skip) /* use previous pattern and substitution */
4310 if (old_sub == NULL) /* there is no previous command */
4312 EMSG(_(e_nopresub));
4313 return;
4315 pat = NULL; /* search_regcomp() will use previous pattern */
4316 sub = old_sub;
4318 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4319 * last column after using "$". */
4320 endcolumn = (curwin->w_curswant == MAXCOL);
4324 * Find trailing options. When '&' is used, keep old options.
4326 if (*cmd == '&')
4327 ++cmd;
4328 else
4330 if (!p_ed)
4332 if (p_gd) /* default is global on */
4333 do_all = TRUE;
4334 else
4335 do_all = FALSE;
4336 do_ask = FALSE;
4338 do_error = TRUE;
4339 do_print = FALSE;
4340 do_count = FALSE;
4341 do_number = FALSE;
4342 do_ic = 0;
4344 while (*cmd)
4347 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4348 * 'r' is never inverted.
4350 if (*cmd == 'g')
4351 do_all = !do_all;
4352 else if (*cmd == 'c')
4353 do_ask = !do_ask;
4354 else if (*cmd == 'n')
4355 do_count = TRUE;
4356 else if (*cmd == 'e')
4357 do_error = !do_error;
4358 else if (*cmd == 'r') /* use last used regexp */
4359 which_pat = RE_LAST;
4360 else if (*cmd == 'p')
4361 do_print = TRUE;
4362 else if (*cmd == '#')
4364 do_print = TRUE;
4365 do_number = TRUE;
4367 else if (*cmd == 'l')
4369 do_print = TRUE;
4370 do_list = TRUE;
4372 else if (*cmd == 'i') /* ignore case */
4373 do_ic = 'i';
4374 else if (*cmd == 'I') /* don't ignore case */
4375 do_ic = 'I';
4376 else
4377 break;
4378 ++cmd;
4380 if (do_count)
4381 do_ask = FALSE;
4384 * check for a trailing count
4386 cmd = skipwhite(cmd);
4387 if (VIM_ISDIGIT(*cmd))
4389 i = getdigits(&cmd);
4390 if (i <= 0 && !eap->skip && do_error)
4392 EMSG(_(e_zerocount));
4393 return;
4395 eap->line1 = eap->line2;
4396 eap->line2 += i - 1;
4397 if (eap->line2 > curbuf->b_ml.ml_line_count)
4398 eap->line2 = curbuf->b_ml.ml_line_count;
4402 * check for trailing command or garbage
4404 cmd = skipwhite(cmd);
4405 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4407 eap->nextcmd = check_nextcmd(cmd);
4408 if (eap->nextcmd == NULL)
4410 EMSG(_(e_trailing));
4411 return;
4415 if (eap->skip) /* not executing commands, only parsing */
4416 return;
4418 if (!do_count && !curbuf->b_p_ma)
4420 /* Substitution is not allowed in non-'modifiable' buffer */
4421 EMSG(_(e_modifiable));
4422 return;
4425 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4427 if (do_error)
4428 EMSG(_(e_invcmd));
4429 return;
4432 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4433 if (do_ic == 'i')
4434 regmatch.rmm_ic = TRUE;
4435 else if (do_ic == 'I')
4436 regmatch.rmm_ic = FALSE;
4438 sub_firstline = NULL;
4441 * ~ in the substitute pattern is replaced with the old pattern.
4442 * We do it here once to avoid it to be replaced over and over again.
4443 * But don't do it when it starts with "\=", then it's an expression.
4445 if (!(sub[0] == '\\' && sub[1] == '='))
4446 sub = regtilde(sub, p_magic);
4449 * Check for a match on each line.
4451 line2 = eap->line2;
4452 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4453 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4454 || aborting()
4455 #endif
4456 ); ++lnum)
4458 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4459 (colnr_T)0, NULL);
4460 if (nmatch)
4462 colnr_T copycol;
4463 colnr_T matchcol;
4464 colnr_T prev_matchcol = MAXCOL;
4465 char_u *new_end, *new_start = NULL;
4466 unsigned new_start_len = 0;
4467 char_u *p1;
4468 int did_sub = FALSE;
4469 int lastone;
4470 unsigned len, needed_len;
4471 long nmatch_tl = 0; /* nr of lines matched below lnum */
4472 int do_again; /* do it again after joining lines */
4473 int skip_match = FALSE;
4474 linenr_T sub_firstlnum; /* nr of first sub line */
4477 * The new text is build up step by step, to avoid too much
4478 * copying. There are these pieces:
4479 * sub_firstline The old text, unmodified.
4480 * copycol Column in the old text where we started
4481 * looking for a match; from here old text still
4482 * needs to be copied to the new text.
4483 * matchcol Column number of the old text where to look
4484 * for the next match. It's just after the
4485 * previous match or one further.
4486 * prev_matchcol Column just after the previous match (if any).
4487 * Mostly equal to matchcol, except for the first
4488 * match and after skipping an empty match.
4489 * regmatch.*pos Where the pattern matched in the old text.
4490 * new_start The new text, all that has been produced so
4491 * far.
4492 * new_end The new text, where to append new text.
4494 * lnum The line number where we found the start of
4495 * the match. Can be below the line we searched
4496 * when there is a \n before a \zs in the
4497 * pattern.
4498 * sub_firstlnum The line number in the buffer where to look
4499 * for a match. Can be different from "lnum"
4500 * when the pattern or substitute string contains
4501 * line breaks.
4503 * Special situations:
4504 * - When the substitute string contains a line break, the part up
4505 * to the line break is inserted in the text, but the copy of
4506 * the original line is kept. "sub_firstlnum" is adjusted for
4507 * the inserted lines.
4508 * - When the matched pattern contains a line break, the old line
4509 * is taken from the line at the end of the pattern. The lines
4510 * in the match are deleted later, "sub_firstlnum" is adjusted
4511 * accordingly.
4513 * The new text is built up in new_start[]. It has some extra
4514 * room to avoid using alloc()/free() too often. new_start_len is
4515 * the length of the allocated memory at new_start.
4517 * Make a copy of the old line, so it won't be taken away when
4518 * updating the screen or handling a multi-line match. The "old_"
4519 * pointers point into this copy.
4521 sub_firstlnum = lnum;
4522 copycol = 0;
4523 matchcol = 0;
4525 /* At first match, remember current cursor position. */
4526 if (!got_match)
4528 setpcmark();
4529 got_match = TRUE;
4533 * Loop until nothing more to replace in this line.
4534 * 1. Handle match with empty string.
4535 * 2. If do_ask is set, ask for confirmation.
4536 * 3. substitute the string.
4537 * 4. if do_all is set, find next match
4538 * 5. break if there isn't another match in this line
4540 for (;;)
4542 /* Advance "lnum" to the line where the match starts. The
4543 * match does not start in the first line when there is a line
4544 * break before \zs. */
4545 if (regmatch.startpos[0].lnum > 0)
4547 lnum += regmatch.startpos[0].lnum;
4548 sub_firstlnum += regmatch.startpos[0].lnum;
4549 nmatch -= regmatch.startpos[0].lnum;
4550 vim_free(sub_firstline);
4551 sub_firstline = NULL;
4554 if (sub_firstline == NULL)
4556 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4557 if (sub_firstline == NULL)
4559 vim_free(new_start);
4560 goto outofmem;
4564 /* Save the line number of the last change for the final
4565 * cursor position (just like Vi). */
4566 curwin->w_cursor.lnum = lnum;
4567 do_again = FALSE;
4570 * 1. Match empty string does not count, except for first
4571 * match. This reproduces the strange vi behaviour.
4572 * This also catches endless loops.
4574 if (matchcol == prev_matchcol
4575 && regmatch.endpos[0].lnum == 0
4576 && matchcol == regmatch.endpos[0].col)
4578 if (sub_firstline[matchcol] == NUL)
4579 /* We already were at the end of the line. Don't look
4580 * for a match in this line again. */
4581 skip_match = TRUE;
4582 else
4583 ++matchcol; /* search for a match at next column */
4584 goto skip;
4587 /* Normally we continue searching for a match just after the
4588 * previous match. */
4589 matchcol = regmatch.endpos[0].col;
4590 prev_matchcol = matchcol;
4593 * 2. If do_count is set only increase the counter.
4594 * If do_ask is set, ask for confirmation.
4596 if (do_count)
4598 /* For a multi-line match, put matchcol at the NUL at
4599 * the end of the line and set nmatch to one, so that
4600 * we continue looking for a match on the next line.
4601 * Avoids that ":s/\nB\@=//gc" get stuck. */
4602 if (nmatch > 1)
4604 matchcol = (colnr_T)STRLEN(sub_firstline);
4605 nmatch = 1;
4606 skip_match = TRUE;
4608 sub_nsubs++;
4609 did_sub = TRUE;
4610 goto skip;
4613 if (do_ask)
4615 /* change State to CONFIRM, so that the mouse works
4616 * properly */
4617 save_State = State;
4618 State = CONFIRM;
4619 #ifdef FEAT_MOUSE
4620 setmouse(); /* disable mouse in xterm */
4621 #endif
4622 curwin->w_cursor.col = regmatch.startpos[0].col;
4624 /* When 'cpoptions' contains "u" don't sync undo when
4625 * asking for confirmation. */
4626 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4627 ++no_u_sync;
4630 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4632 while (do_ask)
4634 if (exmode_active)
4636 char_u *resp;
4637 colnr_T sc, ec;
4639 print_line_no_prefix(lnum, FALSE, FALSE);
4641 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4642 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4643 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4644 msg_start();
4645 for (i = 0; i < (long)sc; ++i)
4646 msg_putchar(' ');
4647 for ( ; i <= (long)ec; ++i)
4648 msg_putchar('^');
4650 resp = getexmodeline('?', NULL, 0);
4651 if (resp != NULL)
4653 i = *resp;
4654 vim_free(resp);
4657 else
4659 #ifdef FEAT_FOLDING
4660 int save_p_fen = curwin->w_p_fen;
4662 curwin->w_p_fen = FALSE;
4663 #endif
4664 /* Invert the matched string.
4665 * Remove the inversion afterwards. */
4666 temp = RedrawingDisabled;
4667 RedrawingDisabled = 0;
4669 search_match_lines = regmatch.endpos[0].lnum
4670 - regmatch.startpos[0].lnum;
4671 search_match_endcol = regmatch.endpos[0].col;
4672 highlight_match = TRUE;
4674 update_topline();
4675 validate_cursor();
4676 update_screen(SOME_VALID);
4677 highlight_match = FALSE;
4678 redraw_later(SOME_VALID);
4680 #ifdef FEAT_FOLDING
4681 curwin->w_p_fen = save_p_fen;
4682 #endif
4683 if (msg_row == Rows - 1)
4684 msg_didout = FALSE; /* avoid a scroll-up */
4685 msg_starthere();
4686 i = msg_scroll;
4687 msg_scroll = 0; /* truncate msg when
4688 needed */
4689 msg_no_more = TRUE;
4690 /* write message same highlighting as for
4691 * wait_return */
4692 smsg_attr(hl_attr(HLF_R),
4693 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4694 msg_no_more = FALSE;
4695 msg_scroll = i;
4696 showruler(TRUE);
4697 windgoto(msg_row, msg_col);
4698 RedrawingDisabled = temp;
4700 #ifdef USE_ON_FLY_SCROLL
4701 dont_scroll = FALSE; /* allow scrolling here */
4702 #endif
4703 ++no_mapping; /* don't map this key */
4704 ++allow_keys; /* allow special keys */
4705 i = plain_vgetc();
4706 --allow_keys;
4707 --no_mapping;
4709 /* clear the question */
4710 msg_didout = FALSE; /* don't scroll up */
4711 msg_col = 0;
4712 gotocmdline(TRUE);
4715 need_wait_return = FALSE; /* no hit-return prompt */
4716 if (i == 'q' || i == ESC || i == Ctrl_C
4717 #ifdef UNIX
4718 || i == intr_char
4719 #endif
4722 got_quit = TRUE;
4723 break;
4725 if (i == 'n')
4726 break;
4727 if (i == 'y')
4728 break;
4729 if (i == 'l')
4731 /* last: replace and then stop */
4732 do_all = FALSE;
4733 line2 = lnum;
4734 break;
4736 if (i == 'a')
4738 do_ask = FALSE;
4739 break;
4741 #ifdef FEAT_INS_EXPAND
4742 if (i == Ctrl_E)
4743 scrollup_clamp();
4744 else if (i == Ctrl_Y)
4745 scrolldown_clamp();
4746 #endif
4748 State = save_State;
4749 #ifdef FEAT_MOUSE
4750 setmouse();
4751 #endif
4752 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4753 --no_u_sync;
4755 if (i == 'n')
4757 /* For a multi-line match, put matchcol at the NUL at
4758 * the end of the line and set nmatch to one, so that
4759 * we continue looking for a match on the next line.
4760 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4761 * get stuck when pressing 'n'. */
4762 if (nmatch > 1)
4764 matchcol = (colnr_T)STRLEN(sub_firstline);
4765 skip_match = TRUE;
4767 goto skip;
4769 if (got_quit)
4770 break;
4773 /* Move the cursor to the start of the match, so that we can
4774 * use "\=col("."). */
4775 curwin->w_cursor.col = regmatch.startpos[0].col;
4778 * 3. substitute the string.
4780 /* get length of substitution part */
4781 sublen = vim_regsub_multi(&regmatch,
4782 sub_firstlnum - regmatch.startpos[0].lnum,
4783 sub, sub_firstline, FALSE, p_magic, TRUE);
4785 /* When the match included the "$" of the last line it may
4786 * go beyond the last line of the buffer. */
4787 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4789 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4790 skip_match = TRUE;
4793 /* Need room for:
4794 * - result so far in new_start (not for first sub in line)
4795 * - original text up to match
4796 * - length of substituted part
4797 * - original text after match
4799 if (nmatch == 1)
4800 p1 = sub_firstline;
4801 else
4803 p1 = ml_get(sub_firstlnum + nmatch - 1);
4804 nmatch_tl += nmatch - 1;
4806 i = regmatch.startpos[0].col - copycol;
4807 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4808 + sublen + 1;
4809 if (new_start == NULL)
4812 * Get some space for a temporary buffer to do the
4813 * substitution into (and some extra space to avoid
4814 * too many calls to alloc()/free()).
4816 new_start_len = needed_len + 50;
4817 if ((new_start = alloc_check(new_start_len)) == NULL)
4818 goto outofmem;
4819 *new_start = NUL;
4820 new_end = new_start;
4822 else
4825 * Check if the temporary buffer is long enough to do the
4826 * substitution into. If not, make it larger (with a bit
4827 * extra to avoid too many calls to alloc()/free()).
4829 len = (unsigned)STRLEN(new_start);
4830 needed_len += len;
4831 if (needed_len > new_start_len)
4833 new_start_len = needed_len + 50;
4834 if ((p1 = alloc_check(new_start_len)) == NULL)
4836 vim_free(new_start);
4837 goto outofmem;
4839 mch_memmove(p1, new_start, (size_t)(len + 1));
4840 vim_free(new_start);
4841 new_start = p1;
4843 new_end = new_start + len;
4847 * copy the text up to the part that matched
4849 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4850 new_end += i;
4852 (void)vim_regsub_multi(&regmatch,
4853 sub_firstlnum - regmatch.startpos[0].lnum,
4854 sub, new_end, TRUE, p_magic, TRUE);
4855 sub_nsubs++;
4856 did_sub = TRUE;
4858 /* Move the cursor to the start of the line, to avoid that it
4859 * is beyond the end of the line after the substitution. */
4860 curwin->w_cursor.col = 0;
4862 /* For a multi-line match, make a copy of the last matched
4863 * line and continue in that one. */
4864 if (nmatch > 1)
4866 sub_firstlnum += nmatch - 1;
4867 vim_free(sub_firstline);
4868 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4869 /* When going beyond the last line, stop substituting. */
4870 if (sub_firstlnum <= line2)
4871 do_again = TRUE;
4872 else
4873 do_all = FALSE;
4876 /* Remember next character to be copied. */
4877 copycol = regmatch.endpos[0].col;
4879 if (skip_match)
4881 /* Already hit end of the buffer, sub_firstlnum is one
4882 * less than what it ought to be. */
4883 vim_free(sub_firstline);
4884 sub_firstline = vim_strsave((char_u *)"");
4885 copycol = 0;
4889 * Now the trick is to replace CTRL-M chars with a real line
4890 * break. This would make it impossible to insert a CTRL-M in
4891 * the text. The line break can be avoided by preceding the
4892 * CTRL-M with a backslash. To be able to insert a backslash,
4893 * they must be doubled in the string and are halved here.
4894 * That is Vi compatible.
4896 for (p1 = new_end; *p1; ++p1)
4898 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4899 STRMOVE(p1, p1 + 1);
4900 else if (*p1 == CAR)
4902 if (u_inssub(lnum) == OK) /* prepare for undo */
4904 *p1 = NUL; /* truncate up to the CR */
4905 ml_append(lnum - 1, new_start,
4906 (colnr_T)(p1 - new_start + 1), FALSE);
4907 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4908 if (do_ask)
4909 appended_lines(lnum - 1, 1L);
4910 else
4912 if (first_line == 0)
4913 first_line = lnum;
4914 last_line = lnum + 1;
4916 /* All line numbers increase. */
4917 ++sub_firstlnum;
4918 ++lnum;
4919 ++line2;
4920 /* move the cursor to the new line, like Vi */
4921 ++curwin->w_cursor.lnum;
4922 /* copy the rest */
4923 STRMOVE(new_start, p1 + 1);
4924 p1 = new_start - 1;
4927 #ifdef FEAT_MBYTE
4928 else if (has_mbyte)
4929 p1 += (*mb_ptr2len)(p1) - 1;
4930 #endif
4934 * 4. If do_all is set, find next match.
4935 * Prevent endless loop with patterns that match empty
4936 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4937 * But ":s/\n/#/" is OK.
4939 skip:
4940 /* We already know that we did the last subst when we are at
4941 * the end of the line, except that a pattern like
4942 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4943 * "line2" when there is a \zs in the pattern after a line
4944 * break. */
4945 lastone = (skip_match
4946 || got_int
4947 || got_quit
4948 || lnum > line2
4949 || !(do_all || do_again)
4950 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4951 && !re_multiline(regmatch.regprog)));
4952 nmatch = -1;
4955 * Replace the line in the buffer when needed. This is
4956 * skipped when there are more matches.
4957 * The check for nmatch_tl is needed for when multi-line
4958 * matching must replace the lines before trying to do another
4959 * match, otherwise "\@<=" won't work.
4960 * When asking the user we like to show the already replaced
4961 * text, but don't do it when "\<@=" or "\<@!" is used, it
4962 * changes what matches.
4963 * When the match starts below where we start searching also
4964 * need to replace the line first (using \zs after \n).
4966 if (lastone
4967 || (do_ask && !re_lookbehind(regmatch.regprog))
4968 || nmatch_tl > 0
4969 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4970 curbuf, sub_firstlnum,
4971 matchcol, NULL)) == 0
4972 || regmatch.startpos[0].lnum > 0)
4974 if (new_start != NULL)
4977 * Copy the rest of the line, that didn't match.
4978 * "matchcol" has to be adjusted, we use the end of
4979 * the line as reference, because the substitute may
4980 * have changed the number of characters. Same for
4981 * "prev_matchcol".
4983 STRCAT(new_start, sub_firstline + copycol);
4984 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4985 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4986 - prev_matchcol;
4988 if (u_savesub(lnum) != OK)
4989 break;
4990 ml_replace(lnum, new_start, TRUE);
4992 if (nmatch_tl > 0)
4995 * Matched lines have now been substituted and are
4996 * useless, delete them. The part after the match
4997 * has been appended to new_start, we don't need
4998 * it in the buffer.
5000 ++lnum;
5001 if (u_savedel(lnum, nmatch_tl) != OK)
5002 break;
5003 for (i = 0; i < nmatch_tl; ++i)
5004 ml_delete(lnum, (int)FALSE);
5005 mark_adjust(lnum, lnum + nmatch_tl - 1,
5006 (long)MAXLNUM, -nmatch_tl);
5007 if (do_ask)
5008 deleted_lines(lnum, nmatch_tl);
5009 --lnum;
5010 line2 -= nmatch_tl; /* nr of lines decreases */
5011 nmatch_tl = 0;
5014 /* When asking, undo is saved each time, must also set
5015 * changed flag each time. */
5016 if (do_ask)
5017 changed_bytes(lnum, 0);
5018 else
5020 if (first_line == 0)
5021 first_line = lnum;
5022 last_line = lnum + 1;
5025 sub_firstlnum = lnum;
5026 vim_free(sub_firstline); /* free the temp buffer */
5027 sub_firstline = new_start;
5028 new_start = NULL;
5029 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5030 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5031 - prev_matchcol;
5032 copycol = 0;
5034 if (nmatch == -1 && !lastone)
5035 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
5036 sub_firstlnum, matchcol, NULL);
5039 * 5. break if there isn't another match in this line
5041 if (nmatch <= 0)
5043 /* If the match found didn't start where we were
5044 * searching, do the next search in the line where we
5045 * found the match. */
5046 if (nmatch == -1)
5047 lnum -= regmatch.startpos[0].lnum;
5048 break;
5052 line_breakcheck();
5055 if (did_sub)
5056 ++sub_nlines;
5057 vim_free(sub_firstline); /* free the copy of the original line */
5058 sub_firstline = NULL;
5061 line_breakcheck();
5064 if (first_line != 0)
5066 /* Need to subtract the number of added lines from "last_line" to get
5067 * the line number before the change (same as adding the number of
5068 * deleted lines). */
5069 i = curbuf->b_ml.ml_line_count - old_line_count;
5070 changed_lines(first_line, 0, last_line - i, i);
5073 outofmem:
5074 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5076 /* ":s/pat//n" doesn't move the cursor */
5077 if (do_count)
5078 curwin->w_cursor = old_cursor;
5080 if (sub_nsubs)
5082 /* Set the '[ and '] marks. */
5083 curbuf->b_op_start.lnum = eap->line1;
5084 curbuf->b_op_end.lnum = line2;
5085 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5087 if (!global_busy)
5089 if (endcolumn)
5090 coladvance((colnr_T)MAXCOL);
5091 else
5092 beginline(BL_WHITE | BL_FIX);
5093 if (!do_sub_msg(do_count) && do_ask)
5094 MSG("");
5096 else
5097 global_need_beginline = TRUE;
5098 if (do_print)
5099 print_line(curwin->w_cursor.lnum, do_number, do_list);
5101 else if (!global_busy)
5103 if (got_int) /* interrupted */
5104 EMSG(_(e_interr));
5105 else if (got_match) /* did find something but nothing substituted */
5106 MSG("");
5107 else if (do_error) /* nothing found */
5108 EMSG2(_(e_patnotf2), get_search_pat());
5111 vim_free(regmatch.regprog);
5115 * Give message for number of substitutions.
5116 * Can also be used after a ":global" command.
5117 * Return TRUE if a message was given.
5120 do_sub_msg(count_only)
5121 int count_only; /* used 'n' flag for ":s" */
5123 int len = 0;
5126 * Only report substitutions when:
5127 * - more than 'report' substitutions
5128 * - command was typed by user, or number of changed lines > 'report'
5129 * - giving messages is not disabled by 'lazyredraw'
5131 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5132 || count_only)
5133 && messaging())
5135 if (got_int)
5137 STRCPY(msg_buf, _("(Interrupted) "));
5138 len = (int)STRLEN(msg_buf);
5140 if (sub_nsubs == 1)
5141 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5142 "%s", count_only ? _("1 match") : _("1 substitution"));
5143 else
5144 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5145 count_only ? _("%ld matches") : _("%ld substitutions"),
5146 sub_nsubs);
5147 len = (int)STRLEN(msg_buf);
5148 if (sub_nlines == 1)
5149 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5150 "%s", _(" on 1 line"));
5151 else
5152 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5153 _(" on %ld lines"), (long)sub_nlines);
5154 if (msg(msg_buf))
5155 /* save message to display it after redraw */
5156 set_keep_msg(msg_buf, 0);
5157 return TRUE;
5159 if (got_int)
5161 EMSG(_(e_interr));
5162 return TRUE;
5164 return FALSE;
5168 * Execute a global command of the form:
5170 * g/pattern/X : execute X on all lines where pattern matches
5171 * v/pattern/X : execute X on all lines where pattern does not match
5173 * where 'X' is an EX command
5175 * The command character (as well as the trailing slash) is optional, and
5176 * is assumed to be 'p' if missing.
5178 * This is implemented in two passes: first we scan the file for the pattern and
5179 * set a mark for each line that (not) matches. secondly we execute the command
5180 * for each line that has a mark. This is required because after deleting
5181 * lines we do not know where to search for the next match.
5183 void
5184 ex_global(eap)
5185 exarg_T *eap;
5187 linenr_T lnum; /* line number according to old situation */
5188 int ndone = 0;
5189 int type; /* first char of cmd: 'v' or 'g' */
5190 char_u *cmd; /* command argument */
5192 char_u delim; /* delimiter, normally '/' */
5193 char_u *pat;
5194 regmmatch_T regmatch;
5195 int match;
5196 int which_pat;
5198 if (global_busy)
5200 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5201 return;
5204 if (eap->forceit) /* ":global!" is like ":vglobal" */
5205 type = 'v';
5206 else
5207 type = *eap->cmd;
5208 cmd = eap->arg;
5209 which_pat = RE_LAST; /* default: use last used regexp */
5210 sub_nsubs = 0;
5211 sub_nlines = 0;
5214 * undocumented vi feature:
5215 * "\/" and "\?": use previous search pattern.
5216 * "\&": use previous substitute pattern.
5218 if (*cmd == '\\')
5220 ++cmd;
5221 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5223 EMSG(_(e_backslash));
5224 return;
5226 if (*cmd == '&')
5227 which_pat = RE_SUBST; /* use previous substitute pattern */
5228 else
5229 which_pat = RE_SEARCH; /* use previous search pattern */
5230 ++cmd;
5231 pat = (char_u *)"";
5233 else if (*cmd == NUL)
5235 EMSG(_("E148: Regular expression missing from global"));
5236 return;
5238 else
5240 delim = *cmd; /* get the delimiter */
5241 if (delim)
5242 ++cmd; /* skip delimiter if there is one */
5243 pat = cmd; /* remember start of pattern */
5244 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5245 if (cmd[0] == delim) /* end delimiter found */
5246 *cmd++ = NUL; /* replace it with a NUL */
5249 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5250 if (p_altkeymap && curwin->w_p_rl)
5251 lrFswap(pat,0);
5252 #endif
5254 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5256 EMSG(_(e_invcmd));
5257 return;
5261 * pass 1: set marks for each (not) matching line
5263 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5265 /* a match on this line? */
5266 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5267 (colnr_T)0, NULL);
5268 if ((type == 'g' && match) || (type == 'v' && !match))
5270 ml_setmarked(lnum);
5271 ndone++;
5273 line_breakcheck();
5277 * pass 2: execute the command for each line that has been marked
5279 if (got_int)
5280 MSG(_(e_interr));
5281 else if (ndone == 0)
5283 if (type == 'v')
5284 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5285 else
5286 smsg((char_u *)_(e_patnotf2), pat);
5288 else
5289 global_exe(cmd);
5291 ml_clearmarked(); /* clear rest of the marks */
5292 vim_free(regmatch.regprog);
5296 * Execute "cmd" on lines marked with ml_setmarked().
5298 void
5299 global_exe(cmd)
5300 char_u *cmd;
5302 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5303 linenr_T lnum; /* line number according to old situation */
5306 * Set current position only once for a global command.
5307 * If global_busy is set, setpcmark() will not do anything.
5308 * If there is an error, global_busy will be incremented.
5310 setpcmark();
5312 /* When the command writes a message, don't overwrite the command. */
5313 msg_didout = TRUE;
5315 global_need_beginline = FALSE;
5316 global_busy = 1;
5317 old_lcount = curbuf->b_ml.ml_line_count;
5318 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5320 curwin->w_cursor.lnum = lnum;
5321 curwin->w_cursor.col = 0;
5322 if (*cmd == NUL || *cmd == '\n')
5323 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5324 else
5325 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5326 ui_breakcheck();
5329 global_busy = 0;
5330 if (global_need_beginline)
5331 beginline(BL_WHITE | BL_FIX);
5332 else
5333 check_cursor(); /* cursor may be beyond the end of the line */
5335 /* the cursor may not have moved in the text but a change in a previous
5336 * line may move it on the screen */
5337 changed_line_abv_curs();
5339 /* If it looks like no message was written, allow overwriting the
5340 * command with the report for number of changes. */
5341 if (msg_col == 0 && msg_scrolled == 0)
5342 msg_didout = FALSE;
5344 /* If substitutes done, report number of substitutes, otherwise report
5345 * number of extra or deleted lines. */
5346 if (!do_sub_msg(FALSE))
5347 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5350 #ifdef FEAT_VIMINFO
5352 read_viminfo_sub_string(virp, force)
5353 vir_T *virp;
5354 int force;
5356 if (old_sub != NULL && force)
5357 vim_free(old_sub);
5358 if (force || old_sub == NULL)
5359 old_sub = viminfo_readstring(virp, 1, TRUE);
5360 return viminfo_readline(virp);
5363 void
5364 write_viminfo_sub_string(fp)
5365 FILE *fp;
5367 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5369 fprintf(fp, _("\n# Last Substitute String:\n$"));
5370 viminfo_writestring(fp, old_sub);
5373 #endif /* FEAT_VIMINFO */
5375 #if defined(EXITFREE) || defined(PROTO)
5376 void
5377 free_old_sub()
5379 vim_free(old_sub);
5381 #endif
5383 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5385 * Set up for a tagpreview.
5386 * Return TRUE when it was created.
5389 prepare_tagpreview(undo_sync)
5390 int undo_sync; /* sync undo when leaving the window */
5392 win_T *wp;
5394 # ifdef FEAT_GUI
5395 need_mouse_correct = TRUE;
5396 # endif
5399 * If there is already a preview window open, use that one.
5401 if (!curwin->w_p_pvw)
5403 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5404 if (wp->w_p_pvw)
5405 break;
5406 if (wp != NULL)
5407 win_enter(wp, undo_sync);
5408 else
5411 * There is no preview window open yet. Create one.
5413 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5414 == FAIL)
5415 return FALSE;
5416 curwin->w_p_pvw = TRUE;
5417 curwin->w_p_wfh = TRUE;
5418 # ifdef FEAT_SCROLLBIND
5419 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5420 # endif
5421 # ifdef FEAT_DIFF
5422 curwin->w_p_diff = FALSE; /* no 'diff' */
5423 # endif
5424 # ifdef FEAT_FOLDING
5425 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5426 # endif
5427 return TRUE;
5430 return FALSE;
5433 #endif
5437 * ":help": open a read-only window on a help file
5439 void
5440 ex_help(eap)
5441 exarg_T *eap;
5443 char_u *arg;
5444 char_u *tag;
5445 FILE *helpfd; /* file descriptor of help file */
5446 int n;
5447 int i;
5448 #ifdef FEAT_WINDOWS
5449 win_T *wp;
5450 #endif
5451 int num_matches;
5452 char_u **matches;
5453 char_u *p;
5454 int empty_fnum = 0;
5455 int alt_fnum = 0;
5456 buf_T *buf;
5457 #ifdef FEAT_MULTI_LANG
5458 int len;
5459 char_u *lang;
5460 #endif
5462 if (eap != NULL)
5465 * A ":help" command ends at the first LF, or at a '|' that is
5466 * followed by some text. Set nextcmd to the following command.
5468 for (arg = eap->arg; *arg; ++arg)
5470 if (*arg == '\n' || *arg == '\r'
5471 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5473 *arg++ = NUL;
5474 eap->nextcmd = arg;
5475 break;
5478 arg = eap->arg;
5480 if (eap->forceit && *arg == NUL)
5482 EMSG(_("E478: Don't panic!"));
5483 return;
5486 if (eap->skip) /* not executing commands */
5487 return;
5489 else
5490 arg = (char_u *)"";
5492 /* remove trailing blanks */
5493 p = arg + STRLEN(arg) - 1;
5494 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5495 *p-- = NUL;
5497 #ifdef FEAT_MULTI_LANG
5498 /* Check for a specified language */
5499 lang = check_help_lang(arg);
5500 #endif
5502 /* When no argument given go to the index. */
5503 if (*arg == NUL)
5504 arg = (char_u *)"help.txt";
5507 * Check if there is a match for the argument.
5509 n = find_help_tags(arg, &num_matches, &matches,
5510 eap != NULL && eap->forceit);
5512 i = 0;
5513 #ifdef FEAT_MULTI_LANG
5514 if (n != FAIL && lang != NULL)
5515 /* Find first item with the requested language. */
5516 for (i = 0; i < num_matches; ++i)
5518 len = (int)STRLEN(matches[i]);
5519 if (len > 3 && matches[i][len - 3] == '@'
5520 && STRICMP(matches[i] + len - 2, lang) == 0)
5521 break;
5523 #endif
5524 if (i >= num_matches || n == FAIL)
5526 #ifdef FEAT_MULTI_LANG
5527 if (lang != NULL)
5528 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5529 else
5530 #endif
5531 EMSG2(_("E149: Sorry, no help for %s"), arg);
5532 if (n != FAIL)
5533 FreeWild(num_matches, matches);
5534 return;
5537 /* The first match (in the requested language) is the best match. */
5538 tag = vim_strsave(matches[i]);
5539 FreeWild(num_matches, matches);
5541 #ifdef FEAT_GUI
5542 need_mouse_correct = TRUE;
5543 #endif
5546 * Re-use an existing help window or open a new one.
5547 * Always open a new one for ":tab help".
5549 if (!curwin->w_buffer->b_help
5550 #ifdef FEAT_WINDOWS
5551 || cmdmod.tab != 0
5552 #endif
5555 #ifdef FEAT_WINDOWS
5556 if (cmdmod.tab != 0)
5557 wp = NULL;
5558 else
5559 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5560 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5561 break;
5562 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5563 win_enter(wp, TRUE);
5564 else
5565 #endif
5568 * There is no help window yet.
5569 * Try to open the file specified by the "helpfile" option.
5571 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5573 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5574 goto erret;
5576 fclose(helpfd);
5578 #ifdef FEAT_WINDOWS
5579 /* Split off help window; put it at far top if no position
5580 * specified, the current window is vertically split and
5581 * narrow. */
5582 n = WSP_HELP;
5583 # ifdef FEAT_VERTSPLIT
5584 if (cmdmod.split == 0 && curwin->w_width != Columns
5585 && curwin->w_width < 80)
5586 n |= WSP_TOP;
5587 # endif
5588 if (win_split(0, n) == FAIL)
5589 goto erret;
5590 #else
5591 /* use current window */
5592 if (!can_abandon(curbuf, FALSE))
5593 goto erret;
5594 #endif
5596 #ifdef FEAT_WINDOWS
5597 if (curwin->w_height < p_hh)
5598 win_setheight((int)p_hh);
5599 #endif
5602 * Open help file (do_ecmd() will set b_help flag, readfile() will
5603 * set b_p_ro flag).
5604 * Set the alternate file to the previously edited file.
5606 alt_fnum = curbuf->b_fnum;
5607 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5608 ECMD_HIDE + ECMD_SET_HELP);
5609 if (!cmdmod.keepalt)
5610 curwin->w_alt_fnum = alt_fnum;
5611 empty_fnum = curbuf->b_fnum;
5615 if (!p_im)
5616 restart_edit = 0; /* don't want insert mode in help file */
5618 if (tag != NULL)
5619 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5621 /* Delete the empty buffer if we're not using it. Careful: autocommands
5622 * may have jumped to another window, check that the buffer is not in a
5623 * window. */
5624 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5626 buf = buflist_findnr(empty_fnum);
5627 if (buf != NULL && buf->b_nwindows == 0)
5628 wipe_buffer(buf, TRUE);
5631 /* keep the previous alternate file */
5632 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5633 curwin->w_alt_fnum = alt_fnum;
5635 erret:
5636 vim_free(tag);
5640 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5642 * In an argument search for a language specifiers in the form "@xx".
5643 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5644 * Returns NULL if not found.
5646 char_u *
5647 check_help_lang(arg)
5648 char_u *arg;
5650 int len = (int)STRLEN(arg);
5652 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5653 && ASCII_ISALPHA(arg[len - 1]))
5655 arg[len - 3] = NUL; /* remove the '@' */
5656 return arg + len - 2;
5658 return NULL;
5660 #endif
5663 * Return a heuristic indicating how well the given string matches. The
5664 * smaller the number, the better the match. This is the order of priorities,
5665 * from best match to worst match:
5666 * - Match with least alpha-numeric characters is better.
5667 * - Match with least total characters is better.
5668 * - Match towards the start is better.
5669 * - Match starting with "+" is worse (feature instead of command)
5670 * Assumption is made that the matched_string passed has already been found to
5671 * match some string for which help is requested. webb.
5674 help_heuristic(matched_string, offset, wrong_case)
5675 char_u *matched_string;
5676 int offset; /* offset for match */
5677 int wrong_case; /* no matching case */
5679 int num_letters;
5680 char_u *p;
5682 num_letters = 0;
5683 for (p = matched_string; *p; p++)
5684 if (ASCII_ISALNUM(*p))
5685 num_letters++;
5688 * Multiply the number of letters by 100 to give it a much bigger
5689 * weighting than the number of characters.
5690 * If there only is a match while ignoring case, add 5000.
5691 * If the match starts in the middle of a word, add 10000 to put it
5692 * somewhere in the last half.
5693 * If the match is more than 2 chars from the start, multiply by 200 to
5694 * put it after matches at the start.
5696 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5697 && ASCII_ISALNUM(matched_string[offset - 1]))
5698 offset += 10000;
5699 else if (offset > 2)
5700 offset *= 200;
5701 if (wrong_case)
5702 offset += 5000;
5703 /* Features are less interesting than the subjects themselves, but "+"
5704 * alone is not a feature. */
5705 if (matched_string[0] == '+' && matched_string[1] != NUL)
5706 offset += 100;
5707 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5711 * Compare functions for qsort() below, that checks the help heuristics number
5712 * that has been put after the tagname by find_tags().
5714 static int
5715 #ifdef __BORLANDC__
5716 _RTLENTRYF
5717 #endif
5718 help_compare(s1, s2)
5719 const void *s1;
5720 const void *s2;
5722 char *p1;
5723 char *p2;
5725 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5726 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5727 return strcmp(p1, p2);
5731 * Find all help tags matching "arg", sort them and return in matches[], with
5732 * the number of matches in num_matches.
5733 * The matches will be sorted with a "best" match algorithm.
5734 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5737 find_help_tags(arg, num_matches, matches, keep_lang)
5738 char_u *arg;
5739 int *num_matches;
5740 char_u ***matches;
5741 int keep_lang;
5743 char_u *s, *d;
5744 int i;
5745 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5746 "/*", "/\\*", "\"*", "**",
5747 "/\\(\\)",
5748 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5749 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5750 "[count]", "[quotex]", "[range]",
5751 "[pattern]", "\\|", "\\%$"};
5752 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5753 "/star", "/\\\\star", "quotestar", "starstar",
5754 "/\\\\(\\\\)",
5755 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5756 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5757 "\\[count]", "\\[quotex]", "\\[range]",
5758 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5759 int flags;
5761 d = IObuff; /* assume IObuff is long enough! */
5764 * Recognize a few exceptions to the rule. Some strings that contain '*'
5765 * with "star". Otherwise '*' is recognized as a wildcard.
5767 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5768 if (STRCMP(arg, mtable[i]) == 0)
5770 STRCPY(d, rtable[i]);
5771 break;
5774 if (i < 0) /* no match in table */
5776 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5777 * Also replace "\%^" and "\%(", they match every tag too.
5778 * Also "\zs", "\z1", etc.
5779 * Also "\@<", "\@=", "\@<=", etc.
5780 * And also "\_$" and "\_^". */
5781 if (arg[0] == '\\'
5782 && ((arg[1] != NUL && arg[2] == NUL)
5783 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5784 && arg[2] != NUL)))
5786 STRCPY(d, "/\\\\");
5787 STRCPY(d + 3, arg + 1);
5788 /* Check for "/\\_$", should be "/\\_\$" */
5789 if (d[3] == '_' && d[4] == '$')
5790 STRCPY(d + 4, "\\$");
5792 else
5794 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5795 if (arg[0] == '[' && (arg[1] == ':'
5796 || (arg[1] == '+' && arg[2] == '+')))
5797 *d++ = '\\';
5799 for (s = arg; *s; ++s)
5802 * Replace "|" with "bar" and '"' with "quote" to match the name of
5803 * the tags for these commands.
5804 * Replace "*" with ".*" and "?" with "." to match command line
5805 * completion.
5806 * Insert a backslash before '~', '$' and '.' to avoid their
5807 * special meaning.
5809 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5810 break;
5811 switch (*s)
5813 case '|': STRCPY(d, "bar");
5814 d += 3;
5815 continue;
5816 case '"': STRCPY(d, "quote");
5817 d += 5;
5818 continue;
5819 case '*': *d++ = '.';
5820 break;
5821 case '?': *d++ = '.';
5822 continue;
5823 case '$':
5824 case '.':
5825 case '~': *d++ = '\\';
5826 break;
5830 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5831 * ":help i_^_CTRL-D" work.
5832 * Insert '-' before and after "CTRL-X" when applicable.
5834 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5835 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5837 if (d > IObuff && d[-1] != '_')
5838 *d++ = '_'; /* prepend a '_' */
5839 STRCPY(d, "CTRL-");
5840 d += 5;
5841 if (*s < ' ')
5843 #ifdef EBCDIC
5844 *d++ = CtrlChar(*s);
5845 #else
5846 *d++ = *s + '@';
5847 #endif
5848 if (d[-1] == '\\')
5849 *d++ = '\\'; /* double a backslash */
5851 else
5852 *d++ = *++s;
5853 if (s[1] != NUL && s[1] != '_')
5854 *d++ = '_'; /* append a '_' */
5855 continue;
5857 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5858 *d++ = '\\';
5861 * Insert a backslash before a backslash after a slash, for search
5862 * pattern tags: "/\|" --> "/\\|".
5864 else if (s[0] == '\\' && s[1] != '\\'
5865 && *arg == '/' && s == arg + 1)
5866 *d++ = '\\';
5868 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5869 * "CTRL-\_CTRL-N" */
5870 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5872 STRCPY(d, "CTRL-\\\\");
5873 d += 7;
5874 s += 6;
5877 *d++ = *s;
5880 * If tag starts with ', toss everything after a second '. Fixes
5881 * CTRL-] on 'option'. (would include the trailing '.').
5883 if (*s == '\'' && s > arg && *arg == '\'')
5884 break;
5886 *d = NUL;
5890 *matches = (char_u **)"";
5891 *num_matches = 0;
5892 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5893 if (keep_lang)
5894 flags |= TAG_KEEP_LANG;
5895 if (find_tags(IObuff, num_matches, matches, flags, TAG_MANY, NULL) == OK
5896 && *num_matches > 0)
5897 /* Sort the matches found on the heuristic number that is after the
5898 * tag name. */
5899 qsort((void *)*matches, (size_t)*num_matches,
5900 sizeof(char_u *), help_compare);
5901 return OK;
5905 * After reading a help file: May cleanup a help buffer when syntax
5906 * highlighting is not used.
5908 void
5909 fix_help_buffer()
5911 linenr_T lnum;
5912 char_u *line;
5913 int in_example = FALSE;
5914 int len;
5915 char_u *p;
5916 char_u *rt;
5917 int mustfree;
5919 /* set filetype to "help". */
5920 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5922 #ifdef FEAT_SYN_HL
5923 if (!syntax_present(curbuf))
5924 #endif
5926 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5928 line = ml_get_buf(curbuf, lnum, FALSE);
5929 len = (int)STRLEN(line);
5930 if (in_example && len > 0 && !vim_iswhite(line[0]))
5932 /* End of example: non-white or '<' in first column. */
5933 if (line[0] == '<')
5935 /* blank-out a '<' in the first column */
5936 line = ml_get_buf(curbuf, lnum, TRUE);
5937 line[0] = ' ';
5939 in_example = FALSE;
5941 if (!in_example && len > 0)
5943 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5945 /* blank-out a '>' in the last column (start of example) */
5946 line = ml_get_buf(curbuf, lnum, TRUE);
5947 line[len - 1] = ' ';
5948 in_example = TRUE;
5950 else if (line[len - 1] == '~')
5952 /* blank-out a '~' at the end of line (header marker) */
5953 line = ml_get_buf(curbuf, lnum, TRUE);
5954 line[len - 1] = ' ';
5961 * In the "help.txt" file, add the locally added help files.
5962 * This uses the very first line in the help file.
5964 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5966 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5968 line = ml_get_buf(curbuf, lnum, FALSE);
5969 if (strstr((char *)line, "*local-additions*") != NULL)
5971 /* Go through all directories in 'runtimepath', skipping
5972 * $VIMRUNTIME. */
5973 p = p_rtp;
5974 while (*p != NUL)
5976 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5977 mustfree = FALSE;
5978 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5979 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5981 int fcount;
5982 char_u **fnames;
5983 FILE *fd;
5984 char_u *s;
5985 int fi;
5986 #ifdef FEAT_MBYTE
5987 vimconv_T vc;
5988 char_u *cp;
5989 #endif
5991 /* Find all "doc/ *.txt" files in this directory. */
5992 add_pathsep(NameBuff);
5993 STRCAT(NameBuff, "doc/*.txt");
5994 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5995 &fnames, EW_FILE|EW_SILENT) == OK
5996 && fcount > 0)
5998 for (fi = 0; fi < fcount; ++fi)
6000 fd = mch_fopen((char *)fnames[fi], "r");
6001 if (fd != NULL)
6003 vim_fgets(IObuff, IOSIZE, fd);
6004 if (IObuff[0] == '*'
6005 && (s = vim_strchr(IObuff + 1, '*'))
6006 != NULL)
6008 #ifdef FEAT_MBYTE
6009 int this_utf = MAYBE;
6010 #endif
6011 /* Change tag definition to a
6012 * reference and remove <CR>/<NL>. */
6013 IObuff[0] = '|';
6014 *s = '|';
6015 while (*s != NUL)
6017 if (*s == '\r' || *s == '\n')
6018 *s = NUL;
6019 #ifdef FEAT_MBYTE
6020 /* The text is utf-8 when a byte
6021 * above 127 is found and no
6022 * illegal byte sequence is found.
6024 if (*s >= 0x80 && this_utf != FALSE)
6026 int l;
6028 this_utf = TRUE;
6029 l = utf_ptr2len(s);
6030 if (l == 1)
6031 this_utf = FALSE;
6032 s += l - 1;
6034 #endif
6035 ++s;
6037 #ifdef FEAT_MBYTE
6038 /* The help file is latin1 or utf-8;
6039 * conversion to the current
6040 * 'encoding' may be required. */
6041 vc.vc_type = CONV_NONE;
6042 convert_setup(&vc, (char_u *)(
6043 this_utf == TRUE ? "utf-8"
6044 : "latin1"), p_enc);
6045 if (vc.vc_type == CONV_NONE)
6046 /* No conversion needed. */
6047 cp = IObuff;
6048 else
6050 /* Do the conversion. If it fails
6051 * use the unconverted text. */
6052 cp = string_convert(&vc, IObuff,
6053 NULL);
6054 if (cp == NULL)
6055 cp = IObuff;
6057 convert_setup(&vc, NULL, NULL);
6059 ml_append(lnum, cp, (colnr_T)0, FALSE);
6060 if (cp != IObuff)
6061 vim_free(cp);
6062 #else
6063 ml_append(lnum, IObuff, (colnr_T)0,
6064 FALSE);
6065 #endif
6066 ++lnum;
6068 fclose(fd);
6071 FreeWild(fcount, fnames);
6074 if (mustfree)
6075 vim_free(rt);
6077 break;
6084 * ":exusage"
6086 /*ARGSUSED*/
6087 void
6088 ex_exusage(eap)
6089 exarg_T *eap;
6091 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6095 * ":viusage"
6097 /*ARGSUSED*/
6098 void
6099 ex_viusage(eap)
6100 exarg_T *eap;
6102 do_cmdline_cmd((char_u *)"help normal-index");
6105 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6106 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
6109 * ":helptags"
6111 void
6112 ex_helptags(eap)
6113 exarg_T *eap;
6115 garray_T ga;
6116 int i, j;
6117 int len;
6118 #ifdef FEAT_MULTI_LANG
6119 char_u lang[2];
6120 #endif
6121 expand_T xpc;
6122 char_u *dirname;
6123 char_u ext[5];
6124 char_u fname[8];
6125 int filecount;
6126 char_u **files;
6127 int add_help_tags = FALSE;
6129 /* Check for ":helptags ++t {dir}". */
6130 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6132 add_help_tags = TRUE;
6133 eap->arg = skipwhite(eap->arg + 3);
6136 ExpandInit(&xpc);
6137 xpc.xp_context = EXPAND_DIRECTORIES;
6138 dirname = ExpandOne(&xpc, eap->arg, NULL,
6139 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6140 if (dirname == NULL || !mch_isdir(dirname))
6142 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6143 return;
6146 #ifdef FEAT_MULTI_LANG
6147 /* Get a list of all files in the directory. */
6148 STRCPY(NameBuff, dirname);
6149 add_pathsep(NameBuff);
6150 STRCAT(NameBuff, "*");
6151 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6152 EW_FILE|EW_SILENT) == FAIL
6153 || filecount == 0)
6155 EMSG2("E151: No match: %s", NameBuff);
6156 vim_free(dirname);
6157 return;
6160 /* Go over all files in the directory to find out what languages are
6161 * present. */
6162 ga_init2(&ga, 1, 10);
6163 for (i = 0; i < filecount; ++i)
6165 len = (int)STRLEN(files[i]);
6166 if (len > 4)
6168 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6170 /* ".txt" -> language "en" */
6171 lang[0] = 'e';
6172 lang[1] = 'n';
6174 else if (files[i][len - 4] == '.'
6175 && ASCII_ISALPHA(files[i][len - 3])
6176 && ASCII_ISALPHA(files[i][len - 2])
6177 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6179 /* ".abx" -> language "ab" */
6180 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6181 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6183 else
6184 continue;
6186 /* Did we find this language already? */
6187 for (j = 0; j < ga.ga_len; j += 2)
6188 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6189 break;
6190 if (j == ga.ga_len)
6192 /* New language, add it. */
6193 if (ga_grow(&ga, 2) == FAIL)
6194 break;
6195 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6196 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6202 * Loop over the found languages to generate a tags file for each one.
6204 for (j = 0; j < ga.ga_len; j += 2)
6206 STRCPY(fname, "tags-xx");
6207 fname[5] = ((char_u *)ga.ga_data)[j];
6208 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6209 if (fname[5] == 'e' && fname[6] == 'n')
6211 /* English is an exception: use ".txt" and "tags". */
6212 fname[4] = NUL;
6213 STRCPY(ext, ".txt");
6215 else
6217 /* Language "ab" uses ".abx" and "tags-ab". */
6218 STRCPY(ext, ".xxx");
6219 ext[1] = fname[5];
6220 ext[2] = fname[6];
6222 helptags_one(dirname, ext, fname, add_help_tags);
6225 ga_clear(&ga);
6226 FreeWild(filecount, files);
6228 #else
6229 /* No language support, just use "*.txt" and "tags". */
6230 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6231 #endif
6232 vim_free(dirname);
6235 static void
6236 helptags_one(dir, ext, tagfname, add_help_tags)
6237 char_u *dir; /* doc directory */
6238 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6239 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6240 int add_help_tags; /* add "help-tags" tag */
6242 FILE *fd_tags;
6243 FILE *fd;
6244 garray_T ga;
6245 int filecount;
6246 char_u **files;
6247 char_u *p1, *p2;
6248 int fi;
6249 char_u *s;
6250 int i;
6251 char_u *fname;
6252 # ifdef FEAT_MBYTE
6253 int utf8 = MAYBE;
6254 int this_utf8;
6255 int firstline;
6256 int mix = FALSE; /* detected mixed encodings */
6257 # endif
6260 * Find all *.txt files.
6262 STRCPY(NameBuff, dir);
6263 add_pathsep(NameBuff);
6264 STRCAT(NameBuff, "*");
6265 STRCAT(NameBuff, ext);
6266 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6267 EW_FILE|EW_SILENT) == FAIL
6268 || filecount == 0)
6270 if (!got_int)
6271 EMSG2("E151: No match: %s", NameBuff);
6272 return;
6276 * Open the tags file for writing.
6277 * Do this before scanning through all the files.
6279 STRCPY(NameBuff, dir);
6280 add_pathsep(NameBuff);
6281 STRCAT(NameBuff, tagfname);
6282 fd_tags = mch_fopen((char *)NameBuff, "w");
6283 if (fd_tags == NULL)
6285 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6286 FreeWild(filecount, files);
6287 return;
6291 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6292 * add the "help-tags" tag.
6294 ga_init2(&ga, (int)sizeof(char_u *), 100);
6295 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6296 dir, FALSE) == FPC_SAME)
6298 if (ga_grow(&ga, 1) == FAIL)
6299 got_int = TRUE;
6300 else
6302 s = alloc(18 + (unsigned)STRLEN(tagfname));
6303 if (s == NULL)
6304 got_int = TRUE;
6305 else
6307 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6308 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6309 ++ga.ga_len;
6315 * Go over all the files and extract the tags.
6317 for (fi = 0; fi < filecount && !got_int; ++fi)
6319 fd = mch_fopen((char *)files[fi], "r");
6320 if (fd == NULL)
6322 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6323 continue;
6325 fname = gettail(files[fi]);
6327 # ifdef FEAT_MBYTE
6328 firstline = TRUE;
6329 # endif
6330 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6332 # ifdef FEAT_MBYTE
6333 if (firstline)
6335 /* Detect utf-8 file by a non-ASCII char in the first line. */
6336 this_utf8 = MAYBE;
6337 for (s = IObuff; *s != NUL; ++s)
6338 if (*s >= 0x80)
6340 int l;
6342 this_utf8 = TRUE;
6343 l = utf_ptr2len(s);
6344 if (l == 1)
6346 /* Illegal UTF-8 byte sequence. */
6347 this_utf8 = FALSE;
6348 break;
6350 s += l - 1;
6352 if (this_utf8 == MAYBE) /* only ASCII characters found */
6353 this_utf8 = FALSE;
6354 if (utf8 == MAYBE) /* first file */
6355 utf8 = this_utf8;
6356 else if (utf8 != this_utf8)
6358 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6359 mix = !got_int;
6360 got_int = TRUE;
6362 firstline = FALSE;
6364 # endif
6365 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6366 while (p1 != NULL)
6368 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6369 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6371 for (s = p1 + 1; s < p2; ++s)
6372 if (*s == ' ' || *s == '\t' || *s == '|')
6373 break;
6376 * Only accept a *tag* when it consists of valid
6377 * characters, there is white space before it and is
6378 * followed by a white character or end-of-line.
6380 if (s == p2
6381 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6382 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6383 || s[1] == '\0'))
6385 *p2 = '\0';
6386 ++p1;
6387 if (ga_grow(&ga, 1) == FAIL)
6389 got_int = TRUE;
6390 break;
6392 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6393 if (s == NULL)
6395 got_int = TRUE;
6396 break;
6398 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6399 ++ga.ga_len;
6400 sprintf((char *)s, "%s\t%s", p1, fname);
6402 /* find next '*' */
6403 p2 = vim_strchr(p2 + 1, '*');
6406 p1 = p2;
6408 line_breakcheck();
6411 fclose(fd);
6414 FreeWild(filecount, files);
6416 if (!got_int)
6419 * Sort the tags.
6421 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6424 * Check for duplicates.
6426 for (i = 1; i < ga.ga_len; ++i)
6428 p1 = ((char_u **)ga.ga_data)[i - 1];
6429 p2 = ((char_u **)ga.ga_data)[i];
6430 while (*p1 == *p2)
6432 if (*p2 == '\t')
6434 *p2 = NUL;
6435 vim_snprintf((char *)NameBuff, MAXPATHL,
6436 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6437 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6438 EMSG(NameBuff);
6439 *p2 = '\t';
6440 break;
6442 ++p1;
6443 ++p2;
6447 # ifdef FEAT_MBYTE
6448 if (utf8 == TRUE)
6449 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6450 # endif
6453 * Write the tags into the file.
6455 for (i = 0; i < ga.ga_len; ++i)
6457 s = ((char_u **)ga.ga_data)[i];
6458 if (STRNCMP(s, "help-tags\t", 10) == 0)
6459 /* help-tags entry was added in formatted form */
6460 fputs((char *)s, fd_tags);
6461 else
6463 fprintf(fd_tags, "%s\t/*", s);
6464 for (p1 = s; *p1 != '\t'; ++p1)
6466 /* insert backslash before '\\' and '/' */
6467 if (*p1 == '\\' || *p1 == '/')
6468 putc('\\', fd_tags);
6469 putc(*p1, fd_tags);
6471 fprintf(fd_tags, "*\n");
6475 #ifdef FEAT_MBYTE
6476 if (mix)
6477 got_int = FALSE; /* continue with other languages */
6478 #endif
6480 for (i = 0; i < ga.ga_len; ++i)
6481 vim_free(((char_u **)ga.ga_data)[i]);
6482 ga_clear(&ga);
6483 fclose(fd_tags); /* there is no check for an error... */
6485 #endif
6487 #if defined(FEAT_SIGNS) || defined(PROTO)
6490 * Struct to hold the sign properties.
6492 typedef struct sign sign_T;
6494 struct sign
6496 sign_T *sn_next; /* next sign in list */
6497 int sn_typenr; /* type number of sign (negative if not equal
6498 to name) */
6499 char_u *sn_name; /* name of sign */
6500 char_u *sn_icon; /* name of pixmap */
6501 #ifdef FEAT_SIGN_ICONS
6502 void *sn_image; /* icon image */
6503 #endif
6504 char_u *sn_text; /* text used instead of pixmap */
6505 int sn_line_hl; /* highlight ID for line */
6506 int sn_text_hl; /* highlight ID for text */
6509 static sign_T *first_sign = NULL;
6510 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6512 static void sign_list_defined __ARGS((sign_T *sp));
6515 * ":sign" command
6517 void
6518 ex_sign(eap)
6519 exarg_T *eap;
6521 char_u *arg = eap->arg;
6522 char_u *p;
6523 int idx;
6524 sign_T *sp;
6525 sign_T *sp_prev;
6526 buf_T *buf;
6527 static char *cmds[] = {
6528 "define",
6529 #define SIGNCMD_DEFINE 0
6530 "undefine",
6531 #define SIGNCMD_UNDEFINE 1
6532 "list",
6533 #define SIGNCMD_LIST 2
6534 "place",
6535 #define SIGNCMD_PLACE 3
6536 "unplace",
6537 #define SIGNCMD_UNPLACE 4
6538 "jump",
6539 #define SIGNCMD_JUMP 5
6540 #define SIGNCMD_LAST 6
6543 /* Parse the subcommand. */
6544 p = skiptowhite(arg);
6545 if (*p != NUL)
6546 *p++ = NUL;
6547 for (idx = 0; ; ++idx)
6549 if (idx == SIGNCMD_LAST)
6551 EMSG2(_("E160: Unknown sign command: %s"), arg);
6552 return;
6554 if (STRCMP(arg, cmds[idx]) == 0)
6555 break;
6557 arg = skipwhite(p);
6559 if (idx <= SIGNCMD_LIST)
6562 * Define, undefine or list signs.
6564 if (idx == SIGNCMD_LIST && *arg == NUL)
6566 /* ":sign list": list all defined signs */
6567 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6568 sign_list_defined(sp);
6570 else if (*arg == NUL)
6571 EMSG(_("E156: Missing sign name"));
6572 else
6574 p = skiptowhite(arg);
6575 if (*p != NUL)
6576 *p++ = NUL;
6577 sp_prev = NULL;
6578 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6580 if (STRCMP(sp->sn_name, arg) == 0)
6581 break;
6582 sp_prev = sp;
6584 if (idx == SIGNCMD_DEFINE)
6586 /* ":sign define {name} ...": define a sign */
6587 if (sp == NULL)
6589 /* Allocate a new sign. */
6590 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6591 if (sp == NULL)
6592 return;
6593 if (sp_prev == NULL)
6594 first_sign = sp;
6595 else
6596 sp_prev->sn_next = sp;
6597 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6599 /* If the name is a number use that for the typenr,
6600 * otherwise use a negative number. */
6601 if (VIM_ISDIGIT(*arg))
6602 sp->sn_typenr = atoi((char *)arg);
6603 else
6605 sign_T *lp;
6606 int start = last_sign_typenr;
6608 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6610 if (lp->sn_typenr == last_sign_typenr)
6612 --last_sign_typenr;
6613 if (last_sign_typenr == 0)
6614 last_sign_typenr = MAX_TYPENR;
6615 if (last_sign_typenr == start)
6617 EMSG(_("E612: Too many signs defined"));
6618 return;
6620 lp = first_sign;
6621 continue;
6625 sp->sn_typenr = last_sign_typenr--;
6626 if (last_sign_typenr == 0)
6627 last_sign_typenr = MAX_TYPENR; /* wrap around */
6631 /* set values for a defined sign. */
6632 for (;;)
6634 arg = skipwhite(p);
6635 if (*arg == NUL)
6636 break;
6637 p = skiptowhite_esc(arg);
6638 if (STRNCMP(arg, "icon=", 5) == 0)
6640 arg += 5;
6641 vim_free(sp->sn_icon);
6642 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6643 backslash_halve(sp->sn_icon);
6644 #ifdef FEAT_SIGN_ICONS
6645 if (gui.in_use)
6647 out_flush();
6648 if (sp->sn_image != NULL)
6649 gui_mch_destroy_sign(sp->sn_image);
6650 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6652 #endif
6654 else if (STRNCMP(arg, "text=", 5) == 0)
6656 char_u *s;
6657 int cells;
6658 int len;
6660 arg += 5;
6661 #ifdef FEAT_MBYTE
6662 /* Count cells and check for non-printable chars */
6663 if (has_mbyte)
6665 cells = 0;
6666 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6668 if (!vim_isprintc((*mb_ptr2char)(s)))
6669 break;
6670 cells += (*mb_ptr2cells)(s);
6673 else
6674 #endif
6676 for (s = arg; s < p; ++s)
6677 if (!vim_isprintc(*s))
6678 break;
6679 cells = (int)(s - arg);
6681 /* Currently must be one or two display cells */
6682 if (s != p || cells < 1 || cells > 2)
6684 *p = NUL;
6685 EMSG2(_("E239: Invalid sign text: %s"), arg);
6686 return;
6689 vim_free(sp->sn_text);
6690 /* Allocate one byte more if we need to pad up
6691 * with a space. */
6692 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6693 sp->sn_text = vim_strnsave(arg, len);
6695 if (sp->sn_text != NULL && cells == 1)
6696 STRCPY(sp->sn_text + len - 1, " ");
6698 else if (STRNCMP(arg, "linehl=", 7) == 0)
6700 arg += 7;
6701 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6703 else if (STRNCMP(arg, "texthl=", 7) == 0)
6705 arg += 7;
6706 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6708 else
6710 EMSG2(_(e_invarg2), arg);
6711 return;
6715 else if (sp == NULL)
6716 EMSG2(_("E155: Unknown sign: %s"), arg);
6717 else if (idx == SIGNCMD_LIST)
6718 /* ":sign list {name}" */
6719 sign_list_defined(sp);
6720 else
6722 /* ":sign undefine {name}" */
6723 vim_free(sp->sn_name);
6724 vim_free(sp->sn_icon);
6725 #ifdef FEAT_SIGN_ICONS
6726 if (sp->sn_image != NULL)
6728 out_flush();
6729 gui_mch_destroy_sign(sp->sn_image);
6731 #endif
6732 vim_free(sp->sn_text);
6733 if (sp_prev == NULL)
6734 first_sign = sp->sn_next;
6735 else
6736 sp_prev->sn_next = sp->sn_next;
6737 vim_free(sp);
6741 else
6743 int id = -1;
6744 linenr_T lnum = -1;
6745 char_u *sign_name = NULL;
6746 char_u *arg1;
6748 if (*arg == NUL)
6750 if (idx == SIGNCMD_PLACE)
6752 /* ":sign place": list placed signs in all buffers */
6753 sign_list_placed(NULL);
6755 else if (idx == SIGNCMD_UNPLACE)
6757 /* ":sign unplace": remove placed sign at cursor */
6758 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6759 if (id > 0)
6761 buf_delsign(curwin->w_buffer, id);
6762 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6764 else
6765 EMSG(_("E159: Missing sign number"));
6767 else
6768 EMSG(_(e_argreq));
6769 return;
6772 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6774 /* ":sign unplace *": remove all placed signs */
6775 buf_delete_all_signs();
6776 return;
6779 /* first arg could be placed sign id */
6780 arg1 = arg;
6781 if (VIM_ISDIGIT(*arg))
6783 id = getdigits(&arg);
6784 if (!vim_iswhite(*arg) && *arg != NUL)
6786 id = -1;
6787 arg = arg1;
6789 else
6791 arg = skipwhite(arg);
6792 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6794 /* ":sign unplace {id}": remove placed sign by number */
6795 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6796 if ((lnum = buf_delsign(buf, id)) != 0)
6797 update_debug_sign(buf, lnum);
6798 return;
6804 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6805 * Leave "arg" pointing to {fname}.
6807 for (;;)
6809 if (STRNCMP(arg, "line=", 5) == 0)
6811 arg += 5;
6812 lnum = atoi((char *)arg);
6813 arg = skiptowhite(arg);
6815 else if (STRNCMP(arg, "name=", 5) == 0)
6817 arg += 5;
6818 sign_name = arg;
6819 arg = skiptowhite(arg);
6820 if (*arg != NUL)
6821 *arg++ = NUL;
6823 else if (STRNCMP(arg, "file=", 5) == 0)
6825 arg += 5;
6826 buf = buflist_findname(arg);
6827 break;
6829 else if (STRNCMP(arg, "buffer=", 7) == 0)
6831 arg += 7;
6832 buf = buflist_findnr((int)getdigits(&arg));
6833 if (*skipwhite(arg) != NUL)
6834 EMSG(_(e_trailing));
6835 break;
6837 else
6839 EMSG(_(e_invarg));
6840 return;
6842 arg = skipwhite(arg);
6845 if (buf == NULL)
6847 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6849 else if (id <= 0)
6851 if (lnum >= 0 || sign_name != NULL)
6852 EMSG(_(e_invarg));
6853 else
6854 /* ":sign place file={fname}": list placed signs in one file */
6855 sign_list_placed(buf);
6857 else if (idx == SIGNCMD_JUMP)
6859 /* ":sign jump {id} file={fname}" */
6860 if (lnum >= 0 || sign_name != NULL)
6861 EMSG(_(e_invarg));
6862 else if ((lnum = buf_findsign(buf, id)) > 0)
6863 { /* goto a sign ... */
6864 if (buf_jump_open_win(buf) != NULL)
6865 { /* ... in a current window */
6866 curwin->w_cursor.lnum = lnum;
6867 check_cursor_lnum();
6868 beginline(BL_WHITE);
6870 else
6871 { /* ... not currently in a window */
6872 char_u *cmd;
6874 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6875 if (cmd == NULL)
6876 return;
6877 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6878 do_cmdline_cmd(cmd);
6879 vim_free(cmd);
6881 #ifdef FEAT_FOLDING
6882 foldOpenCursor();
6883 #endif
6885 else
6886 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6888 else if (idx == SIGNCMD_UNPLACE)
6890 /* ":sign unplace {id} file={fname}" */
6891 if (lnum >= 0 || sign_name != NULL)
6892 EMSG(_(e_invarg));
6893 else
6895 lnum = buf_delsign(buf, id);
6896 update_debug_sign(buf, lnum);
6899 /* idx == SIGNCMD_PLACE */
6900 else if (sign_name != NULL)
6902 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6903 if (STRCMP(sp->sn_name, sign_name) == 0)
6904 break;
6905 if (sp == NULL)
6907 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6908 return;
6910 if (lnum > 0)
6911 /* ":sign place {id} line={lnum} name={name} file={fname}":
6912 * place a sign */
6913 buf_addsign(buf, id, lnum, sp->sn_typenr);
6914 else
6915 /* ":sign place {id} file={fname}": change sign type */
6916 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6917 update_debug_sign(buf, lnum);
6919 else
6920 EMSG(_(e_invarg));
6924 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6926 * Allocate the icons. Called when the GUI has started. Allows defining
6927 * signs before it starts.
6929 void
6930 sign_gui_started()
6932 sign_T *sp;
6934 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6935 if (sp->sn_icon != NULL)
6936 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6938 #endif
6941 * List one sign.
6943 static void
6944 sign_list_defined(sp)
6945 sign_T *sp;
6947 char_u *p;
6949 smsg((char_u *)"sign %s", sp->sn_name);
6950 if (sp->sn_icon != NULL)
6952 MSG_PUTS(" icon=");
6953 msg_outtrans(sp->sn_icon);
6954 #ifdef FEAT_SIGN_ICONS
6955 if (sp->sn_image == NULL)
6956 MSG_PUTS(_(" (NOT FOUND)"));
6957 #else
6958 MSG_PUTS(_(" (not supported)"));
6959 #endif
6961 if (sp->sn_text != NULL)
6963 MSG_PUTS(" text=");
6964 msg_outtrans(sp->sn_text);
6966 if (sp->sn_line_hl > 0)
6968 MSG_PUTS(" linehl=");
6969 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6970 if (p == NULL)
6971 MSG_PUTS("NONE");
6972 else
6973 msg_puts(p);
6975 if (sp->sn_text_hl > 0)
6977 MSG_PUTS(" texthl=");
6978 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6979 if (p == NULL)
6980 MSG_PUTS("NONE");
6981 else
6982 msg_puts(p);
6987 * Get highlighting attribute for sign "typenr".
6988 * If "line" is TRUE: line highl, if FALSE: text highl.
6991 sign_get_attr(typenr, line)
6992 int typenr;
6993 int line;
6995 sign_T *sp;
6997 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6998 if (sp->sn_typenr == typenr)
7000 if (line)
7002 if (sp->sn_line_hl > 0)
7003 return syn_id2attr(sp->sn_line_hl);
7005 else
7007 if (sp->sn_text_hl > 0)
7008 return syn_id2attr(sp->sn_text_hl);
7010 break;
7012 return 0;
7016 * Get text mark for sign "typenr".
7017 * Returns NULL if there isn't one.
7019 char_u *
7020 sign_get_text(typenr)
7021 int typenr;
7023 sign_T *sp;
7025 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7026 if (sp->sn_typenr == typenr)
7027 return sp->sn_text;
7028 return NULL;
7031 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7032 void *
7033 sign_get_image(typenr)
7034 int typenr; /* the attribute which may have a sign */
7036 sign_T *sp;
7038 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7039 if (sp->sn_typenr == typenr)
7040 return sp->sn_image;
7041 return NULL;
7043 #endif
7046 * Get the name of a sign by its typenr.
7048 char_u *
7049 sign_typenr2name(typenr)
7050 int typenr;
7052 sign_T *sp;
7054 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7055 if (sp->sn_typenr == typenr)
7056 return sp->sn_name;
7057 return (char_u *)_("[Deleted]");
7060 #endif
7062 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7064 * ":drop"
7065 * Opens the first argument in a window. When there are two or more arguments
7066 * the argument list is redefined.
7068 void
7069 ex_drop(eap)
7070 exarg_T *eap;
7072 int split = FALSE;
7073 win_T *wp;
7074 buf_T *buf;
7075 # ifdef FEAT_WINDOWS
7076 tabpage_T *tp;
7077 # endif
7080 * Check if the first argument is already being edited in a window. If
7081 * so, jump to that window.
7082 * We would actually need to check all arguments, but that's complicated
7083 * and mostly only one file is dropped.
7084 * This also ignores wildcards, since it is very unlikely the user is
7085 * editing a file name with a wildcard character.
7087 set_arglist(eap->arg);
7090 * Expanding wildcards may result in an empty argument list. E.g. when
7091 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7092 * already did an error message for this.
7094 if (ARGCOUNT == 0)
7095 return;
7097 # ifdef FEAT_WINDOWS
7098 if (cmdmod.tab)
7100 /* ":tab drop file ...": open a tab for each argument that isn't
7101 * edited in a window yet. It's like ":tab all" but without closing
7102 * windows or tabs. */
7103 ex_all(eap);
7105 else
7106 # endif
7108 /* ":drop file ...": Edit the first argument. Jump to an existing
7109 * window if possible, edit in current window if the current buffer
7110 * can be abandoned, otherwise open a new window. */
7111 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7113 FOR_ALL_TAB_WINDOWS(tp, wp)
7115 if (wp->w_buffer == buf)
7117 # ifdef FEAT_WINDOWS
7118 goto_tabpage_win(tp, wp);
7119 # endif
7120 curwin->w_arg_idx = 0;
7121 return;
7126 * Check whether the current buffer is changed. If so, we will need
7127 * to split the current window or data could be lost.
7128 * Skip the check if the 'hidden' option is set, as in this case the
7129 * buffer won't be lost.
7131 if (!P_HID(curbuf))
7133 # ifdef FEAT_WINDOWS
7134 ++emsg_off;
7135 # endif
7136 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7137 # ifdef FEAT_WINDOWS
7138 --emsg_off;
7139 # else
7140 if (split)
7141 return;
7142 # endif
7145 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7146 if (split)
7148 eap->cmdidx = CMD_sfirst;
7149 eap->cmd[0] = 's';
7151 else
7152 eap->cmdidx = CMD_first;
7153 ex_rewind(eap);
7156 #endif