Changed DiffText and Constant highlight groups
[MacVim/jjgod.git] / src / ex_cmds.c
blob32de576105dd35e2d68fa5c7e5a17f2961e16fc0
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));
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 = st_old.st_ino = 0;
1778 st_old.st_mode = 0600;
1779 if (mch_stat((char *)fname, &st_old) == 0
1780 && getuid() != ROOT_UID
1781 && !(st_old.st_uid == getuid()
1782 ? (st_old.st_mode & 0200)
1783 : (st_old.st_gid == getgid()
1784 ? (st_old.st_mode & 0020)
1785 : (st_old.st_mode & 0002))))
1787 int tt = msg_didany;
1789 /* avoid a wait_return for this message, it's annoying */
1790 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1791 msg_didany = tt;
1792 fclose(fp_in);
1793 goto end;
1795 #endif
1796 #ifdef WIN3264
1797 /* Get the file attributes of the existing viminfo file. */
1798 perm = mch_getperm(fname);
1799 #endif
1802 * Make tempname.
1803 * May try twice: Once normal and once with shortname set, just in
1804 * case somebody puts his viminfo file in an 8.3 filesystem.
1806 for (;;)
1808 tempname = buf_modname(
1809 #ifdef UNIX
1810 shortname,
1811 #else
1812 # ifdef SHORT_FNAME
1813 TRUE,
1814 # else
1815 # ifdef FEAT_GUI_W32
1816 gui_is_win32s(),
1817 # else
1818 FALSE,
1819 # endif
1820 # endif
1821 #endif
1822 fname,
1823 #ifdef VMS
1824 (char_u *)"-tmp",
1825 #else
1826 # ifdef RISCOS
1827 (char_u *)"/tmp",
1828 # else
1829 (char_u *)".tmp",
1830 # endif
1831 #endif
1832 FALSE);
1833 if (tempname == NULL) /* out of memory */
1834 break;
1837 * Check if tempfile already exists. Never overwrite an
1838 * existing file!
1840 if (mch_stat((char *)tempname, &st_new) == 0)
1842 #ifdef UNIX
1844 * Check if tempfile is same as original file. May happen
1845 * when modname() gave the same file back. E.g. silly
1846 * link, or file name-length reached. Try again with
1847 * shortname set.
1849 if (!shortname && st_new.st_dev == st_old.st_dev
1850 && st_new.st_ino == st_old.st_ino)
1852 vim_free(tempname);
1853 tempname = NULL;
1854 shortname = TRUE;
1855 continue;
1857 #endif
1859 * Try another name. Change one character, just before
1860 * the extension. This should also work for an 8.3
1861 * file name, when after adding the extension it still is
1862 * the same file as the original.
1864 wp = tempname + STRLEN(tempname) - 5;
1865 if (wp < gettail(tempname)) /* empty file name? */
1866 wp = gettail(tempname);
1867 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1868 --*wp)
1871 * They all exist? Must be something wrong! Don't
1872 * write the viminfo file then.
1874 if (*wp == 'a')
1876 vim_free(tempname);
1877 tempname = NULL;
1878 break;
1882 break;
1885 if (tempname != NULL)
1887 #ifdef VMS
1888 /* fdopen() fails for some reason */
1889 umask_save = umask(077);
1890 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1891 (void)umask(umask_save);
1892 #else
1893 int fd;
1895 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1896 * protection:
1897 * Unix: same as original file, but strip s-bit. Reset umask to
1898 * avoid it getting in the way.
1899 * Others: r&w for user only. */
1900 # ifdef UNIX
1901 umask_save = umask(0);
1902 fd = mch_open((char *)tempname,
1903 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1904 (int)((st_old.st_mode & 0777) | 0600));
1905 (void)umask(umask_save);
1906 # else
1907 fd = mch_open((char *)tempname,
1908 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1909 # endif
1910 if (fd < 0)
1911 fp_out = NULL;
1912 else
1913 fp_out = fdopen(fd, WRITEBIN);
1914 #endif /* VMS */
1917 * If we can't create in the same directory, try creating a
1918 * "normal" temp file.
1920 if (fp_out == NULL)
1922 vim_free(tempname);
1923 if ((tempname = vim_tempname('o')) != NULL)
1924 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1927 #if defined(UNIX) && defined(HAVE_FCHOWN)
1929 * Make sure the owner can read/write it. This only works for
1930 * root.
1932 if (fp_out != NULL)
1933 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1934 #endif
1939 * Check if the new viminfo file can be written to.
1941 if (fp_out == NULL)
1943 EMSG2(_("E138: Can't write viminfo file %s!"),
1944 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1945 if (fp_in != NULL)
1946 fclose(fp_in);
1947 goto end;
1950 if (p_verbose > 0)
1952 verbose_enter();
1953 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1954 verbose_leave();
1957 viminfo_errcnt = 0;
1958 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1960 fclose(fp_out); /* errors are ignored !? */
1961 if (fp_in != NULL)
1963 fclose(fp_in);
1966 * In case of an error keep the original viminfo file.
1967 * Otherwise rename the newly written file.
1969 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1970 mch_remove(tempname);
1972 #ifdef WIN3264
1973 /* If the viminfo file was hidden then also hide the new file. */
1974 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1975 mch_hide(fname);
1976 #endif
1979 end:
1980 vim_free(fname);
1981 vim_free(tempname);
1985 * Get the viminfo file name to use.
1986 * If "file" is given and not empty, use it (has already been expanded by
1987 * cmdline functions).
1988 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1989 * expand environment variables.
1990 * Returns an allocated string. NULL when out of memory.
1992 static char_u *
1993 viminfo_filename(file)
1994 char_u *file;
1996 if (file == NULL || *file == NUL)
1998 if (use_viminfo != NULL)
1999 file = use_viminfo;
2000 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2002 #ifdef VIMINFO_FILE2
2003 /* don't use $HOME when not defined (turned into "c:/"!). */
2004 # ifdef VMS
2005 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2006 # else
2007 if (mch_getenv((char_u *)"HOME") == NULL)
2008 # endif
2010 /* don't use $VIM when not available. */
2011 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2012 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2013 file = (char_u *)VIMINFO_FILE2;
2014 else
2015 file = (char_u *)VIMINFO_FILE;
2017 else
2018 #endif
2019 file = (char_u *)VIMINFO_FILE;
2021 expand_env(file, NameBuff, MAXPATHL);
2022 file = NameBuff;
2024 return vim_strsave(file);
2028 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2030 static void
2031 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2032 FILE *fp_in;
2033 FILE *fp_out;
2034 int want_info;
2035 int want_marks;
2036 int force_read;
2038 int count = 0;
2039 int eof = FALSE;
2040 vir_T vir;
2042 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2043 return;
2044 vir.vir_fd = fp_in;
2045 #ifdef FEAT_MBYTE
2046 vir.vir_conv.vc_type = CONV_NONE;
2047 #endif
2049 if (fp_in != NULL)
2051 if (want_info)
2052 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2053 else
2054 /* Skip info, find start of marks */
2055 while (!(eof = viminfo_readline(&vir))
2056 && vir.vir_line[0] != '>')
2059 if (fp_out != NULL)
2061 /* Write the info: */
2062 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2063 VIM_VERSION_MEDIUM);
2064 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2065 #ifdef FEAT_MBYTE
2066 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2067 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2068 #endif
2069 write_viminfo_search_pattern(fp_out);
2070 write_viminfo_sub_string(fp_out);
2071 #ifdef FEAT_CMDHIST
2072 write_viminfo_history(fp_out);
2073 #endif
2074 write_viminfo_registers(fp_out);
2075 #ifdef FEAT_EVAL
2076 write_viminfo_varlist(fp_out);
2077 #endif
2078 write_viminfo_filemarks(fp_out);
2079 write_viminfo_bufferlist(fp_out);
2080 count = write_viminfo_marks(fp_out);
2082 if (fp_in != NULL && want_marks)
2083 copy_viminfo_marks(&vir, fp_out, count, eof);
2085 vim_free(vir.vir_line);
2086 #ifdef FEAT_MBYTE
2087 if (vir.vir_conv.vc_type != CONV_NONE)
2088 convert_setup(&vir.vir_conv, NULL, NULL);
2089 #endif
2093 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2094 * first part of the viminfo file which contains everything but the marks that
2095 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2097 static int
2098 read_viminfo_up_to_marks(virp, forceit, writing)
2099 vir_T *virp;
2100 int forceit;
2101 int writing;
2103 int eof;
2104 buf_T *buf;
2106 #ifdef FEAT_CMDHIST
2107 prepare_viminfo_history(forceit ? 9999 : 0);
2108 #endif
2109 eof = viminfo_readline(virp);
2110 while (!eof && virp->vir_line[0] != '>')
2112 switch (virp->vir_line[0])
2114 /* Characters reserved for future expansion, ignored now */
2115 case '+': /* "+40 /path/dir file", for running vim without args */
2116 case '|': /* to be defined */
2117 case '^': /* to be defined */
2118 case '<': /* long line - ignored */
2119 /* A comment or empty line. */
2120 case NUL:
2121 case '\r':
2122 case '\n':
2123 case '#':
2124 eof = viminfo_readline(virp);
2125 break;
2126 case '*': /* "*encoding=value" */
2127 eof = viminfo_encoding(virp);
2128 break;
2129 case '!': /* global variable */
2130 #ifdef FEAT_EVAL
2131 eof = read_viminfo_varlist(virp, writing);
2132 #else
2133 eof = viminfo_readline(virp);
2134 #endif
2135 break;
2136 case '%': /* entry for buffer list */
2137 eof = read_viminfo_bufferlist(virp, writing);
2138 break;
2139 case '"':
2140 eof = read_viminfo_register(virp, forceit);
2141 break;
2142 case '/': /* Search string */
2143 case '&': /* Substitute search string */
2144 case '~': /* Last search string, followed by '/' or '&' */
2145 eof = read_viminfo_search_pattern(virp, forceit);
2146 break;
2147 case '$':
2148 eof = read_viminfo_sub_string(virp, forceit);
2149 break;
2150 case ':':
2151 case '?':
2152 case '=':
2153 case '@':
2154 #ifdef FEAT_CMDHIST
2155 eof = read_viminfo_history(virp);
2156 #else
2157 eof = viminfo_readline(virp);
2158 #endif
2159 break;
2160 case '-':
2161 case '\'':
2162 eof = read_viminfo_filemark(virp, forceit);
2163 break;
2164 default:
2165 if (viminfo_error("E575: ", _("Illegal starting char"),
2166 virp->vir_line))
2167 eof = TRUE;
2168 else
2169 eof = viminfo_readline(virp);
2170 break;
2174 #ifdef FEAT_CMDHIST
2175 /* Finish reading history items. */
2176 finish_viminfo_history();
2177 #endif
2179 /* Change file names to buffer numbers for fmarks. */
2180 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2181 fmarks_check_names(buf);
2183 return eof;
2187 * Compare the 'encoding' value in the viminfo file with the current value of
2188 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2189 * conversion of text with iconv() in viminfo_readstring().
2191 static int
2192 viminfo_encoding(virp)
2193 vir_T *virp;
2195 #ifdef FEAT_MBYTE
2196 char_u *p;
2197 int i;
2199 if (get_viminfo_parameter('c') != 0)
2201 p = vim_strchr(virp->vir_line, '=');
2202 if (p != NULL)
2204 /* remove trailing newline */
2205 ++p;
2206 for (i = 0; vim_isprintc(p[i]); ++i)
2208 p[i] = NUL;
2210 convert_setup(&virp->vir_conv, p, p_enc);
2213 #endif
2214 return viminfo_readline(virp);
2218 * Read a line from the viminfo file.
2219 * Returns TRUE for end-of-file;
2222 viminfo_readline(virp)
2223 vir_T *virp;
2225 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2229 * check string read from viminfo file
2230 * remove '\n' at the end of the line
2231 * - replace CTRL-V CTRL-V with CTRL-V
2232 * - replace CTRL-V 'n' with '\n'
2234 * Check for a long line as written by viminfo_writestring().
2236 * Return the string in allocated memory (NULL when out of memory).
2238 /*ARGSUSED*/
2239 char_u *
2240 viminfo_readstring(virp, off, convert)
2241 vir_T *virp;
2242 int off; /* offset for virp->vir_line */
2243 int convert; /* convert the string */
2245 char_u *retval;
2246 char_u *s, *d;
2247 long len;
2249 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2251 len = atol((char *)virp->vir_line + off + 1);
2252 retval = lalloc(len, TRUE);
2253 if (retval == NULL)
2255 /* Line too long? File messed up? Skip next line. */
2256 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2257 return NULL;
2259 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2260 s = retval + 1; /* Skip the leading '<' */
2262 else
2264 retval = vim_strsave(virp->vir_line + off);
2265 if (retval == NULL)
2266 return NULL;
2267 s = retval;
2270 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2271 d = retval;
2272 while (*s != NUL && *s != '\n')
2274 if (s[0] == Ctrl_V && s[1] != NUL)
2276 if (s[1] == 'n')
2277 *d++ = '\n';
2278 else
2279 *d++ = Ctrl_V;
2280 s += 2;
2282 else
2283 *d++ = *s++;
2285 *d = NUL;
2287 #ifdef FEAT_MBYTE
2288 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2290 d = string_convert(&virp->vir_conv, retval, NULL);
2291 if (d != NULL)
2293 vim_free(retval);
2294 retval = d;
2297 #endif
2299 return retval;
2303 * write string to viminfo file
2304 * - replace CTRL-V with CTRL-V CTRL-V
2305 * - replace '\n' with CTRL-V 'n'
2306 * - add a '\n' at the end
2308 * For a long line:
2309 * - write " CTRL-V <length> \n " in first line
2310 * - write " < <string> \n " in second line
2312 void
2313 viminfo_writestring(fd, p)
2314 FILE *fd;
2315 char_u *p;
2317 int c;
2318 char_u *s;
2319 int len = 0;
2321 for (s = p; *s != NUL; ++s)
2323 if (*s == Ctrl_V || *s == '\n')
2324 ++len;
2325 ++len;
2328 /* If the string will be too long, write its length and put it in the next
2329 * line. Take into account that some room is needed for what comes before
2330 * the string (e.g., variable name). Add something to the length for the
2331 * '<', NL and trailing NUL. */
2332 if (len > LSIZE / 2)
2333 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2335 while ((c = *p++) != NUL)
2337 if (c == Ctrl_V || c == '\n')
2339 putc(Ctrl_V, fd);
2340 if (c == '\n')
2341 c = 'n';
2343 putc(c, fd);
2345 putc('\n', fd);
2347 #endif /* FEAT_VIMINFO */
2350 * Implementation of ":fixdel", also used by get_stty().
2351 * <BS> resulting <Del>
2352 * ^? ^H
2353 * not ^? ^?
2355 /*ARGSUSED*/
2356 void
2357 do_fixdel(eap)
2358 exarg_T *eap;
2360 char_u *p;
2362 p = find_termcode((char_u *)"kb");
2363 add_termcode((char_u *)"kD", p != NULL
2364 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2367 void
2368 print_line_no_prefix(lnum, use_number, list)
2369 linenr_T lnum;
2370 int use_number;
2371 int list;
2373 char_u numbuf[30];
2375 if (curwin->w_p_nu || use_number)
2377 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2378 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2380 msg_prt_line(ml_get(lnum), list);
2384 * Print a text line. Also in silent mode ("ex -s").
2386 void
2387 print_line(lnum, use_number, list)
2388 linenr_T lnum;
2389 int use_number;
2390 int list;
2392 int save_silent = silent_mode;
2394 msg_start();
2395 silent_mode = FALSE;
2396 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2397 print_line_no_prefix(lnum, use_number, list);
2398 if (save_silent)
2400 msg_putchar('\n');
2401 cursor_on(); /* msg_start() switches it off */
2402 out_flush();
2403 silent_mode = save_silent;
2404 info_message = FALSE;
2409 * ":file[!] [fname]".
2411 void
2412 ex_file(eap)
2413 exarg_T *eap;
2415 char_u *fname, *sfname, *xfname;
2416 buf_T *buf;
2418 /* ":0file" removes the file name. Check for illegal uses ":3file",
2419 * "0file name", etc. */
2420 if (eap->addr_count > 0
2421 && (*eap->arg != NUL
2422 || eap->line2 > 0
2423 || eap->addr_count > 1))
2425 EMSG(_(e_invarg));
2426 return;
2429 if (*eap->arg != NUL || eap->addr_count == 1)
2431 #ifdef FEAT_AUTOCMD
2432 buf = curbuf;
2433 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2434 /* buffer changed, don't change name now */
2435 if (buf != curbuf)
2436 return;
2437 # ifdef FEAT_EVAL
2438 if (aborting()) /* autocmds may abort script processing */
2439 return;
2440 # endif
2441 #endif
2443 * The name of the current buffer will be changed.
2444 * A new (unlisted) buffer entry needs to be made to hold the old file
2445 * name, which will become the alternate file name.
2446 * But don't set the alternate file name if the buffer didn't have a
2447 * name.
2449 fname = curbuf->b_ffname;
2450 sfname = curbuf->b_sfname;
2451 xfname = curbuf->b_fname;
2452 curbuf->b_ffname = NULL;
2453 curbuf->b_sfname = NULL;
2454 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2456 curbuf->b_ffname = fname;
2457 curbuf->b_sfname = sfname;
2458 return;
2460 curbuf->b_flags |= BF_NOTEDITED;
2461 if (xfname != NULL && *xfname != NUL)
2463 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2464 if (buf != NULL && !cmdmod.keepalt)
2465 curwin->w_alt_fnum = buf->b_fnum;
2467 vim_free(fname);
2468 vim_free(sfname);
2469 #ifdef FEAT_AUTOCMD
2470 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2471 #endif
2472 /* Change directories when the 'acd' option is set. */
2473 DO_AUTOCHDIR
2475 /* print full file name if :cd used */
2476 fileinfo(FALSE, FALSE, eap->forceit);
2480 * ":update".
2482 void
2483 ex_update(eap)
2484 exarg_T *eap;
2486 if (curbufIsChanged())
2487 (void)do_write(eap);
2491 * ":write" and ":saveas".
2493 void
2494 ex_write(eap)
2495 exarg_T *eap;
2497 if (eap->usefilter) /* input lines to shell command */
2498 do_bang(1, eap, FALSE, TRUE, FALSE);
2499 else
2500 (void)do_write(eap);
2504 * write current buffer to file 'eap->arg'
2505 * if 'eap->append' is TRUE, append to the file
2507 * if *eap->arg == NUL write to current file
2509 * return FAIL for failure, OK otherwise
2512 do_write(eap)
2513 exarg_T *eap;
2515 int other;
2516 char_u *fname = NULL; /* init to shut up gcc */
2517 char_u *ffname;
2518 int retval = FAIL;
2519 char_u *free_fname = NULL;
2520 #ifdef FEAT_BROWSE
2521 char_u *browse_file = NULL;
2522 #endif
2523 buf_T *alt_buf = NULL;
2525 if (not_writing()) /* check 'write' option */
2526 return FAIL;
2528 ffname = eap->arg;
2529 #ifdef FEAT_BROWSE
2530 if (cmdmod.browse)
2532 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2533 NULL, NULL, NULL, curbuf);
2534 if (browse_file == NULL)
2535 goto theend;
2536 ffname = browse_file;
2538 #endif
2539 if (*ffname == NUL)
2541 if (eap->cmdidx == CMD_saveas)
2543 EMSG(_(e_argreq));
2544 goto theend;
2546 other = FALSE;
2548 else
2550 fname = ffname;
2551 free_fname = fix_fname(ffname);
2553 * When out-of-memory, keep unexpanded file name, because we MUST be
2554 * able to write the file in this situation.
2556 if (free_fname != NULL)
2557 ffname = free_fname;
2558 other = otherfile(ffname);
2562 * If we have a new file, put its name in the list of alternate file names.
2564 if (other)
2566 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2567 || eap->cmdidx == CMD_saveas)
2568 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2569 else
2570 alt_buf = buflist_findname(ffname);
2571 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2573 /* Overwriting a file that is loaded in another buffer is not a
2574 * good idea. */
2575 EMSG(_(e_bufloaded));
2576 goto theend;
2581 * Writing to the current file is not allowed in readonly mode
2582 * and a file name is required.
2583 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2585 if (!other && (
2586 #ifdef FEAT_QUICKFIX
2587 bt_dontwrite_msg(curbuf) ||
2588 #endif
2589 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2590 goto theend;
2592 if (!other)
2594 ffname = curbuf->b_ffname;
2595 fname = curbuf->b_fname;
2597 * Not writing the whole file is only allowed with '!'.
2599 if ( (eap->line1 != 1
2600 || eap->line2 != curbuf->b_ml.ml_line_count)
2601 && !eap->forceit
2602 && !eap->append
2603 && !p_wa)
2605 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2606 if (p_confirm || cmdmod.confirm)
2608 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2609 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2610 goto theend;
2611 eap->forceit = TRUE;
2613 else
2614 #endif
2616 EMSG(_("E140: Use ! to write partial buffer"));
2617 goto theend;
2622 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2624 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2626 #ifdef FEAT_AUTOCMD
2627 buf_T *was_curbuf = curbuf;
2629 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2630 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2631 # ifdef FEAT_EVAL
2632 if (curbuf != was_curbuf || aborting())
2633 # else
2634 if (curbuf != was_curbuf)
2635 # endif
2637 /* buffer changed, don't change name now */
2638 retval = FAIL;
2639 goto theend;
2641 #endif
2642 /* Exchange the file names for the current and the alternate
2643 * buffer. This makes it look like we are now editing the buffer
2644 * under the new name. Must be done before buf_write(), because
2645 * if there is no file name and 'cpo' contains 'F', it will set
2646 * the file name. */
2647 fname = alt_buf->b_fname;
2648 alt_buf->b_fname = curbuf->b_fname;
2649 curbuf->b_fname = fname;
2650 fname = alt_buf->b_ffname;
2651 alt_buf->b_ffname = curbuf->b_ffname;
2652 curbuf->b_ffname = fname;
2653 fname = alt_buf->b_sfname;
2654 alt_buf->b_sfname = curbuf->b_sfname;
2655 curbuf->b_sfname = fname;
2656 buf_name_changed(curbuf);
2657 #ifdef FEAT_AUTOCMD
2658 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2659 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2660 if (!alt_buf->b_p_bl)
2662 alt_buf->b_p_bl = TRUE;
2663 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2665 # ifdef FEAT_EVAL
2666 if (curbuf != was_curbuf || aborting())
2667 # else
2668 if (curbuf != was_curbuf)
2669 # endif
2671 /* buffer changed, don't write the file */
2672 retval = FAIL;
2673 goto theend;
2676 /* If 'filetype' was empty try detecting it now. */
2677 if (*curbuf->b_p_ft == NUL)
2679 if (au_has_group((char_u *)"filetypedetect"))
2680 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2681 TRUE);
2682 do_modelines(0);
2684 #endif
2687 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2688 eap, eap->append, eap->forceit, TRUE, FALSE);
2690 /* After ":saveas fname" reset 'readonly'. */
2691 if (eap->cmdidx == CMD_saveas)
2693 if (retval == OK)
2694 curbuf->b_p_ro = FALSE;
2695 /* Change directories when the 'acd' option is set. */
2696 DO_AUTOCHDIR
2700 theend:
2701 #ifdef FEAT_BROWSE
2702 vim_free(browse_file);
2703 #endif
2704 vim_free(free_fname);
2705 return retval;
2709 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2710 * BF_NEW or BF_READERR, check for overwriting current file.
2711 * May set eap->forceit if a dialog says it's OK to overwrite.
2712 * Return OK if it's OK, FAIL if it is not.
2714 /*ARGSUSED*/
2715 static int
2716 check_overwrite(eap, buf, fname, ffname, other)
2717 exarg_T *eap;
2718 buf_T *buf;
2719 char_u *fname; /* file name to be used (can differ from
2720 buf->ffname) */
2721 char_u *ffname; /* full path version of fname */
2722 int other; /* writing under other name */
2725 * write to other file or b_flags set or not writing the whole file:
2726 * overwriting only allowed with '!'
2728 if ( (other
2729 || (buf->b_flags & BF_NOTEDITED)
2730 || ((buf->b_flags & BF_NEW)
2731 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2732 || (buf->b_flags & BF_READERR))
2733 && !p_wa
2734 && vim_fexists(ffname))
2736 if (!eap->forceit && !eap->append)
2738 #ifdef UNIX
2739 /* with UNIX it is possible to open a directory */
2740 if (mch_isdir(ffname))
2742 EMSG2(_(e_isadir2), ffname);
2743 return FAIL;
2745 #endif
2746 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2747 if (p_confirm || cmdmod.confirm)
2749 char_u buff[IOSIZE];
2751 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2752 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2753 return FAIL;
2754 eap->forceit = TRUE;
2756 else
2757 #endif
2759 EMSG(_(e_exists));
2760 return FAIL;
2764 /* For ":w! filename" check that no swap file exists for "filename". */
2765 if (other && !emsg_silent)
2767 char_u dir[MAXPATHL];
2768 char_u *p;
2769 int r;
2770 char_u *swapname;
2772 /* We only try the first entry in 'directory', without checking if
2773 * it's writable. If the "." directory is not writable the write
2774 * will probably fail anyway.
2775 * Use 'shortname' of the current buffer, since there is no buffer
2776 * for the written file. */
2777 if (*p_dir == NUL)
2778 STRCPY(dir, ".");
2779 else
2781 p = p_dir;
2782 copy_option_part(&p, dir, MAXPATHL, ",");
2784 swapname = makeswapname(fname, ffname, curbuf, dir);
2785 r = vim_fexists(swapname);
2786 if (r)
2788 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2789 if (p_confirm || cmdmod.confirm)
2791 char_u buff[IOSIZE];
2793 dialog_msg(buff,
2794 _("Swap file \"%s\" exists, overwrite anyway?"),
2795 swapname);
2796 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2797 != VIM_YES)
2799 vim_free(swapname);
2800 return FAIL;
2802 eap->forceit = TRUE;
2804 else
2805 #endif
2807 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2808 swapname);
2809 vim_free(swapname);
2810 return FAIL;
2813 vim_free(swapname);
2816 return OK;
2820 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2822 void
2823 ex_wnext(eap)
2824 exarg_T *eap;
2826 int i;
2828 if (eap->cmd[1] == 'n')
2829 i = curwin->w_arg_idx + (int)eap->line2;
2830 else
2831 i = curwin->w_arg_idx - (int)eap->line2;
2832 eap->line1 = 1;
2833 eap->line2 = curbuf->b_ml.ml_line_count;
2834 if (do_write(eap) != FAIL)
2835 do_argfile(eap, i);
2839 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2841 void
2842 do_wqall(eap)
2843 exarg_T *eap;
2845 buf_T *buf;
2846 int error = 0;
2847 int save_forceit = eap->forceit;
2849 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2850 exiting = TRUE;
2852 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2854 if (bufIsChanged(buf))
2857 * Check if there is a reason the buffer cannot be written:
2858 * 1. if the 'write' option is set
2859 * 2. if there is no file name (even after browsing)
2860 * 3. if the 'readonly' is set (even after a dialog)
2861 * 4. if overwriting is allowed (even after a dialog)
2863 if (not_writing())
2865 ++error;
2866 break;
2868 #ifdef FEAT_BROWSE
2869 /* ":browse wall": ask for file name if there isn't one */
2870 if (buf->b_ffname == NULL && cmdmod.browse)
2871 browse_save_fname(buf);
2872 #endif
2873 if (buf->b_ffname == NULL)
2875 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2876 ++error;
2878 else if (check_readonly(&eap->forceit, buf)
2879 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2880 FALSE) == FAIL)
2882 ++error;
2884 else
2886 if (buf_write_all(buf, eap->forceit) == FAIL)
2887 ++error;
2888 #ifdef FEAT_AUTOCMD
2889 /* an autocommand may have deleted the buffer */
2890 if (!buf_valid(buf))
2891 buf = firstbuf;
2892 #endif
2894 eap->forceit = save_forceit; /* check_overwrite() may set it */
2897 if (exiting)
2899 if (!error)
2900 getout(0); /* exit Vim */
2901 not_exiting();
2906 * Check the 'write' option.
2907 * Return TRUE and give a message when it's not st.
2910 not_writing()
2912 if (p_write)
2913 return FALSE;
2914 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2915 return TRUE;
2919 * Check if a buffer is read-only (either 'readonly' option is set or file is
2920 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2921 * message when the buffer is readonly.
2923 static int
2924 check_readonly(forceit, buf)
2925 int *forceit;
2926 buf_T *buf;
2928 struct stat st;
2930 /* Handle a file being readonly when the 'readonly' option is set or when
2931 * the file exists and permissions are read-only.
2932 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2933 * important for device checks but not here. */
2934 if (!*forceit && (buf->b_p_ro
2935 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2936 && check_file_readonly(buf->b_ffname, 0777))))
2938 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2939 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2941 char_u buff[IOSIZE];
2943 if (buf->b_p_ro)
2944 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2945 buf->b_fname);
2946 else
2947 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2948 buf->b_fname);
2950 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2952 /* Set forceit, to force the writing of a readonly file */
2953 *forceit = TRUE;
2954 return FALSE;
2956 else
2957 return TRUE;
2959 else
2960 #endif
2961 if (buf->b_p_ro)
2962 EMSG(_(e_readonly));
2963 else
2964 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2965 buf->b_fname);
2966 return TRUE;
2969 return FALSE;
2973 * Try to abandon current file and edit a new or existing file.
2974 * 'fnum' is the number of the file, if zero use ffname/sfname.
2976 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2977 * -1 for successfully opening another file.
2978 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2981 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2982 int fnum;
2983 char_u *ffname;
2984 char_u *sfname;
2985 int setpm;
2986 linenr_T lnum;
2987 int forceit;
2989 int other;
2990 int retval;
2991 char_u *free_me = NULL;
2993 if (text_locked())
2994 return 1;
2995 #ifdef FEAT_AUTOCMD
2996 if (curbuf_locked())
2997 return 1;
2998 #endif
3000 if (fnum == 0)
3002 /* make ffname full path, set sfname */
3003 fname_expand(curbuf, &ffname, &sfname);
3004 other = otherfile(ffname);
3005 free_me = ffname; /* has been allocated, free() later */
3007 else
3008 other = (fnum != curbuf->b_fnum);
3010 if (other)
3011 ++no_wait_return; /* don't wait for autowrite message */
3012 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3013 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3015 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3016 if (p_confirm && p_write)
3017 dialog_changed(curbuf, FALSE);
3018 if (curbufIsChanged())
3019 #endif
3021 if (other)
3022 --no_wait_return;
3023 EMSG(_(e_nowrtmsg));
3024 retval = 2; /* file has been changed */
3025 goto theend;
3028 if (other)
3029 --no_wait_return;
3030 if (setpm)
3031 setpcmark();
3032 if (!other)
3034 if (lnum != 0)
3035 curwin->w_cursor.lnum = lnum;
3036 check_cursor_lnum();
3037 beginline(BL_SOL | BL_FIX);
3038 retval = 0; /* it's in the same file */
3040 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3041 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3042 retval = -1; /* opened another file */
3043 else
3044 retval = 1; /* error encountered */
3046 theend:
3047 vim_free(free_me);
3048 return retval;
3052 * start editing a new file
3054 * fnum: file number; if zero use ffname/sfname
3055 * ffname: the file name
3056 * - full path if sfname used,
3057 * - any file name if sfname is NULL
3058 * - empty string to re-edit with the same file name (but may be
3059 * in a different directory)
3060 * - NULL to start an empty buffer
3061 * sfname: the short file name (or NULL)
3062 * eap: contains the command to be executed after loading the file and
3063 * forced 'ff' and 'fenc'
3064 * newlnum: if > 0: put cursor on this line number (if possible)
3065 * if ECMD_LASTL: use last position in loaded file
3066 * if ECMD_LAST: use last position in all files
3067 * if ECMD_ONE: use first line
3068 * flags:
3069 * ECMD_HIDE: if TRUE don't free the current buffer
3070 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3071 * ECMD_OLDBUF: use existing buffer if it exists
3072 * ECMD_FORCEIT: ! used for Ex command
3073 * ECMD_ADDBUF: don't edit, just add to buffer list
3075 * return FAIL for failure, OK otherwise
3078 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3079 int fnum;
3080 char_u *ffname;
3081 char_u *sfname;
3082 exarg_T *eap; /* can be NULL! */
3083 linenr_T newlnum;
3084 int flags;
3086 int other_file; /* TRUE if editing another file */
3087 int oldbuf; /* TRUE if using existing buffer */
3088 #ifdef FEAT_AUTOCMD
3089 int auto_buf = FALSE; /* TRUE if autocommands brought us
3090 into the buffer unexpectedly */
3091 char_u *new_name = NULL;
3092 int did_set_swapcommand = FALSE;
3093 #endif
3094 buf_T *buf;
3095 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3096 buf_T *old_curbuf = curbuf;
3097 #endif
3098 char_u *free_fname = NULL;
3099 #ifdef FEAT_BROWSE
3100 char_u *browse_file = NULL;
3101 #endif
3102 int retval = FAIL;
3103 long n;
3104 linenr_T lnum;
3105 linenr_T topline = 0;
3106 int newcol = -1;
3107 int solcol = -1;
3108 pos_T *pos;
3109 #ifdef FEAT_SUN_WORKSHOP
3110 char_u *cp;
3111 #endif
3112 char_u *command = NULL;
3113 #ifdef FEAT_SPELL
3114 int did_get_winopts = FALSE;
3115 #endif
3117 if (eap != NULL)
3118 command = eap->do_ecmd_cmd;
3120 if (fnum != 0)
3122 if (fnum == curbuf->b_fnum) /* file is already being edited */
3123 return OK; /* nothing to do */
3124 other_file = TRUE;
3126 else
3128 #ifdef FEAT_BROWSE
3129 if (cmdmod.browse)
3131 if (
3132 # ifdef FEAT_GUI
3133 !gui.in_use &&
3134 # endif
3135 au_has_group((char_u *)"FileExplorer"))
3137 /* No browsing supported but we do have the file explorer:
3138 * Edit the directory. */
3139 if (ffname == NULL || !mch_isdir(ffname))
3140 ffname = (char_u *)".";
3142 else
3144 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3145 NULL, NULL, NULL, curbuf);
3146 if (browse_file == NULL)
3147 goto theend;
3148 ffname = browse_file;
3151 #endif
3152 /* if no short name given, use ffname for short name */
3153 if (sfname == NULL)
3154 sfname = ffname;
3155 #ifdef USE_FNAME_CASE
3156 # ifdef USE_LONG_FNAME
3157 if (USE_LONG_FNAME)
3158 # endif
3159 if (sfname != NULL)
3160 fname_case(sfname, 0); /* set correct case for sfname */
3161 #endif
3163 #ifdef FEAT_LISTCMDS
3164 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3165 goto theend;
3166 #endif
3168 if (ffname == NULL)
3169 other_file = TRUE;
3170 /* there is no file name */
3171 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3172 other_file = FALSE;
3173 else
3175 if (*ffname == NUL) /* re-edit with same file name */
3177 ffname = curbuf->b_ffname;
3178 sfname = curbuf->b_fname;
3180 free_fname = fix_fname(ffname); /* may expand to full path name */
3181 if (free_fname != NULL)
3182 ffname = free_fname;
3183 other_file = otherfile(ffname);
3184 #ifdef FEAT_SUN_WORKSHOP
3185 if (usingSunWorkShop && p_acd
3186 && (cp = vim_strrchr(sfname, '/')) != NULL)
3187 sfname = ++cp;
3188 #endif
3193 * if the file was changed we may not be allowed to abandon it
3194 * - if we are going to re-edit the same file
3195 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3197 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3198 || (curbuf->b_nwindows == 1
3199 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3200 && check_changed(curbuf, p_awa, !other_file,
3201 (flags & ECMD_FORCEIT), FALSE))
3203 if (fnum == 0 && other_file && ffname != NULL)
3204 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3205 goto theend;
3208 #ifdef FEAT_VISUAL
3210 * End Visual mode before switching to another buffer, so the text can be
3211 * copied into the GUI selection buffer.
3213 reset_VIsual();
3214 #endif
3216 #ifdef FEAT_AUTOCMD
3217 if ((command != NULL || newlnum > (linenr_T)0)
3218 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3220 int len;
3221 char_u *p;
3223 /* Set v:swapcommand for the SwapExists autocommands. */
3224 if (command != NULL)
3225 len = (int)STRLEN(command) + 3;
3226 else
3227 len = 30;
3228 p = alloc((unsigned)len);
3229 if (p != NULL)
3231 if (command != NULL)
3232 vim_snprintf((char *)p, len, ":%s\r", command);
3233 else
3234 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3235 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3236 did_set_swapcommand = TRUE;
3237 vim_free(p);
3240 #endif
3243 * If we are starting to edit another file, open a (new) buffer.
3244 * Otherwise we re-use the current buffer.
3246 if (other_file)
3248 #ifdef FEAT_LISTCMDS
3249 if (!(flags & ECMD_ADDBUF))
3250 #endif
3252 if (!cmdmod.keepalt)
3253 curwin->w_alt_fnum = curbuf->b_fnum;
3254 buflist_altfpos();
3257 if (fnum)
3258 buf = buflist_findnr(fnum);
3259 else
3261 #ifdef FEAT_LISTCMDS
3262 if (flags & ECMD_ADDBUF)
3264 linenr_T tlnum = 1L;
3266 if (command != NULL)
3268 tlnum = atol((char *)command);
3269 if (tlnum <= 0)
3270 tlnum = 1L;
3272 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3273 goto theend;
3275 #endif
3276 buf = buflist_new(ffname, sfname, 0L,
3277 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3279 if (buf == NULL)
3280 goto theend;
3281 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3283 oldbuf = FALSE;
3284 buf->b_nwindows = 0;
3286 else /* existing memfile */
3288 oldbuf = TRUE;
3289 (void)buf_check_timestamp(buf, FALSE);
3290 /* Check if autocommands made buffer invalid or changed the current
3291 * buffer. */
3292 if (!buf_valid(buf)
3293 #ifdef FEAT_AUTOCMD
3294 || curbuf != old_curbuf
3295 #endif
3297 goto theend;
3298 #ifdef FEAT_EVAL
3299 if (aborting()) /* autocmds may abort script processing */
3300 goto theend;
3301 #endif
3304 /* May jump to last used line number for a loaded buffer or when asked
3305 * for explicitly */
3306 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3308 pos = buflist_findfpos(buf);
3309 newlnum = pos->lnum;
3310 solcol = pos->col;
3314 * Make the (new) buffer the one used by the current window.
3315 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3316 * If the current buffer was empty and has no file name, curbuf
3317 * is returned by buflist_new().
3319 if (buf != curbuf)
3321 #ifdef FEAT_AUTOCMD
3323 * Be careful: The autocommands may delete any buffer and change
3324 * the current buffer.
3325 * - If the buffer we are going to edit is deleted, give up.
3326 * - If the current buffer is deleted, prefer to load the new
3327 * buffer when loading a buffer is required. This avoids
3328 * loading another buffer which then must be closed again.
3329 * - If we ended up in the new buffer already, need to skip a few
3330 * things, set auto_buf.
3332 if (buf->b_fname != NULL)
3333 new_name = vim_strsave(buf->b_fname);
3334 au_new_curbuf = buf;
3335 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3336 if (!buf_valid(buf)) /* new buffer has been deleted */
3338 delbuf_msg(new_name); /* frees new_name */
3339 goto theend;
3341 # ifdef FEAT_EVAL
3342 if (aborting()) /* autocmds may abort script processing */
3344 vim_free(new_name);
3345 goto theend;
3347 # endif
3348 if (buf == curbuf) /* already in new buffer */
3349 auto_buf = TRUE;
3350 else
3352 if (curbuf == old_curbuf)
3353 #endif
3354 buf_copy_options(buf, BCO_ENTER);
3356 /* close the link to the current buffer */
3357 u_sync(FALSE);
3358 close_buffer(curwin, curbuf,
3359 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3361 #ifdef FEAT_AUTOCMD
3362 # ifdef FEAT_EVAL
3363 if (aborting()) /* autocmds may abort script processing */
3365 vim_free(new_name);
3366 goto theend;
3368 # endif
3369 /* Be careful again, like above. */
3370 if (!buf_valid(buf)) /* new buffer has been deleted */
3372 delbuf_msg(new_name); /* frees new_name */
3373 goto theend;
3375 if (buf == curbuf) /* already in new buffer */
3376 auto_buf = TRUE;
3377 else
3378 #endif
3380 curwin->w_buffer = buf;
3381 curbuf = buf;
3382 ++curbuf->b_nwindows;
3383 /* set 'fileformat' */
3384 if (*p_ffs && !oldbuf)
3385 set_fileformat(default_fileformat(), OPT_LOCAL);
3388 /* May get the window options from the last time this buffer
3389 * was in this window (or another window). If not used
3390 * before, reset the local window options to the global
3391 * values. Also restores old folding stuff. */
3392 get_winopts(curbuf);
3393 #ifdef FEAT_SPELL
3394 did_get_winopts = TRUE;
3395 #endif
3397 #ifdef FEAT_AUTOCMD
3399 vim_free(new_name);
3400 au_new_curbuf = NULL;
3401 #endif
3403 else
3404 ++curbuf->b_nwindows;
3406 curwin->w_pcmark.lnum = 1;
3407 curwin->w_pcmark.col = 0;
3409 else /* !other_file */
3411 if (
3412 #ifdef FEAT_LISTCMDS
3413 (flags & ECMD_ADDBUF) ||
3414 #endif
3415 check_fname() == FAIL)
3416 goto theend;
3417 oldbuf = (flags & ECMD_OLDBUF);
3420 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3422 char_u *p;
3424 curbuf->b_help = TRUE;
3425 #ifdef FEAT_QUICKFIX
3426 set_string_option_direct((char_u *)"buftype", -1,
3427 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3428 #endif
3431 * Always set these options after jumping to a help tag, because the
3432 * user may have an autocommand that gets in the way.
3433 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3434 * latin1 word characters (for translated help files).
3435 * Only set it when needed, buf_init_chartab() is some work.
3438 #ifdef EBCDIC
3439 (char_u *)"65-255,^*,^|,^\"";
3440 #else
3441 (char_u *)"!-~,^*,^|,^\",192-255";
3442 #endif
3443 if (STRCMP(curbuf->b_p_isk, p) != 0)
3445 set_string_option_direct((char_u *)"isk", -1, p,
3446 OPT_FREE|OPT_LOCAL, 0);
3447 check_buf_options(curbuf);
3448 (void)buf_init_chartab(curbuf, FALSE);
3451 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3452 curwin->w_p_list = FALSE; /* no list mode */
3454 curbuf->b_p_ma = FALSE; /* not modifiable */
3455 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3456 curwin->w_p_nu = 0; /* no line numbers */
3457 #ifdef FEAT_SCROLLBIND
3458 curwin->w_p_scb = FALSE; /* no scroll binding */
3459 #endif
3460 #ifdef FEAT_ARABIC
3461 curwin->w_p_arab = FALSE; /* no arabic mode */
3462 #endif
3463 #ifdef FEAT_RIGHTLEFT
3464 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3465 #endif
3466 #ifdef FEAT_FOLDING
3467 curwin->w_p_fen = FALSE; /* No folding in the help window */
3468 #endif
3469 #ifdef FEAT_DIFF
3470 curwin->w_p_diff = FALSE; /* No 'diff' */
3471 #endif
3472 #ifdef FEAT_SPELL
3473 curwin->w_p_spell = FALSE; /* No spell checking */
3474 #endif
3476 #ifdef FEAT_AUTOCMD
3477 buf = curbuf;
3478 #endif
3479 set_buflisted(FALSE);
3481 else
3483 #ifdef FEAT_AUTOCMD
3484 buf = curbuf;
3485 #endif
3486 /* Don't make a buffer listed if it's a help buffer. Useful when
3487 * using CTRL-O to go back to a help file. */
3488 if (!curbuf->b_help)
3489 set_buflisted(TRUE);
3492 #ifdef FEAT_AUTOCMD
3493 /* If autocommands change buffers under our fingers, forget about
3494 * editing the file. */
3495 if (buf != curbuf)
3496 goto theend;
3497 # ifdef FEAT_EVAL
3498 if (aborting()) /* autocmds may abort script processing */
3499 goto theend;
3500 # endif
3502 /* Since we are starting to edit a file, consider the filetype to be
3503 * unset. Helps for when an autocommand changes files and expects syntax
3504 * highlighting to work in the other file. */
3505 did_filetype = FALSE;
3506 #endif
3509 * other_file oldbuf
3510 * FALSE FALSE re-edit same file, buffer is re-used
3511 * FALSE TRUE re-edit same file, nothing changes
3512 * TRUE FALSE start editing new file, new buffer
3513 * TRUE TRUE start editing in existing buffer (nothing to do)
3515 if (!other_file && !oldbuf) /* re-use the buffer */
3517 set_last_cursor(curwin); /* may set b_last_cursor */
3518 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3520 newlnum = curwin->w_cursor.lnum;
3521 solcol = curwin->w_cursor.col;
3523 #ifdef FEAT_AUTOCMD
3524 buf = curbuf;
3525 if (buf->b_fname != NULL)
3526 new_name = vim_strsave(buf->b_fname);
3527 else
3528 new_name = NULL;
3529 #endif
3530 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3531 #ifdef FEAT_AUTOCMD
3532 /* If autocommands deleted the buffer we were going to re-edit, give
3533 * up and jump to the end. */
3534 if (!buf_valid(buf))
3536 delbuf_msg(new_name); /* frees new_name */
3537 goto theend;
3539 vim_free(new_name);
3541 /* If autocommands change buffers under our fingers, forget about
3542 * re-editing the file. Should do the buf_clear_file(), but perhaps
3543 * the autocommands changed the buffer... */
3544 if (buf != curbuf)
3545 goto theend;
3546 # ifdef FEAT_EVAL
3547 if (aborting()) /* autocmds may abort script processing */
3548 goto theend;
3549 # endif
3550 #endif
3551 buf_clear_file(curbuf);
3552 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3553 curbuf->b_op_end.lnum = 0;
3557 * If we get here we are sure to start editing
3559 /* don't redraw until the cursor is in the right line */
3560 ++RedrawingDisabled;
3562 /* Assume success now */
3563 retval = OK;
3566 * Reset cursor position, could be used by autocommands.
3568 check_cursor();
3571 * Check if we are editing the w_arg_idx file in the argument list.
3573 check_arg_idx(curwin);
3575 #ifdef FEAT_AUTOCMD
3576 if (!auto_buf)
3577 #endif
3580 * Set cursor and init window before reading the file and executing
3581 * autocommands. This allows for the autocommands to position the
3582 * cursor.
3584 curwin_init();
3586 #ifdef FEAT_FOLDING
3587 /* It's possible that all lines in the buffer changed. Need to update
3588 * automatic folding for all windows where it's used. */
3589 # ifdef FEAT_WINDOWS
3591 win_T *win;
3592 tabpage_T *tp;
3594 FOR_ALL_TAB_WINDOWS(tp, win)
3595 if (win->w_buffer == curbuf)
3596 foldUpdateAll(win);
3598 # else
3599 foldUpdateAll(curwin);
3600 # endif
3601 #endif
3603 /* Change directories when the 'acd' option is set. */
3604 DO_AUTOCHDIR
3607 * Careful: open_buffer() and apply_autocmds() may change the current
3608 * buffer and window.
3610 lnum = curwin->w_cursor.lnum;
3611 topline = curwin->w_topline;
3612 if (!oldbuf) /* need to read the file */
3614 #if defined(HAS_SWAP_EXISTS_ACTION)
3615 swap_exists_action = SEA_DIALOG;
3616 #endif
3617 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3620 * Open the buffer and read the file.
3622 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3623 if (should_abort(open_buffer(FALSE, eap)))
3624 retval = FAIL;
3625 #else
3626 (void)open_buffer(FALSE, eap);
3627 #endif
3629 #if defined(HAS_SWAP_EXISTS_ACTION)
3630 if (swap_exists_action == SEA_QUIT)
3631 retval = FAIL;
3632 handle_swap_exists(old_curbuf);
3633 #endif
3635 #ifdef FEAT_AUTOCMD
3636 else
3638 /* Read the modelines, but only to set window-local options. Any
3639 * buffer-local options have already been set and may have been
3640 * changed by the user. */
3641 do_modelines(OPT_WINONLY);
3643 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3644 &retval);
3645 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3646 &retval);
3648 check_arg_idx(curwin);
3649 #endif
3652 * If autocommands change the cursor position or topline, we should
3653 * keep it.
3655 if (curwin->w_cursor.lnum != lnum)
3657 newlnum = curwin->w_cursor.lnum;
3658 newcol = curwin->w_cursor.col;
3660 if (curwin->w_topline == topline)
3661 topline = 0;
3663 /* Even when cursor didn't move we need to recompute topline. */
3664 changed_line_abv_curs();
3666 #ifdef FEAT_TITLE
3667 maketitle();
3668 #endif
3671 #ifdef FEAT_DIFF
3672 /* Tell the diff stuff that this buffer is new and/or needs updating.
3673 * Also needed when re-editing the same buffer, because unloading will
3674 * have removed it as a diff buffer. */
3675 if (curwin->w_p_diff)
3677 diff_buf_add(curbuf);
3678 diff_invalidate(curbuf);
3680 #endif
3682 #ifdef FEAT_SPELL
3683 /* If the window options were changed may need to set the spell language.
3684 * Can only do this after the buffer has been properly setup. */
3685 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3686 did_set_spelllang(curbuf);
3687 #endif
3689 if (command == NULL)
3691 if (newcol >= 0) /* position set by autocommands */
3693 curwin->w_cursor.lnum = newlnum;
3694 curwin->w_cursor.col = newcol;
3695 check_cursor();
3697 else if (newlnum > 0) /* line number from caller or old position */
3699 curwin->w_cursor.lnum = newlnum;
3700 check_cursor_lnum();
3701 if (solcol >= 0 && !p_sol)
3703 /* 'sol' is off: Use last known column. */
3704 curwin->w_cursor.col = solcol;
3705 check_cursor_col();
3706 #ifdef FEAT_VIRTUALEDIT
3707 curwin->w_cursor.coladd = 0;
3708 #endif
3709 curwin->w_set_curswant = TRUE;
3711 else
3712 beginline(BL_SOL | BL_FIX);
3714 else /* no line number, go to last line in Ex mode */
3716 if (exmode_active)
3717 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3718 beginline(BL_WHITE | BL_FIX);
3722 #ifdef FEAT_WINDOWS
3723 /* Check if cursors in other windows on the same buffer are still valid */
3724 check_lnums(FALSE);
3725 #endif
3728 * Did not read the file, need to show some info about the file.
3729 * Do this after setting the cursor.
3731 if (oldbuf
3732 #ifdef FEAT_AUTOCMD
3733 && !auto_buf
3734 #endif
3737 int msg_scroll_save = msg_scroll;
3739 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3740 * message. */
3741 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3742 msg_scroll = FALSE;
3743 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3744 check_for_delay(FALSE);
3745 msg_start();
3746 msg_scroll = msg_scroll_save;
3747 msg_scrolled_ign = TRUE;
3749 fileinfo(FALSE, TRUE, FALSE);
3751 msg_scrolled_ign = FALSE;
3754 if (command != NULL)
3755 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3757 #ifdef FEAT_KEYMAP
3758 if (curbuf->b_kmap_state & KEYMAP_INIT)
3759 keymap_init();
3760 #endif
3762 --RedrawingDisabled;
3763 if (!skip_redraw)
3765 n = p_so;
3766 if (topline == 0 && command == NULL)
3767 p_so = 999; /* force cursor halfway the window */
3768 update_topline();
3769 #ifdef FEAT_SCROLLBIND
3770 curwin->w_scbind_pos = curwin->w_topline;
3771 #endif
3772 p_so = n;
3773 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3776 if (p_im)
3777 need_start_insertmode = TRUE;
3779 /* Change directories when the 'acd' option is set. */
3780 DO_AUTOCHDIR
3782 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3783 if (gui.in_use && curbuf->b_ffname != NULL)
3785 # ifdef FEAT_SUN_WORKSHOP
3786 if (usingSunWorkShop)
3787 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3788 # endif
3789 # ifdef FEAT_NETBEANS_INTG
3790 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3791 netbeans_file_opened(curbuf);
3792 # endif
3794 #endif
3796 theend:
3797 #ifdef FEAT_AUTOCMD
3798 if (did_set_swapcommand)
3799 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3800 #endif
3801 #ifdef FEAT_BROWSE
3802 vim_free(browse_file);
3803 #endif
3804 vim_free(free_fname);
3805 return retval;
3808 #ifdef FEAT_AUTOCMD
3809 static void
3810 delbuf_msg(name)
3811 char_u *name;
3813 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3814 name == NULL ? (char_u *)"" : name);
3815 vim_free(name);
3816 au_new_curbuf = NULL;
3818 #endif
3820 static int append_indent = 0; /* autoindent for first line */
3823 * ":insert" and ":append", also used by ":change"
3825 void
3826 ex_append(eap)
3827 exarg_T *eap;
3829 char_u *theline;
3830 int did_undo = FALSE;
3831 linenr_T lnum = eap->line2;
3832 int indent = 0;
3833 char_u *p;
3834 int vcol;
3835 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3837 /* the ! flag toggles autoindent */
3838 if (eap->forceit)
3839 curbuf->b_p_ai = !curbuf->b_p_ai;
3841 /* First autoindent comes from the line we start on */
3842 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3843 append_indent = get_indent_lnum(lnum);
3845 if (eap->cmdidx != CMD_append)
3846 --lnum;
3848 /* when the buffer is empty append to line 0 and delete the dummy line */
3849 if (empty && lnum == 1)
3850 lnum = 0;
3852 State = INSERT; /* behave like in Insert mode */
3853 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3854 State |= LANGMAP;
3856 for (;;)
3858 msg_scroll = TRUE;
3859 need_wait_return = FALSE;
3860 if (curbuf->b_p_ai)
3862 if (append_indent >= 0)
3864 indent = append_indent;
3865 append_indent = -1;
3867 else if (lnum > 0)
3868 indent = get_indent_lnum(lnum);
3870 ex_keep_indent = FALSE;
3871 if (eap->getline == NULL)
3873 /* No getline() function, use the lines that follow. This ends
3874 * when there is no more. */
3875 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3876 break;
3877 p = vim_strchr(eap->nextcmd, NL);
3878 if (p == NULL)
3879 p = eap->nextcmd + STRLEN(eap->nextcmd);
3880 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3881 if (*p != NUL)
3882 ++p;
3883 eap->nextcmd = p;
3885 else
3886 theline = eap->getline(
3887 #ifdef FEAT_EVAL
3888 eap->cstack->cs_looplevel > 0 ? -1 :
3889 #endif
3890 NUL, eap->cookie, indent);
3891 lines_left = Rows - 1;
3892 if (theline == NULL)
3893 break;
3895 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3896 if (ex_keep_indent)
3897 append_indent = indent;
3899 /* Look for the "." after automatic indent. */
3900 vcol = 0;
3901 for (p = theline; indent > vcol; ++p)
3903 if (*p == ' ')
3904 ++vcol;
3905 else if (*p == TAB)
3906 vcol += 8 - vcol % 8;
3907 else
3908 break;
3910 if ((p[0] == '.' && p[1] == NUL)
3911 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3912 == FAIL))
3914 vim_free(theline);
3915 break;
3918 /* don't use autoindent if nothing was typed. */
3919 if (p[0] == NUL)
3920 theline[0] = NUL;
3922 did_undo = TRUE;
3923 ml_append(lnum, theline, (colnr_T)0, FALSE);
3924 appended_lines_mark(lnum, 1L);
3926 vim_free(theline);
3927 ++lnum;
3929 if (empty)
3931 ml_delete(2L, FALSE);
3932 empty = FALSE;
3935 State = NORMAL;
3937 if (eap->forceit)
3938 curbuf->b_p_ai = !curbuf->b_p_ai;
3940 /* "start" is set to eap->line2+1 unless that position is invalid (when
3941 * eap->line2 pointed to the end of the buffer and nothing was appended)
3942 * "end" is set to lnum when something has been appended, otherwise
3943 * it is the same than "start" -- Acevedo */
3944 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3945 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3946 if (eap->cmdidx != CMD_append)
3947 --curbuf->b_op_start.lnum;
3948 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3949 ? lnum : curbuf->b_op_start.lnum;
3950 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3951 curwin->w_cursor.lnum = lnum;
3952 check_cursor_lnum();
3953 beginline(BL_SOL | BL_FIX);
3955 need_wait_return = FALSE; /* don't use wait_return() now */
3956 ex_no_reprint = TRUE;
3960 * ":change"
3962 void
3963 ex_change(eap)
3964 exarg_T *eap;
3966 linenr_T lnum;
3968 if (eap->line2 >= eap->line1
3969 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3970 return;
3972 /* the ! flag toggles autoindent */
3973 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3974 append_indent = get_indent_lnum(eap->line1);
3976 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3978 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3979 break;
3980 ml_delete(eap->line1, FALSE);
3982 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3984 /* ":append" on the line above the deleted lines. */
3985 eap->line2 = eap->line1;
3986 ex_append(eap);
3989 void
3990 ex_z(eap)
3991 exarg_T *eap;
3993 char_u *x;
3994 int bigness;
3995 char_u *kind;
3996 int minus = 0;
3997 linenr_T start, end, curs, i;
3998 int j;
3999 linenr_T lnum = eap->line2;
4001 /* Vi compatible: ":z!" uses display height, without a count uses
4002 * 'scroll' */
4003 if (eap->forceit)
4004 bigness = curwin->w_height;
4005 else if (firstwin == lastwin)
4006 bigness = curwin->w_p_scr * 2;
4007 else
4008 bigness = curwin->w_height - 3;
4009 if (bigness < 1)
4010 bigness = 1;
4012 x = eap->arg;
4013 kind = x;
4014 if (*kind == '-' || *kind == '+' || *kind == '='
4015 || *kind == '^' || *kind == '.')
4016 ++x;
4017 while (*x == '-' || *x == '+')
4018 ++x;
4020 if (*x != 0)
4022 if (!VIM_ISDIGIT(*x))
4024 EMSG(_("E144: non-numeric argument to :z"));
4025 return;
4027 else
4029 bigness = atoi((char *)x);
4030 p_window = bigness;
4031 if (*kind == '=')
4032 bigness += 2;
4036 /* the number of '-' and '+' multiplies the distance */
4037 if (*kind == '-' || *kind == '+')
4038 for (x = kind + 1; *x == *kind; ++x)
4041 switch (*kind)
4043 case '-':
4044 start = lnum - bigness * (linenr_T)(x - kind);
4045 end = start + bigness;
4046 curs = end;
4047 break;
4049 case '=':
4050 start = lnum - (bigness + 1) / 2 + 1;
4051 end = lnum + (bigness + 1) / 2 - 1;
4052 curs = lnum;
4053 minus = 1;
4054 break;
4056 case '^':
4057 start = lnum - bigness * 2;
4058 end = lnum - bigness;
4059 curs = lnum - bigness;
4060 break;
4062 case '.':
4063 start = lnum - (bigness + 1) / 2 + 1;
4064 end = lnum + (bigness + 1) / 2 - 1;
4065 curs = end;
4066 break;
4068 default: /* '+' */
4069 start = lnum;
4070 if (*kind == '+')
4071 start += bigness * (linenr_T)(x - kind - 1) + 1;
4072 else if (eap->addr_count == 0)
4073 ++start;
4074 end = start + bigness - 1;
4075 curs = end;
4076 break;
4079 if (start < 1)
4080 start = 1;
4082 if (end > curbuf->b_ml.ml_line_count)
4083 end = curbuf->b_ml.ml_line_count;
4085 if (curs > curbuf->b_ml.ml_line_count)
4086 curs = curbuf->b_ml.ml_line_count;
4088 for (i = start; i <= end; i++)
4090 if (minus && i == lnum)
4092 msg_putchar('\n');
4094 for (j = 1; j < Columns; j++)
4095 msg_putchar('-');
4098 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4100 if (minus && i == lnum)
4102 msg_putchar('\n');
4104 for (j = 1; j < Columns; j++)
4105 msg_putchar('-');
4109 curwin->w_cursor.lnum = curs;
4110 ex_no_reprint = TRUE;
4114 * Check if the restricted flag is set.
4115 * If so, give an error message and return TRUE.
4116 * Otherwise, return FALSE.
4119 check_restricted()
4121 if (restricted)
4123 EMSG(_("E145: Shell commands not allowed in rvim"));
4124 return TRUE;
4126 return FALSE;
4130 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4131 * If so, give an error message and return TRUE.
4132 * Otherwise, return FALSE.
4135 check_secure()
4137 if (secure)
4139 secure = 2;
4140 EMSG(_(e_curdir));
4141 return TRUE;
4143 #ifdef HAVE_SANDBOX
4145 * In the sandbox more things are not allowed, including the things
4146 * disallowed in secure mode.
4148 if (sandbox != 0)
4150 EMSG(_(e_sandbox));
4151 return TRUE;
4153 #endif
4154 return FALSE;
4157 static char_u *old_sub = NULL; /* previous substitute pattern */
4158 static int global_need_beginline; /* call beginline() after ":g" */
4160 /* do_sub()
4162 * Perform a substitution from line eap->line1 to line eap->line2 using the
4163 * command pointed to by eap->arg which should be of the form:
4165 * /pattern/substitution/{flags}
4167 * The usual escapes are supported as described in the regexp docs.
4169 void
4170 do_sub(eap)
4171 exarg_T *eap;
4173 linenr_T lnum;
4174 long i = 0;
4175 regmmatch_T regmatch;
4176 static int do_all = FALSE; /* do multiple substitutions per line */
4177 static int do_ask = FALSE; /* ask for confirmation */
4178 static int do_count = FALSE; /* count only */
4179 static int do_error = TRUE; /* if false, ignore errors */
4180 static int do_print = FALSE; /* print last line with subs. */
4181 static int do_list = FALSE; /* list last line with subs. */
4182 static int do_number = FALSE; /* list last line with line nr*/
4183 static int do_ic = 0; /* ignore case flag */
4184 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4185 int delimiter;
4186 int sublen;
4187 int got_quit = FALSE;
4188 int got_match = FALSE;
4189 int temp;
4190 int which_pat;
4191 char_u *cmd;
4192 int save_State;
4193 linenr_T first_line = 0; /* first changed line */
4194 linenr_T last_line= 0; /* below last changed line AFTER the
4195 * change */
4196 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4197 linenr_T line2;
4198 long nmatch; /* number of lines in match */
4199 linenr_T sub_firstlnum; /* nr of first sub line */
4200 char_u *sub_firstline; /* allocated copy of first sub line */
4201 int endcolumn = FALSE; /* cursor in last column when done */
4202 pos_T old_cursor = curwin->w_cursor;
4204 cmd = eap->arg;
4205 if (!global_busy)
4207 sub_nsubs = 0;
4208 sub_nlines = 0;
4211 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4212 if (p_altkeymap && curwin->w_p_rl)
4213 lrF_sub(cmd);
4214 #endif
4216 if (eap->cmdidx == CMD_tilde)
4217 which_pat = RE_LAST; /* use last used regexp */
4218 else
4219 which_pat = RE_SUBST; /* use last substitute regexp */
4221 /* new pattern and substitution */
4222 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4223 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4225 /* don't accept alphanumeric for separator */
4226 if (isalpha(*cmd))
4228 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4229 return;
4232 * undocumented vi feature:
4233 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4234 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4236 if (*cmd == '\\')
4238 ++cmd;
4239 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4241 EMSG(_(e_backslash));
4242 return;
4244 if (*cmd != '&')
4245 which_pat = RE_SEARCH; /* use last '/' pattern */
4246 pat = (char_u *)""; /* empty search pattern */
4247 delimiter = *cmd++; /* remember delimiter character */
4249 else /* find the end of the regexp */
4251 which_pat = RE_LAST; /* use last used regexp */
4252 delimiter = *cmd++; /* remember delimiter character */
4253 pat = cmd; /* remember start of search pat */
4254 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4255 if (cmd[0] == delimiter) /* end delimiter found */
4256 *cmd++ = NUL; /* replace it with a NUL */
4260 * Small incompatibility: vi sees '\n' as end of the command, but in
4261 * Vim we want to use '\n' to find/substitute a NUL.
4263 sub = cmd; /* remember the start of the substitution */
4265 while (cmd[0])
4267 if (cmd[0] == delimiter) /* end delimiter found */
4269 *cmd++ = NUL; /* replace it with a NUL */
4270 break;
4272 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4273 ++cmd;
4274 mb_ptr_adv(cmd);
4277 if (!eap->skip)
4279 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4280 if (STRCMP(sub, "%") == 0
4281 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4283 if (old_sub == NULL) /* there is no previous command */
4285 EMSG(_(e_nopresub));
4286 return;
4288 sub = old_sub;
4290 else
4292 vim_free(old_sub);
4293 old_sub = vim_strsave(sub);
4297 else if (!eap->skip) /* use previous pattern and substitution */
4299 if (old_sub == NULL) /* there is no previous command */
4301 EMSG(_(e_nopresub));
4302 return;
4304 pat = NULL; /* search_regcomp() will use previous pattern */
4305 sub = old_sub;
4307 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4308 * last column after using "$". */
4309 endcolumn = (curwin->w_curswant == MAXCOL);
4313 * Find trailing options. When '&' is used, keep old options.
4315 if (*cmd == '&')
4316 ++cmd;
4317 else
4319 if (!p_ed)
4321 if (p_gd) /* default is global on */
4322 do_all = TRUE;
4323 else
4324 do_all = FALSE;
4325 do_ask = FALSE;
4327 do_error = TRUE;
4328 do_print = FALSE;
4329 do_count = FALSE;
4330 do_number = FALSE;
4331 do_ic = 0;
4333 while (*cmd)
4336 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4337 * 'r' is never inverted.
4339 if (*cmd == 'g')
4340 do_all = !do_all;
4341 else if (*cmd == 'c')
4342 do_ask = !do_ask;
4343 else if (*cmd == 'n')
4344 do_count = TRUE;
4345 else if (*cmd == 'e')
4346 do_error = !do_error;
4347 else if (*cmd == 'r') /* use last used regexp */
4348 which_pat = RE_LAST;
4349 else if (*cmd == 'p')
4350 do_print = TRUE;
4351 else if (*cmd == '#')
4353 do_print = TRUE;
4354 do_number = TRUE;
4356 else if (*cmd == 'l')
4358 do_print = TRUE;
4359 do_list = TRUE;
4361 else if (*cmd == 'i') /* ignore case */
4362 do_ic = 'i';
4363 else if (*cmd == 'I') /* don't ignore case */
4364 do_ic = 'I';
4365 else
4366 break;
4367 ++cmd;
4369 if (do_count)
4370 do_ask = FALSE;
4373 * check for a trailing count
4375 cmd = skipwhite(cmd);
4376 if (VIM_ISDIGIT(*cmd))
4378 i = getdigits(&cmd);
4379 if (i <= 0 && !eap->skip && do_error)
4381 EMSG(_(e_zerocount));
4382 return;
4384 eap->line1 = eap->line2;
4385 eap->line2 += i - 1;
4386 if (eap->line2 > curbuf->b_ml.ml_line_count)
4387 eap->line2 = curbuf->b_ml.ml_line_count;
4391 * check for trailing command or garbage
4393 cmd = skipwhite(cmd);
4394 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4396 eap->nextcmd = check_nextcmd(cmd);
4397 if (eap->nextcmd == NULL)
4399 EMSG(_(e_trailing));
4400 return;
4404 if (eap->skip) /* not executing commands, only parsing */
4405 return;
4407 if (!do_count && !curbuf->b_p_ma)
4409 /* Substitution is not allowed in non-'modifiable' buffer */
4410 EMSG(_(e_modifiable));
4411 return;
4414 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4416 if (do_error)
4417 EMSG(_(e_invcmd));
4418 return;
4421 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4422 if (do_ic == 'i')
4423 regmatch.rmm_ic = TRUE;
4424 else if (do_ic == 'I')
4425 regmatch.rmm_ic = FALSE;
4427 sub_firstline = NULL;
4430 * ~ in the substitute pattern is replaced with the old pattern.
4431 * We do it here once to avoid it to be replaced over and over again.
4432 * But don't do it when it starts with "\=", then it's an expression.
4434 if (!(sub[0] == '\\' && sub[1] == '='))
4435 sub = regtilde(sub, p_magic);
4438 * Check for a match on each line.
4440 line2 = eap->line2;
4441 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4442 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4443 || aborting()
4444 #endif
4445 ); ++lnum)
4447 sub_firstlnum = lnum;
4448 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
4449 if (nmatch)
4451 colnr_T copycol;
4452 colnr_T matchcol;
4453 colnr_T prev_matchcol = MAXCOL;
4454 char_u *new_end, *new_start = NULL;
4455 unsigned new_start_len = 0;
4456 char_u *p1;
4457 int did_sub = FALSE;
4458 int lastone;
4459 unsigned len, needed_len;
4460 long nmatch_tl = 0; /* nr of lines matched below lnum */
4461 int do_again; /* do it again after joining lines */
4462 int skip_match = FALSE;
4465 * The new text is build up step by step, to avoid too much
4466 * copying. There are these pieces:
4467 * sub_firstline The old text, unmodifed.
4468 * copycol Column in the old text where we started
4469 * looking for a match; from here old text still
4470 * needs to be copied to the new text.
4471 * matchcol Column number of the old text where to look
4472 * for the next match. It's just after the
4473 * previous match or one further.
4474 * prev_matchcol Column just after the previous match (if any).
4475 * Mostly equal to matchcol, except for the first
4476 * match and after skipping an empty match.
4477 * regmatch.*pos Where the pattern matched in the old text.
4478 * new_start The new text, all that has been produced so
4479 * far.
4480 * new_end The new text, where to append new text.
4482 * lnum The line number where we were looking for the
4483 * first match in the old line.
4484 * sub_firstlnum The line number in the buffer where to look
4485 * for a match. Can be different from "lnum"
4486 * when the pattern or substitute string contains
4487 * line breaks.
4489 * Special situations:
4490 * - When the substitute string contains a line break, the part up
4491 * to the line break is inserted in the text, but the copy of
4492 * the original line is kept. "sub_firstlnum" is adjusted for
4493 * the inserted lines.
4494 * - When the matched pattern contains a line break, the old line
4495 * is taken from the line at the end of the pattern. The lines
4496 * in the match are deleted later, "sub_firstlnum" is adjusted
4497 * accordingly.
4499 * The new text is built up in new_start[]. It has some extra
4500 * room to avoid using alloc()/free() too often. new_start_len is
4501 * the length of the allocated memory at new_start.
4503 * Make a copy of the old line, so it won't be taken away when
4504 * updating the screen or handling a multi-line match. The "old_"
4505 * pointers point into this copy.
4507 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4508 if (sub_firstline == NULL)
4510 vim_free(new_start);
4511 goto outofmem;
4513 copycol = 0;
4514 matchcol = 0;
4516 /* At first match, remember current cursor position. */
4517 if (!got_match)
4519 setpcmark();
4520 got_match = TRUE;
4524 * Loop until nothing more to replace in this line.
4525 * 1. Handle match with empty string.
4526 * 2. If do_ask is set, ask for confirmation.
4527 * 3. substitute the string.
4528 * 4. if do_all is set, find next match
4529 * 5. break if there isn't another match in this line
4531 for (;;)
4533 /* Save the line number of the last change for the final
4534 * cursor position (just like Vi). */
4535 curwin->w_cursor.lnum = lnum;
4536 do_again = FALSE;
4539 * 1. Match empty string does not count, except for first
4540 * match. This reproduces the strange vi behaviour.
4541 * This also catches endless loops.
4543 if (matchcol == prev_matchcol
4544 && regmatch.endpos[0].lnum == 0
4545 && matchcol == regmatch.endpos[0].col)
4547 if (sub_firstline[matchcol] == NUL)
4548 /* We already were at the end of the line. Don't look
4549 * for a match in this line again. */
4550 skip_match = TRUE;
4551 else
4552 ++matchcol; /* search for a match at next column */
4553 goto skip;
4556 /* Normally we continue searching for a match just after the
4557 * previous match. */
4558 matchcol = regmatch.endpos[0].col;
4559 prev_matchcol = matchcol;
4562 * 2. If do_count is set only increase the counter.
4563 * If do_ask is set, ask for confirmation.
4565 if (do_count)
4567 /* For a multi-line match, put matchcol at the NUL at
4568 * the end of the line and set nmatch to one, so that
4569 * we continue looking for a match on the next line.
4570 * Avoids that ":s/\nB\@=//gc" get stuck. */
4571 if (nmatch > 1)
4573 matchcol = (colnr_T)STRLEN(sub_firstline);
4574 nmatch = 1;
4576 sub_nsubs++;
4577 did_sub = TRUE;
4578 goto skip;
4581 if (do_ask)
4583 /* change State to CONFIRM, so that the mouse works
4584 * properly */
4585 save_State = State;
4586 State = CONFIRM;
4587 #ifdef FEAT_MOUSE
4588 setmouse(); /* disable mouse in xterm */
4589 #endif
4590 curwin->w_cursor.col = regmatch.startpos[0].col;
4592 /* When 'cpoptions' contains "u" don't sync undo when
4593 * asking for confirmation. */
4594 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4595 ++no_u_sync;
4598 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4600 while (do_ask)
4602 if (exmode_active)
4604 char_u *resp;
4605 colnr_T sc, ec;
4607 print_line_no_prefix(lnum, FALSE, FALSE);
4609 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4610 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4611 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4612 msg_start();
4613 for (i = 0; i < (long)sc; ++i)
4614 msg_putchar(' ');
4615 for ( ; i <= (long)ec; ++i)
4616 msg_putchar('^');
4618 resp = getexmodeline('?', NULL, 0);
4619 if (resp != NULL)
4621 i = *resp;
4622 vim_free(resp);
4625 else
4627 #ifdef FEAT_FOLDING
4628 int save_p_fen = curwin->w_p_fen;
4630 curwin->w_p_fen = FALSE;
4631 #endif
4632 /* Invert the matched string.
4633 * Remove the inversion afterwards. */
4634 temp = RedrawingDisabled;
4635 RedrawingDisabled = 0;
4637 search_match_lines = regmatch.endpos[0].lnum;
4638 search_match_endcol = regmatch.endpos[0].col;
4639 highlight_match = TRUE;
4641 update_topline();
4642 validate_cursor();
4643 update_screen(SOME_VALID);
4644 highlight_match = FALSE;
4645 redraw_later(SOME_VALID);
4647 #ifdef FEAT_FOLDING
4648 curwin->w_p_fen = save_p_fen;
4649 #endif
4650 if (msg_row == Rows - 1)
4651 msg_didout = FALSE; /* avoid a scroll-up */
4652 msg_starthere();
4653 i = msg_scroll;
4654 msg_scroll = 0; /* truncate msg when
4655 needed */
4656 msg_no_more = TRUE;
4657 /* write message same highlighting as for
4658 * wait_return */
4659 smsg_attr(hl_attr(HLF_R),
4660 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4661 msg_no_more = FALSE;
4662 msg_scroll = i;
4663 showruler(TRUE);
4664 windgoto(msg_row, msg_col);
4665 RedrawingDisabled = temp;
4667 #ifdef USE_ON_FLY_SCROLL
4668 dont_scroll = FALSE; /* allow scrolling here */
4669 #endif
4670 ++no_mapping; /* don't map this key */
4671 ++allow_keys; /* allow special keys */
4672 i = plain_vgetc();
4673 --allow_keys;
4674 --no_mapping;
4676 /* clear the question */
4677 msg_didout = FALSE; /* don't scroll up */
4678 msg_col = 0;
4679 gotocmdline(TRUE);
4682 need_wait_return = FALSE; /* no hit-return prompt */
4683 if (i == 'q' || i == ESC || i == Ctrl_C
4684 #ifdef UNIX
4685 || i == intr_char
4686 #endif
4689 got_quit = TRUE;
4690 break;
4692 if (i == 'n')
4693 break;
4694 if (i == 'y')
4695 break;
4696 if (i == 'l')
4698 /* last: replace and then stop */
4699 do_all = FALSE;
4700 line2 = lnum;
4701 break;
4703 if (i == 'a')
4705 do_ask = FALSE;
4706 break;
4708 #ifdef FEAT_INS_EXPAND
4709 if (i == Ctrl_E)
4710 scrollup_clamp();
4711 else if (i == Ctrl_Y)
4712 scrolldown_clamp();
4713 #endif
4715 State = save_State;
4716 #ifdef FEAT_MOUSE
4717 setmouse();
4718 #endif
4719 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4720 --no_u_sync;
4722 if (i == 'n')
4724 /* For a multi-line match, put matchcol at the NUL at
4725 * the end of the line and set nmatch to one, so that
4726 * we continue looking for a match on the next line.
4727 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4728 * get stuck when pressing 'n'. */
4729 if (nmatch > 1)
4731 matchcol = (colnr_T)STRLEN(sub_firstline);
4732 skip_match = TRUE;
4734 goto skip;
4736 if (got_quit)
4737 break;
4740 /* Move the cursor to the start of the match, so that we can
4741 * use "\=col("."). */
4742 curwin->w_cursor.col = regmatch.startpos[0].col;
4745 * 3. substitute the string.
4747 /* get length of substitution part */
4748 sublen = vim_regsub_multi(&regmatch, sub_firstlnum,
4749 sub, sub_firstline, FALSE, p_magic, TRUE);
4751 /* When the match included the "$" of the last line it may
4752 * go beyond the last line of the buffer. */
4753 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4755 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4756 skip_match = TRUE;
4759 /* Need room for:
4760 * - result so far in new_start (not for first sub in line)
4761 * - original text up to match
4762 * - length of substituted part
4763 * - original text after match
4765 if (nmatch == 1)
4766 p1 = sub_firstline;
4767 else
4769 p1 = ml_get(sub_firstlnum + nmatch - 1);
4770 nmatch_tl += nmatch - 1;
4772 i = regmatch.startpos[0].col - copycol;
4773 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4774 + sublen + 1;
4775 if (new_start == NULL)
4778 * Get some space for a temporary buffer to do the
4779 * substitution into (and some extra space to avoid
4780 * too many calls to alloc()/free()).
4782 new_start_len = needed_len + 50;
4783 if ((new_start = alloc_check(new_start_len)) == NULL)
4784 goto outofmem;
4785 *new_start = NUL;
4786 new_end = new_start;
4788 else
4791 * Check if the temporary buffer is long enough to do the
4792 * substitution into. If not, make it larger (with a bit
4793 * extra to avoid too many calls to alloc()/free()).
4795 len = (unsigned)STRLEN(new_start);
4796 needed_len += len;
4797 if (needed_len > new_start_len)
4799 new_start_len = needed_len + 50;
4800 if ((p1 = alloc_check(new_start_len)) == NULL)
4802 vim_free(new_start);
4803 goto outofmem;
4805 mch_memmove(p1, new_start, (size_t)(len + 1));
4806 vim_free(new_start);
4807 new_start = p1;
4809 new_end = new_start + len;
4813 * copy the text up to the part that matched
4815 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4816 new_end += i;
4818 (void)vim_regsub_multi(&regmatch, sub_firstlnum,
4819 sub, new_end, TRUE, p_magic, TRUE);
4820 sub_nsubs++;
4821 did_sub = TRUE;
4823 /* Move the cursor to the start of the line, to avoid that it
4824 * is beyond the end of the line after the substitution. */
4825 curwin->w_cursor.col = 0;
4827 /* For a multi-line match, make a copy of the last matched
4828 * line and continue in that one. */
4829 if (nmatch > 1)
4831 sub_firstlnum += nmatch - 1;
4832 vim_free(sub_firstline);
4833 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4834 /* When going beyond the last line, stop substituting. */
4835 if (sub_firstlnum <= line2)
4836 do_again = TRUE;
4837 else
4838 do_all = FALSE;
4841 /* Remember next character to be copied. */
4842 copycol = regmatch.endpos[0].col;
4844 if (skip_match)
4846 /* Already hit end of the buffer, sub_firstlnum is one
4847 * less than what it ought to be. */
4848 vim_free(sub_firstline);
4849 sub_firstline = vim_strsave((char_u *)"");
4850 copycol = 0;
4854 * Now the trick is to replace CTRL-M chars with a real line
4855 * break. This would make it impossible to insert a CTRL-M in
4856 * the text. The line break can be avoided by preceding the
4857 * CTRL-M with a backslash. To be able to insert a backslash,
4858 * they must be doubled in the string and are halved here.
4859 * That is Vi compatible.
4861 for (p1 = new_end; *p1; ++p1)
4863 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4864 mch_memmove(p1, p1 + 1, STRLEN(p1));
4865 else if (*p1 == CAR)
4867 if (u_inssub(lnum) == OK) /* prepare for undo */
4869 *p1 = NUL; /* truncate up to the CR */
4870 ml_append(lnum - 1, new_start,
4871 (colnr_T)(p1 - new_start + 1), FALSE);
4872 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4873 if (do_ask)
4874 appended_lines(lnum - 1, 1L);
4875 else
4877 if (first_line == 0)
4878 first_line = lnum;
4879 last_line = lnum + 1;
4881 /* All line numbers increase. */
4882 ++sub_firstlnum;
4883 ++lnum;
4884 ++line2;
4885 /* move the cursor to the new line, like Vi */
4886 ++curwin->w_cursor.lnum;
4887 STRCPY(new_start, p1 + 1); /* copy the rest */
4888 p1 = new_start - 1;
4891 #ifdef FEAT_MBYTE
4892 else if (has_mbyte)
4893 p1 += (*mb_ptr2len)(p1) - 1;
4894 #endif
4898 * 4. If do_all is set, find next match.
4899 * Prevent endless loop with patterns that match empty
4900 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4901 * But ":s/\n/#/" is OK.
4903 skip:
4904 /* We already know that we did the last subst when we are at
4905 * the end of the line, except that a pattern like
4906 * "bar\|\nfoo" may match at the NUL. */
4907 lastone = (skip_match
4908 || got_int
4909 || got_quit
4910 || !(do_all || do_again)
4911 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4912 && !re_multiline(regmatch.regprog)));
4913 nmatch = -1;
4916 * Replace the line in the buffer when needed. This is
4917 * skipped when there are more matches.
4918 * The check for nmatch_tl is needed for when multi-line
4919 * matching must replace the lines before trying to do another
4920 * match, otherwise "\@<=" won't work.
4921 * When asking the user we like to show the already replaced
4922 * text, but don't do it when "\<@=" or "\<@!" is used, it
4923 * changes what matches.
4925 if (lastone
4926 || (do_ask && !re_lookbehind(regmatch.regprog))
4927 || nmatch_tl > 0
4928 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4929 curbuf, sub_firstlnum, matchcol)) == 0)
4931 if (new_start != NULL)
4934 * Copy the rest of the line, that didn't match.
4935 * "matchcol" has to be adjusted, we use the end of
4936 * the line as reference, because the substitute may
4937 * have changed the number of characters. Same for
4938 * "prev_matchcol".
4940 STRCAT(new_start, sub_firstline + copycol);
4941 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4942 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4943 - prev_matchcol;
4945 if (u_savesub(lnum) != OK)
4946 break;
4947 ml_replace(lnum, new_start, TRUE);
4949 if (nmatch_tl > 0)
4952 * Matched lines have now been substituted and are
4953 * useless, delete them. The part after the match
4954 * has been appended to new_start, we don't need
4955 * it in the buffer.
4957 ++lnum;
4958 if (u_savedel(lnum, nmatch_tl) != OK)
4959 break;
4960 for (i = 0; i < nmatch_tl; ++i)
4961 ml_delete(lnum, (int)FALSE);
4962 mark_adjust(lnum, lnum + nmatch_tl - 1,
4963 (long)MAXLNUM, -nmatch_tl);
4964 if (do_ask)
4965 deleted_lines(lnum, nmatch_tl);
4966 --lnum;
4967 line2 -= nmatch_tl; /* nr of lines decreases */
4968 nmatch_tl = 0;
4971 /* When asking, undo is saved each time, must also set
4972 * changed flag each time. */
4973 if (do_ask)
4974 changed_bytes(lnum, 0);
4975 else
4977 if (first_line == 0)
4978 first_line = lnum;
4979 last_line = lnum + 1;
4982 sub_firstlnum = lnum;
4983 vim_free(sub_firstline); /* free the temp buffer */
4984 sub_firstline = new_start;
4985 new_start = NULL;
4986 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4987 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4988 - prev_matchcol;
4989 copycol = 0;
4991 if (nmatch == -1 && !lastone)
4992 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
4993 sub_firstlnum, matchcol);
4996 * 5. break if there isn't another match in this line
4998 if (nmatch <= 0)
4999 break;
5002 line_breakcheck();
5005 if (did_sub)
5006 ++sub_nlines;
5007 vim_free(sub_firstline); /* free the copy of the original line */
5008 sub_firstline = NULL;
5011 line_breakcheck();
5014 if (first_line != 0)
5016 /* Need to subtract the number of added lines from "last_line" to get
5017 * the line number before the change (same as adding the number of
5018 * deleted lines). */
5019 i = curbuf->b_ml.ml_line_count - old_line_count;
5020 changed_lines(first_line, 0, last_line - i, i);
5023 outofmem:
5024 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5026 /* ":s/pat//n" doesn't move the cursor */
5027 if (do_count)
5028 curwin->w_cursor = old_cursor;
5030 if (sub_nsubs)
5032 /* Set the '[ and '] marks. */
5033 curbuf->b_op_start.lnum = eap->line1;
5034 curbuf->b_op_end.lnum = line2;
5035 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5037 if (!global_busy)
5039 if (endcolumn)
5040 coladvance((colnr_T)MAXCOL);
5041 else
5042 beginline(BL_WHITE | BL_FIX);
5043 if (!do_sub_msg(do_count) && do_ask)
5044 MSG("");
5046 else
5047 global_need_beginline = TRUE;
5048 if (do_print)
5049 print_line(curwin->w_cursor.lnum, do_number, do_list);
5051 else if (!global_busy)
5053 if (got_int) /* interrupted */
5054 EMSG(_(e_interr));
5055 else if (got_match) /* did find something but nothing substituted */
5056 MSG("");
5057 else if (do_error) /* nothing found */
5058 EMSG2(_(e_patnotf2), get_search_pat());
5061 vim_free(regmatch.regprog);
5065 * Give message for number of substitutions.
5066 * Can also be used after a ":global" command.
5067 * Return TRUE if a message was given.
5070 do_sub_msg(count_only)
5071 int count_only; /* used 'n' flag for ":s" */
5073 int len = 0;
5076 * Only report substitutions when:
5077 * - more than 'report' substitutions
5078 * - command was typed by user, or number of changed lines > 'report'
5079 * - giving messages is not disabled by 'lazyredraw'
5081 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5082 || count_only)
5083 && messaging())
5085 if (got_int)
5087 STRCPY(msg_buf, _("(Interrupted) "));
5088 len = (int)STRLEN(msg_buf);
5090 if (sub_nsubs == 1)
5091 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5092 "%s", count_only ? _("1 match") : _("1 substitution"));
5093 else
5094 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5095 count_only ? _("%ld matches") : _("%ld substitutions"),
5096 sub_nsubs);
5097 len = (int)STRLEN(msg_buf);
5098 if (sub_nlines == 1)
5099 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5100 "%s", _(" on 1 line"));
5101 else
5102 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5103 _(" on %ld lines"), (long)sub_nlines);
5104 if (msg(msg_buf))
5105 /* save message to display it after redraw */
5106 set_keep_msg(msg_buf, 0);
5107 return TRUE;
5109 if (got_int)
5111 EMSG(_(e_interr));
5112 return TRUE;
5114 return FALSE;
5118 * Execute a global command of the form:
5120 * g/pattern/X : execute X on all lines where pattern matches
5121 * v/pattern/X : execute X on all lines where pattern does not match
5123 * where 'X' is an EX command
5125 * The command character (as well as the trailing slash) is optional, and
5126 * is assumed to be 'p' if missing.
5128 * This is implemented in two passes: first we scan the file for the pattern and
5129 * set a mark for each line that (not) matches. secondly we execute the command
5130 * for each line that has a mark. This is required because after deleting
5131 * lines we do not know where to search for the next match.
5133 void
5134 ex_global(eap)
5135 exarg_T *eap;
5137 linenr_T lnum; /* line number according to old situation */
5138 int ndone = 0;
5139 int type; /* first char of cmd: 'v' or 'g' */
5140 char_u *cmd; /* command argument */
5142 char_u delim; /* delimiter, normally '/' */
5143 char_u *pat;
5144 regmmatch_T regmatch;
5145 int match;
5146 int which_pat;
5148 if (global_busy)
5150 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5151 return;
5154 if (eap->forceit) /* ":global!" is like ":vglobal" */
5155 type = 'v';
5156 else
5157 type = *eap->cmd;
5158 cmd = eap->arg;
5159 which_pat = RE_LAST; /* default: use last used regexp */
5160 sub_nsubs = 0;
5161 sub_nlines = 0;
5164 * undocumented vi feature:
5165 * "\/" and "\?": use previous search pattern.
5166 * "\&": use previous substitute pattern.
5168 if (*cmd == '\\')
5170 ++cmd;
5171 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5173 EMSG(_(e_backslash));
5174 return;
5176 if (*cmd == '&')
5177 which_pat = RE_SUBST; /* use previous substitute pattern */
5178 else
5179 which_pat = RE_SEARCH; /* use previous search pattern */
5180 ++cmd;
5181 pat = (char_u *)"";
5183 else if (*cmd == NUL)
5185 EMSG(_("E148: Regular expression missing from global"));
5186 return;
5188 else
5190 delim = *cmd; /* get the delimiter */
5191 if (delim)
5192 ++cmd; /* skip delimiter if there is one */
5193 pat = cmd; /* remember start of pattern */
5194 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5195 if (cmd[0] == delim) /* end delimiter found */
5196 *cmd++ = NUL; /* replace it with a NUL */
5199 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5200 if (p_altkeymap && curwin->w_p_rl)
5201 lrFswap(pat,0);
5202 #endif
5204 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5206 EMSG(_(e_invcmd));
5207 return;
5211 * pass 1: set marks for each (not) matching line
5213 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5215 /* a match on this line? */
5216 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
5217 if ((type == 'g' && match) || (type == 'v' && !match))
5219 ml_setmarked(lnum);
5220 ndone++;
5222 line_breakcheck();
5226 * pass 2: execute the command for each line that has been marked
5228 if (got_int)
5229 MSG(_(e_interr));
5230 else if (ndone == 0)
5232 if (type == 'v')
5233 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5234 else
5235 smsg((char_u *)_(e_patnotf2), pat);
5237 else
5238 global_exe(cmd);
5240 ml_clearmarked(); /* clear rest of the marks */
5241 vim_free(regmatch.regprog);
5245 * Execute "cmd" on lines marked with ml_setmarked().
5247 void
5248 global_exe(cmd)
5249 char_u *cmd;
5251 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5252 linenr_T lnum; /* line number according to old situation */
5255 * Set current position only once for a global command.
5256 * If global_busy is set, setpcmark() will not do anything.
5257 * If there is an error, global_busy will be incremented.
5259 setpcmark();
5261 /* When the command writes a message, don't overwrite the command. */
5262 msg_didout = TRUE;
5264 global_need_beginline = FALSE;
5265 global_busy = 1;
5266 old_lcount = curbuf->b_ml.ml_line_count;
5267 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5269 curwin->w_cursor.lnum = lnum;
5270 curwin->w_cursor.col = 0;
5271 if (*cmd == NUL || *cmd == '\n')
5272 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5273 else
5274 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5275 ui_breakcheck();
5278 global_busy = 0;
5279 if (global_need_beginline)
5280 beginline(BL_WHITE | BL_FIX);
5281 else
5282 check_cursor(); /* cursor may be beyond the end of the line */
5284 /* the cursor may not have moved in the text but a change in a previous
5285 * line may move it on the screen */
5286 changed_line_abv_curs();
5288 /* If it looks like no message was written, allow overwriting the
5289 * command with the report for number of changes. */
5290 if (msg_col == 0 && msg_scrolled == 0)
5291 msg_didout = FALSE;
5293 /* If substitutes done, report number of substitutes, otherwise report
5294 * number of extra or deleted lines. */
5295 if (!do_sub_msg(FALSE))
5296 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5299 #ifdef FEAT_VIMINFO
5301 read_viminfo_sub_string(virp, force)
5302 vir_T *virp;
5303 int force;
5305 if (old_sub != NULL && force)
5306 vim_free(old_sub);
5307 if (force || old_sub == NULL)
5308 old_sub = viminfo_readstring(virp, 1, TRUE);
5309 return viminfo_readline(virp);
5312 void
5313 write_viminfo_sub_string(fp)
5314 FILE *fp;
5316 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5318 fprintf(fp, _("\n# Last Substitute String:\n$"));
5319 viminfo_writestring(fp, old_sub);
5322 #endif /* FEAT_VIMINFO */
5324 #if defined(EXITFREE) || defined(PROTO)
5325 void
5326 free_old_sub()
5328 vim_free(old_sub);
5330 #endif
5332 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5334 * Set up for a tagpreview.
5335 * Return TRUE when it was created.
5338 prepare_tagpreview(undo_sync)
5339 int undo_sync; /* sync undo when leaving the window */
5341 win_T *wp;
5343 # ifdef FEAT_GUI
5344 need_mouse_correct = TRUE;
5345 # endif
5348 * If there is already a preview window open, use that one.
5350 if (!curwin->w_p_pvw)
5352 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5353 if (wp->w_p_pvw)
5354 break;
5355 if (wp != NULL)
5356 win_enter(wp, undo_sync);
5357 else
5360 * There is no preview window open yet. Create one.
5362 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5363 == FAIL)
5364 return FALSE;
5365 curwin->w_p_pvw = TRUE;
5366 curwin->w_p_wfh = TRUE;
5367 # ifdef FEAT_SCROLLBIND
5368 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5369 # endif
5370 # ifdef FEAT_DIFF
5371 curwin->w_p_diff = FALSE; /* no 'diff' */
5372 # endif
5373 # ifdef FEAT_FOLDING
5374 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5375 # endif
5376 return TRUE;
5379 return FALSE;
5382 #endif
5386 * ":help": open a read-only window on a help file
5388 void
5389 ex_help(eap)
5390 exarg_T *eap;
5392 char_u *arg;
5393 char_u *tag;
5394 FILE *helpfd; /* file descriptor of help file */
5395 int n;
5396 int i;
5397 #ifdef FEAT_WINDOWS
5398 win_T *wp;
5399 #endif
5400 int num_matches;
5401 char_u **matches;
5402 char_u *p;
5403 int empty_fnum = 0;
5404 int alt_fnum = 0;
5405 buf_T *buf;
5406 #ifdef FEAT_MULTI_LANG
5407 int len;
5408 char_u *lang;
5409 #endif
5411 if (eap != NULL)
5414 * A ":help" command ends at the first LF, or at a '|' that is
5415 * followed by some text. Set nextcmd to the following command.
5417 for (arg = eap->arg; *arg; ++arg)
5419 if (*arg == '\n' || *arg == '\r'
5420 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5422 *arg++ = NUL;
5423 eap->nextcmd = arg;
5424 break;
5427 arg = eap->arg;
5429 if (eap->forceit && *arg == NUL)
5431 EMSG(_("E478: Don't panic!"));
5432 return;
5435 if (eap->skip) /* not executing commands */
5436 return;
5438 else
5439 arg = (char_u *)"";
5441 /* remove trailing blanks */
5442 p = arg + STRLEN(arg) - 1;
5443 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5444 *p-- = NUL;
5446 #ifdef FEAT_MULTI_LANG
5447 /* Check for a specified language */
5448 lang = check_help_lang(arg);
5449 #endif
5451 /* When no argument given go to the index. */
5452 if (*arg == NUL)
5453 arg = (char_u *)"help.txt";
5456 * Check if there is a match for the argument.
5458 n = find_help_tags(arg, &num_matches, &matches,
5459 eap != NULL && eap->forceit);
5461 i = 0;
5462 #ifdef FEAT_MULTI_LANG
5463 if (n != FAIL && lang != NULL)
5464 /* Find first item with the requested language. */
5465 for (i = 0; i < num_matches; ++i)
5467 len = (int)STRLEN(matches[i]);
5468 if (len > 3 && matches[i][len - 3] == '@'
5469 && STRICMP(matches[i] + len - 2, lang) == 0)
5470 break;
5472 #endif
5473 if (i >= num_matches || n == FAIL)
5475 #ifdef FEAT_MULTI_LANG
5476 if (lang != NULL)
5477 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5478 else
5479 #endif
5480 EMSG2(_("E149: Sorry, no help for %s"), arg);
5481 if (n != FAIL)
5482 FreeWild(num_matches, matches);
5483 return;
5486 /* The first match (in the requested language) is the best match. */
5487 tag = vim_strsave(matches[i]);
5488 FreeWild(num_matches, matches);
5490 #ifdef FEAT_GUI
5491 need_mouse_correct = TRUE;
5492 #endif
5495 * Re-use an existing help window or open a new one.
5496 * Always open a new one for ":tab help".
5498 if (!curwin->w_buffer->b_help
5499 #ifdef FEAT_WINDOWS
5500 || cmdmod.tab != 0
5501 #endif
5504 #ifdef FEAT_WINDOWS
5505 if (cmdmod.tab != 0)
5506 wp = NULL;
5507 else
5508 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5509 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5510 break;
5511 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5512 win_enter(wp, TRUE);
5513 else
5514 #endif
5517 * There is no help window yet.
5518 * Try to open the file specified by the "helpfile" option.
5520 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5522 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5523 goto erret;
5525 fclose(helpfd);
5527 #ifdef FEAT_WINDOWS
5528 /* Split off help window; put it at far top if no position
5529 * specified, the current window is vertically split and
5530 * narrow. */
5531 n = WSP_HELP;
5532 # ifdef FEAT_VERTSPLIT
5533 if (cmdmod.split == 0 && curwin->w_width != Columns
5534 && curwin->w_width < 80)
5535 n |= WSP_TOP;
5536 # endif
5537 if (win_split(0, n) == FAIL)
5538 goto erret;
5539 #else
5540 /* use current window */
5541 if (!can_abandon(curbuf, FALSE))
5542 goto erret;
5543 #endif
5545 #ifdef FEAT_WINDOWS
5546 if (curwin->w_height < p_hh)
5547 win_setheight((int)p_hh);
5548 #endif
5551 * Open help file (do_ecmd() will set b_help flag, readfile() will
5552 * set b_p_ro flag).
5553 * Set the alternate file to the previously edited file.
5555 alt_fnum = curbuf->b_fnum;
5556 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5557 ECMD_HIDE + ECMD_SET_HELP);
5558 if (!cmdmod.keepalt)
5559 curwin->w_alt_fnum = alt_fnum;
5560 empty_fnum = curbuf->b_fnum;
5564 if (!p_im)
5565 restart_edit = 0; /* don't want insert mode in help file */
5567 if (tag != NULL)
5568 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5570 /* Delete the empty buffer if we're not using it. Careful: autocommands
5571 * may have jumped to another window, check that the buffer is not in a
5572 * window. */
5573 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5575 buf = buflist_findnr(empty_fnum);
5576 if (buf != NULL && buf->b_nwindows == 0)
5577 wipe_buffer(buf, TRUE);
5580 /* keep the previous alternate file */
5581 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5582 curwin->w_alt_fnum = alt_fnum;
5584 erret:
5585 vim_free(tag);
5589 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5591 * In an argument search for a language specifiers in the form "@xx".
5592 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5593 * Returns NULL if not found.
5595 char_u *
5596 check_help_lang(arg)
5597 char_u *arg;
5599 int len = (int)STRLEN(arg);
5601 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5602 && ASCII_ISALPHA(arg[len - 1]))
5604 arg[len - 3] = NUL; /* remove the '@' */
5605 return arg + len - 2;
5607 return NULL;
5609 #endif
5612 * Return a heuristic indicating how well the given string matches. The
5613 * smaller the number, the better the match. This is the order of priorities,
5614 * from best match to worst match:
5615 * - Match with least alpha-numeric characters is better.
5616 * - Match with least total characters is better.
5617 * - Match towards the start is better.
5618 * - Match starting with "+" is worse (feature instead of command)
5619 * Assumption is made that the matched_string passed has already been found to
5620 * match some string for which help is requested. webb.
5623 help_heuristic(matched_string, offset, wrong_case)
5624 char_u *matched_string;
5625 int offset; /* offset for match */
5626 int wrong_case; /* no matching case */
5628 int num_letters;
5629 char_u *p;
5631 num_letters = 0;
5632 for (p = matched_string; *p; p++)
5633 if (ASCII_ISALNUM(*p))
5634 num_letters++;
5637 * Multiply the number of letters by 100 to give it a much bigger
5638 * weighting than the number of characters.
5639 * If there only is a match while ignoring case, add 5000.
5640 * If the match starts in the middle of a word, add 10000 to put it
5641 * somewhere in the last half.
5642 * If the match is more than 2 chars from the start, multiply by 200 to
5643 * put it after matches at the start.
5645 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5646 && ASCII_ISALNUM(matched_string[offset - 1]))
5647 offset += 10000;
5648 else if (offset > 2)
5649 offset *= 200;
5650 if (wrong_case)
5651 offset += 5000;
5652 /* Features are less interesting than the subjects themselves, but "+"
5653 * alone is not a feature. */
5654 if (matched_string[0] == '+' && matched_string[1] != NUL)
5655 offset += 100;
5656 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5660 * Compare functions for qsort() below, that checks the help heuristics number
5661 * that has been put after the tagname by find_tags().
5663 static int
5664 #ifdef __BORLANDC__
5665 _RTLENTRYF
5666 #endif
5667 help_compare(s1, s2)
5668 const void *s1;
5669 const void *s2;
5671 char *p1;
5672 char *p2;
5674 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5675 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5676 return strcmp(p1, p2);
5680 * Find all help tags matching "arg", sort them and return in matches[], with
5681 * the number of matches in num_matches.
5682 * The matches will be sorted with a "best" match algorithm.
5683 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5686 find_help_tags(arg, num_matches, matches, keep_lang)
5687 char_u *arg;
5688 int *num_matches;
5689 char_u ***matches;
5690 int keep_lang;
5692 char_u *s, *d;
5693 int i;
5694 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5695 "/*", "/\\*", "\"*", "**",
5696 "/\\(\\)",
5697 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5698 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5699 "[count]", "[quotex]", "[range]",
5700 "[pattern]", "\\|", "\\%$"};
5701 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5702 "/star", "/\\\\star", "quotestar", "starstar",
5703 "/\\\\(\\\\)",
5704 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5705 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5706 "\\[count]", "\\[quotex]", "\\[range]",
5707 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5708 int flags;
5710 d = IObuff; /* assume IObuff is long enough! */
5713 * Recognize a few exceptions to the rule. Some strings that contain '*'
5714 * with "star". Otherwise '*' is recognized as a wildcard.
5716 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5717 if (STRCMP(arg, mtable[i]) == 0)
5719 STRCPY(d, rtable[i]);
5720 break;
5723 if (i < 0) /* no match in table */
5725 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5726 * Also replace "\%^" and "\%(", they match every tag too.
5727 * Also "\zs", "\z1", etc.
5728 * Also "\@<", "\@=", "\@<=", etc.
5729 * And also "\_$" and "\_^". */
5730 if (arg[0] == '\\'
5731 && ((arg[1] != NUL && arg[2] == NUL)
5732 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5733 && arg[2] != NUL)))
5735 STRCPY(d, "/\\\\");
5736 STRCPY(d + 3, arg + 1);
5737 /* Check for "/\\_$", should be "/\\_\$" */
5738 if (d[3] == '_' && d[4] == '$')
5739 STRCPY(d + 4, "\\$");
5741 else
5743 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5744 if (arg[0] == '[' && (arg[1] == ':'
5745 || (arg[1] == '+' && arg[2] == '+')))
5746 *d++ = '\\';
5748 for (s = arg; *s; ++s)
5751 * Replace "|" with "bar" and '"' with "quote" to match the name of
5752 * the tags for these commands.
5753 * Replace "*" with ".*" and "?" with "." to match command line
5754 * completion.
5755 * Insert a backslash before '~', '$' and '.' to avoid their
5756 * special meaning.
5758 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5759 break;
5760 switch (*s)
5762 case '|': STRCPY(d, "bar");
5763 d += 3;
5764 continue;
5765 case '"': STRCPY(d, "quote");
5766 d += 5;
5767 continue;
5768 case '*': *d++ = '.';
5769 break;
5770 case '?': *d++ = '.';
5771 continue;
5772 case '$':
5773 case '.':
5774 case '~': *d++ = '\\';
5775 break;
5779 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5780 * ":help i_^_CTRL-D" work.
5781 * Insert '-' before and after "CTRL-X" when applicable.
5783 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5784 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5786 if (d > IObuff && d[-1] != '_')
5787 *d++ = '_'; /* prepend a '_' */
5788 STRCPY(d, "CTRL-");
5789 d += 5;
5790 if (*s < ' ')
5792 #ifdef EBCDIC
5793 *d++ = CtrlChar(*s);
5794 #else
5795 *d++ = *s + '@';
5796 #endif
5797 if (d[-1] == '\\')
5798 *d++ = '\\'; /* double a backslash */
5800 else
5801 *d++ = *++s;
5802 if (s[1] != NUL && s[1] != '_')
5803 *d++ = '_'; /* append a '_' */
5804 continue;
5806 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5807 *d++ = '\\';
5810 * Insert a backslash before a backslash after a slash, for search
5811 * pattern tags: "/\|" --> "/\\|".
5813 else if (s[0] == '\\' && s[1] != '\\'
5814 && *arg == '/' && s == arg + 1)
5815 *d++ = '\\';
5817 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5818 * "CTRL-\_CTRL-N" */
5819 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5821 STRCPY(d, "CTRL-\\\\");
5822 d += 7;
5823 s += 6;
5826 *d++ = *s;
5829 * If tag starts with ', toss everything after a second '. Fixes
5830 * CTRL-] on 'option'. (would include the trailing '.').
5832 if (*s == '\'' && s > arg && *arg == '\'')
5833 break;
5835 *d = NUL;
5839 *matches = (char_u **)"";
5840 *num_matches = 0;
5841 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5842 if (keep_lang)
5843 flags |= TAG_KEEP_LANG;
5844 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5845 && *num_matches > 0)
5846 /* Sort the matches found on the heuristic number that is after the
5847 * tag name. */
5848 qsort((void *)*matches, (size_t)*num_matches,
5849 sizeof(char_u *), help_compare);
5850 return OK;
5854 * After reading a help file: May cleanup a help buffer when syntax
5855 * highlighting is not used.
5857 void
5858 fix_help_buffer()
5860 linenr_T lnum;
5861 char_u *line;
5862 int in_example = FALSE;
5863 int len;
5864 char_u *p;
5865 char_u *rt;
5866 int mustfree;
5868 /* set filetype to "help". */
5869 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5871 #ifdef FEAT_SYN_HL
5872 if (!syntax_present(curbuf))
5873 #endif
5875 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5877 line = ml_get_buf(curbuf, lnum, FALSE);
5878 len = (int)STRLEN(line);
5879 if (in_example && len > 0 && !vim_iswhite(line[0]))
5881 /* End of example: non-white or '<' in first column. */
5882 if (line[0] == '<')
5884 /* blank-out a '<' in the first column */
5885 line = ml_get_buf(curbuf, lnum, TRUE);
5886 line[0] = ' ';
5888 in_example = FALSE;
5890 if (!in_example && len > 0)
5892 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5894 /* blank-out a '>' in the last column (start of example) */
5895 line = ml_get_buf(curbuf, lnum, TRUE);
5896 line[len - 1] = ' ';
5897 in_example = TRUE;
5899 else if (line[len - 1] == '~')
5901 /* blank-out a '~' at the end of line (header marker) */
5902 line = ml_get_buf(curbuf, lnum, TRUE);
5903 line[len - 1] = ' ';
5910 * In the "help.txt" file, add the locally added help files.
5911 * This uses the very first line in the help file.
5913 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5915 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5917 line = ml_get_buf(curbuf, lnum, FALSE);
5918 if (strstr((char *)line, "*local-additions*") != NULL)
5920 /* Go through all directories in 'runtimepath', skipping
5921 * $VIMRUNTIME. */
5922 p = p_rtp;
5923 while (*p != NUL)
5925 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5926 mustfree = FALSE;
5927 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5928 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5930 int fcount;
5931 char_u **fnames;
5932 FILE *fd;
5933 char_u *s;
5934 int fi;
5935 #ifdef FEAT_MBYTE
5936 vimconv_T vc;
5937 char_u *cp;
5938 #endif
5940 /* Find all "doc/ *.txt" files in this directory. */
5941 add_pathsep(NameBuff);
5942 STRCAT(NameBuff, "doc/*.txt");
5943 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5944 &fnames, EW_FILE|EW_SILENT) == OK
5945 && fcount > 0)
5947 for (fi = 0; fi < fcount; ++fi)
5949 fd = mch_fopen((char *)fnames[fi], "r");
5950 if (fd != NULL)
5952 vim_fgets(IObuff, IOSIZE, fd);
5953 if (IObuff[0] == '*'
5954 && (s = vim_strchr(IObuff + 1, '*'))
5955 != NULL)
5957 #ifdef FEAT_MBYTE
5958 int this_utf = MAYBE;
5959 #endif
5960 /* Change tag definition to a
5961 * reference and remove <CR>/<NL>. */
5962 IObuff[0] = '|';
5963 *s = '|';
5964 while (*s != NUL)
5966 if (*s == '\r' || *s == '\n')
5967 *s = NUL;
5968 #ifdef FEAT_MBYTE
5969 /* The text is utf-8 when a byte
5970 * above 127 is found and no
5971 * illegal byte sequence is found.
5973 if (*s >= 0x80 && this_utf != FALSE)
5975 int l;
5977 this_utf = TRUE;
5978 l = utf_ptr2len(s);
5979 if (l == 1)
5980 this_utf = FALSE;
5981 s += l - 1;
5983 #endif
5984 ++s;
5986 #ifdef FEAT_MBYTE
5987 /* The help file is latin1 or utf-8;
5988 * conversion to the current
5989 * 'encoding' may be required. */
5990 vc.vc_type = CONV_NONE;
5991 convert_setup(&vc, (char_u *)(
5992 this_utf == TRUE ? "utf-8"
5993 : "latin1"), p_enc);
5994 if (vc.vc_type == CONV_NONE)
5995 /* No conversion needed. */
5996 cp = IObuff;
5997 else
5999 /* Do the conversion. If it fails
6000 * use the unconverted text. */
6001 cp = string_convert(&vc, IObuff,
6002 NULL);
6003 if (cp == NULL)
6004 cp = IObuff;
6006 convert_setup(&vc, NULL, NULL);
6008 ml_append(lnum, cp, (colnr_T)0, FALSE);
6009 if (cp != IObuff)
6010 vim_free(cp);
6011 #else
6012 ml_append(lnum, IObuff, (colnr_T)0,
6013 FALSE);
6014 #endif
6015 ++lnum;
6017 fclose(fd);
6020 FreeWild(fcount, fnames);
6023 if (mustfree)
6024 vim_free(rt);
6026 break;
6033 * ":exusage"
6035 /*ARGSUSED*/
6036 void
6037 ex_exusage(eap)
6038 exarg_T *eap;
6040 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6044 * ":viusage"
6046 /*ARGSUSED*/
6047 void
6048 ex_viusage(eap)
6049 exarg_T *eap;
6051 do_cmdline_cmd((char_u *)"help normal-index");
6054 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6055 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang));
6058 * ":helptags"
6060 void
6061 ex_helptags(eap)
6062 exarg_T *eap;
6064 garray_T ga;
6065 int i, j;
6066 int len;
6067 #ifdef FEAT_MULTI_LANG
6068 char_u lang[2];
6069 #endif
6070 char_u ext[5];
6071 char_u fname[8];
6072 int filecount;
6073 char_u **files;
6075 if (!mch_isdir(eap->arg))
6077 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6078 return;
6081 #ifdef FEAT_MULTI_LANG
6082 /* Get a list of all files in the directory. */
6083 STRCPY(NameBuff, eap->arg);
6084 add_pathsep(NameBuff);
6085 STRCAT(NameBuff, "*");
6086 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6087 EW_FILE|EW_SILENT) == FAIL
6088 || filecount == 0)
6090 EMSG2("E151: No match: %s", NameBuff);
6091 return;
6094 /* Go over all files in the directory to find out what languages are
6095 * present. */
6096 ga_init2(&ga, 1, 10);
6097 for (i = 0; i < filecount; ++i)
6099 len = (int)STRLEN(files[i]);
6100 if (len > 4)
6102 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6104 /* ".txt" -> language "en" */
6105 lang[0] = 'e';
6106 lang[1] = 'n';
6108 else if (files[i][len - 4] == '.'
6109 && ASCII_ISALPHA(files[i][len - 3])
6110 && ASCII_ISALPHA(files[i][len - 2])
6111 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6113 /* ".abx" -> language "ab" */
6114 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6115 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6117 else
6118 continue;
6120 /* Did we find this language already? */
6121 for (j = 0; j < ga.ga_len; j += 2)
6122 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6123 break;
6124 if (j == ga.ga_len)
6126 /* New language, add it. */
6127 if (ga_grow(&ga, 2) == FAIL)
6128 break;
6129 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6130 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6136 * Loop over the found languages to generate a tags file for each one.
6138 for (j = 0; j < ga.ga_len; j += 2)
6140 STRCPY(fname, "tags-xx");
6141 fname[5] = ((char_u *)ga.ga_data)[j];
6142 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6143 if (fname[5] == 'e' && fname[6] == 'n')
6145 /* English is an exception: use ".txt" and "tags". */
6146 fname[4] = NUL;
6147 STRCPY(ext, ".txt");
6149 else
6151 /* Language "ab" uses ".abx" and "tags-ab". */
6152 STRCPY(ext, ".xxx");
6153 ext[1] = fname[5];
6154 ext[2] = fname[6];
6156 helptags_one(eap->arg, ext, fname);
6159 ga_clear(&ga);
6160 FreeWild(filecount, files);
6162 #else
6163 /* No language support, just use "*.txt" and "tags". */
6164 helptags_one(eap->arg, (char_u *)".txt", (char_u *)"tags");
6165 #endif
6168 static void
6169 helptags_one(dir, ext, tagfname)
6170 char_u *dir; /* doc directory */
6171 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6172 char_u *tagfname; /* "tags" for English, "tags-it" for Italian. */
6174 FILE *fd_tags;
6175 FILE *fd;
6176 garray_T ga;
6177 int filecount;
6178 char_u **files;
6179 char_u *p1, *p2;
6180 int fi;
6181 char_u *s;
6182 int i;
6183 char_u *fname;
6184 # ifdef FEAT_MBYTE
6185 int utf8 = MAYBE;
6186 int this_utf8;
6187 int firstline;
6188 int mix = FALSE; /* detected mixed encodings */
6189 # endif
6192 * Find all *.txt files.
6194 STRCPY(NameBuff, dir);
6195 add_pathsep(NameBuff);
6196 STRCAT(NameBuff, "*");
6197 STRCAT(NameBuff, ext);
6198 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6199 EW_FILE|EW_SILENT) == FAIL
6200 || filecount == 0)
6202 if (!got_int)
6203 EMSG2("E151: No match: %s", NameBuff);
6204 return;
6208 * Open the tags file for writing.
6209 * Do this before scanning through all the files.
6211 STRCPY(NameBuff, dir);
6212 add_pathsep(NameBuff);
6213 STRCAT(NameBuff, tagfname);
6214 fd_tags = mch_fopen((char *)NameBuff, "w");
6215 if (fd_tags == NULL)
6217 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6218 FreeWild(filecount, files);
6219 return;
6223 * If generating tags for "$VIMRUNTIME/doc" add the "help-tags" tag.
6225 ga_init2(&ga, (int)sizeof(char_u *), 100);
6226 if (fullpathcmp((char_u *)"$VIMRUNTIME/doc", dir, FALSE) == FPC_SAME)
6228 if (ga_grow(&ga, 1) == FAIL)
6229 got_int = TRUE;
6230 else
6232 s = alloc(18 + (unsigned)STRLEN(tagfname));
6233 if (s == NULL)
6234 got_int = TRUE;
6235 else
6237 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6238 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6239 ++ga.ga_len;
6245 * Go over all the files and extract the tags.
6247 for (fi = 0; fi < filecount && !got_int; ++fi)
6249 fd = mch_fopen((char *)files[fi], "r");
6250 if (fd == NULL)
6252 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6253 continue;
6255 fname = gettail(files[fi]);
6257 # ifdef FEAT_MBYTE
6258 firstline = TRUE;
6259 # endif
6260 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6262 # ifdef FEAT_MBYTE
6263 if (firstline)
6265 /* Detect utf-8 file by a non-ASCII char in the first line. */
6266 this_utf8 = MAYBE;
6267 for (s = IObuff; *s != NUL; ++s)
6268 if (*s >= 0x80)
6270 int l;
6272 this_utf8 = TRUE;
6273 l = utf_ptr2len(s);
6274 if (l == 1)
6276 /* Illegal UTF-8 byte sequence. */
6277 this_utf8 = FALSE;
6278 break;
6280 s += l - 1;
6282 if (this_utf8 == MAYBE) /* only ASCII characters found */
6283 this_utf8 = FALSE;
6284 if (utf8 == MAYBE) /* first file */
6285 utf8 = this_utf8;
6286 else if (utf8 != this_utf8)
6288 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6289 mix = !got_int;
6290 got_int = TRUE;
6292 firstline = FALSE;
6294 # endif
6295 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6296 while (p1 != NULL)
6298 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6299 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6301 for (s = p1 + 1; s < p2; ++s)
6302 if (*s == ' ' || *s == '\t' || *s == '|')
6303 break;
6306 * Only accept a *tag* when it consists of valid
6307 * characters, there is white space before it and is
6308 * followed by a white character or end-of-line.
6310 if (s == p2
6311 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6312 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6313 || s[1] == '\0'))
6315 *p2 = '\0';
6316 ++p1;
6317 if (ga_grow(&ga, 1) == FAIL)
6319 got_int = TRUE;
6320 break;
6322 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6323 if (s == NULL)
6325 got_int = TRUE;
6326 break;
6328 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6329 ++ga.ga_len;
6330 sprintf((char *)s, "%s\t%s", p1, fname);
6332 /* find next '*' */
6333 p2 = vim_strchr(p2 + 1, '*');
6336 p1 = p2;
6338 line_breakcheck();
6341 fclose(fd);
6344 FreeWild(filecount, files);
6346 if (!got_int)
6349 * Sort the tags.
6351 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6354 * Check for duplicates.
6356 for (i = 1; i < ga.ga_len; ++i)
6358 p1 = ((char_u **)ga.ga_data)[i - 1];
6359 p2 = ((char_u **)ga.ga_data)[i];
6360 while (*p1 == *p2)
6362 if (*p2 == '\t')
6364 *p2 = NUL;
6365 vim_snprintf((char *)NameBuff, MAXPATHL,
6366 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6367 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6368 EMSG(NameBuff);
6369 *p2 = '\t';
6370 break;
6372 ++p1;
6373 ++p2;
6377 # ifdef FEAT_MBYTE
6378 if (utf8 == TRUE)
6379 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6380 # endif
6383 * Write the tags into the file.
6385 for (i = 0; i < ga.ga_len; ++i)
6387 s = ((char_u **)ga.ga_data)[i];
6388 if (STRNCMP(s, "help-tags\t", 10) == 0)
6389 /* help-tags entry was added in formatted form */
6390 fputs((char *)s, fd_tags);
6391 else
6393 fprintf(fd_tags, "%s\t/*", s);
6394 for (p1 = s; *p1 != '\t'; ++p1)
6396 /* insert backslash before '\\' and '/' */
6397 if (*p1 == '\\' || *p1 == '/')
6398 putc('\\', fd_tags);
6399 putc(*p1, fd_tags);
6401 fprintf(fd_tags, "*\n");
6405 #ifdef FEAT_MBYTE
6406 if (mix)
6407 got_int = FALSE; /* continue with other languages */
6408 #endif
6410 for (i = 0; i < ga.ga_len; ++i)
6411 vim_free(((char_u **)ga.ga_data)[i]);
6412 ga_clear(&ga);
6413 fclose(fd_tags); /* there is no check for an error... */
6415 #endif
6417 #if defined(FEAT_SIGNS) || defined(PROTO)
6420 * Struct to hold the sign properties.
6422 typedef struct sign sign_T;
6424 struct sign
6426 sign_T *sn_next; /* next sign in list */
6427 int sn_typenr; /* type number of sign (negative if not equal
6428 to name) */
6429 char_u *sn_name; /* name of sign */
6430 char_u *sn_icon; /* name of pixmap */
6431 #ifdef FEAT_SIGN_ICONS
6432 void *sn_image; /* icon image */
6433 #endif
6434 char_u *sn_text; /* text used instead of pixmap */
6435 int sn_line_hl; /* highlight ID for line */
6436 int sn_text_hl; /* highlight ID for text */
6439 static sign_T *first_sign = NULL;
6440 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6442 static void sign_list_defined __ARGS((sign_T *sp));
6445 * ":sign" command
6447 void
6448 ex_sign(eap)
6449 exarg_T *eap;
6451 char_u *arg = eap->arg;
6452 char_u *p;
6453 int idx;
6454 sign_T *sp;
6455 sign_T *sp_prev;
6456 buf_T *buf;
6457 static char *cmds[] = {
6458 "define",
6459 #define SIGNCMD_DEFINE 0
6460 "undefine",
6461 #define SIGNCMD_UNDEFINE 1
6462 "list",
6463 #define SIGNCMD_LIST 2
6464 "place",
6465 #define SIGNCMD_PLACE 3
6466 "unplace",
6467 #define SIGNCMD_UNPLACE 4
6468 "jump",
6469 #define SIGNCMD_JUMP 5
6470 #define SIGNCMD_LAST 6
6473 /* Parse the subcommand. */
6474 p = skiptowhite(arg);
6475 if (*p != NUL)
6476 *p++ = NUL;
6477 for (idx = 0; ; ++idx)
6479 if (idx == SIGNCMD_LAST)
6481 EMSG2(_("E160: Unknown sign command: %s"), arg);
6482 return;
6484 if (STRCMP(arg, cmds[idx]) == 0)
6485 break;
6487 arg = skipwhite(p);
6489 if (idx <= SIGNCMD_LIST)
6492 * Define, undefine or list signs.
6494 if (idx == SIGNCMD_LIST && *arg == NUL)
6496 /* ":sign list": list all defined signs */
6497 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6498 sign_list_defined(sp);
6500 else if (*arg == NUL)
6501 EMSG(_("E156: Missing sign name"));
6502 else
6504 p = skiptowhite(arg);
6505 if (*p != NUL)
6506 *p++ = NUL;
6507 sp_prev = NULL;
6508 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6510 if (STRCMP(sp->sn_name, arg) == 0)
6511 break;
6512 sp_prev = sp;
6514 if (idx == SIGNCMD_DEFINE)
6516 /* ":sign define {name} ...": define a sign */
6517 if (sp == NULL)
6519 /* Allocate a new sign. */
6520 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6521 if (sp == NULL)
6522 return;
6523 if (sp_prev == NULL)
6524 first_sign = sp;
6525 else
6526 sp_prev->sn_next = sp;
6527 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6529 /* If the name is a number use that for the typenr,
6530 * otherwise use a negative number. */
6531 if (VIM_ISDIGIT(*arg))
6532 sp->sn_typenr = atoi((char *)arg);
6533 else
6535 sign_T *lp;
6536 int start = last_sign_typenr;
6538 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6540 if (lp->sn_typenr == last_sign_typenr)
6542 --last_sign_typenr;
6543 if (last_sign_typenr == 0)
6544 last_sign_typenr = MAX_TYPENR;
6545 if (last_sign_typenr == start)
6547 EMSG(_("E612: Too many signs defined"));
6548 return;
6550 lp = first_sign;
6551 continue;
6555 sp->sn_typenr = last_sign_typenr--;
6556 if (last_sign_typenr == 0)
6557 last_sign_typenr = MAX_TYPENR; /* wrap around */
6561 /* set values for a defined sign. */
6562 for (;;)
6564 arg = skipwhite(p);
6565 if (*arg == NUL)
6566 break;
6567 p = skiptowhite_esc(arg);
6568 if (STRNCMP(arg, "icon=", 5) == 0)
6570 arg += 5;
6571 vim_free(sp->sn_icon);
6572 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6573 backslash_halve(sp->sn_icon);
6574 #ifdef FEAT_SIGN_ICONS
6575 if (gui.in_use)
6577 out_flush();
6578 if (sp->sn_image != NULL)
6579 gui_mch_destroy_sign(sp->sn_image);
6580 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6582 #endif
6584 else if (STRNCMP(arg, "text=", 5) == 0)
6586 char_u *s;
6587 int cells;
6588 int len;
6590 arg += 5;
6591 #ifdef FEAT_MBYTE
6592 /* Count cells and check for non-printable chars */
6593 if (has_mbyte)
6595 cells = 0;
6596 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6598 if (!vim_isprintc((*mb_ptr2char)(s)))
6599 break;
6600 cells += (*mb_ptr2cells)(s);
6603 else
6604 #endif
6606 for (s = arg; s < p; ++s)
6607 if (!vim_isprintc(*s))
6608 break;
6609 cells = (int)(s - arg);
6611 /* Currently must be one or two display cells */
6612 if (s != p || cells < 1 || cells > 2)
6614 *p = NUL;
6615 EMSG2(_("E239: Invalid sign text: %s"), arg);
6616 return;
6619 vim_free(sp->sn_text);
6620 /* Allocate one byte more if we need to pad up
6621 * with a space. */
6622 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6623 sp->sn_text = vim_strnsave(arg, len);
6625 if (sp->sn_text != NULL && cells == 1)
6626 STRCPY(sp->sn_text + len - 1, " ");
6628 else if (STRNCMP(arg, "linehl=", 7) == 0)
6630 arg += 7;
6631 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6633 else if (STRNCMP(arg, "texthl=", 7) == 0)
6635 arg += 7;
6636 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6638 else
6640 EMSG2(_(e_invarg2), arg);
6641 return;
6645 else if (sp == NULL)
6646 EMSG2(_("E155: Unknown sign: %s"), arg);
6647 else if (idx == SIGNCMD_LIST)
6648 /* ":sign list {name}" */
6649 sign_list_defined(sp);
6650 else
6652 /* ":sign undefine {name}" */
6653 vim_free(sp->sn_name);
6654 vim_free(sp->sn_icon);
6655 #ifdef FEAT_SIGN_ICONS
6656 if (sp->sn_image != NULL)
6658 out_flush();
6659 gui_mch_destroy_sign(sp->sn_image);
6661 #endif
6662 vim_free(sp->sn_text);
6663 if (sp_prev == NULL)
6664 first_sign = sp->sn_next;
6665 else
6666 sp_prev->sn_next = sp->sn_next;
6667 vim_free(sp);
6671 else
6673 int id = -1;
6674 linenr_T lnum = -1;
6675 char_u *sign_name = NULL;
6676 char_u *arg1;
6678 if (*arg == NUL)
6680 if (idx == SIGNCMD_PLACE)
6682 /* ":sign place": list placed signs in all buffers */
6683 sign_list_placed(NULL);
6685 else if (idx == SIGNCMD_UNPLACE)
6687 /* ":sign unplace": remove placed sign at cursor */
6688 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6689 if (id > 0)
6691 buf_delsign(curwin->w_buffer, id);
6692 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6694 else
6695 EMSG(_("E159: Missing sign number"));
6697 else
6698 EMSG(_(e_argreq));
6699 return;
6702 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6704 /* ":sign unplace *": remove all placed signs */
6705 buf_delete_all_signs();
6706 return;
6709 /* first arg could be placed sign id */
6710 arg1 = arg;
6711 if (VIM_ISDIGIT(*arg))
6713 id = getdigits(&arg);
6714 if (!vim_iswhite(*arg) && *arg != NUL)
6716 id = -1;
6717 arg = arg1;
6719 else
6721 arg = skipwhite(arg);
6722 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6724 /* ":sign unplace {id}": remove placed sign by number */
6725 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6726 if ((lnum = buf_delsign(buf, id)) != 0)
6727 update_debug_sign(buf, lnum);
6728 return;
6734 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6735 * Leave "arg" pointing to {fname}.
6737 for (;;)
6739 if (STRNCMP(arg, "line=", 5) == 0)
6741 arg += 5;
6742 lnum = atoi((char *)arg);
6743 arg = skiptowhite(arg);
6745 else if (STRNCMP(arg, "name=", 5) == 0)
6747 arg += 5;
6748 sign_name = arg;
6749 arg = skiptowhite(arg);
6750 if (*arg != NUL)
6751 *arg++ = NUL;
6753 else if (STRNCMP(arg, "file=", 5) == 0)
6755 arg += 5;
6756 buf = buflist_findname(arg);
6757 break;
6759 else if (STRNCMP(arg, "buffer=", 7) == 0)
6761 arg += 7;
6762 buf = buflist_findnr((int)getdigits(&arg));
6763 if (*skipwhite(arg) != NUL)
6764 EMSG(_(e_trailing));
6765 break;
6767 else
6769 EMSG(_(e_invarg));
6770 return;
6772 arg = skipwhite(arg);
6775 if (buf == NULL)
6777 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6779 else if (id <= 0)
6781 if (lnum >= 0 || sign_name != NULL)
6782 EMSG(_(e_invarg));
6783 else
6784 /* ":sign place file={fname}": list placed signs in one file */
6785 sign_list_placed(buf);
6787 else if (idx == SIGNCMD_JUMP)
6789 /* ":sign jump {id} file={fname}" */
6790 if (lnum >= 0 || sign_name != NULL)
6791 EMSG(_(e_invarg));
6792 else if ((lnum = buf_findsign(buf, id)) > 0)
6793 { /* goto a sign ... */
6794 if (buf_jump_open_win(buf) != NULL)
6795 { /* ... in a current window */
6796 curwin->w_cursor.lnum = lnum;
6797 check_cursor_lnum();
6798 beginline(BL_WHITE);
6800 else
6801 { /* ... not currently in a window */
6802 char_u *cmd;
6804 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6805 if (cmd == NULL)
6806 return;
6807 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6808 do_cmdline_cmd(cmd);
6809 vim_free(cmd);
6811 #ifdef FEAT_FOLDING
6812 foldOpenCursor();
6813 #endif
6815 else
6816 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6818 else if (idx == SIGNCMD_UNPLACE)
6820 /* ":sign unplace {id} file={fname}" */
6821 if (lnum >= 0 || sign_name != NULL)
6822 EMSG(_(e_invarg));
6823 else
6825 lnum = buf_delsign(buf, id);
6826 update_debug_sign(buf, lnum);
6829 /* idx == SIGNCMD_PLACE */
6830 else if (sign_name != NULL)
6832 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6833 if (STRCMP(sp->sn_name, sign_name) == 0)
6834 break;
6835 if (sp == NULL)
6837 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6838 return;
6840 if (lnum > 0)
6841 /* ":sign place {id} line={lnum} name={name} file={fname}":
6842 * place a sign */
6843 buf_addsign(buf, id, lnum, sp->sn_typenr);
6844 else
6845 /* ":sign place {id} file={fname}": change sign type */
6846 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6847 update_debug_sign(buf, lnum);
6849 else
6850 EMSG(_(e_invarg));
6854 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6856 * Allocate the icons. Called when the GUI has started. Allows defining
6857 * signs before it starts.
6859 void
6860 sign_gui_started()
6862 sign_T *sp;
6864 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6865 if (sp->sn_icon != NULL)
6866 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6868 #endif
6871 * List one sign.
6873 static void
6874 sign_list_defined(sp)
6875 sign_T *sp;
6877 char_u *p;
6879 smsg((char_u *)"sign %s", sp->sn_name);
6880 if (sp->sn_icon != NULL)
6882 MSG_PUTS(" icon=");
6883 msg_outtrans(sp->sn_icon);
6884 #ifdef FEAT_SIGN_ICONS
6885 if (sp->sn_image == NULL)
6886 MSG_PUTS(_(" (NOT FOUND)"));
6887 #else
6888 MSG_PUTS(_(" (not supported)"));
6889 #endif
6891 if (sp->sn_text != NULL)
6893 MSG_PUTS(" text=");
6894 msg_outtrans(sp->sn_text);
6896 if (sp->sn_line_hl > 0)
6898 MSG_PUTS(" linehl=");
6899 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6900 if (p == NULL)
6901 MSG_PUTS("NONE");
6902 else
6903 msg_puts(p);
6905 if (sp->sn_text_hl > 0)
6907 MSG_PUTS(" texthl=");
6908 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6909 if (p == NULL)
6910 MSG_PUTS("NONE");
6911 else
6912 msg_puts(p);
6917 * Get highlighting attribute for sign "typenr".
6918 * If "line" is TRUE: line highl, if FALSE: text highl.
6921 sign_get_attr(typenr, line)
6922 int typenr;
6923 int line;
6925 sign_T *sp;
6927 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6928 if (sp->sn_typenr == typenr)
6930 if (line)
6932 if (sp->sn_line_hl > 0)
6933 return syn_id2attr(sp->sn_line_hl);
6935 else
6937 if (sp->sn_text_hl > 0)
6938 return syn_id2attr(sp->sn_text_hl);
6940 break;
6942 return 0;
6946 * Get text mark for sign "typenr".
6947 * Returns NULL if there isn't one.
6949 char_u *
6950 sign_get_text(typenr)
6951 int typenr;
6953 sign_T *sp;
6955 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6956 if (sp->sn_typenr == typenr)
6957 return sp->sn_text;
6958 return NULL;
6961 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6962 void *
6963 sign_get_image(typenr)
6964 int typenr; /* the attribute which may have a sign */
6966 sign_T *sp;
6968 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6969 if (sp->sn_typenr == typenr)
6970 return sp->sn_image;
6971 return NULL;
6973 #endif
6976 * Get the name of a sign by its typenr.
6978 char_u *
6979 sign_typenr2name(typenr)
6980 int typenr;
6982 sign_T *sp;
6984 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6985 if (sp->sn_typenr == typenr)
6986 return sp->sn_name;
6987 return (char_u *)_("[Deleted]");
6990 #endif
6992 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
6994 * ":drop"
6995 * Opens the first argument in a window. When there are two or more arguments
6996 * the argument list is redefined.
6998 void
6999 ex_drop(eap)
7000 exarg_T *eap;
7002 int split = FALSE;
7003 win_T *wp;
7004 buf_T *buf;
7005 # ifdef FEAT_WINDOWS
7006 tabpage_T *tp;
7007 # endif
7010 * Check if the first argument is already being edited in a window. If
7011 * so, jump to that window.
7012 * We would actually need to check all arguments, but that's complicated
7013 * and mostly only one file is dropped.
7014 * This also ignores wildcards, since it is very unlikely the user is
7015 * editing a file name with a wildcard character.
7017 set_arglist(eap->arg);
7020 * Expanding wildcards may result in an empty argument list. E.g. when
7021 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7022 * already did an error message for this.
7024 if (ARGCOUNT == 0)
7025 return;
7027 # ifdef FEAT_WINDOWS
7028 if (cmdmod.tab)
7030 /* ":tab drop file ...": open a tab for each argument that isn't
7031 * edited in a window yet. It's like ":tab all" but without closing
7032 * windows or tabs. */
7033 ex_all(eap);
7035 else
7036 # endif
7038 /* ":drop file ...": Edit the first argument. Jump to an existing
7039 * window if possible, edit in current window if the current buffer
7040 * can be abandoned, otherwise open a new window. */
7041 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7043 FOR_ALL_TAB_WINDOWS(tp, wp)
7045 if (wp->w_buffer == buf)
7047 # ifdef FEAT_WINDOWS
7048 goto_tabpage_win(tp, wp);
7049 # endif
7050 curwin->w_arg_idx = 0;
7051 return;
7056 * Check whether the current buffer is changed. If so, we will need
7057 * to split the current window or data could be lost.
7058 * Skip the check if the 'hidden' option is set, as in this case the
7059 * buffer won't be lost.
7061 if (!P_HID(curbuf))
7063 # ifdef FEAT_WINDOWS
7064 ++emsg_off;
7065 # endif
7066 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7067 # ifdef FEAT_WINDOWS
7068 --emsg_off;
7069 # else
7070 if (split)
7071 return;
7072 # endif
7075 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7076 if (split)
7078 eap->cmdidx = CMD_sfirst;
7079 eap->cmd[0] = 's';
7081 else
7082 eap->cmdidx = CMD_first;
7083 ex_rewind(eap);
7086 #endif