Merged from the latest developing branch.
[MacVim/KaoriYa.git] / src / ex_cmds.c
blob335b2bae7ee0b8b81d491b74a60936bb9cd1c926
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 #include "vim.h"
15 #ifdef HAVE_FCNTL_H
16 # include <fcntl.h>
17 #endif
18 #include "version.h"
20 #ifdef FEAT_EX_EXTRA
21 static int linelen __ARGS((int *has_tab));
22 #endif
23 static void do_filter __ARGS((linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out));
24 #ifdef FEAT_VIMINFO
25 static char_u *viminfo_filename __ARGS((char_u *));
26 static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int want_info, int want_marks, int force_read));
27 static int viminfo_encoding __ARGS((vir_T *virp));
28 static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
29 #endif
31 static int check_overwrite __ARGS((exarg_T *eap, buf_T *buf, char_u *fname, char_u *ffname, int other));
32 static int check_readonly __ARGS((int *forceit, buf_T *buf));
33 #ifdef FEAT_AUTOCMD
34 static void delbuf_msg __ARGS((char_u *name));
35 #endif
36 static int
37 #ifdef __BORLANDC__
38 _RTLENTRYF
39 #endif
40 help_compare __ARGS((const void *s1, const void *s2));
43 * ":ascii" and "ga".
45 /*ARGSUSED*/
46 void
47 do_ascii(eap)
48 exarg_T *eap;
50 int c;
51 char buf1[20];
52 char buf2[20];
53 char_u buf3[7];
54 #ifdef FEAT_MBYTE
55 int cc[MAX_MCO];
56 int ci = 0;
57 int len;
59 if (enc_utf8)
60 c = utfc_ptr2char(ml_get_cursor(), cc);
61 else
62 #endif
63 c = gchar_cursor();
64 if (c == NUL)
66 MSG("NUL");
67 return;
70 #ifdef FEAT_MBYTE
71 IObuff[0] = NUL;
72 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
73 #endif
75 if (c == NL) /* NUL is stored as NL */
76 c = NUL;
77 if (vim_isprintc_strict(c) && (c < ' '
78 #ifndef EBCDIC
79 || c > '~'
80 #endif
83 transchar_nonprint(buf3, c);
84 sprintf(buf1, " <%s>", (char *)buf3);
86 else
87 buf1[0] = NUL;
88 #ifndef EBCDIC
89 if (c >= 0x80)
90 sprintf(buf2, " <M-%s>", transchar(c & 0x7f));
91 else
92 #endif
93 buf2[0] = NUL;
94 vim_snprintf((char *)IObuff, IOSIZE,
95 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
96 transchar(c), buf1, buf2, c, c, c);
97 #ifdef FEAT_MBYTE
98 if (enc_utf8)
99 c = cc[ci++];
100 else
101 c = 0;
102 #endif
105 #ifdef FEAT_MBYTE
106 /* Repeat for combining characters. */
107 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
109 len = (int)STRLEN(IObuff);
110 /* This assumes every multi-byte char is printable... */
111 if (len > 0)
112 IObuff[len++] = ' ';
113 IObuff[len++] = '<';
114 if (enc_utf8 && utf_iscomposing(c)
115 # ifdef USE_GUI
116 && !gui.in_use
117 # endif
119 IObuff[len++] = ' '; /* draw composing char on top of a space */
120 len += (*mb_char2bytes)(c, IObuff + len);
121 vim_snprintf((char *)IObuff + len, IOSIZE - len,
122 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
123 : _("> %d, Hex %08x, Octal %o"), c, c, c);
124 if (ci == MAX_MCO)
125 break;
126 if (enc_utf8)
127 c = cc[ci++];
128 else
129 c = 0;
131 #endif
133 msg(IObuff);
136 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
138 * ":left", ":center" and ":right": align text.
140 void
141 ex_align(eap)
142 exarg_T *eap;
144 pos_T save_curpos;
145 int len;
146 int indent = 0;
147 int new_indent;
148 int has_tab;
149 int width;
151 #ifdef FEAT_RIGHTLEFT
152 if (curwin->w_p_rl)
154 /* switch left and right aligning */
155 if (eap->cmdidx == CMD_right)
156 eap->cmdidx = CMD_left;
157 else if (eap->cmdidx == CMD_left)
158 eap->cmdidx = CMD_right;
160 #endif
162 width = atoi((char *)eap->arg);
163 save_curpos = curwin->w_cursor;
164 if (eap->cmdidx == CMD_left) /* width is used for new indent */
166 if (width >= 0)
167 indent = width;
169 else
172 * if 'textwidth' set, use it
173 * else if 'wrapmargin' set, use it
174 * if invalid value, use 80
176 if (width <= 0)
177 width = curbuf->b_p_tw;
178 if (width == 0 && curbuf->b_p_wm > 0)
179 width = W_WIDTH(curwin) - curbuf->b_p_wm;
180 if (width <= 0)
181 width = 80;
184 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
185 return;
187 for (curwin->w_cursor.lnum = eap->line1;
188 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
190 if (eap->cmdidx == CMD_left) /* left align */
191 new_indent = indent;
192 else
194 has_tab = FALSE; /* avoid uninit warnings */
195 len = linelen(eap->cmdidx == CMD_right ? &has_tab
196 : NULL) - get_indent();
198 if (len <= 0) /* skip blank lines */
199 continue;
201 if (eap->cmdidx == CMD_center)
202 new_indent = (width - len) / 2;
203 else
205 new_indent = width - len; /* right align */
208 * Make sure that embedded TABs don't make the text go too far
209 * to the right.
211 if (has_tab)
212 while (new_indent > 0)
214 (void)set_indent(new_indent, 0);
215 if (linelen(NULL) <= width)
218 * Now try to move the line as much as possible to
219 * the right. Stop when it moves too far.
222 (void)set_indent(++new_indent, 0);
223 while (linelen(NULL) <= width);
224 --new_indent;
225 break;
227 --new_indent;
231 if (new_indent < 0)
232 new_indent = 0;
233 (void)set_indent(new_indent, 0); /* set indent */
235 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
236 curwin->w_cursor = save_curpos;
237 beginline(BL_WHITE | BL_FIX);
241 * Get the length of the current line, excluding trailing white space.
243 static int
244 linelen(has_tab)
245 int *has_tab;
247 char_u *line;
248 char_u *first;
249 char_u *last;
250 int save;
251 int len;
253 /* find the first non-blank character */
254 line = ml_get_curline();
255 first = skipwhite(line);
257 /* find the character after the last non-blank character */
258 for (last = first + STRLEN(first);
259 last > first && vim_iswhite(last[-1]); --last)
261 save = *last;
262 *last = NUL;
263 len = linetabsize(line); /* get line length */
264 if (has_tab != NULL) /* check for embedded TAB */
265 *has_tab = (vim_strrchr(first, TAB) != NULL);
266 *last = save;
268 return len;
271 /* Buffer for two lines used during sorting. They are allocated to
272 * contain the longest line being sorted. */
273 static char_u *sortbuf1;
274 static char_u *sortbuf2;
276 static int sort_ic; /* ignore case */
277 static int sort_nr; /* sort on number */
278 static int sort_rx; /* sort on regex instead of skipping it */
280 static int sort_abort; /* flag to indicate if sorting has been interrupted */
282 /* Struct to store info to be sorted. */
283 typedef struct
285 linenr_T lnum; /* line number */
286 long start_col_nr; /* starting column number or number */
287 long end_col_nr; /* ending column number */
288 } sorti_T;
290 static int
291 #ifdef __BORLANDC__
292 _RTLENTRYF
293 #endif
294 sort_compare __ARGS((const void *s1, const void *s2));
296 static int
297 #ifdef __BORLANDC__
298 _RTLENTRYF
299 #endif
300 sort_compare(s1, s2)
301 const void *s1;
302 const void *s2;
304 sorti_T l1 = *(sorti_T *)s1;
305 sorti_T l2 = *(sorti_T *)s2;
306 int result = 0;
308 /* If the user interrupts, there's no way to stop qsort() immediately, but
309 * if we return 0 every time, qsort will assume it's done sorting and
310 * exit. */
311 if (sort_abort)
312 return 0;
313 fast_breakcheck();
314 if (got_int)
315 sort_abort = TRUE;
317 /* When sorting numbers "start_col_nr" is the number, not the column
318 * number. */
319 if (sort_nr)
320 result = l1.start_col_nr - l2.start_col_nr;
321 else
323 /* We need to copy one line into "sortbuf1", because there is no
324 * guarantee that the first pointer becomes invalid when obtaining the
325 * second one. */
326 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
327 l1.end_col_nr - l1.start_col_nr + 1);
328 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
329 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
330 l2.end_col_nr - l2.start_col_nr + 1);
331 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
333 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
334 : STRCMP(sortbuf1, sortbuf2);
337 /* If two lines have the same value, preserve the original line order. */
338 if (result == 0)
339 return (int)(l1.lnum - l2.lnum);
340 return result;
344 * ":sort".
346 void
347 ex_sort(eap)
348 exarg_T *eap;
350 regmatch_T regmatch;
351 int len;
352 linenr_T lnum;
353 long maxlen = 0;
354 sorti_T *nrs;
355 size_t count = eap->line2 - eap->line1 + 1;
356 size_t i;
357 char_u *p;
358 char_u *s;
359 char_u *s2;
360 char_u c; /* temporary character storage */
361 int unique = FALSE;
362 long deleted;
363 colnr_T start_col;
364 colnr_T end_col;
365 int sort_oct; /* sort on octal number */
366 int sort_hex; /* sort on hex number */
368 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
369 return;
370 sortbuf1 = NULL;
371 sortbuf2 = NULL;
372 regmatch.regprog = NULL;
373 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
374 if (nrs == NULL)
375 goto sortend;
377 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
379 for (p = eap->arg; *p != NUL; ++p)
381 if (vim_iswhite(*p))
383 else if (*p == 'i')
384 sort_ic = TRUE;
385 else if (*p == 'r')
386 sort_rx = TRUE;
387 else if (*p == 'n')
388 sort_nr = 2;
389 else if (*p == 'o')
390 sort_oct = 2;
391 else if (*p == 'x')
392 sort_hex = 2;
393 else if (*p == 'u')
394 unique = TRUE;
395 else if (*p == '"') /* comment start */
396 break;
397 else if (check_nextcmd(p) != NULL)
399 eap->nextcmd = check_nextcmd(p);
400 break;
402 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
404 s = skip_regexp(p + 1, *p, TRUE, NULL);
405 if (*s != *p)
407 EMSG(_(e_invalpat));
408 goto sortend;
410 *s = NUL;
411 /* Use last search pattern if sort pattern is empty. */
412 if (s == p + 1 && last_search_pat() != NULL)
413 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
414 else
415 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
416 if (regmatch.regprog == NULL)
417 goto sortend;
418 p = s; /* continue after the regexp */
419 regmatch.rm_ic = p_ic;
421 else
423 EMSG2(_(e_invarg2), p);
424 goto sortend;
428 /* Can only have one of 'n', 'o' and 'x'. */
429 if (sort_nr + sort_oct + sort_hex > 2)
431 EMSG(_(e_invarg));
432 goto sortend;
435 /* From here on "sort_nr" is used as a flag for any number sorting. */
436 sort_nr += sort_oct + sort_hex;
439 * Make an array with all line numbers. This avoids having to copy all
440 * the lines into allocated memory.
441 * When sorting on strings "start_col_nr" is the offset in the line, for
442 * numbers sorting it's the number to sort on. This means the pattern
443 * matching and number conversion only has to be done once per line.
444 * Also get the longest line length for allocating "sortbuf".
446 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
448 s = ml_get(lnum);
449 len = (int)STRLEN(s);
450 if (maxlen < len)
451 maxlen = len;
453 start_col = 0;
454 end_col = len;
455 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
457 if (sort_rx)
459 start_col = (colnr_T)(regmatch.startp[0] - s);
460 end_col = (colnr_T)(regmatch.endp[0] - s);
462 else
463 start_col = (colnr_T)(regmatch.endp[0] - s);
465 else
466 if (regmatch.regprog != NULL)
467 end_col = 0;
469 if (sort_nr)
471 /* Make sure vim_str2nr doesn't read any digits past the end
472 * of the match, by temporarily terminating the string there */
473 s2 = s + end_col;
474 c = *s2;
475 (*s2) = 0;
476 /* Sorting on number: Store the number itself. */
477 if (sort_hex)
478 s = skiptohex(s + start_col);
479 else
480 s = skiptodigit(s + start_col);
481 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
482 &nrs[lnum - eap->line1].start_col_nr, NULL);
483 (*s2) = c;
485 else
487 /* Store the column to sort at. */
488 nrs[lnum - eap->line1].start_col_nr = start_col;
489 nrs[lnum - eap->line1].end_col_nr = end_col;
492 nrs[lnum - eap->line1].lnum = lnum;
494 if (regmatch.regprog != NULL)
495 fast_breakcheck();
496 if (got_int)
497 goto sortend;
500 /* Allocate a buffer that can hold the longest line. */
501 sortbuf1 = alloc((unsigned)maxlen + 1);
502 if (sortbuf1 == NULL)
503 goto sortend;
504 sortbuf2 = alloc((unsigned)maxlen + 1);
505 if (sortbuf2 == NULL)
506 goto sortend;
508 /* Sort the array of line numbers. Note: can't be interrupted! */
509 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
511 if (sort_abort)
512 goto sortend;
514 /* Insert the lines in the sorted order below the last one. */
515 lnum = eap->line2;
516 for (i = 0; i < count; ++i)
518 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
519 if (!unique || i == 0
520 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
522 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
523 break;
524 if (unique)
525 STRCPY(sortbuf1, s);
527 fast_breakcheck();
528 if (got_int)
529 goto sortend;
532 /* delete the original lines if appending worked */
533 if (i == count)
534 for (i = 0; i < count; ++i)
535 ml_delete(eap->line1, FALSE);
536 else
537 count = 0;
539 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
540 deleted = (long)(count - (lnum - eap->line2));
541 if (deleted > 0)
542 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
543 else if (deleted < 0)
544 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
545 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
547 curwin->w_cursor.lnum = eap->line1;
548 beginline(BL_WHITE | BL_FIX);
550 sortend:
551 vim_free(nrs);
552 vim_free(sortbuf1);
553 vim_free(sortbuf2);
554 vim_free(regmatch.regprog);
555 if (got_int)
556 EMSG(_(e_interr));
560 * ":retab".
562 void
563 ex_retab(eap)
564 exarg_T *eap;
566 linenr_T lnum;
567 int got_tab = FALSE;
568 long num_spaces = 0;
569 long num_tabs;
570 long len;
571 long col;
572 long vcol;
573 long start_col = 0; /* For start of white-space string */
574 long start_vcol = 0; /* For start of white-space string */
575 int temp;
576 long old_len;
577 char_u *ptr;
578 char_u *new_line = (char_u *)1; /* init to non-NULL */
579 int did_undo; /* called u_save for current line */
580 int new_ts;
581 int save_list;
582 linenr_T first_line = 0; /* first changed line */
583 linenr_T last_line = 0; /* last changed line */
585 save_list = curwin->w_p_list;
586 curwin->w_p_list = 0; /* don't want list mode here */
588 new_ts = getdigits(&(eap->arg));
589 if (new_ts < 0)
591 EMSG(_(e_positive));
592 return;
594 if (new_ts == 0)
595 new_ts = curbuf->b_p_ts;
596 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
598 ptr = ml_get(lnum);
599 col = 0;
600 vcol = 0;
601 did_undo = FALSE;
602 for (;;)
604 if (vim_iswhite(ptr[col]))
606 if (!got_tab && num_spaces == 0)
608 /* First consecutive white-space */
609 start_vcol = vcol;
610 start_col = col;
612 if (ptr[col] == ' ')
613 num_spaces++;
614 else
615 got_tab = TRUE;
617 else
619 if (got_tab || (eap->forceit && num_spaces > 1))
621 /* Retabulate this string of white-space */
623 /* len is virtual length of white string */
624 len = num_spaces = vcol - start_vcol;
625 num_tabs = 0;
626 if (!curbuf->b_p_et)
628 temp = new_ts - (start_vcol % new_ts);
629 if (num_spaces >= temp)
631 num_spaces -= temp;
632 num_tabs++;
634 num_tabs += num_spaces / new_ts;
635 num_spaces -= (num_spaces / new_ts) * new_ts;
637 if (curbuf->b_p_et || got_tab ||
638 (num_spaces + num_tabs < len))
640 if (did_undo == FALSE)
642 did_undo = TRUE;
643 if (u_save((linenr_T)(lnum - 1),
644 (linenr_T)(lnum + 1)) == FAIL)
646 new_line = NULL; /* flag out-of-memory */
647 break;
651 /* len is actual number of white characters used */
652 len = num_spaces + num_tabs;
653 old_len = (long)STRLEN(ptr);
654 new_line = lalloc(old_len - col + start_col + len + 1,
655 TRUE);
656 if (new_line == NULL)
657 break;
658 if (start_col > 0)
659 mch_memmove(new_line, ptr, (size_t)start_col);
660 mch_memmove(new_line + start_col + len,
661 ptr + col, (size_t)(old_len - col + 1));
662 ptr = new_line + start_col;
663 for (col = 0; col < len; col++)
664 ptr[col] = (col < num_tabs) ? '\t' : ' ';
665 ml_replace(lnum, new_line, FALSE);
666 if (first_line == 0)
667 first_line = lnum;
668 last_line = lnum;
669 ptr = new_line;
670 col = start_col + len;
673 got_tab = FALSE;
674 num_spaces = 0;
676 if (ptr[col] == NUL)
677 break;
678 vcol += chartabsize(ptr + col, (colnr_T)vcol);
679 #ifdef FEAT_MBYTE
680 if (has_mbyte)
681 col += (*mb_ptr2len)(ptr + col);
682 else
683 #endif
684 ++col;
686 if (new_line == NULL) /* out of memory */
687 break;
688 line_breakcheck();
690 if (got_int)
691 EMSG(_(e_interr));
693 if (curbuf->b_p_ts != new_ts)
694 redraw_curbuf_later(NOT_VALID);
695 if (first_line != 0)
696 changed_lines(first_line, 0, last_line + 1, 0L);
698 curwin->w_p_list = save_list; /* restore 'list' */
700 curbuf->b_p_ts = new_ts;
701 coladvance(curwin->w_curswant);
703 u_clearline();
705 #endif
708 * :move command - move lines line1-line2 to line dest
710 * return FAIL for failure, OK otherwise
713 do_move(line1, line2, dest)
714 linenr_T line1;
715 linenr_T line2;
716 linenr_T dest;
718 char_u *str;
719 linenr_T l;
720 linenr_T extra; /* Num lines added before line1 */
721 linenr_T num_lines; /* Num lines moved */
722 linenr_T last_line; /* Last line in file after adding new text */
724 if (dest >= line1 && dest < line2)
726 EMSG(_("E134: Move lines into themselves"));
727 return FAIL;
730 num_lines = line2 - line1 + 1;
733 * First we copy the old text to its new location -- webb
734 * Also copy the flag that ":global" command uses.
736 if (u_save(dest, dest + 1) == FAIL)
737 return FAIL;
738 for (extra = 0, l = line1; l <= line2; l++)
740 str = vim_strsave(ml_get(l + extra));
741 if (str != NULL)
743 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
744 vim_free(str);
745 if (dest < line1)
746 extra++;
751 * Now we must be careful adjusting our marks so that we don't overlap our
752 * mark_adjust() calls.
754 * We adjust the marks within the old text so that they refer to the
755 * last lines of the file (temporarily), because we know no other marks
756 * will be set there since these line numbers did not exist until we added
757 * our new lines.
759 * Then we adjust the marks on lines between the old and new text positions
760 * (either forwards or backwards).
762 * And Finally we adjust the marks we put at the end of the file back to
763 * their final destination at the new text position -- webb
765 last_line = curbuf->b_ml.ml_line_count;
766 mark_adjust(line1, line2, last_line - line2, 0L);
767 if (dest >= line2)
769 mark_adjust(line2 + 1, dest, -num_lines, 0L);
770 curbuf->b_op_start.lnum = dest - num_lines + 1;
771 curbuf->b_op_end.lnum = dest;
773 else
775 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
776 curbuf->b_op_start.lnum = dest + 1;
777 curbuf->b_op_end.lnum = dest + num_lines;
779 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
780 mark_adjust(last_line - num_lines + 1, last_line,
781 -(last_line - dest - extra), 0L);
784 * Now we delete the original text -- webb
786 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
787 return FAIL;
789 for (l = line1; l <= line2; l++)
790 ml_delete(line1 + extra, TRUE);
792 if (!global_busy && num_lines > p_report)
794 if (num_lines == 1)
795 MSG(_("1 line moved"));
796 else
797 smsg((char_u *)_("%ld lines moved"), num_lines);
801 * Leave the cursor on the last of the moved lines.
803 if (dest >= line1)
804 curwin->w_cursor.lnum = dest;
805 else
806 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
808 if (line1 < dest)
809 changed_lines(line1, 0, dest + num_lines + 1, 0L);
810 else
811 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
813 return OK;
817 * ":copy"
819 void
820 ex_copy(line1, line2, n)
821 linenr_T line1;
822 linenr_T line2;
823 linenr_T n;
825 linenr_T count;
826 char_u *p;
828 count = line2 - line1 + 1;
829 curbuf->b_op_start.lnum = n + 1;
830 curbuf->b_op_end.lnum = n + count;
831 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
834 * there are three situations:
835 * 1. destination is above line1
836 * 2. destination is between line1 and line2
837 * 3. destination is below line2
839 * n = destination (when starting)
840 * curwin->w_cursor.lnum = destination (while copying)
841 * line1 = start of source (while copying)
842 * line2 = end of source (while copying)
844 if (u_save(n, n + 1) == FAIL)
845 return;
847 curwin->w_cursor.lnum = n;
848 while (line1 <= line2)
850 /* need to use vim_strsave() because the line will be unlocked within
851 * ml_append() */
852 p = vim_strsave(ml_get(line1));
853 if (p != NULL)
855 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
856 vim_free(p);
858 /* situation 2: skip already copied lines */
859 if (line1 == n)
860 line1 = curwin->w_cursor.lnum;
861 ++line1;
862 if (curwin->w_cursor.lnum < line1)
863 ++line1;
864 if (curwin->w_cursor.lnum < line2)
865 ++line2;
866 ++curwin->w_cursor.lnum;
869 appended_lines_mark(n, count);
871 msgmore((long)count);
874 static char_u *prevcmd = NULL; /* the previous command */
876 #if defined(EXITFREE) || defined(PROTO)
877 void
878 free_prev_shellcmd()
880 vim_free(prevcmd);
882 #endif
885 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
886 * Bangs in the argument are replaced with the previously entered command.
887 * Remember the argument.
889 * RISCOS: Bangs only replaced when followed by a space, since many
890 * pathnames contain one.
892 void
893 do_bang(addr_count, eap, forceit, do_in, do_out)
894 int addr_count;
895 exarg_T *eap;
896 int forceit;
897 int do_in, do_out;
899 char_u *arg = eap->arg; /* command */
900 linenr_T line1 = eap->line1; /* start of range */
901 linenr_T line2 = eap->line2; /* end of range */
902 char_u *newcmd = NULL; /* the new command */
903 int free_newcmd = FALSE; /* need to free() newcmd */
904 int ins_prevcmd;
905 char_u *t;
906 char_u *p;
907 char_u *trailarg;
908 int len;
909 int scroll_save = msg_scroll;
912 * Disallow shell commands for "rvim".
913 * Disallow shell commands from .exrc and .vimrc in current directory for
914 * security reasons.
916 if (check_restricted() || check_secure())
917 return;
919 if (addr_count == 0) /* :! */
921 msg_scroll = FALSE; /* don't scroll here */
922 autowrite_all();
923 msg_scroll = scroll_save;
927 * Try to find an embedded bang, like in :!<cmd> ! [args]
928 * (:!! is indicated by the 'forceit' variable)
930 ins_prevcmd = forceit;
931 trailarg = arg;
934 len = (int)STRLEN(trailarg) + 1;
935 if (newcmd != NULL)
936 len += (int)STRLEN(newcmd);
937 if (ins_prevcmd)
939 if (prevcmd == NULL)
941 EMSG(_(e_noprev));
942 vim_free(newcmd);
943 return;
945 len += (int)STRLEN(prevcmd);
947 if ((t = alloc(len)) == NULL)
949 vim_free(newcmd);
950 return;
952 *t = NUL;
953 if (newcmd != NULL)
954 STRCAT(t, newcmd);
955 if (ins_prevcmd)
956 STRCAT(t, prevcmd);
957 p = t + STRLEN(t);
958 STRCAT(t, trailarg);
959 vim_free(newcmd);
960 newcmd = t;
963 * Scan the rest of the argument for '!', which is replaced by the
964 * previous command. "\!" is replaced by "!" (this is vi compatible).
966 trailarg = NULL;
967 while (*p)
969 if (*p == '!'
970 #ifdef RISCOS
971 && (p[1] == ' ' || p[1] == NUL)
972 #endif
975 if (p > newcmd && p[-1] == '\\')
976 mch_memmove(p - 1, p, (size_t)(STRLEN(p) + 1));
977 else
979 trailarg = p;
980 *trailarg++ = NUL;
981 ins_prevcmd = TRUE;
982 break;
985 ++p;
987 } while (trailarg != NULL);
989 vim_free(prevcmd);
990 prevcmd = newcmd;
992 if (bangredo) /* put cmd in redo buffer for ! command */
994 AppendToRedobuffLit(prevcmd, -1);
995 AppendToRedobuff((char_u *)"\n");
996 bangredo = FALSE;
999 * Add quotes around the command, for shells that need them.
1001 if (*p_shq != NUL)
1003 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1004 if (newcmd == NULL)
1005 return;
1006 STRCPY(newcmd, p_shq);
1007 STRCAT(newcmd, prevcmd);
1008 STRCAT(newcmd, p_shq);
1009 free_newcmd = TRUE;
1011 if (addr_count == 0) /* :! */
1013 /* echo the command */
1014 msg_start();
1015 msg_putchar(':');
1016 msg_putchar('!');
1017 msg_outtrans(newcmd);
1018 msg_clr_eos();
1019 windgoto(msg_row, msg_col);
1021 do_shell(newcmd, 0);
1023 else /* :range! */
1025 /* Careful: This may recursively call do_bang() again! (because of
1026 * autocommands) */
1027 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1028 #ifdef FEAT_AUTOCMD
1029 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1030 #endif
1032 if (free_newcmd)
1033 vim_free(newcmd);
1037 * do_filter: filter lines through a command given by the user
1039 * We mostly use temp files and the call_shell() routine here. This would
1040 * normally be done using pipes on a UNIX machine, but this is more portable
1041 * to non-unix machines. The call_shell() routine needs to be able
1042 * to deal with redirection somehow, and should handle things like looking
1043 * at the PATH env. variable, and adding reasonable extensions to the
1044 * command name given by the user. All reasonable versions of call_shell()
1045 * do this.
1046 * Alternatively, if on Unix and redirecting input or output, but not both,
1047 * and the 'shelltemp' option isn't set, use pipes.
1048 * We use input redirection if do_in is TRUE.
1049 * We use output redirection if do_out is TRUE.
1051 static void
1052 do_filter(line1, line2, eap, cmd, do_in, do_out)
1053 linenr_T line1, line2;
1054 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1055 char_u *cmd;
1056 int do_in, do_out;
1058 char_u *itmp = NULL;
1059 char_u *otmp = NULL;
1060 linenr_T linecount;
1061 linenr_T read_linecount;
1062 pos_T cursor_save;
1063 char_u *cmd_buf;
1064 #ifdef FEAT_AUTOCMD
1065 buf_T *old_curbuf = curbuf;
1066 #endif
1067 int shell_flags = 0;
1069 if (*cmd == NUL) /* no filter command */
1070 return;
1072 #ifdef WIN3264
1074 * Check if external commands are allowed now.
1076 if (can_end_termcap_mode(TRUE) == FALSE)
1077 return;
1078 #endif
1080 cursor_save = curwin->w_cursor;
1081 linecount = line2 - line1 + 1;
1082 curwin->w_cursor.lnum = line1;
1083 curwin->w_cursor.col = 0;
1084 changed_line_abv_curs();
1085 invalidate_botline();
1088 * When using temp files:
1089 * 1. * Form temp file names
1090 * 2. * Write the lines to a temp file
1091 * 3. Run the filter command on the temp file
1092 * 4. * Read the output of the command into the buffer
1093 * 5. * Delete the original lines to be filtered
1094 * 6. * Remove the temp files
1096 * When writing the input with a pipe or when catching the output with a
1097 * pipe only need to do 3.
1100 if (do_out)
1101 shell_flags |= SHELL_DOOUT;
1103 #if !defined(USE_SYSTEM) && defined(UNIX)
1104 if (!do_in && do_out && !p_stmp)
1106 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1107 shell_flags |= SHELL_READ;
1108 curwin->w_cursor.lnum = line2;
1110 else if (do_in && !do_out && !p_stmp)
1112 /* Use a pipe to write stdin of the command, do not use a temp file. */
1113 shell_flags |= SHELL_WRITE;
1114 curbuf->b_op_start.lnum = line1;
1115 curbuf->b_op_end.lnum = line2;
1117 else if (do_in && do_out && !p_stmp)
1119 /* Use a pipe to write stdin and fetch stdout of the command, do not
1120 * use a temp file. */
1121 shell_flags |= SHELL_READ|SHELL_WRITE;
1122 curbuf->b_op_start.lnum = line1;
1123 curbuf->b_op_end.lnum = line2;
1124 curwin->w_cursor.lnum = line2;
1126 else
1127 #endif
1128 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1129 || (do_out && (otmp = vim_tempname('o')) == NULL))
1131 EMSG(_(e_notmp));
1132 goto filterend;
1136 * The writing and reading of temp files will not be shown.
1137 * Vi also doesn't do this and the messages are not very informative.
1139 ++no_wait_return; /* don't call wait_return() while busy */
1140 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1141 FALSE, FALSE, FALSE, TRUE) == FAIL)
1143 msg_putchar('\n'); /* keep message from buf_write() */
1144 --no_wait_return;
1145 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1146 if (!aborting())
1147 #endif
1148 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1149 goto filterend;
1151 #ifdef FEAT_AUTOCMD
1152 if (curbuf != old_curbuf)
1153 goto filterend;
1154 #endif
1156 if (!do_out)
1157 msg_putchar('\n');
1159 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1160 if (cmd_buf == NULL)
1161 goto filterend;
1163 windgoto((int)Rows - 1, 0);
1164 cursor_on();
1167 * When not redirecting the output the command can write anything to the
1168 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1169 * stderr output of external command. Clear the screen later.
1170 * If do_in is FALSE, this could be something like ":r !cat", which may
1171 * also mess up the screen, clear it later.
1173 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1174 redraw_later_clear();
1176 if (do_out)
1178 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1179 goto error;
1180 redraw_curbuf_later(VALID);
1182 read_linecount = curbuf->b_ml.ml_line_count;
1185 * When call_shell() fails wait_return() is called to give the user a
1186 * chance to read the error messages. Otherwise errors are ignored, so you
1187 * can see the error messages from the command that appear on stdout; use
1188 * 'u' to fix the text
1189 * Switch to cooked mode when not redirecting stdin, avoids that something
1190 * like ":r !cat" hangs.
1191 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1193 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1195 redraw_later_clear();
1196 wait_return(FALSE);
1198 vim_free(cmd_buf);
1200 did_check_timestamps = FALSE;
1201 need_check_timestamps = TRUE;
1203 /* When interrupting the shell command, it may still have produced some
1204 * useful output. Reset got_int here, so that readfile() won't cancel
1205 * reading. */
1206 ui_breakcheck();
1207 got_int = FALSE;
1209 if (do_out)
1211 if (otmp != NULL)
1213 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1214 eap, READ_FILTER) == FAIL)
1216 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1217 if (!aborting())
1218 #endif
1220 msg_putchar('\n');
1221 EMSG2(_(e_notread), otmp);
1223 goto error;
1225 #ifdef FEAT_AUTOCMD
1226 if (curbuf != old_curbuf)
1227 goto filterend;
1228 #endif
1231 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1233 if (shell_flags & SHELL_READ)
1235 curbuf->b_op_start.lnum = line2 + 1;
1236 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1237 appended_lines_mark(line2, read_linecount);
1240 if (do_in)
1242 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1244 if (read_linecount >= linecount)
1245 /* move all marks from old lines to new lines */
1246 mark_adjust(line1, line2, linecount, 0L);
1247 else
1249 /* move marks from old lines to new lines, delete marks
1250 * that are in deleted lines */
1251 mark_adjust(line1, line1 + read_linecount - 1,
1252 linecount, 0L);
1253 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1258 * Put cursor on first filtered line for ":range!cmd".
1259 * Adjust '[ and '] (set by buf_write()).
1261 curwin->w_cursor.lnum = line1;
1262 del_lines(linecount, TRUE);
1263 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1264 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1265 write_lnum_adjust(-linecount); /* adjust last line
1266 for next write */
1267 #ifdef FEAT_FOLDING
1268 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1269 #endif
1271 else
1274 * Put cursor on last new line for ":r !cmd".
1276 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1277 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1280 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1281 --no_wait_return;
1283 if (linecount > p_report)
1285 if (do_in)
1287 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1288 _("%ld lines filtered"), (long)linecount);
1289 if (msg(msg_buf) && !msg_scroll)
1290 /* save message to display it after redraw */
1291 set_keep_msg(msg_buf, 0);
1293 else
1294 msgmore((long)linecount);
1297 else
1299 error:
1300 /* put cursor back in same position for ":w !cmd" */
1301 curwin->w_cursor = cursor_save;
1302 --no_wait_return;
1303 wait_return(FALSE);
1306 filterend:
1308 #ifdef FEAT_AUTOCMD
1309 if (curbuf != old_curbuf)
1311 --no_wait_return;
1312 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1314 #endif
1315 if (itmp != NULL)
1316 mch_remove(itmp);
1317 if (otmp != NULL)
1318 mch_remove(otmp);
1319 vim_free(itmp);
1320 vim_free(otmp);
1324 * Call a shell to execute a command.
1325 * When "cmd" is NULL start an interactive shell.
1327 void
1328 do_shell(cmd, flags)
1329 char_u *cmd;
1330 int flags; /* may be SHELL_DOOUT when output is redirected */
1332 buf_T *buf;
1333 #ifndef FEAT_GUI_MSWIN
1334 int save_nwr;
1335 #endif
1336 #ifdef MSWIN
1337 int winstart = FALSE;
1338 #endif
1341 * Disallow shell commands for "rvim".
1342 * Disallow shell commands from .exrc and .vimrc in current directory for
1343 * security reasons.
1345 if (check_restricted() || check_secure())
1347 msg_end();
1348 return;
1351 #ifdef MSWIN
1353 * Check if external commands are allowed now.
1355 if (can_end_termcap_mode(TRUE) == FALSE)
1356 return;
1359 * Check if ":!start" is used.
1361 if (cmd != NULL)
1362 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1363 #endif
1366 * For autocommands we want to get the output on the current screen, to
1367 * avoid having to type return below.
1369 msg_putchar('\r'); /* put cursor at start of line */
1370 #ifdef FEAT_AUTOCMD
1371 if (!autocmd_busy)
1372 #endif
1374 #ifdef MSWIN
1375 if (!winstart)
1376 #endif
1377 stoptermcap();
1379 #ifdef MSWIN
1380 if (!winstart)
1381 #endif
1382 msg_putchar('\n'); /* may shift screen one line up */
1384 /* warning message before calling the shell */
1385 if (p_warn
1386 #ifdef FEAT_AUTOCMD
1387 && !autocmd_busy
1388 #endif
1389 && msg_silent == 0)
1390 for (buf = firstbuf; buf; buf = buf->b_next)
1391 if (bufIsChanged(buf))
1393 #ifdef FEAT_GUI_MSWIN
1394 if (!winstart)
1395 starttermcap(); /* don't want a message box here */
1396 #endif
1397 MSG_PUTS(_("[No write since last change]\n"));
1398 #ifdef FEAT_GUI_MSWIN
1399 if (!winstart)
1400 stoptermcap();
1401 #endif
1402 break;
1405 /* This windgoto is required for when the '\n' resulted in a "delete line
1406 * 1" command to the terminal. */
1407 if (!swapping_screen())
1408 windgoto(msg_row, msg_col);
1409 cursor_on();
1410 (void)call_shell(cmd, SHELL_COOKED | flags);
1411 did_check_timestamps = FALSE;
1412 need_check_timestamps = TRUE;
1415 * put the message cursor at the end of the screen, avoids wait_return()
1416 * to overwrite the text that the external command showed
1418 if (!swapping_screen())
1420 msg_row = Rows - 1;
1421 msg_col = 0;
1424 #ifdef FEAT_AUTOCMD
1425 if (autocmd_busy)
1427 if (msg_silent == 0)
1428 redraw_later_clear();
1430 else
1431 #endif
1434 * For ":sh" there is no need to call wait_return(), just redraw.
1435 * Also for the Win32 GUI (the output is in a console window).
1436 * Otherwise there is probably text on the screen that the user wants
1437 * to read before redrawing, so call wait_return().
1439 #ifndef FEAT_GUI_MSWIN
1440 if (cmd == NULL
1441 # ifdef WIN3264
1442 || (winstart && !need_wait_return)
1443 # endif
1446 if (msg_silent == 0)
1447 redraw_later_clear();
1448 need_wait_return = FALSE;
1450 else
1453 * If we switch screens when starttermcap() is called, we really
1454 * want to wait for "hit return to continue".
1456 save_nwr = no_wait_return;
1457 if (swapping_screen())
1458 no_wait_return = FALSE;
1459 # ifdef AMIGA
1460 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1461 # else
1462 wait_return(msg_silent == 0);
1463 # endif
1464 no_wait_return = save_nwr;
1466 #endif /* FEAT_GUI_W32 */
1468 #ifdef MSWIN
1469 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1470 #endif
1471 starttermcap(); /* start termcap if not done by wait_return() */
1474 * In an Amiga window redrawing is caused by asking the window size.
1475 * If we got an interrupt this will not work. The chance that the
1476 * window size is wrong is very small, but we need to redraw the
1477 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1478 * but it saves an extra redraw.
1480 #ifdef AMIGA
1481 if (skip_redraw) /* ':' hit in wait_return() */
1483 if (msg_silent == 0)
1484 redraw_later_clear();
1486 else if (term_console)
1488 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1489 if (got_int && msg_silent == 0)
1490 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1491 else
1492 must_redraw = 0; /* no extra redraw needed */
1494 #endif
1497 /* display any error messages now */
1498 display_errors();
1500 #ifdef FEAT_AUTOCMD
1501 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1502 #endif
1506 * Create a shell command from a command string, input redirection file and
1507 * output redirection file.
1508 * Returns an allocated string with the shell command, or NULL for failure.
1510 char_u *
1511 make_filter_cmd(cmd, itmp, otmp)
1512 char_u *cmd; /* command */
1513 char_u *itmp; /* NULL or name of input file */
1514 char_u *otmp; /* NULL or name of output file */
1516 char_u *buf;
1517 long_u len;
1519 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1520 if (itmp != NULL)
1521 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1522 if (otmp != NULL)
1523 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1524 buf = lalloc(len, TRUE);
1525 if (buf == NULL)
1526 return NULL;
1528 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1530 * Put braces around the command (for concatenated commands) when
1531 * redirecting input and/or output.
1533 if (itmp != NULL || otmp != NULL)
1534 sprintf((char *)buf, "(%s)", (char *)cmd);
1535 else
1536 STRCPY(buf, cmd);
1537 if (itmp != NULL)
1539 STRCAT(buf, " < ");
1540 STRCAT(buf, itmp);
1542 #else
1544 * for shells that don't understand braces around commands, at least allow
1545 * the use of commands in a pipe.
1547 STRCPY(buf, cmd);
1548 if (itmp != NULL)
1550 char_u *p;
1553 * If there is a pipe, we have to put the '<' in front of it.
1554 * Don't do this when 'shellquote' is not empty, otherwise the
1555 * redirection would be inside the quotes.
1557 if (*p_shq == NUL)
1559 p = vim_strchr(buf, '|');
1560 if (p != NULL)
1561 *p = NUL;
1563 # ifdef RISCOS
1564 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1565 STRCAT(buf, itmp);
1566 STRCAT(buf, " } ");
1567 # else
1568 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1569 STRCAT(buf, itmp);
1570 # endif
1571 if (*p_shq == NUL)
1573 p = vim_strchr(cmd, '|');
1574 if (p != NULL)
1576 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1577 STRCAT(buf, p);
1581 #endif
1582 if (otmp != NULL)
1583 append_redir(buf, p_srr, otmp);
1585 return buf;
1589 * Append output redirection for file "fname" to the end of string buffer "buf"
1590 * Works with the 'shellredir' and 'shellpipe' options.
1591 * The caller should make sure that there is enough room:
1592 * STRLEN(opt) + STRLEN(fname) + 3
1594 void
1595 append_redir(buf, opt, fname)
1596 char_u *buf;
1597 char_u *opt;
1598 char_u *fname;
1600 char_u *p;
1602 buf += STRLEN(buf);
1603 /* find "%s", skipping "%%" */
1604 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1605 if (p[1] == 's')
1606 break;
1607 if (p != NULL)
1609 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1610 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1612 else
1613 sprintf((char *)buf,
1614 #ifdef FEAT_QUICKFIX
1615 # ifndef RISCOS
1616 opt != p_sp ? " %s%s" :
1617 # endif
1618 " %s %s",
1619 #else
1620 # ifndef RISCOS
1621 " %s%s", /* " > %s" causes problems on Amiga */
1622 # else
1623 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1624 # endif
1625 #endif
1626 (char *)opt, (char *)fname);
1629 #ifdef FEAT_VIMINFO
1631 static int no_viminfo __ARGS((void));
1632 static int viminfo_errcnt;
1634 static int
1635 no_viminfo()
1637 /* "vim -i NONE" does not read or write a viminfo file */
1638 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1642 * Report an error for reading a viminfo file.
1643 * Count the number of errors. When there are more than 10, return TRUE.
1646 viminfo_error(errnum, message, line)
1647 char *errnum;
1648 char *message;
1649 char_u *line;
1651 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1652 errnum, message);
1653 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1654 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1655 IObuff[STRLEN(IObuff) - 1] = NUL;
1656 emsg(IObuff);
1657 if (++viminfo_errcnt >= 10)
1659 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1660 return TRUE;
1662 return FALSE;
1666 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1667 * set are not over-written unless force is TRUE. -- webb
1670 read_viminfo(file, want_info, want_marks, forceit)
1671 char_u *file;
1672 int want_info;
1673 int want_marks;
1674 int forceit;
1676 FILE *fp;
1677 char_u *fname;
1679 if (no_viminfo())
1680 return FAIL;
1682 fname = viminfo_filename(file); /* may set to default if NULL */
1683 if (fname == NULL)
1684 return FAIL;
1685 fp = mch_fopen((char *)fname, READBIN);
1687 if (p_verbose > 0)
1689 verbose_enter();
1690 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1691 fname,
1692 want_info ? _(" info") : "",
1693 want_marks ? _(" marks") : "",
1694 fp == NULL ? _(" FAILED") : "");
1695 verbose_leave();
1698 vim_free(fname);
1699 if (fp == NULL)
1700 return FAIL;
1702 viminfo_errcnt = 0;
1703 do_viminfo(fp, NULL, want_info, want_marks, forceit);
1705 fclose(fp);
1707 return OK;
1711 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1712 * that effectively a merge of current info and old info is done. This allows
1713 * multiple vims to run simultaneously, without losing any marks etc. If
1714 * forceit is TRUE, then the old file is not read in, and only internal info is
1715 * written to the file. -- webb
1717 void
1718 write_viminfo(file, forceit)
1719 char_u *file;
1720 int forceit;
1722 char_u *fname;
1723 FILE *fp_in = NULL; /* input viminfo file, if any */
1724 FILE *fp_out = NULL; /* output viminfo file */
1725 char_u *tempname = NULL; /* name of temp viminfo file */
1726 struct stat st_new; /* mch_stat() of potential new file */
1727 char_u *wp;
1728 #if defined(UNIX) || defined(VMS)
1729 mode_t umask_save;
1730 #endif
1731 #ifdef UNIX
1732 int shortname = FALSE; /* use 8.3 file name */
1733 struct stat st_old; /* mch_stat() of existing viminfo file */
1734 #endif
1735 #ifdef WIN3264
1736 long perm = -1;
1737 #endif
1739 if (no_viminfo())
1740 return;
1742 fname = viminfo_filename(file); /* may set to default if NULL */
1743 if (fname == NULL)
1744 return;
1746 fp_in = mch_fopen((char *)fname, READBIN);
1747 if (fp_in == NULL)
1749 /* if it does exist, but we can't read it, don't try writing */
1750 if (mch_stat((char *)fname, &st_new) == 0)
1751 goto end;
1752 #if defined(UNIX) || defined(VMS)
1754 * For Unix we create the .viminfo non-accessible for others,
1755 * because it may contain text from non-accessible documents.
1757 umask_save = umask(077);
1758 #endif
1759 fp_out = mch_fopen((char *)fname, WRITEBIN);
1760 #if defined(UNIX) || defined(VMS)
1761 (void)umask(umask_save);
1762 #endif
1764 else
1767 * There is an existing viminfo file. Create a temporary file to
1768 * write the new viminfo into, in the same directory as the
1769 * existing viminfo file, which will be renamed later.
1771 #ifdef UNIX
1773 * For Unix we check the owner of the file. It's not very nice to
1774 * overwrite a user's viminfo file after a "su root", with a
1775 * viminfo file that the user can't read.
1777 st_old.st_dev = 0;
1778 st_old.st_ino = 0;
1779 st_old.st_mode = 0600;
1780 if (mch_stat((char *)fname, &st_old) == 0
1781 && getuid() != ROOT_UID
1782 && !(st_old.st_uid == getuid()
1783 ? (st_old.st_mode & 0200)
1784 : (st_old.st_gid == getgid()
1785 ? (st_old.st_mode & 0020)
1786 : (st_old.st_mode & 0002))))
1788 int tt = msg_didany;
1790 /* avoid a wait_return for this message, it's annoying */
1791 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1792 msg_didany = tt;
1793 fclose(fp_in);
1794 goto end;
1796 #endif
1797 #ifdef WIN3264
1798 /* Get the file attributes of the existing viminfo file. */
1799 perm = mch_getperm(fname);
1800 #endif
1803 * Make tempname.
1804 * May try twice: Once normal and once with shortname set, just in
1805 * case somebody puts his viminfo file in an 8.3 filesystem.
1807 for (;;)
1809 tempname = buf_modname(
1810 #ifdef UNIX
1811 shortname,
1812 #else
1813 # ifdef SHORT_FNAME
1814 TRUE,
1815 # else
1816 # ifdef FEAT_GUI_W32
1817 gui_is_win32s(),
1818 # else
1819 FALSE,
1820 # endif
1821 # endif
1822 #endif
1823 fname,
1824 #ifdef VMS
1825 (char_u *)"-tmp",
1826 #else
1827 # ifdef RISCOS
1828 (char_u *)"/tmp",
1829 # else
1830 (char_u *)".tmp",
1831 # endif
1832 #endif
1833 FALSE);
1834 if (tempname == NULL) /* out of memory */
1835 break;
1838 * Check if tempfile already exists. Never overwrite an
1839 * existing file!
1841 if (mch_stat((char *)tempname, &st_new) == 0)
1843 #ifdef UNIX
1845 * Check if tempfile is same as original file. May happen
1846 * when modname() gave the same file back. E.g. silly
1847 * link, or file name-length reached. Try again with
1848 * shortname set.
1850 if (!shortname && st_new.st_dev == st_old.st_dev
1851 && st_new.st_ino == st_old.st_ino)
1853 vim_free(tempname);
1854 tempname = NULL;
1855 shortname = TRUE;
1856 continue;
1858 #endif
1860 * Try another name. Change one character, just before
1861 * the extension. This should also work for an 8.3
1862 * file name, when after adding the extension it still is
1863 * the same file as the original.
1865 wp = tempname + STRLEN(tempname) - 5;
1866 if (wp < gettail(tempname)) /* empty file name? */
1867 wp = gettail(tempname);
1868 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1869 --*wp)
1872 * They all exist? Must be something wrong! Don't
1873 * write the viminfo file then.
1875 if (*wp == 'a')
1877 vim_free(tempname);
1878 tempname = NULL;
1879 break;
1883 break;
1886 if (tempname != NULL)
1888 #ifdef VMS
1889 /* fdopen() fails for some reason */
1890 umask_save = umask(077);
1891 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1892 (void)umask(umask_save);
1893 #else
1894 int fd;
1896 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1897 * protection:
1898 * Unix: same as original file, but strip s-bit. Reset umask to
1899 * avoid it getting in the way.
1900 * Others: r&w for user only. */
1901 # ifdef UNIX
1902 umask_save = umask(0);
1903 fd = mch_open((char *)tempname,
1904 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1905 (int)((st_old.st_mode & 0777) | 0600));
1906 (void)umask(umask_save);
1907 # else
1908 fd = mch_open((char *)tempname,
1909 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1910 # endif
1911 if (fd < 0)
1912 fp_out = NULL;
1913 else
1914 fp_out = fdopen(fd, WRITEBIN);
1915 #endif /* VMS */
1918 * If we can't create in the same directory, try creating a
1919 * "normal" temp file.
1921 if (fp_out == NULL)
1923 vim_free(tempname);
1924 if ((tempname = vim_tempname('o')) != NULL)
1925 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1928 #if defined(UNIX) && defined(HAVE_FCHOWN)
1930 * Make sure the owner can read/write it. This only works for
1931 * root.
1933 if (fp_out != NULL)
1934 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1935 #endif
1940 * Check if the new viminfo file can be written to.
1942 if (fp_out == NULL)
1944 EMSG2(_("E138: Can't write viminfo file %s!"),
1945 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1946 if (fp_in != NULL)
1947 fclose(fp_in);
1948 goto end;
1951 if (p_verbose > 0)
1953 verbose_enter();
1954 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1955 verbose_leave();
1958 viminfo_errcnt = 0;
1959 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1961 fclose(fp_out); /* errors are ignored !? */
1962 if (fp_in != NULL)
1964 fclose(fp_in);
1967 * In case of an error keep the original viminfo file.
1968 * Otherwise rename the newly written file.
1970 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1971 mch_remove(tempname);
1973 #ifdef WIN3264
1974 /* If the viminfo file was hidden then also hide the new file. */
1975 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1976 mch_hide(fname);
1977 #endif
1980 end:
1981 vim_free(fname);
1982 vim_free(tempname);
1986 * Get the viminfo file name to use.
1987 * If "file" is given and not empty, use it (has already been expanded by
1988 * cmdline functions).
1989 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1990 * expand environment variables.
1991 * Returns an allocated string. NULL when out of memory.
1993 static char_u *
1994 viminfo_filename(file)
1995 char_u *file;
1997 if (file == NULL || *file == NUL)
1999 if (use_viminfo != NULL)
2000 file = use_viminfo;
2001 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2003 #ifdef VIMINFO_FILE2
2004 /* don't use $HOME when not defined (turned into "c:/"!). */
2005 # ifdef VMS
2006 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2007 # else
2008 if (mch_getenv((char_u *)"HOME") == NULL)
2009 # endif
2011 /* don't use $VIM when not available. */
2012 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2013 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2014 file = (char_u *)VIMINFO_FILE2;
2015 else
2016 file = (char_u *)VIMINFO_FILE;
2018 else
2019 #endif
2020 file = (char_u *)VIMINFO_FILE;
2022 expand_env(file, NameBuff, MAXPATHL);
2023 file = NameBuff;
2025 return vim_strsave(file);
2029 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2031 static void
2032 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2033 FILE *fp_in;
2034 FILE *fp_out;
2035 int want_info;
2036 int want_marks;
2037 int force_read;
2039 int count = 0;
2040 int eof = FALSE;
2041 vir_T vir;
2043 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2044 return;
2045 vir.vir_fd = fp_in;
2046 #ifdef FEAT_MBYTE
2047 vir.vir_conv.vc_type = CONV_NONE;
2048 #endif
2050 if (fp_in != NULL)
2052 if (want_info)
2053 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2054 else
2055 /* Skip info, find start of marks */
2056 while (!(eof = viminfo_readline(&vir))
2057 && vir.vir_line[0] != '>')
2060 if (fp_out != NULL)
2062 /* Write the info: */
2063 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2064 VIM_VERSION_MEDIUM);
2065 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2066 #ifdef FEAT_MBYTE
2067 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2068 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2069 #endif
2070 write_viminfo_search_pattern(fp_out);
2071 write_viminfo_sub_string(fp_out);
2072 #ifdef FEAT_CMDHIST
2073 write_viminfo_history(fp_out);
2074 #endif
2075 write_viminfo_registers(fp_out);
2076 #ifdef FEAT_EVAL
2077 write_viminfo_varlist(fp_out);
2078 #endif
2079 write_viminfo_filemarks(fp_out);
2080 write_viminfo_bufferlist(fp_out);
2081 count = write_viminfo_marks(fp_out);
2083 if (fp_in != NULL && want_marks)
2084 copy_viminfo_marks(&vir, fp_out, count, eof);
2086 vim_free(vir.vir_line);
2087 #ifdef FEAT_MBYTE
2088 if (vir.vir_conv.vc_type != CONV_NONE)
2089 convert_setup(&vir.vir_conv, NULL, NULL);
2090 #endif
2094 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2095 * first part of the viminfo file which contains everything but the marks that
2096 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2098 static int
2099 read_viminfo_up_to_marks(virp, forceit, writing)
2100 vir_T *virp;
2101 int forceit;
2102 int writing;
2104 int eof;
2105 buf_T *buf;
2107 #ifdef FEAT_CMDHIST
2108 prepare_viminfo_history(forceit ? 9999 : 0);
2109 #endif
2110 eof = viminfo_readline(virp);
2111 while (!eof && virp->vir_line[0] != '>')
2113 switch (virp->vir_line[0])
2115 /* Characters reserved for future expansion, ignored now */
2116 case '+': /* "+40 /path/dir file", for running vim without args */
2117 case '|': /* to be defined */
2118 case '^': /* to be defined */
2119 case '<': /* long line - ignored */
2120 /* A comment or empty line. */
2121 case NUL:
2122 case '\r':
2123 case '\n':
2124 case '#':
2125 eof = viminfo_readline(virp);
2126 break;
2127 case '*': /* "*encoding=value" */
2128 eof = viminfo_encoding(virp);
2129 break;
2130 case '!': /* global variable */
2131 #ifdef FEAT_EVAL
2132 eof = read_viminfo_varlist(virp, writing);
2133 #else
2134 eof = viminfo_readline(virp);
2135 #endif
2136 break;
2137 case '%': /* entry for buffer list */
2138 eof = read_viminfo_bufferlist(virp, writing);
2139 break;
2140 case '"':
2141 eof = read_viminfo_register(virp, forceit);
2142 break;
2143 case '/': /* Search string */
2144 case '&': /* Substitute search string */
2145 case '~': /* Last search string, followed by '/' or '&' */
2146 eof = read_viminfo_search_pattern(virp, forceit);
2147 break;
2148 case '$':
2149 eof = read_viminfo_sub_string(virp, forceit);
2150 break;
2151 case ':':
2152 case '?':
2153 case '=':
2154 case '@':
2155 #ifdef FEAT_CMDHIST
2156 eof = read_viminfo_history(virp);
2157 #else
2158 eof = viminfo_readline(virp);
2159 #endif
2160 break;
2161 case '-':
2162 case '\'':
2163 eof = read_viminfo_filemark(virp, forceit);
2164 break;
2165 default:
2166 if (viminfo_error("E575: ", _("Illegal starting char"),
2167 virp->vir_line))
2168 eof = TRUE;
2169 else
2170 eof = viminfo_readline(virp);
2171 break;
2175 #ifdef FEAT_CMDHIST
2176 /* Finish reading history items. */
2177 finish_viminfo_history();
2178 #endif
2180 /* Change file names to buffer numbers for fmarks. */
2181 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2182 fmarks_check_names(buf);
2184 return eof;
2188 * Compare the 'encoding' value in the viminfo file with the current value of
2189 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2190 * conversion of text with iconv() in viminfo_readstring().
2192 static int
2193 viminfo_encoding(virp)
2194 vir_T *virp;
2196 #ifdef FEAT_MBYTE
2197 char_u *p;
2198 int i;
2200 if (get_viminfo_parameter('c') != 0)
2202 p = vim_strchr(virp->vir_line, '=');
2203 if (p != NULL)
2205 /* remove trailing newline */
2206 ++p;
2207 for (i = 0; vim_isprintc(p[i]); ++i)
2209 p[i] = NUL;
2211 convert_setup(&virp->vir_conv, p, p_enc);
2214 #endif
2215 return viminfo_readline(virp);
2219 * Read a line from the viminfo file.
2220 * Returns TRUE for end-of-file;
2223 viminfo_readline(virp)
2224 vir_T *virp;
2226 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2230 * check string read from viminfo file
2231 * remove '\n' at the end of the line
2232 * - replace CTRL-V CTRL-V with CTRL-V
2233 * - replace CTRL-V 'n' with '\n'
2235 * Check for a long line as written by viminfo_writestring().
2237 * Return the string in allocated memory (NULL when out of memory).
2239 /*ARGSUSED*/
2240 char_u *
2241 viminfo_readstring(virp, off, convert)
2242 vir_T *virp;
2243 int off; /* offset for virp->vir_line */
2244 int convert; /* convert the string */
2246 char_u *retval;
2247 char_u *s, *d;
2248 long len;
2250 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2252 len = atol((char *)virp->vir_line + off + 1);
2253 retval = lalloc(len, TRUE);
2254 if (retval == NULL)
2256 /* Line too long? File messed up? Skip next line. */
2257 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2258 return NULL;
2260 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2261 s = retval + 1; /* Skip the leading '<' */
2263 else
2265 retval = vim_strsave(virp->vir_line + off);
2266 if (retval == NULL)
2267 return NULL;
2268 s = retval;
2271 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2272 d = retval;
2273 while (*s != NUL && *s != '\n')
2275 if (s[0] == Ctrl_V && s[1] != NUL)
2277 if (s[1] == 'n')
2278 *d++ = '\n';
2279 else
2280 *d++ = Ctrl_V;
2281 s += 2;
2283 else
2284 *d++ = *s++;
2286 *d = NUL;
2288 #ifdef FEAT_MBYTE
2289 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2291 d = string_convert(&virp->vir_conv, retval, NULL);
2292 if (d != NULL)
2294 vim_free(retval);
2295 retval = d;
2298 #endif
2300 return retval;
2304 * write string to viminfo file
2305 * - replace CTRL-V with CTRL-V CTRL-V
2306 * - replace '\n' with CTRL-V 'n'
2307 * - add a '\n' at the end
2309 * For a long line:
2310 * - write " CTRL-V <length> \n " in first line
2311 * - write " < <string> \n " in second line
2313 void
2314 viminfo_writestring(fd, p)
2315 FILE *fd;
2316 char_u *p;
2318 int c;
2319 char_u *s;
2320 int len = 0;
2322 for (s = p; *s != NUL; ++s)
2324 if (*s == Ctrl_V || *s == '\n')
2325 ++len;
2326 ++len;
2329 /* If the string will be too long, write its length and put it in the next
2330 * line. Take into account that some room is needed for what comes before
2331 * the string (e.g., variable name). Add something to the length for the
2332 * '<', NL and trailing NUL. */
2333 if (len > LSIZE / 2)
2334 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2336 while ((c = *p++) != NUL)
2338 if (c == Ctrl_V || c == '\n')
2340 putc(Ctrl_V, fd);
2341 if (c == '\n')
2342 c = 'n';
2344 putc(c, fd);
2346 putc('\n', fd);
2348 #endif /* FEAT_VIMINFO */
2351 * Implementation of ":fixdel", also used by get_stty().
2352 * <BS> resulting <Del>
2353 * ^? ^H
2354 * not ^? ^?
2356 /*ARGSUSED*/
2357 void
2358 do_fixdel(eap)
2359 exarg_T *eap;
2361 char_u *p;
2363 p = find_termcode((char_u *)"kb");
2364 add_termcode((char_u *)"kD", p != NULL
2365 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2368 void
2369 print_line_no_prefix(lnum, use_number, list)
2370 linenr_T lnum;
2371 int use_number;
2372 int list;
2374 char_u numbuf[30];
2376 if (curwin->w_p_nu || use_number)
2378 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2379 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2381 msg_prt_line(ml_get(lnum), list);
2385 * Print a text line. Also in silent mode ("ex -s").
2387 void
2388 print_line(lnum, use_number, list)
2389 linenr_T lnum;
2390 int use_number;
2391 int list;
2393 int save_silent = silent_mode;
2395 msg_start();
2396 silent_mode = FALSE;
2397 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2398 print_line_no_prefix(lnum, use_number, list);
2399 if (save_silent)
2401 msg_putchar('\n');
2402 cursor_on(); /* msg_start() switches it off */
2403 out_flush();
2404 silent_mode = save_silent;
2405 info_message = FALSE;
2410 * ":file[!] [fname]".
2412 void
2413 ex_file(eap)
2414 exarg_T *eap;
2416 char_u *fname, *sfname, *xfname;
2417 buf_T *buf;
2419 /* ":0file" removes the file name. Check for illegal uses ":3file",
2420 * "0file name", etc. */
2421 if (eap->addr_count > 0
2422 && (*eap->arg != NUL
2423 || eap->line2 > 0
2424 || eap->addr_count > 1))
2426 EMSG(_(e_invarg));
2427 return;
2430 if (*eap->arg != NUL || eap->addr_count == 1)
2432 #ifdef FEAT_AUTOCMD
2433 buf = curbuf;
2434 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2435 /* buffer changed, don't change name now */
2436 if (buf != curbuf)
2437 return;
2438 # ifdef FEAT_EVAL
2439 if (aborting()) /* autocmds may abort script processing */
2440 return;
2441 # endif
2442 #endif
2444 * The name of the current buffer will be changed.
2445 * A new (unlisted) buffer entry needs to be made to hold the old file
2446 * name, which will become the alternate file name.
2447 * But don't set the alternate file name if the buffer didn't have a
2448 * name.
2450 fname = curbuf->b_ffname;
2451 sfname = curbuf->b_sfname;
2452 xfname = curbuf->b_fname;
2453 curbuf->b_ffname = NULL;
2454 curbuf->b_sfname = NULL;
2455 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2457 curbuf->b_ffname = fname;
2458 curbuf->b_sfname = sfname;
2459 return;
2461 curbuf->b_flags |= BF_NOTEDITED;
2462 if (xfname != NULL && *xfname != NUL)
2464 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2465 if (buf != NULL && !cmdmod.keepalt)
2466 curwin->w_alt_fnum = buf->b_fnum;
2468 vim_free(fname);
2469 vim_free(sfname);
2470 #ifdef FEAT_AUTOCMD
2471 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2472 #endif
2473 /* Change directories when the 'acd' option is set. */
2474 DO_AUTOCHDIR
2476 /* print full file name if :cd used */
2477 fileinfo(FALSE, FALSE, eap->forceit);
2481 * ":update".
2483 void
2484 ex_update(eap)
2485 exarg_T *eap;
2487 if (curbufIsChanged())
2488 (void)do_write(eap);
2492 * ":write" and ":saveas".
2494 void
2495 ex_write(eap)
2496 exarg_T *eap;
2498 if (eap->usefilter) /* input lines to shell command */
2499 do_bang(1, eap, FALSE, TRUE, FALSE);
2500 else
2501 (void)do_write(eap);
2505 * write current buffer to file 'eap->arg'
2506 * if 'eap->append' is TRUE, append to the file
2508 * if *eap->arg == NUL write to current file
2510 * return FAIL for failure, OK otherwise
2513 do_write(eap)
2514 exarg_T *eap;
2516 int other;
2517 char_u *fname = NULL; /* init to shut up gcc */
2518 char_u *ffname;
2519 int retval = FAIL;
2520 char_u *free_fname = NULL;
2521 #ifdef FEAT_BROWSE
2522 char_u *browse_file = NULL;
2523 #endif
2524 buf_T *alt_buf = NULL;
2526 if (not_writing()) /* check 'write' option */
2527 return FAIL;
2529 ffname = eap->arg;
2530 #ifdef FEAT_BROWSE
2531 if (cmdmod.browse)
2533 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2534 NULL, NULL, NULL, curbuf);
2535 if (browse_file == NULL)
2536 goto theend;
2537 ffname = browse_file;
2539 #endif
2540 if (*ffname == NUL)
2542 if (eap->cmdidx == CMD_saveas)
2544 EMSG(_(e_argreq));
2545 goto theend;
2547 other = FALSE;
2549 else
2551 fname = ffname;
2552 free_fname = fix_fname(ffname);
2554 * When out-of-memory, keep unexpanded file name, because we MUST be
2555 * able to write the file in this situation.
2557 if (free_fname != NULL)
2558 ffname = free_fname;
2559 other = otherfile(ffname);
2563 * If we have a new file, put its name in the list of alternate file names.
2565 if (other)
2567 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2568 || eap->cmdidx == CMD_saveas)
2569 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2570 else
2571 alt_buf = buflist_findname(ffname);
2572 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2574 /* Overwriting a file that is loaded in another buffer is not a
2575 * good idea. */
2576 EMSG(_(e_bufloaded));
2577 goto theend;
2582 * Writing to the current file is not allowed in readonly mode
2583 * and a file name is required.
2584 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2586 if (!other && (
2587 #ifdef FEAT_QUICKFIX
2588 bt_dontwrite_msg(curbuf) ||
2589 #endif
2590 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2591 goto theend;
2593 if (!other)
2595 ffname = curbuf->b_ffname;
2596 fname = curbuf->b_fname;
2598 * Not writing the whole file is only allowed with '!'.
2600 if ( (eap->line1 != 1
2601 || eap->line2 != curbuf->b_ml.ml_line_count)
2602 && !eap->forceit
2603 && !eap->append
2604 && !p_wa)
2606 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2607 if (p_confirm || cmdmod.confirm)
2609 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2610 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2611 goto theend;
2612 eap->forceit = TRUE;
2614 else
2615 #endif
2617 EMSG(_("E140: Use ! to write partial buffer"));
2618 goto theend;
2623 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2625 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2627 #ifdef FEAT_AUTOCMD
2628 buf_T *was_curbuf = curbuf;
2630 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2631 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2632 # ifdef FEAT_EVAL
2633 if (curbuf != was_curbuf || aborting())
2634 # else
2635 if (curbuf != was_curbuf)
2636 # endif
2638 /* buffer changed, don't change name now */
2639 retval = FAIL;
2640 goto theend;
2642 #endif
2643 /* Exchange the file names for the current and the alternate
2644 * buffer. This makes it look like we are now editing the buffer
2645 * under the new name. Must be done before buf_write(), because
2646 * if there is no file name and 'cpo' contains 'F', it will set
2647 * the file name. */
2648 fname = alt_buf->b_fname;
2649 alt_buf->b_fname = curbuf->b_fname;
2650 curbuf->b_fname = fname;
2651 fname = alt_buf->b_ffname;
2652 alt_buf->b_ffname = curbuf->b_ffname;
2653 curbuf->b_ffname = fname;
2654 fname = alt_buf->b_sfname;
2655 alt_buf->b_sfname = curbuf->b_sfname;
2656 curbuf->b_sfname = fname;
2657 buf_name_changed(curbuf);
2658 #ifdef FEAT_AUTOCMD
2659 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2660 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2661 if (!alt_buf->b_p_bl)
2663 alt_buf->b_p_bl = TRUE;
2664 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2666 # ifdef FEAT_EVAL
2667 if (curbuf != was_curbuf || aborting())
2668 # else
2669 if (curbuf != was_curbuf)
2670 # endif
2672 /* buffer changed, don't write the file */
2673 retval = FAIL;
2674 goto theend;
2677 /* If 'filetype' was empty try detecting it now. */
2678 if (*curbuf->b_p_ft == NUL)
2680 if (au_has_group((char_u *)"filetypedetect"))
2681 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2682 TRUE);
2683 do_modelines(0);
2685 #endif
2688 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2689 eap, eap->append, eap->forceit, TRUE, FALSE);
2691 /* After ":saveas fname" reset 'readonly'. */
2692 if (eap->cmdidx == CMD_saveas)
2694 if (retval == OK)
2695 curbuf->b_p_ro = FALSE;
2696 /* Change directories when the 'acd' option is set. */
2697 DO_AUTOCHDIR
2701 theend:
2702 #ifdef FEAT_BROWSE
2703 vim_free(browse_file);
2704 #endif
2705 vim_free(free_fname);
2706 return retval;
2710 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2711 * BF_NEW or BF_READERR, check for overwriting current file.
2712 * May set eap->forceit if a dialog says it's OK to overwrite.
2713 * Return OK if it's OK, FAIL if it is not.
2715 /*ARGSUSED*/
2716 static int
2717 check_overwrite(eap, buf, fname, ffname, other)
2718 exarg_T *eap;
2719 buf_T *buf;
2720 char_u *fname; /* file name to be used (can differ from
2721 buf->ffname) */
2722 char_u *ffname; /* full path version of fname */
2723 int other; /* writing under other name */
2726 * write to other file or b_flags set or not writing the whole file:
2727 * overwriting only allowed with '!'
2729 if ( (other
2730 || (buf->b_flags & BF_NOTEDITED)
2731 || ((buf->b_flags & BF_NEW)
2732 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2733 || (buf->b_flags & BF_READERR))
2734 && !p_wa
2735 #ifdef FEAT_QUICKFIX
2736 && !bt_nofile(buf)
2737 #endif
2738 && vim_fexists(ffname))
2740 if (!eap->forceit && !eap->append)
2742 #ifdef UNIX
2743 /* with UNIX it is possible to open a directory */
2744 if (mch_isdir(ffname))
2746 EMSG2(_(e_isadir2), ffname);
2747 return FAIL;
2749 #endif
2750 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2751 if (p_confirm || cmdmod.confirm)
2753 char_u buff[IOSIZE];
2755 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2756 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2757 return FAIL;
2758 eap->forceit = TRUE;
2760 else
2761 #endif
2763 EMSG(_(e_exists));
2764 return FAIL;
2768 /* For ":w! filename" check that no swap file exists for "filename". */
2769 if (other && !emsg_silent)
2771 char_u dir[MAXPATHL];
2772 char_u *p;
2773 int r;
2774 char_u *swapname;
2776 /* We only try the first entry in 'directory', without checking if
2777 * it's writable. If the "." directory is not writable the write
2778 * will probably fail anyway.
2779 * Use 'shortname' of the current buffer, since there is no buffer
2780 * for the written file. */
2781 if (*p_dir == NUL)
2782 STRCPY(dir, ".");
2783 else
2785 p = p_dir;
2786 copy_option_part(&p, dir, MAXPATHL, ",");
2788 swapname = makeswapname(fname, ffname, curbuf, dir);
2789 r = vim_fexists(swapname);
2790 if (r)
2792 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2793 if (p_confirm || cmdmod.confirm)
2795 char_u buff[IOSIZE];
2797 dialog_msg(buff,
2798 _("Swap file \"%s\" exists, overwrite anyway?"),
2799 swapname);
2800 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2801 != VIM_YES)
2803 vim_free(swapname);
2804 return FAIL;
2806 eap->forceit = TRUE;
2808 else
2809 #endif
2811 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2812 swapname);
2813 vim_free(swapname);
2814 return FAIL;
2817 vim_free(swapname);
2820 return OK;
2824 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2826 void
2827 ex_wnext(eap)
2828 exarg_T *eap;
2830 int i;
2832 if (eap->cmd[1] == 'n')
2833 i = curwin->w_arg_idx + (int)eap->line2;
2834 else
2835 i = curwin->w_arg_idx - (int)eap->line2;
2836 eap->line1 = 1;
2837 eap->line2 = curbuf->b_ml.ml_line_count;
2838 if (do_write(eap) != FAIL)
2839 do_argfile(eap, i);
2843 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2845 void
2846 do_wqall(eap)
2847 exarg_T *eap;
2849 buf_T *buf;
2850 int error = 0;
2851 int save_forceit = eap->forceit;
2853 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2854 exiting = TRUE;
2856 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2858 if (bufIsChanged(buf))
2861 * Check if there is a reason the buffer cannot be written:
2862 * 1. if the 'write' option is set
2863 * 2. if there is no file name (even after browsing)
2864 * 3. if the 'readonly' is set (even after a dialog)
2865 * 4. if overwriting is allowed (even after a dialog)
2867 if (not_writing())
2869 ++error;
2870 break;
2872 #ifdef FEAT_BROWSE
2873 /* ":browse wall": ask for file name if there isn't one */
2874 if (buf->b_ffname == NULL && cmdmod.browse)
2875 browse_save_fname(buf);
2876 #endif
2877 if (buf->b_ffname == NULL)
2879 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2880 ++error;
2882 else if (check_readonly(&eap->forceit, buf)
2883 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2884 FALSE) == FAIL)
2886 ++error;
2888 else
2890 if (buf_write_all(buf, eap->forceit) == FAIL)
2891 ++error;
2892 #ifdef FEAT_AUTOCMD
2893 /* an autocommand may have deleted the buffer */
2894 if (!buf_valid(buf))
2895 buf = firstbuf;
2896 #endif
2898 eap->forceit = save_forceit; /* check_overwrite() may set it */
2901 if (exiting)
2903 if (!error)
2904 getout(0); /* exit Vim */
2905 not_exiting();
2910 * Check the 'write' option.
2911 * Return TRUE and give a message when it's not st.
2914 not_writing()
2916 if (p_write)
2917 return FALSE;
2918 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2919 return TRUE;
2923 * Check if a buffer is read-only (either 'readonly' option is set or file is
2924 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2925 * message when the buffer is readonly.
2927 static int
2928 check_readonly(forceit, buf)
2929 int *forceit;
2930 buf_T *buf;
2932 struct stat st;
2934 /* Handle a file being readonly when the 'readonly' option is set or when
2935 * the file exists and permissions are read-only.
2936 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2937 * important for device checks but not here. */
2938 if (!*forceit && (buf->b_p_ro
2939 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2940 && check_file_readonly(buf->b_ffname, 0777))))
2942 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2943 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2945 char_u buff[IOSIZE];
2947 if (buf->b_p_ro)
2948 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2949 buf->b_fname);
2950 else
2951 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2952 buf->b_fname);
2954 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2956 /* Set forceit, to force the writing of a readonly file */
2957 *forceit = TRUE;
2958 return FALSE;
2960 else
2961 return TRUE;
2963 else
2964 #endif
2965 if (buf->b_p_ro)
2966 EMSG(_(e_readonly));
2967 else
2968 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2969 buf->b_fname);
2970 return TRUE;
2973 return FALSE;
2977 * Try to abandon current file and edit a new or existing file.
2978 * 'fnum' is the number of the file, if zero use ffname/sfname.
2980 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2981 * -1 for successfully opening another file.
2982 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2985 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2986 int fnum;
2987 char_u *ffname;
2988 char_u *sfname;
2989 int setpm;
2990 linenr_T lnum;
2991 int forceit;
2993 int other;
2994 int retval;
2995 char_u *free_me = NULL;
2997 if (text_locked())
2998 return 1;
2999 #ifdef FEAT_AUTOCMD
3000 if (curbuf_locked())
3001 return 1;
3002 #endif
3004 if (fnum == 0)
3006 /* make ffname full path, set sfname */
3007 fname_expand(curbuf, &ffname, &sfname);
3008 other = otherfile(ffname);
3009 free_me = ffname; /* has been allocated, free() later */
3011 else
3012 other = (fnum != curbuf->b_fnum);
3014 if (other)
3015 ++no_wait_return; /* don't wait for autowrite message */
3016 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3017 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3019 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3020 if (p_confirm && p_write)
3021 dialog_changed(curbuf, FALSE);
3022 if (curbufIsChanged())
3023 #endif
3025 if (other)
3026 --no_wait_return;
3027 EMSG(_(e_nowrtmsg));
3028 retval = 2; /* file has been changed */
3029 goto theend;
3032 if (other)
3033 --no_wait_return;
3034 if (setpm)
3035 setpcmark();
3036 if (!other)
3038 if (lnum != 0)
3039 curwin->w_cursor.lnum = lnum;
3040 check_cursor_lnum();
3041 beginline(BL_SOL | BL_FIX);
3042 retval = 0; /* it's in the same file */
3044 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3045 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3046 retval = -1; /* opened another file */
3047 else
3048 retval = 1; /* error encountered */
3050 theend:
3051 vim_free(free_me);
3052 return retval;
3056 * start editing a new file
3058 * fnum: file number; if zero use ffname/sfname
3059 * ffname: the file name
3060 * - full path if sfname used,
3061 * - any file name if sfname is NULL
3062 * - empty string to re-edit with the same file name (but may be
3063 * in a different directory)
3064 * - NULL to start an empty buffer
3065 * sfname: the short file name (or NULL)
3066 * eap: contains the command to be executed after loading the file and
3067 * forced 'ff' and 'fenc'
3068 * newlnum: if > 0: put cursor on this line number (if possible)
3069 * if ECMD_LASTL: use last position in loaded file
3070 * if ECMD_LAST: use last position in all files
3071 * if ECMD_ONE: use first line
3072 * flags:
3073 * ECMD_HIDE: if TRUE don't free the current buffer
3074 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3075 * ECMD_OLDBUF: use existing buffer if it exists
3076 * ECMD_FORCEIT: ! used for Ex command
3077 * ECMD_ADDBUF: don't edit, just add to buffer list
3079 * return FAIL for failure, OK otherwise
3082 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3083 int fnum;
3084 char_u *ffname;
3085 char_u *sfname;
3086 exarg_T *eap; /* can be NULL! */
3087 linenr_T newlnum;
3088 int flags;
3090 int other_file; /* TRUE if editing another file */
3091 int oldbuf; /* TRUE if using existing buffer */
3092 #ifdef FEAT_AUTOCMD
3093 int auto_buf = FALSE; /* TRUE if autocommands brought us
3094 into the buffer unexpectedly */
3095 char_u *new_name = NULL;
3096 int did_set_swapcommand = FALSE;
3097 #endif
3098 buf_T *buf;
3099 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3100 buf_T *old_curbuf = curbuf;
3101 #endif
3102 char_u *free_fname = NULL;
3103 #ifdef FEAT_BROWSE
3104 char_u *browse_file = NULL;
3105 #endif
3106 int retval = FAIL;
3107 long n;
3108 linenr_T lnum;
3109 linenr_T topline = 0;
3110 int newcol = -1;
3111 int solcol = -1;
3112 pos_T *pos;
3113 #ifdef FEAT_SUN_WORKSHOP
3114 char_u *cp;
3115 #endif
3116 char_u *command = NULL;
3117 #ifdef FEAT_SPELL
3118 int did_get_winopts = FALSE;
3119 #endif
3121 if (eap != NULL)
3122 command = eap->do_ecmd_cmd;
3124 if (fnum != 0)
3126 if (fnum == curbuf->b_fnum) /* file is already being edited */
3127 return OK; /* nothing to do */
3128 other_file = TRUE;
3130 else
3132 #ifdef FEAT_BROWSE
3133 if (cmdmod.browse)
3135 if (
3136 # ifdef FEAT_GUI
3137 !gui.in_use &&
3138 # endif
3139 au_has_group((char_u *)"FileExplorer"))
3141 /* No browsing supported but we do have the file explorer:
3142 * Edit the directory. */
3143 if (ffname == NULL || !mch_isdir(ffname))
3144 ffname = (char_u *)".";
3146 else
3148 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3149 NULL, NULL, NULL, curbuf);
3150 if (browse_file == NULL)
3151 goto theend;
3152 ffname = browse_file;
3155 #endif
3156 /* if no short name given, use ffname for short name */
3157 if (sfname == NULL)
3158 sfname = ffname;
3159 #ifdef USE_FNAME_CASE
3160 # ifdef USE_LONG_FNAME
3161 if (USE_LONG_FNAME)
3162 # endif
3163 if (sfname != NULL)
3164 fname_case(sfname, 0); /* set correct case for sfname */
3165 #endif
3167 #ifdef FEAT_LISTCMDS
3168 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3169 goto theend;
3170 #endif
3172 if (ffname == NULL)
3173 other_file = TRUE;
3174 /* there is no file name */
3175 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3176 other_file = FALSE;
3177 else
3179 if (*ffname == NUL) /* re-edit with same file name */
3181 ffname = curbuf->b_ffname;
3182 sfname = curbuf->b_fname;
3184 free_fname = fix_fname(ffname); /* may expand to full path name */
3185 if (free_fname != NULL)
3186 ffname = free_fname;
3187 other_file = otherfile(ffname);
3188 #ifdef FEAT_SUN_WORKSHOP
3189 if (usingSunWorkShop && p_acd
3190 && (cp = vim_strrchr(sfname, '/')) != NULL)
3191 sfname = ++cp;
3192 #endif
3197 * if the file was changed we may not be allowed to abandon it
3198 * - if we are going to re-edit the same file
3199 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3201 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3202 || (curbuf->b_nwindows == 1
3203 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3204 && check_changed(curbuf, p_awa, !other_file,
3205 (flags & ECMD_FORCEIT), FALSE))
3207 if (fnum == 0 && other_file && ffname != NULL)
3208 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3209 goto theend;
3212 #ifdef FEAT_VISUAL
3214 * End Visual mode before switching to another buffer, so the text can be
3215 * copied into the GUI selection buffer.
3217 reset_VIsual();
3218 #endif
3220 #ifdef FEAT_AUTOCMD
3221 if ((command != NULL || newlnum > (linenr_T)0)
3222 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3224 int len;
3225 char_u *p;
3227 /* Set v:swapcommand for the SwapExists autocommands. */
3228 if (command != NULL)
3229 len = (int)STRLEN(command) + 3;
3230 else
3231 len = 30;
3232 p = alloc((unsigned)len);
3233 if (p != NULL)
3235 if (command != NULL)
3236 vim_snprintf((char *)p, len, ":%s\r", command);
3237 else
3238 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3239 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3240 did_set_swapcommand = TRUE;
3241 vim_free(p);
3244 #endif
3247 * If we are starting to edit another file, open a (new) buffer.
3248 * Otherwise we re-use the current buffer.
3250 if (other_file)
3252 #ifdef FEAT_LISTCMDS
3253 if (!(flags & ECMD_ADDBUF))
3254 #endif
3256 if (!cmdmod.keepalt)
3257 curwin->w_alt_fnum = curbuf->b_fnum;
3258 buflist_altfpos();
3261 if (fnum)
3262 buf = buflist_findnr(fnum);
3263 else
3265 #ifdef FEAT_LISTCMDS
3266 if (flags & ECMD_ADDBUF)
3268 linenr_T tlnum = 1L;
3270 if (command != NULL)
3272 tlnum = atol((char *)command);
3273 if (tlnum <= 0)
3274 tlnum = 1L;
3276 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3277 goto theend;
3279 #endif
3280 buf = buflist_new(ffname, sfname, 0L,
3281 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3283 if (buf == NULL)
3284 goto theend;
3285 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3287 oldbuf = FALSE;
3288 buf->b_nwindows = 0;
3290 else /* existing memfile */
3292 oldbuf = TRUE;
3293 (void)buf_check_timestamp(buf, FALSE);
3294 /* Check if autocommands made buffer invalid or changed the current
3295 * buffer. */
3296 if (!buf_valid(buf)
3297 #ifdef FEAT_AUTOCMD
3298 || curbuf != old_curbuf
3299 #endif
3301 goto theend;
3302 #ifdef FEAT_EVAL
3303 if (aborting()) /* autocmds may abort script processing */
3304 goto theend;
3305 #endif
3308 /* May jump to last used line number for a loaded buffer or when asked
3309 * for explicitly */
3310 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3312 pos = buflist_findfpos(buf);
3313 newlnum = pos->lnum;
3314 solcol = pos->col;
3318 * Make the (new) buffer the one used by the current window.
3319 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3320 * If the current buffer was empty and has no file name, curbuf
3321 * is returned by buflist_new().
3323 if (buf != curbuf)
3325 #ifdef FEAT_AUTOCMD
3327 * Be careful: The autocommands may delete any buffer and change
3328 * the current buffer.
3329 * - If the buffer we are going to edit is deleted, give up.
3330 * - If the current buffer is deleted, prefer to load the new
3331 * buffer when loading a buffer is required. This avoids
3332 * loading another buffer which then must be closed again.
3333 * - If we ended up in the new buffer already, need to skip a few
3334 * things, set auto_buf.
3336 if (buf->b_fname != NULL)
3337 new_name = vim_strsave(buf->b_fname);
3338 au_new_curbuf = buf;
3339 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3340 if (!buf_valid(buf)) /* new buffer has been deleted */
3342 delbuf_msg(new_name); /* frees new_name */
3343 goto theend;
3345 # ifdef FEAT_EVAL
3346 if (aborting()) /* autocmds may abort script processing */
3348 vim_free(new_name);
3349 goto theend;
3351 # endif
3352 if (buf == curbuf) /* already in new buffer */
3353 auto_buf = TRUE;
3354 else
3356 if (curbuf == old_curbuf)
3357 #endif
3358 buf_copy_options(buf, BCO_ENTER);
3360 /* close the link to the current buffer */
3361 u_sync(FALSE);
3362 close_buffer(curwin, curbuf,
3363 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3365 #ifdef FEAT_AUTOCMD
3366 # ifdef FEAT_EVAL
3367 if (aborting()) /* autocmds may abort script processing */
3369 vim_free(new_name);
3370 goto theend;
3372 # endif
3373 /* Be careful again, like above. */
3374 if (!buf_valid(buf)) /* new buffer has been deleted */
3376 delbuf_msg(new_name); /* frees new_name */
3377 goto theend;
3379 if (buf == curbuf) /* already in new buffer */
3380 auto_buf = TRUE;
3381 else
3382 #endif
3384 curwin->w_buffer = buf;
3385 curbuf = buf;
3386 ++curbuf->b_nwindows;
3387 /* set 'fileformat' */
3388 if (*p_ffs && !oldbuf)
3389 set_fileformat(default_fileformat(), OPT_LOCAL);
3392 /* May get the window options from the last time this buffer
3393 * was in this window (or another window). If not used
3394 * before, reset the local window options to the global
3395 * values. Also restores old folding stuff. */
3396 get_winopts(curbuf);
3397 #ifdef FEAT_SPELL
3398 did_get_winopts = TRUE;
3399 #endif
3401 #ifdef FEAT_AUTOCMD
3403 vim_free(new_name);
3404 au_new_curbuf = NULL;
3405 #endif
3407 else
3408 ++curbuf->b_nwindows;
3410 curwin->w_pcmark.lnum = 1;
3411 curwin->w_pcmark.col = 0;
3413 else /* !other_file */
3415 if (
3416 #ifdef FEAT_LISTCMDS
3417 (flags & ECMD_ADDBUF) ||
3418 #endif
3419 check_fname() == FAIL)
3420 goto theend;
3421 oldbuf = (flags & ECMD_OLDBUF);
3424 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3426 char_u *p;
3428 curbuf->b_help = TRUE;
3429 #ifdef FEAT_QUICKFIX
3430 set_string_option_direct((char_u *)"buftype", -1,
3431 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3432 #endif
3435 * Always set these options after jumping to a help tag, because the
3436 * user may have an autocommand that gets in the way.
3437 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3438 * latin1 word characters (for translated help files).
3439 * Only set it when needed, buf_init_chartab() is some work.
3442 #ifdef EBCDIC
3443 (char_u *)"65-255,^*,^|,^\"";
3444 #else
3445 (char_u *)"!-~,^*,^|,^\",192-255";
3446 #endif
3447 if (STRCMP(curbuf->b_p_isk, p) != 0)
3449 set_string_option_direct((char_u *)"isk", -1, p,
3450 OPT_FREE|OPT_LOCAL, 0);
3451 check_buf_options(curbuf);
3452 (void)buf_init_chartab(curbuf, FALSE);
3455 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3456 curwin->w_p_list = FALSE; /* no list mode */
3458 curbuf->b_p_ma = FALSE; /* not modifiable */
3459 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3460 curwin->w_p_nu = 0; /* no line numbers */
3461 #ifdef FEAT_SCROLLBIND
3462 curwin->w_p_scb = FALSE; /* no scroll binding */
3463 #endif
3464 #ifdef FEAT_ARABIC
3465 curwin->w_p_arab = FALSE; /* no arabic mode */
3466 #endif
3467 #ifdef FEAT_RIGHTLEFT
3468 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3469 #endif
3470 #ifdef FEAT_FOLDING
3471 curwin->w_p_fen = FALSE; /* No folding in the help window */
3472 #endif
3473 #ifdef FEAT_DIFF
3474 curwin->w_p_diff = FALSE; /* No 'diff' */
3475 #endif
3476 #ifdef FEAT_SPELL
3477 curwin->w_p_spell = FALSE; /* No spell checking */
3478 #endif
3480 #ifdef FEAT_AUTOCMD
3481 buf = curbuf;
3482 #endif
3483 set_buflisted(FALSE);
3485 else
3487 #ifdef FEAT_AUTOCMD
3488 buf = curbuf;
3489 #endif
3490 /* Don't make a buffer listed if it's a help buffer. Useful when
3491 * using CTRL-O to go back to a help file. */
3492 if (!curbuf->b_help)
3493 set_buflisted(TRUE);
3496 #ifdef FEAT_AUTOCMD
3497 /* If autocommands change buffers under our fingers, forget about
3498 * editing the file. */
3499 if (buf != curbuf)
3500 goto theend;
3501 # ifdef FEAT_EVAL
3502 if (aborting()) /* autocmds may abort script processing */
3503 goto theend;
3504 # endif
3506 /* Since we are starting to edit a file, consider the filetype to be
3507 * unset. Helps for when an autocommand changes files and expects syntax
3508 * highlighting to work in the other file. */
3509 did_filetype = FALSE;
3510 #endif
3513 * other_file oldbuf
3514 * FALSE FALSE re-edit same file, buffer is re-used
3515 * FALSE TRUE re-edit same file, nothing changes
3516 * TRUE FALSE start editing new file, new buffer
3517 * TRUE TRUE start editing in existing buffer (nothing to do)
3519 if (!other_file && !oldbuf) /* re-use the buffer */
3521 set_last_cursor(curwin); /* may set b_last_cursor */
3522 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3524 newlnum = curwin->w_cursor.lnum;
3525 solcol = curwin->w_cursor.col;
3527 #ifdef FEAT_AUTOCMD
3528 buf = curbuf;
3529 if (buf->b_fname != NULL)
3530 new_name = vim_strsave(buf->b_fname);
3531 else
3532 new_name = NULL;
3533 #endif
3534 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3535 #ifdef FEAT_AUTOCMD
3536 /* If autocommands deleted the buffer we were going to re-edit, give
3537 * up and jump to the end. */
3538 if (!buf_valid(buf))
3540 delbuf_msg(new_name); /* frees new_name */
3541 goto theend;
3543 vim_free(new_name);
3545 /* If autocommands change buffers under our fingers, forget about
3546 * re-editing the file. Should do the buf_clear_file(), but perhaps
3547 * the autocommands changed the buffer... */
3548 if (buf != curbuf)
3549 goto theend;
3550 # ifdef FEAT_EVAL
3551 if (aborting()) /* autocmds may abort script processing */
3552 goto theend;
3553 # endif
3554 #endif
3555 buf_clear_file(curbuf);
3556 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3557 curbuf->b_op_end.lnum = 0;
3561 * If we get here we are sure to start editing
3563 /* don't redraw until the cursor is in the right line */
3564 ++RedrawingDisabled;
3566 /* Assume success now */
3567 retval = OK;
3570 * Reset cursor position, could be used by autocommands.
3572 check_cursor();
3575 * Check if we are editing the w_arg_idx file in the argument list.
3577 check_arg_idx(curwin);
3579 #ifdef FEAT_AUTOCMD
3580 if (!auto_buf)
3581 #endif
3584 * Set cursor and init window before reading the file and executing
3585 * autocommands. This allows for the autocommands to position the
3586 * cursor.
3588 curwin_init();
3590 #ifdef FEAT_FOLDING
3591 /* It's possible that all lines in the buffer changed. Need to update
3592 * automatic folding for all windows where it's used. */
3593 # ifdef FEAT_WINDOWS
3595 win_T *win;
3596 tabpage_T *tp;
3598 FOR_ALL_TAB_WINDOWS(tp, win)
3599 if (win->w_buffer == curbuf)
3600 foldUpdateAll(win);
3602 # else
3603 foldUpdateAll(curwin);
3604 # endif
3605 #endif
3607 /* Change directories when the 'acd' option is set. */
3608 DO_AUTOCHDIR
3611 * Careful: open_buffer() and apply_autocmds() may change the current
3612 * buffer and window.
3614 lnum = curwin->w_cursor.lnum;
3615 topline = curwin->w_topline;
3616 if (!oldbuf) /* need to read the file */
3618 #if defined(HAS_SWAP_EXISTS_ACTION)
3619 swap_exists_action = SEA_DIALOG;
3620 #endif
3621 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3624 * Open the buffer and read the file.
3626 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3627 if (should_abort(open_buffer(FALSE, eap)))
3628 retval = FAIL;
3629 #else
3630 (void)open_buffer(FALSE, eap);
3631 #endif
3633 #if defined(HAS_SWAP_EXISTS_ACTION)
3634 if (swap_exists_action == SEA_QUIT)
3635 retval = FAIL;
3636 handle_swap_exists(old_curbuf);
3637 #endif
3639 #ifdef FEAT_AUTOCMD
3640 else
3642 /* Read the modelines, but only to set window-local options. Any
3643 * buffer-local options have already been set and may have been
3644 * changed by the user. */
3645 do_modelines(OPT_WINONLY);
3647 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3648 &retval);
3649 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3650 &retval);
3652 check_arg_idx(curwin);
3653 #endif
3656 * If autocommands change the cursor position or topline, we should
3657 * keep it.
3659 if (curwin->w_cursor.lnum != lnum)
3661 newlnum = curwin->w_cursor.lnum;
3662 newcol = curwin->w_cursor.col;
3664 if (curwin->w_topline == topline)
3665 topline = 0;
3667 /* Even when cursor didn't move we need to recompute topline. */
3668 changed_line_abv_curs();
3670 #ifdef FEAT_TITLE
3671 maketitle();
3672 #endif
3675 #ifdef FEAT_DIFF
3676 /* Tell the diff stuff that this buffer is new and/or needs updating.
3677 * Also needed when re-editing the same buffer, because unloading will
3678 * have removed it as a diff buffer. */
3679 if (curwin->w_p_diff)
3681 diff_buf_add(curbuf);
3682 diff_invalidate(curbuf);
3684 #endif
3686 #ifdef FEAT_SPELL
3687 /* If the window options were changed may need to set the spell language.
3688 * Can only do this after the buffer has been properly setup. */
3689 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3690 did_set_spelllang(curbuf);
3691 #endif
3693 if (command == NULL)
3695 if (newcol >= 0) /* position set by autocommands */
3697 curwin->w_cursor.lnum = newlnum;
3698 curwin->w_cursor.col = newcol;
3699 check_cursor();
3701 else if (newlnum > 0) /* line number from caller or old position */
3703 curwin->w_cursor.lnum = newlnum;
3704 check_cursor_lnum();
3705 if (solcol >= 0 && !p_sol)
3707 /* 'sol' is off: Use last known column. */
3708 curwin->w_cursor.col = solcol;
3709 check_cursor_col();
3710 #ifdef FEAT_VIRTUALEDIT
3711 curwin->w_cursor.coladd = 0;
3712 #endif
3713 curwin->w_set_curswant = TRUE;
3715 else
3716 beginline(BL_SOL | BL_FIX);
3718 else /* no line number, go to last line in Ex mode */
3720 if (exmode_active)
3721 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3722 beginline(BL_WHITE | BL_FIX);
3726 #ifdef FEAT_WINDOWS
3727 /* Check if cursors in other windows on the same buffer are still valid */
3728 check_lnums(FALSE);
3729 #endif
3732 * Did not read the file, need to show some info about the file.
3733 * Do this after setting the cursor.
3735 if (oldbuf
3736 #ifdef FEAT_AUTOCMD
3737 && !auto_buf
3738 #endif
3741 int msg_scroll_save = msg_scroll;
3743 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3744 * message. */
3745 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3746 msg_scroll = FALSE;
3747 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3748 check_for_delay(FALSE);
3749 msg_start();
3750 msg_scroll = msg_scroll_save;
3751 msg_scrolled_ign = TRUE;
3753 fileinfo(FALSE, TRUE, FALSE);
3755 msg_scrolled_ign = FALSE;
3758 if (command != NULL)
3759 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3761 #ifdef FEAT_KEYMAP
3762 if (curbuf->b_kmap_state & KEYMAP_INIT)
3763 keymap_init();
3764 #endif
3766 --RedrawingDisabled;
3767 if (!skip_redraw)
3769 n = p_so;
3770 if (topline == 0 && command == NULL)
3771 p_so = 999; /* force cursor halfway the window */
3772 update_topline();
3773 #ifdef FEAT_SCROLLBIND
3774 curwin->w_scbind_pos = curwin->w_topline;
3775 #endif
3776 p_so = n;
3777 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3780 if (p_im)
3781 need_start_insertmode = TRUE;
3783 /* Change directories when the 'acd' option is set. */
3784 DO_AUTOCHDIR
3786 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3787 if (gui.in_use && curbuf->b_ffname != NULL)
3789 # ifdef FEAT_SUN_WORKSHOP
3790 if (usingSunWorkShop)
3791 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3792 # endif
3793 # ifdef FEAT_NETBEANS_INTG
3794 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3795 netbeans_file_opened(curbuf);
3796 # endif
3798 #endif
3800 theend:
3801 #ifdef FEAT_AUTOCMD
3802 if (did_set_swapcommand)
3803 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3804 #endif
3805 #ifdef FEAT_BROWSE
3806 vim_free(browse_file);
3807 #endif
3808 vim_free(free_fname);
3809 return retval;
3812 #ifdef FEAT_AUTOCMD
3813 static void
3814 delbuf_msg(name)
3815 char_u *name;
3817 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3818 name == NULL ? (char_u *)"" : name);
3819 vim_free(name);
3820 au_new_curbuf = NULL;
3822 #endif
3824 static int append_indent = 0; /* autoindent for first line */
3827 * ":insert" and ":append", also used by ":change"
3829 void
3830 ex_append(eap)
3831 exarg_T *eap;
3833 char_u *theline;
3834 int did_undo = FALSE;
3835 linenr_T lnum = eap->line2;
3836 int indent = 0;
3837 char_u *p;
3838 int vcol;
3839 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3841 /* the ! flag toggles autoindent */
3842 if (eap->forceit)
3843 curbuf->b_p_ai = !curbuf->b_p_ai;
3845 /* First autoindent comes from the line we start on */
3846 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3847 append_indent = get_indent_lnum(lnum);
3849 if (eap->cmdidx != CMD_append)
3850 --lnum;
3852 /* when the buffer is empty append to line 0 and delete the dummy line */
3853 if (empty && lnum == 1)
3854 lnum = 0;
3856 State = INSERT; /* behave like in Insert mode */
3857 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3858 State |= LANGMAP;
3860 for (;;)
3862 msg_scroll = TRUE;
3863 need_wait_return = FALSE;
3864 if (curbuf->b_p_ai)
3866 if (append_indent >= 0)
3868 indent = append_indent;
3869 append_indent = -1;
3871 else if (lnum > 0)
3872 indent = get_indent_lnum(lnum);
3874 ex_keep_indent = FALSE;
3875 if (eap->getline == NULL)
3877 /* No getline() function, use the lines that follow. This ends
3878 * when there is no more. */
3879 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3880 break;
3881 p = vim_strchr(eap->nextcmd, NL);
3882 if (p == NULL)
3883 p = eap->nextcmd + STRLEN(eap->nextcmd);
3884 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3885 if (*p != NUL)
3886 ++p;
3887 eap->nextcmd = p;
3889 else
3890 theline = eap->getline(
3891 #ifdef FEAT_EVAL
3892 eap->cstack->cs_looplevel > 0 ? -1 :
3893 #endif
3894 NUL, eap->cookie, indent);
3895 lines_left = Rows - 1;
3896 if (theline == NULL)
3897 break;
3899 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3900 if (ex_keep_indent)
3901 append_indent = indent;
3903 /* Look for the "." after automatic indent. */
3904 vcol = 0;
3905 for (p = theline; indent > vcol; ++p)
3907 if (*p == ' ')
3908 ++vcol;
3909 else if (*p == TAB)
3910 vcol += 8 - vcol % 8;
3911 else
3912 break;
3914 if ((p[0] == '.' && p[1] == NUL)
3915 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3916 == FAIL))
3918 vim_free(theline);
3919 break;
3922 /* don't use autoindent if nothing was typed. */
3923 if (p[0] == NUL)
3924 theline[0] = NUL;
3926 did_undo = TRUE;
3927 ml_append(lnum, theline, (colnr_T)0, FALSE);
3928 appended_lines_mark(lnum, 1L);
3930 vim_free(theline);
3931 ++lnum;
3933 if (empty)
3935 ml_delete(2L, FALSE);
3936 empty = FALSE;
3939 State = NORMAL;
3941 if (eap->forceit)
3942 curbuf->b_p_ai = !curbuf->b_p_ai;
3944 /* "start" is set to eap->line2+1 unless that position is invalid (when
3945 * eap->line2 pointed to the end of the buffer and nothing was appended)
3946 * "end" is set to lnum when something has been appended, otherwise
3947 * it is the same than "start" -- Acevedo */
3948 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3949 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3950 if (eap->cmdidx != CMD_append)
3951 --curbuf->b_op_start.lnum;
3952 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3953 ? lnum : curbuf->b_op_start.lnum;
3954 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3955 curwin->w_cursor.lnum = lnum;
3956 check_cursor_lnum();
3957 beginline(BL_SOL | BL_FIX);
3959 need_wait_return = FALSE; /* don't use wait_return() now */
3960 ex_no_reprint = TRUE;
3964 * ":change"
3966 void
3967 ex_change(eap)
3968 exarg_T *eap;
3970 linenr_T lnum;
3972 if (eap->line2 >= eap->line1
3973 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3974 return;
3976 /* the ! flag toggles autoindent */
3977 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3978 append_indent = get_indent_lnum(eap->line1);
3980 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3982 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3983 break;
3984 ml_delete(eap->line1, FALSE);
3986 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3988 /* ":append" on the line above the deleted lines. */
3989 eap->line2 = eap->line1;
3990 ex_append(eap);
3993 void
3994 ex_z(eap)
3995 exarg_T *eap;
3997 char_u *x;
3998 int bigness;
3999 char_u *kind;
4000 int minus = 0;
4001 linenr_T start, end, curs, i;
4002 int j;
4003 linenr_T lnum = eap->line2;
4005 /* Vi compatible: ":z!" uses display height, without a count uses
4006 * 'scroll' */
4007 if (eap->forceit)
4008 bigness = curwin->w_height;
4009 else if (firstwin == lastwin)
4010 bigness = curwin->w_p_scr * 2;
4011 else
4012 bigness = curwin->w_height - 3;
4013 if (bigness < 1)
4014 bigness = 1;
4016 x = eap->arg;
4017 kind = x;
4018 if (*kind == '-' || *kind == '+' || *kind == '='
4019 || *kind == '^' || *kind == '.')
4020 ++x;
4021 while (*x == '-' || *x == '+')
4022 ++x;
4024 if (*x != 0)
4026 if (!VIM_ISDIGIT(*x))
4028 EMSG(_("E144: non-numeric argument to :z"));
4029 return;
4031 else
4033 bigness = atoi((char *)x);
4034 p_window = bigness;
4035 if (*kind == '=')
4036 bigness += 2;
4040 /* the number of '-' and '+' multiplies the distance */
4041 if (*kind == '-' || *kind == '+')
4042 for (x = kind + 1; *x == *kind; ++x)
4045 switch (*kind)
4047 case '-':
4048 start = lnum - bigness * (linenr_T)(x - kind);
4049 end = start + bigness;
4050 curs = end;
4051 break;
4053 case '=':
4054 start = lnum - (bigness + 1) / 2 + 1;
4055 end = lnum + (bigness + 1) / 2 - 1;
4056 curs = lnum;
4057 minus = 1;
4058 break;
4060 case '^':
4061 start = lnum - bigness * 2;
4062 end = lnum - bigness;
4063 curs = lnum - bigness;
4064 break;
4066 case '.':
4067 start = lnum - (bigness + 1) / 2 + 1;
4068 end = lnum + (bigness + 1) / 2 - 1;
4069 curs = end;
4070 break;
4072 default: /* '+' */
4073 start = lnum;
4074 if (*kind == '+')
4075 start += bigness * (linenr_T)(x - kind - 1) + 1;
4076 else if (eap->addr_count == 0)
4077 ++start;
4078 end = start + bigness - 1;
4079 curs = end;
4080 break;
4083 if (start < 1)
4084 start = 1;
4086 if (end > curbuf->b_ml.ml_line_count)
4087 end = curbuf->b_ml.ml_line_count;
4089 if (curs > curbuf->b_ml.ml_line_count)
4090 curs = curbuf->b_ml.ml_line_count;
4092 for (i = start; i <= end; i++)
4094 if (minus && i == lnum)
4096 msg_putchar('\n');
4098 for (j = 1; j < Columns; j++)
4099 msg_putchar('-');
4102 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4104 if (minus && i == lnum)
4106 msg_putchar('\n');
4108 for (j = 1; j < Columns; j++)
4109 msg_putchar('-');
4113 curwin->w_cursor.lnum = curs;
4114 ex_no_reprint = TRUE;
4118 * Check if the restricted flag is set.
4119 * If so, give an error message and return TRUE.
4120 * Otherwise, return FALSE.
4123 check_restricted()
4125 if (restricted)
4127 EMSG(_("E145: Shell commands not allowed in rvim"));
4128 return TRUE;
4130 return FALSE;
4134 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4135 * If so, give an error message and return TRUE.
4136 * Otherwise, return FALSE.
4139 check_secure()
4141 if (secure)
4143 secure = 2;
4144 EMSG(_(e_curdir));
4145 return TRUE;
4147 #ifdef HAVE_SANDBOX
4149 * In the sandbox more things are not allowed, including the things
4150 * disallowed in secure mode.
4152 if (sandbox != 0)
4154 EMSG(_(e_sandbox));
4155 return TRUE;
4157 #endif
4158 return FALSE;
4161 static char_u *old_sub = NULL; /* previous substitute pattern */
4162 static int global_need_beginline; /* call beginline() after ":g" */
4164 /* do_sub()
4166 * Perform a substitution from line eap->line1 to line eap->line2 using the
4167 * command pointed to by eap->arg which should be of the form:
4169 * /pattern/substitution/{flags}
4171 * The usual escapes are supported as described in the regexp docs.
4173 void
4174 do_sub(eap)
4175 exarg_T *eap;
4177 linenr_T lnum;
4178 long i = 0;
4179 regmmatch_T regmatch;
4180 static int do_all = FALSE; /* do multiple substitutions per line */
4181 static int do_ask = FALSE; /* ask for confirmation */
4182 static int do_count = FALSE; /* count only */
4183 static int do_error = TRUE; /* if false, ignore errors */
4184 static int do_print = FALSE; /* print last line with subs. */
4185 static int do_list = FALSE; /* list last line with subs. */
4186 static int do_number = FALSE; /* list last line with line nr*/
4187 static int do_ic = 0; /* ignore case flag */
4188 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4189 int delimiter;
4190 int sublen;
4191 int got_quit = FALSE;
4192 int got_match = FALSE;
4193 int temp;
4194 int which_pat;
4195 char_u *cmd;
4196 int save_State;
4197 linenr_T first_line = 0; /* first changed line */
4198 linenr_T last_line= 0; /* below last changed line AFTER the
4199 * change */
4200 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4201 linenr_T line2;
4202 long nmatch; /* number of lines in match */
4203 linenr_T sub_firstlnum; /* nr of first sub line */
4204 char_u *sub_firstline; /* allocated copy of first sub line */
4205 int endcolumn = FALSE; /* cursor in last column when done */
4206 pos_T old_cursor = curwin->w_cursor;
4208 cmd = eap->arg;
4209 if (!global_busy)
4211 sub_nsubs = 0;
4212 sub_nlines = 0;
4215 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4216 if (p_altkeymap && curwin->w_p_rl)
4217 lrF_sub(cmd);
4218 #endif
4220 if (eap->cmdidx == CMD_tilde)
4221 which_pat = RE_LAST; /* use last used regexp */
4222 else
4223 which_pat = RE_SUBST; /* use last substitute regexp */
4225 /* new pattern and substitution */
4226 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4227 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4229 /* don't accept alphanumeric for separator */
4230 if (isalpha(*cmd))
4232 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4233 return;
4236 * undocumented vi feature:
4237 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4238 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4240 if (*cmd == '\\')
4242 ++cmd;
4243 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4245 EMSG(_(e_backslash));
4246 return;
4248 if (*cmd != '&')
4249 which_pat = RE_SEARCH; /* use last '/' pattern */
4250 pat = (char_u *)""; /* empty search pattern */
4251 delimiter = *cmd++; /* remember delimiter character */
4253 else /* find the end of the regexp */
4255 which_pat = RE_LAST; /* use last used regexp */
4256 delimiter = *cmd++; /* remember delimiter character */
4257 pat = cmd; /* remember start of search pat */
4258 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4259 if (cmd[0] == delimiter) /* end delimiter found */
4260 *cmd++ = NUL; /* replace it with a NUL */
4264 * Small incompatibility: vi sees '\n' as end of the command, but in
4265 * Vim we want to use '\n' to find/substitute a NUL.
4267 sub = cmd; /* remember the start of the substitution */
4269 while (cmd[0])
4271 if (cmd[0] == delimiter) /* end delimiter found */
4273 *cmd++ = NUL; /* replace it with a NUL */
4274 break;
4276 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4277 ++cmd;
4278 mb_ptr_adv(cmd);
4281 if (!eap->skip)
4283 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4284 if (STRCMP(sub, "%") == 0
4285 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4287 if (old_sub == NULL) /* there is no previous command */
4289 EMSG(_(e_nopresub));
4290 return;
4292 sub = old_sub;
4294 else
4296 vim_free(old_sub);
4297 old_sub = vim_strsave(sub);
4301 else if (!eap->skip) /* use previous pattern and substitution */
4303 if (old_sub == NULL) /* there is no previous command */
4305 EMSG(_(e_nopresub));
4306 return;
4308 pat = NULL; /* search_regcomp() will use previous pattern */
4309 sub = old_sub;
4311 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4312 * last column after using "$". */
4313 endcolumn = (curwin->w_curswant == MAXCOL);
4317 * Find trailing options. When '&' is used, keep old options.
4319 if (*cmd == '&')
4320 ++cmd;
4321 else
4323 if (!p_ed)
4325 if (p_gd) /* default is global on */
4326 do_all = TRUE;
4327 else
4328 do_all = FALSE;
4329 do_ask = FALSE;
4331 do_error = TRUE;
4332 do_print = FALSE;
4333 do_count = FALSE;
4334 do_number = FALSE;
4335 do_ic = 0;
4337 while (*cmd)
4340 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4341 * 'r' is never inverted.
4343 if (*cmd == 'g')
4344 do_all = !do_all;
4345 else if (*cmd == 'c')
4346 do_ask = !do_ask;
4347 else if (*cmd == 'n')
4348 do_count = TRUE;
4349 else if (*cmd == 'e')
4350 do_error = !do_error;
4351 else if (*cmd == 'r') /* use last used regexp */
4352 which_pat = RE_LAST;
4353 else if (*cmd == 'p')
4354 do_print = TRUE;
4355 else if (*cmd == '#')
4357 do_print = TRUE;
4358 do_number = TRUE;
4360 else if (*cmd == 'l')
4362 do_print = TRUE;
4363 do_list = TRUE;
4365 else if (*cmd == 'i') /* ignore case */
4366 do_ic = 'i';
4367 else if (*cmd == 'I') /* don't ignore case */
4368 do_ic = 'I';
4369 else
4370 break;
4371 ++cmd;
4373 if (do_count)
4374 do_ask = FALSE;
4377 * check for a trailing count
4379 cmd = skipwhite(cmd);
4380 if (VIM_ISDIGIT(*cmd))
4382 i = getdigits(&cmd);
4383 if (i <= 0 && !eap->skip && do_error)
4385 EMSG(_(e_zerocount));
4386 return;
4388 eap->line1 = eap->line2;
4389 eap->line2 += i - 1;
4390 if (eap->line2 > curbuf->b_ml.ml_line_count)
4391 eap->line2 = curbuf->b_ml.ml_line_count;
4395 * check for trailing command or garbage
4397 cmd = skipwhite(cmd);
4398 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4400 eap->nextcmd = check_nextcmd(cmd);
4401 if (eap->nextcmd == NULL)
4403 EMSG(_(e_trailing));
4404 return;
4408 if (eap->skip) /* not executing commands, only parsing */
4409 return;
4411 if (!do_count && !curbuf->b_p_ma)
4413 /* Substitution is not allowed in non-'modifiable' buffer */
4414 EMSG(_(e_modifiable));
4415 return;
4418 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4420 if (do_error)
4421 EMSG(_(e_invcmd));
4422 return;
4425 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4426 if (do_ic == 'i')
4427 regmatch.rmm_ic = TRUE;
4428 else if (do_ic == 'I')
4429 regmatch.rmm_ic = FALSE;
4431 sub_firstline = NULL;
4434 * ~ in the substitute pattern is replaced with the old pattern.
4435 * We do it here once to avoid it to be replaced over and over again.
4436 * But don't do it when it starts with "\=", then it's an expression.
4438 if (!(sub[0] == '\\' && sub[1] == '='))
4439 sub = regtilde(sub, p_magic);
4442 * Check for a match on each line.
4444 line2 = eap->line2;
4445 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4446 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4447 || aborting()
4448 #endif
4449 ); ++lnum)
4451 sub_firstlnum = lnum;
4452 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
4453 if (nmatch)
4455 colnr_T copycol;
4456 colnr_T matchcol;
4457 colnr_T prev_matchcol = MAXCOL;
4458 char_u *new_end, *new_start = NULL;
4459 unsigned new_start_len = 0;
4460 char_u *p1;
4461 int did_sub = FALSE;
4462 int lastone;
4463 unsigned len, needed_len;
4464 long nmatch_tl = 0; /* nr of lines matched below lnum */
4465 int do_again; /* do it again after joining lines */
4466 int skip_match = FALSE;
4469 * The new text is build up step by step, to avoid too much
4470 * copying. There are these pieces:
4471 * sub_firstline The old text, unmodifed.
4472 * copycol Column in the old text where we started
4473 * looking for a match; from here old text still
4474 * needs to be copied to the new text.
4475 * matchcol Column number of the old text where to look
4476 * for the next match. It's just after the
4477 * previous match or one further.
4478 * prev_matchcol Column just after the previous match (if any).
4479 * Mostly equal to matchcol, except for the first
4480 * match and after skipping an empty match.
4481 * regmatch.*pos Where the pattern matched in the old text.
4482 * new_start The new text, all that has been produced so
4483 * far.
4484 * new_end The new text, where to append new text.
4486 * lnum The line number where we were looking for the
4487 * first match in the old line.
4488 * sub_firstlnum The line number in the buffer where to look
4489 * for a match. Can be different from "lnum"
4490 * when the pattern or substitute string contains
4491 * line breaks.
4493 * Special situations:
4494 * - When the substitute string contains a line break, the part up
4495 * to the line break is inserted in the text, but the copy of
4496 * the original line is kept. "sub_firstlnum" is adjusted for
4497 * the inserted lines.
4498 * - When the matched pattern contains a line break, the old line
4499 * is taken from the line at the end of the pattern. The lines
4500 * in the match are deleted later, "sub_firstlnum" is adjusted
4501 * accordingly.
4503 * The new text is built up in new_start[]. It has some extra
4504 * room to avoid using alloc()/free() too often. new_start_len is
4505 * the length of the allocated memory at new_start.
4507 * Make a copy of the old line, so it won't be taken away when
4508 * updating the screen or handling a multi-line match. The "old_"
4509 * pointers point into this copy.
4511 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4512 if (sub_firstline == NULL)
4514 vim_free(new_start);
4515 goto outofmem;
4517 copycol = 0;
4518 matchcol = 0;
4520 /* At first match, remember current cursor position. */
4521 if (!got_match)
4523 setpcmark();
4524 got_match = TRUE;
4528 * Loop until nothing more to replace in this line.
4529 * 1. Handle match with empty string.
4530 * 2. If do_ask is set, ask for confirmation.
4531 * 3. substitute the string.
4532 * 4. if do_all is set, find next match
4533 * 5. break if there isn't another match in this line
4535 for (;;)
4537 /* Save the line number of the last change for the final
4538 * cursor position (just like Vi). */
4539 curwin->w_cursor.lnum = lnum;
4540 do_again = FALSE;
4543 * 1. Match empty string does not count, except for first
4544 * match. This reproduces the strange vi behaviour.
4545 * This also catches endless loops.
4547 if (matchcol == prev_matchcol
4548 && regmatch.endpos[0].lnum == 0
4549 && matchcol == regmatch.endpos[0].col)
4551 if (sub_firstline[matchcol] == NUL)
4552 /* We already were at the end of the line. Don't look
4553 * for a match in this line again. */
4554 skip_match = TRUE;
4555 else
4556 ++matchcol; /* search for a match at next column */
4557 goto skip;
4560 /* Normally we continue searching for a match just after the
4561 * previous match. */
4562 matchcol = regmatch.endpos[0].col;
4563 prev_matchcol = matchcol;
4566 * 2. If do_count is set only increase the counter.
4567 * If do_ask is set, ask for confirmation.
4569 if (do_count)
4571 /* For a multi-line match, put matchcol at the NUL at
4572 * the end of the line and set nmatch to one, so that
4573 * we continue looking for a match on the next line.
4574 * Avoids that ":s/\nB\@=//gc" get stuck. */
4575 if (nmatch > 1)
4577 matchcol = (colnr_T)STRLEN(sub_firstline);
4578 nmatch = 1;
4580 sub_nsubs++;
4581 did_sub = TRUE;
4582 goto skip;
4585 if (do_ask)
4587 /* change State to CONFIRM, so that the mouse works
4588 * properly */
4589 save_State = State;
4590 State = CONFIRM;
4591 #ifdef FEAT_MOUSE
4592 setmouse(); /* disable mouse in xterm */
4593 #endif
4594 curwin->w_cursor.col = regmatch.startpos[0].col;
4596 /* When 'cpoptions' contains "u" don't sync undo when
4597 * asking for confirmation. */
4598 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4599 ++no_u_sync;
4602 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4604 while (do_ask)
4606 if (exmode_active)
4608 char_u *resp;
4609 colnr_T sc, ec;
4611 print_line_no_prefix(lnum, FALSE, FALSE);
4613 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4614 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4615 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4616 msg_start();
4617 for (i = 0; i < (long)sc; ++i)
4618 msg_putchar(' ');
4619 for ( ; i <= (long)ec; ++i)
4620 msg_putchar('^');
4622 resp = getexmodeline('?', NULL, 0);
4623 if (resp != NULL)
4625 i = *resp;
4626 vim_free(resp);
4629 else
4631 #ifdef FEAT_FOLDING
4632 int save_p_fen = curwin->w_p_fen;
4634 curwin->w_p_fen = FALSE;
4635 #endif
4636 /* Invert the matched string.
4637 * Remove the inversion afterwards. */
4638 temp = RedrawingDisabled;
4639 RedrawingDisabled = 0;
4641 search_match_lines = regmatch.endpos[0].lnum;
4642 search_match_endcol = regmatch.endpos[0].col;
4643 highlight_match = TRUE;
4645 update_topline();
4646 validate_cursor();
4647 update_screen(SOME_VALID);
4648 highlight_match = FALSE;
4649 redraw_later(SOME_VALID);
4651 #ifdef FEAT_FOLDING
4652 curwin->w_p_fen = save_p_fen;
4653 #endif
4654 if (msg_row == Rows - 1)
4655 msg_didout = FALSE; /* avoid a scroll-up */
4656 msg_starthere();
4657 i = msg_scroll;
4658 msg_scroll = 0; /* truncate msg when
4659 needed */
4660 msg_no_more = TRUE;
4661 /* write message same highlighting as for
4662 * wait_return */
4663 smsg_attr(hl_attr(HLF_R),
4664 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4665 msg_no_more = FALSE;
4666 msg_scroll = i;
4667 showruler(TRUE);
4668 windgoto(msg_row, msg_col);
4669 RedrawingDisabled = temp;
4671 #ifdef USE_ON_FLY_SCROLL
4672 dont_scroll = FALSE; /* allow scrolling here */
4673 #endif
4674 ++no_mapping; /* don't map this key */
4675 ++allow_keys; /* allow special keys */
4676 i = plain_vgetc();
4677 --allow_keys;
4678 --no_mapping;
4680 /* clear the question */
4681 msg_didout = FALSE; /* don't scroll up */
4682 msg_col = 0;
4683 gotocmdline(TRUE);
4686 need_wait_return = FALSE; /* no hit-return prompt */
4687 if (i == 'q' || i == ESC || i == Ctrl_C
4688 #ifdef UNIX
4689 || i == intr_char
4690 #endif
4693 got_quit = TRUE;
4694 break;
4696 if (i == 'n')
4697 break;
4698 if (i == 'y')
4699 break;
4700 if (i == 'l')
4702 /* last: replace and then stop */
4703 do_all = FALSE;
4704 line2 = lnum;
4705 break;
4707 if (i == 'a')
4709 do_ask = FALSE;
4710 break;
4712 #ifdef FEAT_INS_EXPAND
4713 if (i == Ctrl_E)
4714 scrollup_clamp();
4715 else if (i == Ctrl_Y)
4716 scrolldown_clamp();
4717 #endif
4719 State = save_State;
4720 #ifdef FEAT_MOUSE
4721 setmouse();
4722 #endif
4723 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4724 --no_u_sync;
4726 if (i == 'n')
4728 /* For a multi-line match, put matchcol at the NUL at
4729 * the end of the line and set nmatch to one, so that
4730 * we continue looking for a match on the next line.
4731 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4732 * get stuck when pressing 'n'. */
4733 if (nmatch > 1)
4735 matchcol = (colnr_T)STRLEN(sub_firstline);
4736 skip_match = TRUE;
4738 goto skip;
4740 if (got_quit)
4741 break;
4744 /* Move the cursor to the start of the match, so that we can
4745 * use "\=col("."). */
4746 curwin->w_cursor.col = regmatch.startpos[0].col;
4749 * 3. substitute the string.
4751 /* get length of substitution part */
4752 sublen = vim_regsub_multi(&regmatch, sub_firstlnum,
4753 sub, sub_firstline, FALSE, p_magic, TRUE);
4755 /* When the match included the "$" of the last line it may
4756 * go beyond the last line of the buffer. */
4757 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4759 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4760 skip_match = TRUE;
4763 /* Need room for:
4764 * - result so far in new_start (not for first sub in line)
4765 * - original text up to match
4766 * - length of substituted part
4767 * - original text after match
4769 if (nmatch == 1)
4770 p1 = sub_firstline;
4771 else
4773 p1 = ml_get(sub_firstlnum + nmatch - 1);
4774 nmatch_tl += nmatch - 1;
4776 i = regmatch.startpos[0].col - copycol;
4777 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4778 + sublen + 1;
4779 if (new_start == NULL)
4782 * Get some space for a temporary buffer to do the
4783 * substitution into (and some extra space to avoid
4784 * too many calls to alloc()/free()).
4786 new_start_len = needed_len + 50;
4787 if ((new_start = alloc_check(new_start_len)) == NULL)
4788 goto outofmem;
4789 *new_start = NUL;
4790 new_end = new_start;
4792 else
4795 * Check if the temporary buffer is long enough to do the
4796 * substitution into. If not, make it larger (with a bit
4797 * extra to avoid too many calls to alloc()/free()).
4799 len = (unsigned)STRLEN(new_start);
4800 needed_len += len;
4801 if (needed_len > new_start_len)
4803 new_start_len = needed_len + 50;
4804 if ((p1 = alloc_check(new_start_len)) == NULL)
4806 vim_free(new_start);
4807 goto outofmem;
4809 mch_memmove(p1, new_start, (size_t)(len + 1));
4810 vim_free(new_start);
4811 new_start = p1;
4813 new_end = new_start + len;
4817 * copy the text up to the part that matched
4819 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4820 new_end += i;
4822 (void)vim_regsub_multi(&regmatch, sub_firstlnum,
4823 sub, new_end, TRUE, p_magic, TRUE);
4824 sub_nsubs++;
4825 did_sub = TRUE;
4827 /* Move the cursor to the start of the line, to avoid that it
4828 * is beyond the end of the line after the substitution. */
4829 curwin->w_cursor.col = 0;
4831 /* For a multi-line match, make a copy of the last matched
4832 * line and continue in that one. */
4833 if (nmatch > 1)
4835 sub_firstlnum += nmatch - 1;
4836 vim_free(sub_firstline);
4837 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4838 /* When going beyond the last line, stop substituting. */
4839 if (sub_firstlnum <= line2)
4840 do_again = TRUE;
4841 else
4842 do_all = FALSE;
4845 /* Remember next character to be copied. */
4846 copycol = regmatch.endpos[0].col;
4848 if (skip_match)
4850 /* Already hit end of the buffer, sub_firstlnum is one
4851 * less than what it ought to be. */
4852 vim_free(sub_firstline);
4853 sub_firstline = vim_strsave((char_u *)"");
4854 copycol = 0;
4858 * Now the trick is to replace CTRL-M chars with a real line
4859 * break. This would make it impossible to insert a CTRL-M in
4860 * the text. The line break can be avoided by preceding the
4861 * CTRL-M with a backslash. To be able to insert a backslash,
4862 * they must be doubled in the string and are halved here.
4863 * That is Vi compatible.
4865 for (p1 = new_end; *p1; ++p1)
4867 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4868 mch_memmove(p1, p1 + 1, STRLEN(p1));
4869 else if (*p1 == CAR)
4871 if (u_inssub(lnum) == OK) /* prepare for undo */
4873 *p1 = NUL; /* truncate up to the CR */
4874 ml_append(lnum - 1, new_start,
4875 (colnr_T)(p1 - new_start + 1), FALSE);
4876 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4877 if (do_ask)
4878 appended_lines(lnum - 1, 1L);
4879 else
4881 if (first_line == 0)
4882 first_line = lnum;
4883 last_line = lnum + 1;
4885 /* All line numbers increase. */
4886 ++sub_firstlnum;
4887 ++lnum;
4888 ++line2;
4889 /* move the cursor to the new line, like Vi */
4890 ++curwin->w_cursor.lnum;
4891 /* copy the rest */
4892 mch_memmove(new_start, p1 + 1, STRLEN(p1 + 1) + 1);
4893 p1 = new_start - 1;
4896 #ifdef FEAT_MBYTE
4897 else if (has_mbyte)
4898 p1 += (*mb_ptr2len)(p1) - 1;
4899 #endif
4903 * 4. If do_all is set, find next match.
4904 * Prevent endless loop with patterns that match empty
4905 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4906 * But ":s/\n/#/" is OK.
4908 skip:
4909 /* We already know that we did the last subst when we are at
4910 * the end of the line, except that a pattern like
4911 * "bar\|\nfoo" may match at the NUL. */
4912 lastone = (skip_match
4913 || got_int
4914 || got_quit
4915 || !(do_all || do_again)
4916 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4917 && !re_multiline(regmatch.regprog)));
4918 nmatch = -1;
4921 * Replace the line in the buffer when needed. This is
4922 * skipped when there are more matches.
4923 * The check for nmatch_tl is needed for when multi-line
4924 * matching must replace the lines before trying to do another
4925 * match, otherwise "\@<=" won't work.
4926 * When asking the user we like to show the already replaced
4927 * text, but don't do it when "\<@=" or "\<@!" is used, it
4928 * changes what matches.
4930 if (lastone
4931 || (do_ask && !re_lookbehind(regmatch.regprog))
4932 || nmatch_tl > 0
4933 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4934 curbuf, sub_firstlnum, matchcol)) == 0)
4936 if (new_start != NULL)
4939 * Copy the rest of the line, that didn't match.
4940 * "matchcol" has to be adjusted, we use the end of
4941 * the line as reference, because the substitute may
4942 * have changed the number of characters. Same for
4943 * "prev_matchcol".
4945 STRCAT(new_start, sub_firstline + copycol);
4946 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4947 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4948 - prev_matchcol;
4950 if (u_savesub(lnum) != OK)
4951 break;
4952 ml_replace(lnum, new_start, TRUE);
4954 if (nmatch_tl > 0)
4957 * Matched lines have now been substituted and are
4958 * useless, delete them. The part after the match
4959 * has been appended to new_start, we don't need
4960 * it in the buffer.
4962 ++lnum;
4963 if (u_savedel(lnum, nmatch_tl) != OK)
4964 break;
4965 for (i = 0; i < nmatch_tl; ++i)
4966 ml_delete(lnum, (int)FALSE);
4967 mark_adjust(lnum, lnum + nmatch_tl - 1,
4968 (long)MAXLNUM, -nmatch_tl);
4969 if (do_ask)
4970 deleted_lines(lnum, nmatch_tl);
4971 --lnum;
4972 line2 -= nmatch_tl; /* nr of lines decreases */
4973 nmatch_tl = 0;
4976 /* When asking, undo is saved each time, must also set
4977 * changed flag each time. */
4978 if (do_ask)
4979 changed_bytes(lnum, 0);
4980 else
4982 if (first_line == 0)
4983 first_line = lnum;
4984 last_line = lnum + 1;
4987 sub_firstlnum = lnum;
4988 vim_free(sub_firstline); /* free the temp buffer */
4989 sub_firstline = new_start;
4990 new_start = NULL;
4991 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4992 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4993 - prev_matchcol;
4994 copycol = 0;
4996 if (nmatch == -1 && !lastone)
4997 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
4998 sub_firstlnum, matchcol);
5001 * 5. break if there isn't another match in this line
5003 if (nmatch <= 0)
5004 break;
5007 line_breakcheck();
5010 if (did_sub)
5011 ++sub_nlines;
5012 vim_free(sub_firstline); /* free the copy of the original line */
5013 sub_firstline = NULL;
5016 line_breakcheck();
5019 if (first_line != 0)
5021 /* Need to subtract the number of added lines from "last_line" to get
5022 * the line number before the change (same as adding the number of
5023 * deleted lines). */
5024 i = curbuf->b_ml.ml_line_count - old_line_count;
5025 changed_lines(first_line, 0, last_line - i, i);
5028 outofmem:
5029 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5031 /* ":s/pat//n" doesn't move the cursor */
5032 if (do_count)
5033 curwin->w_cursor = old_cursor;
5035 if (sub_nsubs)
5037 /* Set the '[ and '] marks. */
5038 curbuf->b_op_start.lnum = eap->line1;
5039 curbuf->b_op_end.lnum = line2;
5040 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5042 if (!global_busy)
5044 if (endcolumn)
5045 coladvance((colnr_T)MAXCOL);
5046 else
5047 beginline(BL_WHITE | BL_FIX);
5048 if (!do_sub_msg(do_count) && do_ask)
5049 MSG("");
5051 else
5052 global_need_beginline = TRUE;
5053 if (do_print)
5054 print_line(curwin->w_cursor.lnum, do_number, do_list);
5056 else if (!global_busy)
5058 if (got_int) /* interrupted */
5059 EMSG(_(e_interr));
5060 else if (got_match) /* did find something but nothing substituted */
5061 MSG("");
5062 else if (do_error) /* nothing found */
5063 EMSG2(_(e_patnotf2), get_search_pat());
5066 vim_free(regmatch.regprog);
5070 * Give message for number of substitutions.
5071 * Can also be used after a ":global" command.
5072 * Return TRUE if a message was given.
5075 do_sub_msg(count_only)
5076 int count_only; /* used 'n' flag for ":s" */
5078 int len = 0;
5081 * Only report substitutions when:
5082 * - more than 'report' substitutions
5083 * - command was typed by user, or number of changed lines > 'report'
5084 * - giving messages is not disabled by 'lazyredraw'
5086 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5087 || count_only)
5088 && messaging())
5090 if (got_int)
5092 STRCPY(msg_buf, _("(Interrupted) "));
5093 len = (int)STRLEN(msg_buf);
5095 if (sub_nsubs == 1)
5096 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5097 "%s", count_only ? _("1 match") : _("1 substitution"));
5098 else
5099 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5100 count_only ? _("%ld matches") : _("%ld substitutions"),
5101 sub_nsubs);
5102 len = (int)STRLEN(msg_buf);
5103 if (sub_nlines == 1)
5104 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5105 "%s", _(" on 1 line"));
5106 else
5107 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5108 _(" on %ld lines"), (long)sub_nlines);
5109 if (msg(msg_buf))
5110 /* save message to display it after redraw */
5111 set_keep_msg(msg_buf, 0);
5112 return TRUE;
5114 if (got_int)
5116 EMSG(_(e_interr));
5117 return TRUE;
5119 return FALSE;
5123 * Execute a global command of the form:
5125 * g/pattern/X : execute X on all lines where pattern matches
5126 * v/pattern/X : execute X on all lines where pattern does not match
5128 * where 'X' is an EX command
5130 * The command character (as well as the trailing slash) is optional, and
5131 * is assumed to be 'p' if missing.
5133 * This is implemented in two passes: first we scan the file for the pattern and
5134 * set a mark for each line that (not) matches. secondly we execute the command
5135 * for each line that has a mark. This is required because after deleting
5136 * lines we do not know where to search for the next match.
5138 void
5139 ex_global(eap)
5140 exarg_T *eap;
5142 linenr_T lnum; /* line number according to old situation */
5143 int ndone = 0;
5144 int type; /* first char of cmd: 'v' or 'g' */
5145 char_u *cmd; /* command argument */
5147 char_u delim; /* delimiter, normally '/' */
5148 char_u *pat;
5149 regmmatch_T regmatch;
5150 int match;
5151 int which_pat;
5153 if (global_busy)
5155 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5156 return;
5159 if (eap->forceit) /* ":global!" is like ":vglobal" */
5160 type = 'v';
5161 else
5162 type = *eap->cmd;
5163 cmd = eap->arg;
5164 which_pat = RE_LAST; /* default: use last used regexp */
5165 sub_nsubs = 0;
5166 sub_nlines = 0;
5169 * undocumented vi feature:
5170 * "\/" and "\?": use previous search pattern.
5171 * "\&": use previous substitute pattern.
5173 if (*cmd == '\\')
5175 ++cmd;
5176 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5178 EMSG(_(e_backslash));
5179 return;
5181 if (*cmd == '&')
5182 which_pat = RE_SUBST; /* use previous substitute pattern */
5183 else
5184 which_pat = RE_SEARCH; /* use previous search pattern */
5185 ++cmd;
5186 pat = (char_u *)"";
5188 else if (*cmd == NUL)
5190 EMSG(_("E148: Regular expression missing from global"));
5191 return;
5193 else
5195 delim = *cmd; /* get the delimiter */
5196 if (delim)
5197 ++cmd; /* skip delimiter if there is one */
5198 pat = cmd; /* remember start of pattern */
5199 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5200 if (cmd[0] == delim) /* end delimiter found */
5201 *cmd++ = NUL; /* replace it with a NUL */
5204 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5205 if (p_altkeymap && curwin->w_p_rl)
5206 lrFswap(pat,0);
5207 #endif
5209 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5211 EMSG(_(e_invcmd));
5212 return;
5216 * pass 1: set marks for each (not) matching line
5218 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5220 /* a match on this line? */
5221 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
5222 if ((type == 'g' && match) || (type == 'v' && !match))
5224 ml_setmarked(lnum);
5225 ndone++;
5227 line_breakcheck();
5231 * pass 2: execute the command for each line that has been marked
5233 if (got_int)
5234 MSG(_(e_interr));
5235 else if (ndone == 0)
5237 if (type == 'v')
5238 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5239 else
5240 smsg((char_u *)_(e_patnotf2), pat);
5242 else
5243 global_exe(cmd);
5245 ml_clearmarked(); /* clear rest of the marks */
5246 vim_free(regmatch.regprog);
5250 * Execute "cmd" on lines marked with ml_setmarked().
5252 void
5253 global_exe(cmd)
5254 char_u *cmd;
5256 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5257 linenr_T lnum; /* line number according to old situation */
5260 * Set current position only once for a global command.
5261 * If global_busy is set, setpcmark() will not do anything.
5262 * If there is an error, global_busy will be incremented.
5264 setpcmark();
5266 /* When the command writes a message, don't overwrite the command. */
5267 msg_didout = TRUE;
5269 global_need_beginline = FALSE;
5270 global_busy = 1;
5271 old_lcount = curbuf->b_ml.ml_line_count;
5272 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5274 curwin->w_cursor.lnum = lnum;
5275 curwin->w_cursor.col = 0;
5276 if (*cmd == NUL || *cmd == '\n')
5277 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5278 else
5279 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5280 ui_breakcheck();
5283 global_busy = 0;
5284 if (global_need_beginline)
5285 beginline(BL_WHITE | BL_FIX);
5286 else
5287 check_cursor(); /* cursor may be beyond the end of the line */
5289 /* the cursor may not have moved in the text but a change in a previous
5290 * line may move it on the screen */
5291 changed_line_abv_curs();
5293 /* If it looks like no message was written, allow overwriting the
5294 * command with the report for number of changes. */
5295 if (msg_col == 0 && msg_scrolled == 0)
5296 msg_didout = FALSE;
5298 /* If substitutes done, report number of substitutes, otherwise report
5299 * number of extra or deleted lines. */
5300 if (!do_sub_msg(FALSE))
5301 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5304 #ifdef FEAT_VIMINFO
5306 read_viminfo_sub_string(virp, force)
5307 vir_T *virp;
5308 int force;
5310 if (old_sub != NULL && force)
5311 vim_free(old_sub);
5312 if (force || old_sub == NULL)
5313 old_sub = viminfo_readstring(virp, 1, TRUE);
5314 return viminfo_readline(virp);
5317 void
5318 write_viminfo_sub_string(fp)
5319 FILE *fp;
5321 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5323 fprintf(fp, _("\n# Last Substitute String:\n$"));
5324 viminfo_writestring(fp, old_sub);
5327 #endif /* FEAT_VIMINFO */
5329 #if defined(EXITFREE) || defined(PROTO)
5330 void
5331 free_old_sub()
5333 vim_free(old_sub);
5335 #endif
5337 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5339 * Set up for a tagpreview.
5340 * Return TRUE when it was created.
5343 prepare_tagpreview(undo_sync)
5344 int undo_sync; /* sync undo when leaving the window */
5346 win_T *wp;
5348 # ifdef FEAT_GUI
5349 need_mouse_correct = TRUE;
5350 # endif
5353 * If there is already a preview window open, use that one.
5355 if (!curwin->w_p_pvw)
5357 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5358 if (wp->w_p_pvw)
5359 break;
5360 if (wp != NULL)
5361 win_enter(wp, undo_sync);
5362 else
5365 * There is no preview window open yet. Create one.
5367 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5368 == FAIL)
5369 return FALSE;
5370 curwin->w_p_pvw = TRUE;
5371 curwin->w_p_wfh = TRUE;
5372 # ifdef FEAT_SCROLLBIND
5373 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5374 # endif
5375 # ifdef FEAT_DIFF
5376 curwin->w_p_diff = FALSE; /* no 'diff' */
5377 # endif
5378 # ifdef FEAT_FOLDING
5379 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5380 # endif
5381 return TRUE;
5384 return FALSE;
5387 #endif
5391 * ":help": open a read-only window on a help file
5393 void
5394 ex_help(eap)
5395 exarg_T *eap;
5397 char_u *arg;
5398 char_u *tag;
5399 FILE *helpfd; /* file descriptor of help file */
5400 int n;
5401 int i;
5402 #ifdef FEAT_WINDOWS
5403 win_T *wp;
5404 #endif
5405 int num_matches;
5406 char_u **matches;
5407 char_u *p;
5408 int empty_fnum = 0;
5409 int alt_fnum = 0;
5410 buf_T *buf;
5411 #ifdef FEAT_MULTI_LANG
5412 int len;
5413 char_u *lang;
5414 #endif
5416 if (eap != NULL)
5419 * A ":help" command ends at the first LF, or at a '|' that is
5420 * followed by some text. Set nextcmd to the following command.
5422 for (arg = eap->arg; *arg; ++arg)
5424 if (*arg == '\n' || *arg == '\r'
5425 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5427 *arg++ = NUL;
5428 eap->nextcmd = arg;
5429 break;
5432 arg = eap->arg;
5434 if (eap->forceit && *arg == NUL)
5436 EMSG(_("E478: Don't panic!"));
5437 return;
5440 if (eap->skip) /* not executing commands */
5441 return;
5443 else
5444 arg = (char_u *)"";
5446 /* remove trailing blanks */
5447 p = arg + STRLEN(arg) - 1;
5448 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5449 *p-- = NUL;
5451 #ifdef FEAT_MULTI_LANG
5452 /* Check for a specified language */
5453 lang = check_help_lang(arg);
5454 #endif
5456 /* When no argument given go to the index. */
5457 if (*arg == NUL)
5458 arg = (char_u *)"help.txt";
5461 * Check if there is a match for the argument.
5463 n = find_help_tags(arg, &num_matches, &matches,
5464 eap != NULL && eap->forceit);
5466 i = 0;
5467 #ifdef FEAT_MULTI_LANG
5468 if (n != FAIL && lang != NULL)
5469 /* Find first item with the requested language. */
5470 for (i = 0; i < num_matches; ++i)
5472 len = (int)STRLEN(matches[i]);
5473 if (len > 3 && matches[i][len - 3] == '@'
5474 && STRICMP(matches[i] + len - 2, lang) == 0)
5475 break;
5477 #endif
5478 if (i >= num_matches || n == FAIL)
5480 #ifdef FEAT_MULTI_LANG
5481 if (lang != NULL)
5482 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5483 else
5484 #endif
5485 EMSG2(_("E149: Sorry, no help for %s"), arg);
5486 if (n != FAIL)
5487 FreeWild(num_matches, matches);
5488 return;
5491 /* The first match (in the requested language) is the best match. */
5492 tag = vim_strsave(matches[i]);
5493 FreeWild(num_matches, matches);
5495 #ifdef FEAT_GUI
5496 need_mouse_correct = TRUE;
5497 #endif
5500 * Re-use an existing help window or open a new one.
5501 * Always open a new one for ":tab help".
5503 if (!curwin->w_buffer->b_help
5504 #ifdef FEAT_WINDOWS
5505 || cmdmod.tab != 0
5506 #endif
5509 #ifdef FEAT_WINDOWS
5510 if (cmdmod.tab != 0)
5511 wp = NULL;
5512 else
5513 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5514 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5515 break;
5516 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5517 win_enter(wp, TRUE);
5518 else
5519 #endif
5522 * There is no help window yet.
5523 * Try to open the file specified by the "helpfile" option.
5525 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5527 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5528 goto erret;
5530 fclose(helpfd);
5532 #ifdef FEAT_WINDOWS
5533 /* Split off help window; put it at far top if no position
5534 * specified, the current window is vertically split and
5535 * narrow. */
5536 n = WSP_HELP;
5537 # ifdef FEAT_VERTSPLIT
5538 if (cmdmod.split == 0 && curwin->w_width != Columns
5539 && curwin->w_width < 80)
5540 n |= WSP_TOP;
5541 # endif
5542 if (win_split(0, n) == FAIL)
5543 goto erret;
5544 #else
5545 /* use current window */
5546 if (!can_abandon(curbuf, FALSE))
5547 goto erret;
5548 #endif
5550 #ifdef FEAT_WINDOWS
5551 if (curwin->w_height < p_hh)
5552 win_setheight((int)p_hh);
5553 #endif
5556 * Open help file (do_ecmd() will set b_help flag, readfile() will
5557 * set b_p_ro flag).
5558 * Set the alternate file to the previously edited file.
5560 alt_fnum = curbuf->b_fnum;
5561 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5562 ECMD_HIDE + ECMD_SET_HELP);
5563 if (!cmdmod.keepalt)
5564 curwin->w_alt_fnum = alt_fnum;
5565 empty_fnum = curbuf->b_fnum;
5569 if (!p_im)
5570 restart_edit = 0; /* don't want insert mode in help file */
5572 if (tag != NULL)
5573 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5575 /* Delete the empty buffer if we're not using it. Careful: autocommands
5576 * may have jumped to another window, check that the buffer is not in a
5577 * window. */
5578 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5580 buf = buflist_findnr(empty_fnum);
5581 if (buf != NULL && buf->b_nwindows == 0)
5582 wipe_buffer(buf, TRUE);
5585 /* keep the previous alternate file */
5586 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5587 curwin->w_alt_fnum = alt_fnum;
5589 erret:
5590 vim_free(tag);
5594 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5596 * In an argument search for a language specifiers in the form "@xx".
5597 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5598 * Returns NULL if not found.
5600 char_u *
5601 check_help_lang(arg)
5602 char_u *arg;
5604 int len = (int)STRLEN(arg);
5606 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5607 && ASCII_ISALPHA(arg[len - 1]))
5609 arg[len - 3] = NUL; /* remove the '@' */
5610 return arg + len - 2;
5612 return NULL;
5614 #endif
5617 * Return a heuristic indicating how well the given string matches. The
5618 * smaller the number, the better the match. This is the order of priorities,
5619 * from best match to worst match:
5620 * - Match with least alpha-numeric characters is better.
5621 * - Match with least total characters is better.
5622 * - Match towards the start is better.
5623 * - Match starting with "+" is worse (feature instead of command)
5624 * Assumption is made that the matched_string passed has already been found to
5625 * match some string for which help is requested. webb.
5628 help_heuristic(matched_string, offset, wrong_case)
5629 char_u *matched_string;
5630 int offset; /* offset for match */
5631 int wrong_case; /* no matching case */
5633 int num_letters;
5634 char_u *p;
5636 num_letters = 0;
5637 for (p = matched_string; *p; p++)
5638 if (ASCII_ISALNUM(*p))
5639 num_letters++;
5642 * Multiply the number of letters by 100 to give it a much bigger
5643 * weighting than the number of characters.
5644 * If there only is a match while ignoring case, add 5000.
5645 * If the match starts in the middle of a word, add 10000 to put it
5646 * somewhere in the last half.
5647 * If the match is more than 2 chars from the start, multiply by 200 to
5648 * put it after matches at the start.
5650 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5651 && ASCII_ISALNUM(matched_string[offset - 1]))
5652 offset += 10000;
5653 else if (offset > 2)
5654 offset *= 200;
5655 if (wrong_case)
5656 offset += 5000;
5657 /* Features are less interesting than the subjects themselves, but "+"
5658 * alone is not a feature. */
5659 if (matched_string[0] == '+' && matched_string[1] != NUL)
5660 offset += 100;
5661 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5665 * Compare functions for qsort() below, that checks the help heuristics number
5666 * that has been put after the tagname by find_tags().
5668 static int
5669 #ifdef __BORLANDC__
5670 _RTLENTRYF
5671 #endif
5672 help_compare(s1, s2)
5673 const void *s1;
5674 const void *s2;
5676 char *p1;
5677 char *p2;
5679 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5680 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5681 return strcmp(p1, p2);
5685 * Find all help tags matching "arg", sort them and return in matches[], with
5686 * the number of matches in num_matches.
5687 * The matches will be sorted with a "best" match algorithm.
5688 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5691 find_help_tags(arg, num_matches, matches, keep_lang)
5692 char_u *arg;
5693 int *num_matches;
5694 char_u ***matches;
5695 int keep_lang;
5697 char_u *s, *d;
5698 int i;
5699 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5700 "/*", "/\\*", "\"*", "**",
5701 "/\\(\\)",
5702 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5703 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5704 "[count]", "[quotex]", "[range]",
5705 "[pattern]", "\\|", "\\%$"};
5706 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5707 "/star", "/\\\\star", "quotestar", "starstar",
5708 "/\\\\(\\\\)",
5709 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5710 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5711 "\\[count]", "\\[quotex]", "\\[range]",
5712 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5713 int flags;
5715 d = IObuff; /* assume IObuff is long enough! */
5718 * Recognize a few exceptions to the rule. Some strings that contain '*'
5719 * with "star". Otherwise '*' is recognized as a wildcard.
5721 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5722 if (STRCMP(arg, mtable[i]) == 0)
5724 STRCPY(d, rtable[i]);
5725 break;
5728 if (i < 0) /* no match in table */
5730 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5731 * Also replace "\%^" and "\%(", they match every tag too.
5732 * Also "\zs", "\z1", etc.
5733 * Also "\@<", "\@=", "\@<=", etc.
5734 * And also "\_$" and "\_^". */
5735 if (arg[0] == '\\'
5736 && ((arg[1] != NUL && arg[2] == NUL)
5737 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5738 && arg[2] != NUL)))
5740 STRCPY(d, "/\\\\");
5741 STRCPY(d + 3, arg + 1);
5742 /* Check for "/\\_$", should be "/\\_\$" */
5743 if (d[3] == '_' && d[4] == '$')
5744 STRCPY(d + 4, "\\$");
5746 else
5748 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5749 if (arg[0] == '[' && (arg[1] == ':'
5750 || (arg[1] == '+' && arg[2] == '+')))
5751 *d++ = '\\';
5753 for (s = arg; *s; ++s)
5756 * Replace "|" with "bar" and '"' with "quote" to match the name of
5757 * the tags for these commands.
5758 * Replace "*" with ".*" and "?" with "." to match command line
5759 * completion.
5760 * Insert a backslash before '~', '$' and '.' to avoid their
5761 * special meaning.
5763 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5764 break;
5765 switch (*s)
5767 case '|': STRCPY(d, "bar");
5768 d += 3;
5769 continue;
5770 case '"': STRCPY(d, "quote");
5771 d += 5;
5772 continue;
5773 case '*': *d++ = '.';
5774 break;
5775 case '?': *d++ = '.';
5776 continue;
5777 case '$':
5778 case '.':
5779 case '~': *d++ = '\\';
5780 break;
5784 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5785 * ":help i_^_CTRL-D" work.
5786 * Insert '-' before and after "CTRL-X" when applicable.
5788 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5789 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5791 if (d > IObuff && d[-1] != '_')
5792 *d++ = '_'; /* prepend a '_' */
5793 STRCPY(d, "CTRL-");
5794 d += 5;
5795 if (*s < ' ')
5797 #ifdef EBCDIC
5798 *d++ = CtrlChar(*s);
5799 #else
5800 *d++ = *s + '@';
5801 #endif
5802 if (d[-1] == '\\')
5803 *d++ = '\\'; /* double a backslash */
5805 else
5806 *d++ = *++s;
5807 if (s[1] != NUL && s[1] != '_')
5808 *d++ = '_'; /* append a '_' */
5809 continue;
5811 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5812 *d++ = '\\';
5815 * Insert a backslash before a backslash after a slash, for search
5816 * pattern tags: "/\|" --> "/\\|".
5818 else if (s[0] == '\\' && s[1] != '\\'
5819 && *arg == '/' && s == arg + 1)
5820 *d++ = '\\';
5822 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5823 * "CTRL-\_CTRL-N" */
5824 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5826 STRCPY(d, "CTRL-\\\\");
5827 d += 7;
5828 s += 6;
5831 *d++ = *s;
5834 * If tag starts with ', toss everything after a second '. Fixes
5835 * CTRL-] on 'option'. (would include the trailing '.').
5837 if (*s == '\'' && s > arg && *arg == '\'')
5838 break;
5840 *d = NUL;
5844 *matches = (char_u **)"";
5845 *num_matches = 0;
5846 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5847 if (keep_lang)
5848 flags |= TAG_KEEP_LANG;
5849 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5850 && *num_matches > 0)
5851 /* Sort the matches found on the heuristic number that is after the
5852 * tag name. */
5853 qsort((void *)*matches, (size_t)*num_matches,
5854 sizeof(char_u *), help_compare);
5855 return OK;
5859 * After reading a help file: May cleanup a help buffer when syntax
5860 * highlighting is not used.
5862 void
5863 fix_help_buffer()
5865 linenr_T lnum;
5866 char_u *line;
5867 int in_example = FALSE;
5868 int len;
5869 char_u *p;
5870 char_u *rt;
5871 int mustfree;
5873 /* set filetype to "help". */
5874 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5876 #ifdef FEAT_SYN_HL
5877 if (!syntax_present(curbuf))
5878 #endif
5880 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5882 line = ml_get_buf(curbuf, lnum, FALSE);
5883 len = (int)STRLEN(line);
5884 if (in_example && len > 0 && !vim_iswhite(line[0]))
5886 /* End of example: non-white or '<' in first column. */
5887 if (line[0] == '<')
5889 /* blank-out a '<' in the first column */
5890 line = ml_get_buf(curbuf, lnum, TRUE);
5891 line[0] = ' ';
5893 in_example = FALSE;
5895 if (!in_example && len > 0)
5897 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5899 /* blank-out a '>' in the last column (start of example) */
5900 line = ml_get_buf(curbuf, lnum, TRUE);
5901 line[len - 1] = ' ';
5902 in_example = TRUE;
5904 else if (line[len - 1] == '~')
5906 /* blank-out a '~' at the end of line (header marker) */
5907 line = ml_get_buf(curbuf, lnum, TRUE);
5908 line[len - 1] = ' ';
5915 * In the "help.txt" file, add the locally added help files.
5916 * This uses the very first line in the help file.
5918 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5920 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5922 line = ml_get_buf(curbuf, lnum, FALSE);
5923 if (strstr((char *)line, "*local-additions*") != NULL)
5925 /* Go through all directories in 'runtimepath', skipping
5926 * $VIMRUNTIME. */
5927 p = p_rtp;
5928 while (*p != NUL)
5930 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5931 mustfree = FALSE;
5932 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5933 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5935 int fcount;
5936 char_u **fnames;
5937 FILE *fd;
5938 char_u *s;
5939 int fi;
5940 #ifdef FEAT_MBYTE
5941 vimconv_T vc;
5942 char_u *cp;
5943 #endif
5945 /* Find all "doc/ *.txt" files in this directory. */
5946 add_pathsep(NameBuff);
5947 STRCAT(NameBuff, "doc/*.txt");
5948 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5949 &fnames, EW_FILE|EW_SILENT) == OK
5950 && fcount > 0)
5952 for (fi = 0; fi < fcount; ++fi)
5954 fd = mch_fopen((char *)fnames[fi], "r");
5955 if (fd != NULL)
5957 vim_fgets(IObuff, IOSIZE, fd);
5958 if (IObuff[0] == '*'
5959 && (s = vim_strchr(IObuff + 1, '*'))
5960 != NULL)
5962 #ifdef FEAT_MBYTE
5963 int this_utf = MAYBE;
5964 #endif
5965 /* Change tag definition to a
5966 * reference and remove <CR>/<NL>. */
5967 IObuff[0] = '|';
5968 *s = '|';
5969 while (*s != NUL)
5971 if (*s == '\r' || *s == '\n')
5972 *s = NUL;
5973 #ifdef FEAT_MBYTE
5974 /* The text is utf-8 when a byte
5975 * above 127 is found and no
5976 * illegal byte sequence is found.
5978 if (*s >= 0x80 && this_utf != FALSE)
5980 int l;
5982 this_utf = TRUE;
5983 l = utf_ptr2len(s);
5984 if (l == 1)
5985 this_utf = FALSE;
5986 s += l - 1;
5988 #endif
5989 ++s;
5991 #ifdef FEAT_MBYTE
5992 /* The help file is latin1 or utf-8;
5993 * conversion to the current
5994 * 'encoding' may be required. */
5995 vc.vc_type = CONV_NONE;
5996 convert_setup(&vc, (char_u *)(
5997 this_utf == TRUE ? "utf-8"
5998 : "latin1"), p_enc);
5999 if (vc.vc_type == CONV_NONE)
6000 /* No conversion needed. */
6001 cp = IObuff;
6002 else
6004 /* Do the conversion. If it fails
6005 * use the unconverted text. */
6006 cp = string_convert(&vc, IObuff,
6007 NULL);
6008 if (cp == NULL)
6009 cp = IObuff;
6011 convert_setup(&vc, NULL, NULL);
6013 ml_append(lnum, cp, (colnr_T)0, FALSE);
6014 if (cp != IObuff)
6015 vim_free(cp);
6016 #else
6017 ml_append(lnum, IObuff, (colnr_T)0,
6018 FALSE);
6019 #endif
6020 ++lnum;
6022 fclose(fd);
6025 FreeWild(fcount, fnames);
6028 if (mustfree)
6029 vim_free(rt);
6031 break;
6038 * ":exusage"
6040 /*ARGSUSED*/
6041 void
6042 ex_exusage(eap)
6043 exarg_T *eap;
6045 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6049 * ":viusage"
6051 /*ARGSUSED*/
6052 void
6053 ex_viusage(eap)
6054 exarg_T *eap;
6056 do_cmdline_cmd((char_u *)"help normal-index");
6059 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6060 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang));
6063 * ":helptags"
6065 void
6066 ex_helptags(eap)
6067 exarg_T *eap;
6069 garray_T ga;
6070 int i, j;
6071 int len;
6072 #ifdef FEAT_MULTI_LANG
6073 char_u lang[2];
6074 #endif
6075 char_u ext[5];
6076 char_u fname[8];
6077 int filecount;
6078 char_u **files;
6080 if (!mch_isdir(eap->arg))
6082 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6083 return;
6086 #ifdef FEAT_MULTI_LANG
6087 /* Get a list of all files in the directory. */
6088 STRCPY(NameBuff, eap->arg);
6089 add_pathsep(NameBuff);
6090 STRCAT(NameBuff, "*");
6091 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6092 EW_FILE|EW_SILENT) == FAIL
6093 || filecount == 0)
6095 EMSG2("E151: No match: %s", NameBuff);
6096 return;
6099 /* Go over all files in the directory to find out what languages are
6100 * present. */
6101 ga_init2(&ga, 1, 10);
6102 for (i = 0; i < filecount; ++i)
6104 len = (int)STRLEN(files[i]);
6105 if (len > 4)
6107 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6109 /* ".txt" -> language "en" */
6110 lang[0] = 'e';
6111 lang[1] = 'n';
6113 else if (files[i][len - 4] == '.'
6114 && ASCII_ISALPHA(files[i][len - 3])
6115 && ASCII_ISALPHA(files[i][len - 2])
6116 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6118 /* ".abx" -> language "ab" */
6119 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6120 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6122 else
6123 continue;
6125 /* Did we find this language already? */
6126 for (j = 0; j < ga.ga_len; j += 2)
6127 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6128 break;
6129 if (j == ga.ga_len)
6131 /* New language, add it. */
6132 if (ga_grow(&ga, 2) == FAIL)
6133 break;
6134 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6135 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6141 * Loop over the found languages to generate a tags file for each one.
6143 for (j = 0; j < ga.ga_len; j += 2)
6145 STRCPY(fname, "tags-xx");
6146 fname[5] = ((char_u *)ga.ga_data)[j];
6147 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6148 if (fname[5] == 'e' && fname[6] == 'n')
6150 /* English is an exception: use ".txt" and "tags". */
6151 fname[4] = NUL;
6152 STRCPY(ext, ".txt");
6154 else
6156 /* Language "ab" uses ".abx" and "tags-ab". */
6157 STRCPY(ext, ".xxx");
6158 ext[1] = fname[5];
6159 ext[2] = fname[6];
6161 helptags_one(eap->arg, ext, fname);
6164 ga_clear(&ga);
6165 FreeWild(filecount, files);
6167 #else
6168 /* No language support, just use "*.txt" and "tags". */
6169 helptags_one(eap->arg, (char_u *)".txt", (char_u *)"tags");
6170 #endif
6173 static void
6174 helptags_one(dir, ext, tagfname)
6175 char_u *dir; /* doc directory */
6176 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6177 char_u *tagfname; /* "tags" for English, "tags-it" for Italian. */
6179 FILE *fd_tags;
6180 FILE *fd;
6181 garray_T ga;
6182 int filecount;
6183 char_u **files;
6184 char_u *p1, *p2;
6185 int fi;
6186 char_u *s;
6187 int i;
6188 char_u *fname;
6189 # ifdef FEAT_MBYTE
6190 int utf8 = MAYBE;
6191 int this_utf8;
6192 int firstline;
6193 int mix = FALSE; /* detected mixed encodings */
6194 # endif
6197 * Find all *.txt files.
6199 STRCPY(NameBuff, dir);
6200 add_pathsep(NameBuff);
6201 STRCAT(NameBuff, "*");
6202 STRCAT(NameBuff, ext);
6203 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6204 EW_FILE|EW_SILENT) == FAIL
6205 || filecount == 0)
6207 if (!got_int)
6208 EMSG2("E151: No match: %s", NameBuff);
6209 return;
6213 * Open the tags file for writing.
6214 * Do this before scanning through all the files.
6216 STRCPY(NameBuff, dir);
6217 add_pathsep(NameBuff);
6218 STRCAT(NameBuff, tagfname);
6219 fd_tags = mch_fopen((char *)NameBuff, "w");
6220 if (fd_tags == NULL)
6222 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6223 FreeWild(filecount, files);
6224 return;
6228 * If generating tags for "$VIMRUNTIME/doc" add the "help-tags" tag.
6230 ga_init2(&ga, (int)sizeof(char_u *), 100);
6231 if (fullpathcmp((char_u *)"$VIMRUNTIME/doc", dir, FALSE) == FPC_SAME)
6233 if (ga_grow(&ga, 1) == FAIL)
6234 got_int = TRUE;
6235 else
6237 s = alloc(18 + (unsigned)STRLEN(tagfname));
6238 if (s == NULL)
6239 got_int = TRUE;
6240 else
6242 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6243 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6244 ++ga.ga_len;
6250 * Go over all the files and extract the tags.
6252 for (fi = 0; fi < filecount && !got_int; ++fi)
6254 fd = mch_fopen((char *)files[fi], "r");
6255 if (fd == NULL)
6257 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6258 continue;
6260 fname = gettail(files[fi]);
6262 # ifdef FEAT_MBYTE
6263 firstline = TRUE;
6264 # endif
6265 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6267 # ifdef FEAT_MBYTE
6268 if (firstline)
6270 /* Detect utf-8 file by a non-ASCII char in the first line. */
6271 this_utf8 = MAYBE;
6272 for (s = IObuff; *s != NUL; ++s)
6273 if (*s >= 0x80)
6275 int l;
6277 this_utf8 = TRUE;
6278 l = utf_ptr2len(s);
6279 if (l == 1)
6281 /* Illegal UTF-8 byte sequence. */
6282 this_utf8 = FALSE;
6283 break;
6285 s += l - 1;
6287 if (this_utf8 == MAYBE) /* only ASCII characters found */
6288 this_utf8 = FALSE;
6289 if (utf8 == MAYBE) /* first file */
6290 utf8 = this_utf8;
6291 else if (utf8 != this_utf8)
6293 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6294 mix = !got_int;
6295 got_int = TRUE;
6297 firstline = FALSE;
6299 # endif
6300 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6301 while (p1 != NULL)
6303 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6304 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6306 for (s = p1 + 1; s < p2; ++s)
6307 if (*s == ' ' || *s == '\t' || *s == '|')
6308 break;
6311 * Only accept a *tag* when it consists of valid
6312 * characters, there is white space before it and is
6313 * followed by a white character or end-of-line.
6315 if (s == p2
6316 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6317 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6318 || s[1] == '\0'))
6320 *p2 = '\0';
6321 ++p1;
6322 if (ga_grow(&ga, 1) == FAIL)
6324 got_int = TRUE;
6325 break;
6327 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6328 if (s == NULL)
6330 got_int = TRUE;
6331 break;
6333 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6334 ++ga.ga_len;
6335 sprintf((char *)s, "%s\t%s", p1, fname);
6337 /* find next '*' */
6338 p2 = vim_strchr(p2 + 1, '*');
6341 p1 = p2;
6343 line_breakcheck();
6346 fclose(fd);
6349 FreeWild(filecount, files);
6351 if (!got_int)
6354 * Sort the tags.
6356 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6359 * Check for duplicates.
6361 for (i = 1; i < ga.ga_len; ++i)
6363 p1 = ((char_u **)ga.ga_data)[i - 1];
6364 p2 = ((char_u **)ga.ga_data)[i];
6365 while (*p1 == *p2)
6367 if (*p2 == '\t')
6369 *p2 = NUL;
6370 vim_snprintf((char *)NameBuff, MAXPATHL,
6371 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6372 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6373 EMSG(NameBuff);
6374 *p2 = '\t';
6375 break;
6377 ++p1;
6378 ++p2;
6382 # ifdef FEAT_MBYTE
6383 if (utf8 == TRUE)
6384 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6385 # endif
6388 * Write the tags into the file.
6390 for (i = 0; i < ga.ga_len; ++i)
6392 s = ((char_u **)ga.ga_data)[i];
6393 if (STRNCMP(s, "help-tags\t", 10) == 0)
6394 /* help-tags entry was added in formatted form */
6395 fputs((char *)s, fd_tags);
6396 else
6398 fprintf(fd_tags, "%s\t/*", s);
6399 for (p1 = s; *p1 != '\t'; ++p1)
6401 /* insert backslash before '\\' and '/' */
6402 if (*p1 == '\\' || *p1 == '/')
6403 putc('\\', fd_tags);
6404 putc(*p1, fd_tags);
6406 fprintf(fd_tags, "*\n");
6410 #ifdef FEAT_MBYTE
6411 if (mix)
6412 got_int = FALSE; /* continue with other languages */
6413 #endif
6415 for (i = 0; i < ga.ga_len; ++i)
6416 vim_free(((char_u **)ga.ga_data)[i]);
6417 ga_clear(&ga);
6418 fclose(fd_tags); /* there is no check for an error... */
6420 #endif
6422 #if defined(FEAT_SIGNS) || defined(PROTO)
6425 * Struct to hold the sign properties.
6427 typedef struct sign sign_T;
6429 struct sign
6431 sign_T *sn_next; /* next sign in list */
6432 int sn_typenr; /* type number of sign (negative if not equal
6433 to name) */
6434 char_u *sn_name; /* name of sign */
6435 char_u *sn_icon; /* name of pixmap */
6436 #ifdef FEAT_SIGN_ICONS
6437 void *sn_image; /* icon image */
6438 #endif
6439 char_u *sn_text; /* text used instead of pixmap */
6440 int sn_line_hl; /* highlight ID for line */
6441 int sn_text_hl; /* highlight ID for text */
6444 static sign_T *first_sign = NULL;
6445 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6447 static void sign_list_defined __ARGS((sign_T *sp));
6450 * ":sign" command
6452 void
6453 ex_sign(eap)
6454 exarg_T *eap;
6456 char_u *arg = eap->arg;
6457 char_u *p;
6458 int idx;
6459 sign_T *sp;
6460 sign_T *sp_prev;
6461 buf_T *buf;
6462 static char *cmds[] = {
6463 "define",
6464 #define SIGNCMD_DEFINE 0
6465 "undefine",
6466 #define SIGNCMD_UNDEFINE 1
6467 "list",
6468 #define SIGNCMD_LIST 2
6469 "place",
6470 #define SIGNCMD_PLACE 3
6471 "unplace",
6472 #define SIGNCMD_UNPLACE 4
6473 "jump",
6474 #define SIGNCMD_JUMP 5
6475 #define SIGNCMD_LAST 6
6478 /* Parse the subcommand. */
6479 p = skiptowhite(arg);
6480 if (*p != NUL)
6481 *p++ = NUL;
6482 for (idx = 0; ; ++idx)
6484 if (idx == SIGNCMD_LAST)
6486 EMSG2(_("E160: Unknown sign command: %s"), arg);
6487 return;
6489 if (STRCMP(arg, cmds[idx]) == 0)
6490 break;
6492 arg = skipwhite(p);
6494 if (idx <= SIGNCMD_LIST)
6497 * Define, undefine or list signs.
6499 if (idx == SIGNCMD_LIST && *arg == NUL)
6501 /* ":sign list": list all defined signs */
6502 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6503 sign_list_defined(sp);
6505 else if (*arg == NUL)
6506 EMSG(_("E156: Missing sign name"));
6507 else
6509 p = skiptowhite(arg);
6510 if (*p != NUL)
6511 *p++ = NUL;
6512 sp_prev = NULL;
6513 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6515 if (STRCMP(sp->sn_name, arg) == 0)
6516 break;
6517 sp_prev = sp;
6519 if (idx == SIGNCMD_DEFINE)
6521 /* ":sign define {name} ...": define a sign */
6522 if (sp == NULL)
6524 /* Allocate a new sign. */
6525 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6526 if (sp == NULL)
6527 return;
6528 if (sp_prev == NULL)
6529 first_sign = sp;
6530 else
6531 sp_prev->sn_next = sp;
6532 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6534 /* If the name is a number use that for the typenr,
6535 * otherwise use a negative number. */
6536 if (VIM_ISDIGIT(*arg))
6537 sp->sn_typenr = atoi((char *)arg);
6538 else
6540 sign_T *lp;
6541 int start = last_sign_typenr;
6543 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6545 if (lp->sn_typenr == last_sign_typenr)
6547 --last_sign_typenr;
6548 if (last_sign_typenr == 0)
6549 last_sign_typenr = MAX_TYPENR;
6550 if (last_sign_typenr == start)
6552 EMSG(_("E612: Too many signs defined"));
6553 return;
6555 lp = first_sign;
6556 continue;
6560 sp->sn_typenr = last_sign_typenr--;
6561 if (last_sign_typenr == 0)
6562 last_sign_typenr = MAX_TYPENR; /* wrap around */
6566 /* set values for a defined sign. */
6567 for (;;)
6569 arg = skipwhite(p);
6570 if (*arg == NUL)
6571 break;
6572 p = skiptowhite_esc(arg);
6573 if (STRNCMP(arg, "icon=", 5) == 0)
6575 arg += 5;
6576 vim_free(sp->sn_icon);
6577 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6578 backslash_halve(sp->sn_icon);
6579 #ifdef FEAT_SIGN_ICONS
6580 if (gui.in_use)
6582 out_flush();
6583 if (sp->sn_image != NULL)
6584 gui_mch_destroy_sign(sp->sn_image);
6585 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6587 #endif
6589 else if (STRNCMP(arg, "text=", 5) == 0)
6591 char_u *s;
6592 int cells;
6593 int len;
6595 arg += 5;
6596 #ifdef FEAT_MBYTE
6597 /* Count cells and check for non-printable chars */
6598 if (has_mbyte)
6600 cells = 0;
6601 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6603 if (!vim_isprintc((*mb_ptr2char)(s)))
6604 break;
6605 cells += (*mb_ptr2cells)(s);
6608 else
6609 #endif
6611 for (s = arg; s < p; ++s)
6612 if (!vim_isprintc(*s))
6613 break;
6614 cells = (int)(s - arg);
6616 /* Currently must be one or two display cells */
6617 if (s != p || cells < 1 || cells > 2)
6619 *p = NUL;
6620 EMSG2(_("E239: Invalid sign text: %s"), arg);
6621 return;
6624 vim_free(sp->sn_text);
6625 /* Allocate one byte more if we need to pad up
6626 * with a space. */
6627 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6628 sp->sn_text = vim_strnsave(arg, len);
6630 if (sp->sn_text != NULL && cells == 1)
6631 STRCPY(sp->sn_text + len - 1, " ");
6633 else if (STRNCMP(arg, "linehl=", 7) == 0)
6635 arg += 7;
6636 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6638 else if (STRNCMP(arg, "texthl=", 7) == 0)
6640 arg += 7;
6641 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6643 else
6645 EMSG2(_(e_invarg2), arg);
6646 return;
6650 else if (sp == NULL)
6651 EMSG2(_("E155: Unknown sign: %s"), arg);
6652 else if (idx == SIGNCMD_LIST)
6653 /* ":sign list {name}" */
6654 sign_list_defined(sp);
6655 else
6657 /* ":sign undefine {name}" */
6658 vim_free(sp->sn_name);
6659 vim_free(sp->sn_icon);
6660 #ifdef FEAT_SIGN_ICONS
6661 if (sp->sn_image != NULL)
6663 out_flush();
6664 gui_mch_destroy_sign(sp->sn_image);
6666 #endif
6667 vim_free(sp->sn_text);
6668 if (sp_prev == NULL)
6669 first_sign = sp->sn_next;
6670 else
6671 sp_prev->sn_next = sp->sn_next;
6672 vim_free(sp);
6676 else
6678 int id = -1;
6679 linenr_T lnum = -1;
6680 char_u *sign_name = NULL;
6681 char_u *arg1;
6683 if (*arg == NUL)
6685 if (idx == SIGNCMD_PLACE)
6687 /* ":sign place": list placed signs in all buffers */
6688 sign_list_placed(NULL);
6690 else if (idx == SIGNCMD_UNPLACE)
6692 /* ":sign unplace": remove placed sign at cursor */
6693 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6694 if (id > 0)
6696 buf_delsign(curwin->w_buffer, id);
6697 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6699 else
6700 EMSG(_("E159: Missing sign number"));
6702 else
6703 EMSG(_(e_argreq));
6704 return;
6707 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6709 /* ":sign unplace *": remove all placed signs */
6710 buf_delete_all_signs();
6711 return;
6714 /* first arg could be placed sign id */
6715 arg1 = arg;
6716 if (VIM_ISDIGIT(*arg))
6718 id = getdigits(&arg);
6719 if (!vim_iswhite(*arg) && *arg != NUL)
6721 id = -1;
6722 arg = arg1;
6724 else
6726 arg = skipwhite(arg);
6727 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6729 /* ":sign unplace {id}": remove placed sign by number */
6730 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6731 if ((lnum = buf_delsign(buf, id)) != 0)
6732 update_debug_sign(buf, lnum);
6733 return;
6739 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6740 * Leave "arg" pointing to {fname}.
6742 for (;;)
6744 if (STRNCMP(arg, "line=", 5) == 0)
6746 arg += 5;
6747 lnum = atoi((char *)arg);
6748 arg = skiptowhite(arg);
6750 else if (STRNCMP(arg, "name=", 5) == 0)
6752 arg += 5;
6753 sign_name = arg;
6754 arg = skiptowhite(arg);
6755 if (*arg != NUL)
6756 *arg++ = NUL;
6758 else if (STRNCMP(arg, "file=", 5) == 0)
6760 arg += 5;
6761 buf = buflist_findname(arg);
6762 break;
6764 else if (STRNCMP(arg, "buffer=", 7) == 0)
6766 arg += 7;
6767 buf = buflist_findnr((int)getdigits(&arg));
6768 if (*skipwhite(arg) != NUL)
6769 EMSG(_(e_trailing));
6770 break;
6772 else
6774 EMSG(_(e_invarg));
6775 return;
6777 arg = skipwhite(arg);
6780 if (buf == NULL)
6782 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6784 else if (id <= 0)
6786 if (lnum >= 0 || sign_name != NULL)
6787 EMSG(_(e_invarg));
6788 else
6789 /* ":sign place file={fname}": list placed signs in one file */
6790 sign_list_placed(buf);
6792 else if (idx == SIGNCMD_JUMP)
6794 /* ":sign jump {id} file={fname}" */
6795 if (lnum >= 0 || sign_name != NULL)
6796 EMSG(_(e_invarg));
6797 else if ((lnum = buf_findsign(buf, id)) > 0)
6798 { /* goto a sign ... */
6799 if (buf_jump_open_win(buf) != NULL)
6800 { /* ... in a current window */
6801 curwin->w_cursor.lnum = lnum;
6802 check_cursor_lnum();
6803 beginline(BL_WHITE);
6805 else
6806 { /* ... not currently in a window */
6807 char_u *cmd;
6809 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6810 if (cmd == NULL)
6811 return;
6812 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6813 do_cmdline_cmd(cmd);
6814 vim_free(cmd);
6816 #ifdef FEAT_FOLDING
6817 foldOpenCursor();
6818 #endif
6820 else
6821 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6823 else if (idx == SIGNCMD_UNPLACE)
6825 /* ":sign unplace {id} file={fname}" */
6826 if (lnum >= 0 || sign_name != NULL)
6827 EMSG(_(e_invarg));
6828 else
6830 lnum = buf_delsign(buf, id);
6831 update_debug_sign(buf, lnum);
6834 /* idx == SIGNCMD_PLACE */
6835 else if (sign_name != NULL)
6837 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6838 if (STRCMP(sp->sn_name, sign_name) == 0)
6839 break;
6840 if (sp == NULL)
6842 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6843 return;
6845 if (lnum > 0)
6846 /* ":sign place {id} line={lnum} name={name} file={fname}":
6847 * place a sign */
6848 buf_addsign(buf, id, lnum, sp->sn_typenr);
6849 else
6850 /* ":sign place {id} file={fname}": change sign type */
6851 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6852 update_debug_sign(buf, lnum);
6854 else
6855 EMSG(_(e_invarg));
6859 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6861 * Allocate the icons. Called when the GUI has started. Allows defining
6862 * signs before it starts.
6864 void
6865 sign_gui_started()
6867 sign_T *sp;
6869 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6870 if (sp->sn_icon != NULL)
6871 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6873 #endif
6876 * List one sign.
6878 static void
6879 sign_list_defined(sp)
6880 sign_T *sp;
6882 char_u *p;
6884 smsg((char_u *)"sign %s", sp->sn_name);
6885 if (sp->sn_icon != NULL)
6887 MSG_PUTS(" icon=");
6888 msg_outtrans(sp->sn_icon);
6889 #ifdef FEAT_SIGN_ICONS
6890 if (sp->sn_image == NULL)
6891 MSG_PUTS(_(" (NOT FOUND)"));
6892 #else
6893 MSG_PUTS(_(" (not supported)"));
6894 #endif
6896 if (sp->sn_text != NULL)
6898 MSG_PUTS(" text=");
6899 msg_outtrans(sp->sn_text);
6901 if (sp->sn_line_hl > 0)
6903 MSG_PUTS(" linehl=");
6904 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6905 if (p == NULL)
6906 MSG_PUTS("NONE");
6907 else
6908 msg_puts(p);
6910 if (sp->sn_text_hl > 0)
6912 MSG_PUTS(" texthl=");
6913 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6914 if (p == NULL)
6915 MSG_PUTS("NONE");
6916 else
6917 msg_puts(p);
6922 * Get highlighting attribute for sign "typenr".
6923 * If "line" is TRUE: line highl, if FALSE: text highl.
6926 sign_get_attr(typenr, line)
6927 int typenr;
6928 int line;
6930 sign_T *sp;
6932 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6933 if (sp->sn_typenr == typenr)
6935 if (line)
6937 if (sp->sn_line_hl > 0)
6938 return syn_id2attr(sp->sn_line_hl);
6940 else
6942 if (sp->sn_text_hl > 0)
6943 return syn_id2attr(sp->sn_text_hl);
6945 break;
6947 return 0;
6951 * Get text mark for sign "typenr".
6952 * Returns NULL if there isn't one.
6954 char_u *
6955 sign_get_text(typenr)
6956 int typenr;
6958 sign_T *sp;
6960 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6961 if (sp->sn_typenr == typenr)
6962 return sp->sn_text;
6963 return NULL;
6966 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6967 void *
6968 sign_get_image(typenr)
6969 int typenr; /* the attribute which may have a sign */
6971 sign_T *sp;
6973 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6974 if (sp->sn_typenr == typenr)
6975 return sp->sn_image;
6976 return NULL;
6978 #endif
6981 * Get the name of a sign by its typenr.
6983 char_u *
6984 sign_typenr2name(typenr)
6985 int typenr;
6987 sign_T *sp;
6989 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6990 if (sp->sn_typenr == typenr)
6991 return sp->sn_name;
6992 return (char_u *)_("[Deleted]");
6995 #endif
6997 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
6999 * ":drop"
7000 * Opens the first argument in a window. When there are two or more arguments
7001 * the argument list is redefined.
7003 void
7004 ex_drop(eap)
7005 exarg_T *eap;
7007 int split = FALSE;
7008 win_T *wp;
7009 buf_T *buf;
7010 # ifdef FEAT_WINDOWS
7011 tabpage_T *tp;
7012 # endif
7015 * Check if the first argument is already being edited in a window. If
7016 * so, jump to that window.
7017 * We would actually need to check all arguments, but that's complicated
7018 * and mostly only one file is dropped.
7019 * This also ignores wildcards, since it is very unlikely the user is
7020 * editing a file name with a wildcard character.
7022 set_arglist(eap->arg);
7025 * Expanding wildcards may result in an empty argument list. E.g. when
7026 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7027 * already did an error message for this.
7029 if (ARGCOUNT == 0)
7030 return;
7032 # ifdef FEAT_WINDOWS
7033 if (cmdmod.tab)
7035 /* ":tab drop file ...": open a tab for each argument that isn't
7036 * edited in a window yet. It's like ":tab all" but without closing
7037 * windows or tabs. */
7038 ex_all(eap);
7040 else
7041 # endif
7043 /* ":drop file ...": Edit the first argument. Jump to an existing
7044 * window if possible, edit in current window if the current buffer
7045 * can be abandoned, otherwise open a new window. */
7046 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7048 FOR_ALL_TAB_WINDOWS(tp, wp)
7050 if (wp->w_buffer == buf)
7052 # ifdef FEAT_WINDOWS
7053 goto_tabpage_win(tp, wp);
7054 # endif
7055 curwin->w_arg_idx = 0;
7056 return;
7061 * Check whether the current buffer is changed. If so, we will need
7062 * to split the current window or data could be lost.
7063 * Skip the check if the 'hidden' option is set, as in this case the
7064 * buffer won't be lost.
7066 if (!P_HID(curbuf))
7068 # ifdef FEAT_WINDOWS
7069 ++emsg_off;
7070 # endif
7071 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7072 # ifdef FEAT_WINDOWS
7073 --emsg_off;
7074 # else
7075 if (split)
7076 return;
7077 # endif
7080 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7081 if (split)
7083 eap->cmdidx = CMD_sfirst;
7084 eap->cmd[0] = 's';
7086 else
7087 eap->cmdidx = CMD_first;
7088 ex_rewind(eap);
7091 #endif