Merged from the latest developing branch.
[MacVim/jjgod.git] / src / ex_cmds.c
blob46671dca0ab9a1d253bc38620fbd76092f7b35e2
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 succesfully 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 like all lines in the buffer changed. Need to update
3588 * automatic folding. */
3589 foldUpdateAll(curwin);
3590 #endif
3592 /* Change directories when the 'acd' option is set. */
3593 DO_AUTOCHDIR
3596 * Careful: open_buffer() and apply_autocmds() may change the current
3597 * buffer and window.
3599 lnum = curwin->w_cursor.lnum;
3600 topline = curwin->w_topline;
3601 if (!oldbuf) /* need to read the file */
3603 #if defined(HAS_SWAP_EXISTS_ACTION)
3604 swap_exists_action = SEA_DIALOG;
3605 #endif
3606 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3609 * Open the buffer and read the file.
3611 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3612 if (should_abort(open_buffer(FALSE, eap)))
3613 retval = FAIL;
3614 #else
3615 (void)open_buffer(FALSE, eap);
3616 #endif
3618 #if defined(HAS_SWAP_EXISTS_ACTION)
3619 if (swap_exists_action == SEA_QUIT)
3620 retval = FAIL;
3621 handle_swap_exists(old_curbuf);
3622 #endif
3624 #ifdef FEAT_AUTOCMD
3625 else
3627 /* Read the modelines, but only to set window-local options. Any
3628 * buffer-local options have already been set and may have been
3629 * changed by the user. */
3630 do_modelines(OPT_WINONLY);
3632 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3633 &retval);
3634 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3635 &retval);
3637 check_arg_idx(curwin);
3638 #endif
3641 * If autocommands change the cursor position or topline, we should
3642 * keep it.
3644 if (curwin->w_cursor.lnum != lnum)
3646 newlnum = curwin->w_cursor.lnum;
3647 newcol = curwin->w_cursor.col;
3649 if (curwin->w_topline == topline)
3650 topline = 0;
3652 /* Even when cursor didn't move we need to recompute topline. */
3653 changed_line_abv_curs();
3655 #ifdef FEAT_TITLE
3656 maketitle();
3657 #endif
3660 #ifdef FEAT_DIFF
3661 /* Tell the diff stuff that this buffer is new and/or needs updating.
3662 * Also needed when re-editing the same buffer, because unloading will
3663 * have removed it as a diff buffer. */
3664 if (curwin->w_p_diff)
3666 diff_buf_add(curbuf);
3667 diff_invalidate(curbuf);
3669 #endif
3671 #ifdef FEAT_SPELL
3672 /* If the window options were changed may need to set the spell language.
3673 * Can only do this after the buffer has been properly setup. */
3674 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3675 did_set_spelllang(curbuf);
3676 #endif
3678 if (command == NULL)
3680 if (newcol >= 0) /* position set by autocommands */
3682 curwin->w_cursor.lnum = newlnum;
3683 curwin->w_cursor.col = newcol;
3684 check_cursor();
3686 else if (newlnum > 0) /* line number from caller or old position */
3688 curwin->w_cursor.lnum = newlnum;
3689 check_cursor_lnum();
3690 if (solcol >= 0 && !p_sol)
3692 /* 'sol' is off: Use last known column. */
3693 curwin->w_cursor.col = solcol;
3694 check_cursor_col();
3695 #ifdef FEAT_VIRTUALEDIT
3696 curwin->w_cursor.coladd = 0;
3697 #endif
3698 curwin->w_set_curswant = TRUE;
3700 else
3701 beginline(BL_SOL | BL_FIX);
3703 else /* no line number, go to last line in Ex mode */
3705 if (exmode_active)
3706 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3707 beginline(BL_WHITE | BL_FIX);
3711 #ifdef FEAT_WINDOWS
3712 /* Check if cursors in other windows on the same buffer are still valid */
3713 check_lnums(FALSE);
3714 #endif
3717 * Did not read the file, need to show some info about the file.
3718 * Do this after setting the cursor.
3720 if (oldbuf
3721 #ifdef FEAT_AUTOCMD
3722 && !auto_buf
3723 #endif
3726 int msg_scroll_save = msg_scroll;
3728 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3729 * message. */
3730 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3731 msg_scroll = FALSE;
3732 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3733 check_for_delay(FALSE);
3734 msg_start();
3735 msg_scroll = msg_scroll_save;
3736 msg_scrolled_ign = TRUE;
3738 fileinfo(FALSE, TRUE, FALSE);
3740 msg_scrolled_ign = FALSE;
3743 if (command != NULL)
3744 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3746 #ifdef FEAT_KEYMAP
3747 if (curbuf->b_kmap_state & KEYMAP_INIT)
3748 keymap_init();
3749 #endif
3751 --RedrawingDisabled;
3752 if (!skip_redraw)
3754 n = p_so;
3755 if (topline == 0 && command == NULL)
3756 p_so = 999; /* force cursor halfway the window */
3757 update_topline();
3758 #ifdef FEAT_SCROLLBIND
3759 curwin->w_scbind_pos = curwin->w_topline;
3760 #endif
3761 p_so = n;
3762 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3765 if (p_im)
3766 need_start_insertmode = TRUE;
3768 /* Change directories when the 'acd' option is set. */
3769 DO_AUTOCHDIR
3771 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3772 if (gui.in_use && curbuf->b_ffname != NULL)
3774 # ifdef FEAT_SUN_WORKSHOP
3775 if (usingSunWorkShop)
3776 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3777 # endif
3778 # ifdef FEAT_NETBEANS_INTG
3779 if (usingNetbeans & ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3780 netbeans_file_opened(curbuf);
3781 # endif
3783 #endif
3785 theend:
3786 #ifdef FEAT_AUTOCMD
3787 if (did_set_swapcommand)
3788 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3789 #endif
3790 #ifdef FEAT_BROWSE
3791 vim_free(browse_file);
3792 #endif
3793 vim_free(free_fname);
3794 return retval;
3797 #ifdef FEAT_AUTOCMD
3798 static void
3799 delbuf_msg(name)
3800 char_u *name;
3802 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3803 name == NULL ? (char_u *)"" : name);
3804 vim_free(name);
3805 au_new_curbuf = NULL;
3807 #endif
3809 static int append_indent = 0; /* autoindent for first line */
3812 * ":insert" and ":append", also used by ":change"
3814 void
3815 ex_append(eap)
3816 exarg_T *eap;
3818 char_u *theline;
3819 int did_undo = FALSE;
3820 linenr_T lnum = eap->line2;
3821 int indent = 0;
3822 char_u *p;
3823 int vcol;
3824 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3826 /* the ! flag toggles autoindent */
3827 if (eap->forceit)
3828 curbuf->b_p_ai = !curbuf->b_p_ai;
3830 /* First autoindent comes from the line we start on */
3831 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3832 append_indent = get_indent_lnum(lnum);
3834 if (eap->cmdidx != CMD_append)
3835 --lnum;
3837 /* when the buffer is empty append to line 0 and delete the dummy line */
3838 if (empty && lnum == 1)
3839 lnum = 0;
3841 State = INSERT; /* behave like in Insert mode */
3842 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3843 State |= LANGMAP;
3845 for (;;)
3847 msg_scroll = TRUE;
3848 need_wait_return = FALSE;
3849 if (curbuf->b_p_ai)
3851 if (append_indent >= 0)
3853 indent = append_indent;
3854 append_indent = -1;
3856 else if (lnum > 0)
3857 indent = get_indent_lnum(lnum);
3859 ex_keep_indent = FALSE;
3860 if (eap->getline == NULL)
3862 /* No getline() function, use the lines that follow. This ends
3863 * when there is no more. */
3864 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3865 break;
3866 p = vim_strchr(eap->nextcmd, NL);
3867 if (p == NULL)
3868 p = eap->nextcmd + STRLEN(eap->nextcmd);
3869 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3870 if (*p != NUL)
3871 ++p;
3872 eap->nextcmd = p;
3874 else
3875 theline = eap->getline(
3876 #ifdef FEAT_EVAL
3877 eap->cstack->cs_looplevel > 0 ? -1 :
3878 #endif
3879 NUL, eap->cookie, indent);
3880 lines_left = Rows - 1;
3881 if (theline == NULL)
3882 break;
3884 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3885 if (ex_keep_indent)
3886 append_indent = indent;
3888 /* Look for the "." after automatic indent. */
3889 vcol = 0;
3890 for (p = theline; indent > vcol; ++p)
3892 if (*p == ' ')
3893 ++vcol;
3894 else if (*p == TAB)
3895 vcol += 8 - vcol % 8;
3896 else
3897 break;
3899 if ((p[0] == '.' && p[1] == NUL)
3900 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3901 == FAIL))
3903 vim_free(theline);
3904 break;
3907 /* don't use autoindent if nothing was typed. */
3908 if (p[0] == NUL)
3909 theline[0] = NUL;
3911 did_undo = TRUE;
3912 ml_append(lnum, theline, (colnr_T)0, FALSE);
3913 appended_lines_mark(lnum, 1L);
3915 vim_free(theline);
3916 ++lnum;
3918 if (empty)
3920 ml_delete(2L, FALSE);
3921 empty = FALSE;
3924 State = NORMAL;
3926 if (eap->forceit)
3927 curbuf->b_p_ai = !curbuf->b_p_ai;
3929 /* "start" is set to eap->line2+1 unless that position is invalid (when
3930 * eap->line2 pointed to the end of the buffer and nothing was appended)
3931 * "end" is set to lnum when something has been appended, otherwise
3932 * it is the same than "start" -- Acevedo */
3933 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3934 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3935 if (eap->cmdidx != CMD_append)
3936 --curbuf->b_op_start.lnum;
3937 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3938 ? lnum : curbuf->b_op_start.lnum;
3939 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3940 curwin->w_cursor.lnum = lnum;
3941 check_cursor_lnum();
3942 beginline(BL_SOL | BL_FIX);
3944 need_wait_return = FALSE; /* don't use wait_return() now */
3945 ex_no_reprint = TRUE;
3949 * ":change"
3951 void
3952 ex_change(eap)
3953 exarg_T *eap;
3955 linenr_T lnum;
3957 if (eap->line2 >= eap->line1
3958 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3959 return;
3961 /* the ! flag toggles autoindent */
3962 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3963 append_indent = get_indent_lnum(eap->line1);
3965 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3967 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3968 break;
3969 ml_delete(eap->line1, FALSE);
3971 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3973 /* ":append" on the line above the deleted lines. */
3974 eap->line2 = eap->line1;
3975 ex_append(eap);
3978 void
3979 ex_z(eap)
3980 exarg_T *eap;
3982 char_u *x;
3983 int bigness;
3984 char_u *kind;
3985 int minus = 0;
3986 linenr_T start, end, curs, i;
3987 int j;
3988 linenr_T lnum = eap->line2;
3990 /* Vi compatible: ":z!" uses display height, without a count uses
3991 * 'scroll' */
3992 if (eap->forceit)
3993 bigness = curwin->w_height;
3994 else if (firstwin == lastwin)
3995 bigness = curwin->w_p_scr * 2;
3996 else
3997 bigness = curwin->w_height - 3;
3998 if (bigness < 1)
3999 bigness = 1;
4001 x = eap->arg;
4002 kind = x;
4003 if (*kind == '-' || *kind == '+' || *kind == '='
4004 || *kind == '^' || *kind == '.')
4005 ++x;
4006 while (*x == '-' || *x == '+')
4007 ++x;
4009 if (*x != 0)
4011 if (!VIM_ISDIGIT(*x))
4013 EMSG(_("E144: non-numeric argument to :z"));
4014 return;
4016 else
4018 bigness = atoi((char *)x);
4019 p_window = bigness;
4020 if (*kind == '=')
4021 bigness += 2;
4025 /* the number of '-' and '+' multiplies the distance */
4026 if (*kind == '-' || *kind == '+')
4027 for (x = kind + 1; *x == *kind; ++x)
4030 switch (*kind)
4032 case '-':
4033 start = lnum - bigness * (linenr_T)(x - kind);
4034 end = start + bigness;
4035 curs = end;
4036 break;
4038 case '=':
4039 start = lnum - (bigness + 1) / 2 + 1;
4040 end = lnum + (bigness + 1) / 2 - 1;
4041 curs = lnum;
4042 minus = 1;
4043 break;
4045 case '^':
4046 start = lnum - bigness * 2;
4047 end = lnum - bigness;
4048 curs = lnum - bigness;
4049 break;
4051 case '.':
4052 start = lnum - (bigness + 1) / 2 + 1;
4053 end = lnum + (bigness + 1) / 2 - 1;
4054 curs = end;
4055 break;
4057 default: /* '+' */
4058 start = lnum;
4059 if (*kind == '+')
4060 start += bigness * (linenr_T)(x - kind - 1) + 1;
4061 else if (eap->addr_count == 0)
4062 ++start;
4063 end = start + bigness - 1;
4064 curs = end;
4065 break;
4068 if (start < 1)
4069 start = 1;
4071 if (end > curbuf->b_ml.ml_line_count)
4072 end = curbuf->b_ml.ml_line_count;
4074 if (curs > curbuf->b_ml.ml_line_count)
4075 curs = curbuf->b_ml.ml_line_count;
4077 for (i = start; i <= end; i++)
4079 if (minus && i == lnum)
4081 msg_putchar('\n');
4083 for (j = 1; j < Columns; j++)
4084 msg_putchar('-');
4087 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4089 if (minus && i == lnum)
4091 msg_putchar('\n');
4093 for (j = 1; j < Columns; j++)
4094 msg_putchar('-');
4098 curwin->w_cursor.lnum = curs;
4099 ex_no_reprint = TRUE;
4103 * Check if the restricted flag is set.
4104 * If so, give an error message and return TRUE.
4105 * Otherwise, return FALSE.
4108 check_restricted()
4110 if (restricted)
4112 EMSG(_("E145: Shell commands not allowed in rvim"));
4113 return TRUE;
4115 return FALSE;
4119 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4120 * If so, give an error message and return TRUE.
4121 * Otherwise, return FALSE.
4124 check_secure()
4126 if (secure)
4128 secure = 2;
4129 EMSG(_(e_curdir));
4130 return TRUE;
4132 #ifdef HAVE_SANDBOX
4134 * In the sandbox more things are not allowed, including the things
4135 * disallowed in secure mode.
4137 if (sandbox != 0)
4139 EMSG(_(e_sandbox));
4140 return TRUE;
4142 #endif
4143 return FALSE;
4146 static char_u *old_sub = NULL; /* previous substitute pattern */
4147 static int global_need_beginline; /* call beginline() after ":g" */
4149 /* do_sub()
4151 * Perform a substitution from line eap->line1 to line eap->line2 using the
4152 * command pointed to by eap->arg which should be of the form:
4154 * /pattern/substitution/{flags}
4156 * The usual escapes are supported as described in the regexp docs.
4158 void
4159 do_sub(eap)
4160 exarg_T *eap;
4162 linenr_T lnum;
4163 long i = 0;
4164 regmmatch_T regmatch;
4165 static int do_all = FALSE; /* do multiple substitutions per line */
4166 static int do_ask = FALSE; /* ask for confirmation */
4167 static int do_count = FALSE; /* count only */
4168 static int do_error = TRUE; /* if false, ignore errors */
4169 static int do_print = FALSE; /* print last line with subs. */
4170 static int do_list = FALSE; /* list last line with subs. */
4171 static int do_number = FALSE; /* list last line with line nr*/
4172 static int do_ic = 0; /* ignore case flag */
4173 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4174 int delimiter;
4175 int sublen;
4176 int got_quit = FALSE;
4177 int got_match = FALSE;
4178 int temp;
4179 int which_pat;
4180 char_u *cmd;
4181 int save_State;
4182 linenr_T first_line = 0; /* first changed line */
4183 linenr_T last_line= 0; /* below last changed line AFTER the
4184 * change */
4185 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4186 linenr_T line2;
4187 long nmatch; /* number of lines in match */
4188 linenr_T sub_firstlnum; /* nr of first sub line */
4189 char_u *sub_firstline; /* allocated copy of first sub line */
4190 int endcolumn = FALSE; /* cursor in last column when done */
4191 pos_T old_cursor = curwin->w_cursor;
4193 cmd = eap->arg;
4194 if (!global_busy)
4196 sub_nsubs = 0;
4197 sub_nlines = 0;
4200 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4201 if (p_altkeymap && curwin->w_p_rl)
4202 lrF_sub(cmd);
4203 #endif
4205 if (eap->cmdidx == CMD_tilde)
4206 which_pat = RE_LAST; /* use last used regexp */
4207 else
4208 which_pat = RE_SUBST; /* use last substitute regexp */
4210 /* new pattern and substitution */
4211 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4212 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4214 /* don't accept alphanumeric for separator */
4215 if (isalpha(*cmd))
4217 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4218 return;
4221 * undocumented vi feature:
4222 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4223 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4225 if (*cmd == '\\')
4227 ++cmd;
4228 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4230 EMSG(_(e_backslash));
4231 return;
4233 if (*cmd != '&')
4234 which_pat = RE_SEARCH; /* use last '/' pattern */
4235 pat = (char_u *)""; /* empty search pattern */
4236 delimiter = *cmd++; /* remember delimiter character */
4238 else /* find the end of the regexp */
4240 which_pat = RE_LAST; /* use last used regexp */
4241 delimiter = *cmd++; /* remember delimiter character */
4242 pat = cmd; /* remember start of search pat */
4243 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4244 if (cmd[0] == delimiter) /* end delimiter found */
4245 *cmd++ = NUL; /* replace it with a NUL */
4249 * Small incompatibility: vi sees '\n' as end of the command, but in
4250 * Vim we want to use '\n' to find/substitute a NUL.
4252 sub = cmd; /* remember the start of the substitution */
4254 while (cmd[0])
4256 if (cmd[0] == delimiter) /* end delimiter found */
4258 *cmd++ = NUL; /* replace it with a NUL */
4259 break;
4261 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4262 ++cmd;
4263 mb_ptr_adv(cmd);
4266 if (!eap->skip)
4268 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4269 if (STRCMP(sub, "%") == 0
4270 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4272 if (old_sub == NULL) /* there is no previous command */
4274 EMSG(_(e_nopresub));
4275 return;
4277 sub = old_sub;
4279 else
4281 vim_free(old_sub);
4282 old_sub = vim_strsave(sub);
4286 else if (!eap->skip) /* use previous pattern and substitution */
4288 if (old_sub == NULL) /* there is no previous command */
4290 EMSG(_(e_nopresub));
4291 return;
4293 pat = NULL; /* search_regcomp() will use previous pattern */
4294 sub = old_sub;
4296 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4297 * last column after using "$". */
4298 endcolumn = (curwin->w_curswant == MAXCOL);
4302 * Find trailing options. When '&' is used, keep old options.
4304 if (*cmd == '&')
4305 ++cmd;
4306 else
4308 if (!p_ed)
4310 if (p_gd) /* default is global on */
4311 do_all = TRUE;
4312 else
4313 do_all = FALSE;
4314 do_ask = FALSE;
4316 do_error = TRUE;
4317 do_print = FALSE;
4318 do_count = FALSE;
4319 do_number = FALSE;
4320 do_ic = 0;
4322 while (*cmd)
4325 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4326 * 'r' is never inverted.
4328 if (*cmd == 'g')
4329 do_all = !do_all;
4330 else if (*cmd == 'c')
4331 do_ask = !do_ask;
4332 else if (*cmd == 'n')
4333 do_count = TRUE;
4334 else if (*cmd == 'e')
4335 do_error = !do_error;
4336 else if (*cmd == 'r') /* use last used regexp */
4337 which_pat = RE_LAST;
4338 else if (*cmd == 'p')
4339 do_print = TRUE;
4340 else if (*cmd == '#')
4342 do_print = TRUE;
4343 do_number = TRUE;
4345 else if (*cmd == 'l')
4347 do_print = TRUE;
4348 do_list = TRUE;
4350 else if (*cmd == 'i') /* ignore case */
4351 do_ic = 'i';
4352 else if (*cmd == 'I') /* don't ignore case */
4353 do_ic = 'I';
4354 else
4355 break;
4356 ++cmd;
4358 if (do_count)
4359 do_ask = FALSE;
4362 * check for a trailing count
4364 cmd = skipwhite(cmd);
4365 if (VIM_ISDIGIT(*cmd))
4367 i = getdigits(&cmd);
4368 if (i <= 0 && !eap->skip && do_error)
4370 EMSG(_(e_zerocount));
4371 return;
4373 eap->line1 = eap->line2;
4374 eap->line2 += i - 1;
4375 if (eap->line2 > curbuf->b_ml.ml_line_count)
4376 eap->line2 = curbuf->b_ml.ml_line_count;
4380 * check for trailing command or garbage
4382 cmd = skipwhite(cmd);
4383 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4385 eap->nextcmd = check_nextcmd(cmd);
4386 if (eap->nextcmd == NULL)
4388 EMSG(_(e_trailing));
4389 return;
4393 if (eap->skip) /* not executing commands, only parsing */
4394 return;
4396 if (!do_count && !curbuf->b_p_ma)
4398 /* Substitution is not allowed in non-'modifiable' buffer */
4399 EMSG(_(e_modifiable));
4400 return;
4403 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4405 if (do_error)
4406 EMSG(_(e_invcmd));
4407 return;
4410 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4411 if (do_ic == 'i')
4412 regmatch.rmm_ic = TRUE;
4413 else if (do_ic == 'I')
4414 regmatch.rmm_ic = FALSE;
4416 sub_firstline = NULL;
4419 * ~ in the substitute pattern is replaced with the old pattern.
4420 * We do it here once to avoid it to be replaced over and over again.
4421 * But don't do it when it starts with "\=", then it's an expression.
4423 if (!(sub[0] == '\\' && sub[1] == '='))
4424 sub = regtilde(sub, p_magic);
4427 * Check for a match on each line.
4429 line2 = eap->line2;
4430 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4431 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4432 || aborting()
4433 #endif
4434 ); ++lnum)
4436 sub_firstlnum = lnum;
4437 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
4438 if (nmatch)
4440 colnr_T copycol;
4441 colnr_T matchcol;
4442 colnr_T prev_matchcol = MAXCOL;
4443 char_u *new_end, *new_start = NULL;
4444 unsigned new_start_len = 0;
4445 char_u *p1;
4446 int did_sub = FALSE;
4447 int lastone;
4448 unsigned len, needed_len;
4449 long nmatch_tl = 0; /* nr of lines matched below lnum */
4450 int do_again; /* do it again after joining lines */
4451 int skip_match = FALSE;
4454 * The new text is build up step by step, to avoid too much
4455 * copying. There are these pieces:
4456 * sub_firstline The old text, unmodifed.
4457 * copycol Column in the old text where we started
4458 * looking for a match; from here old text still
4459 * needs to be copied to the new text.
4460 * matchcol Column number of the old text where to look
4461 * for the next match. It's just after the
4462 * previous match or one further.
4463 * prev_matchcol Column just after the previous match (if any).
4464 * Mostly equal to matchcol, except for the first
4465 * match and after skipping an empty match.
4466 * regmatch.*pos Where the pattern matched in the old text.
4467 * new_start The new text, all that has been produced so
4468 * far.
4469 * new_end The new text, where to append new text.
4471 * lnum The line number where we were looking for the
4472 * first match in the old line.
4473 * sub_firstlnum The line number in the buffer where to look
4474 * for a match. Can be different from "lnum"
4475 * when the pattern or substitute string contains
4476 * line breaks.
4478 * Special situations:
4479 * - When the substitute string contains a line break, the part up
4480 * to the line break is inserted in the text, but the copy of
4481 * the original line is kept. "sub_firstlnum" is adjusted for
4482 * the inserted lines.
4483 * - When the matched pattern contains a line break, the old line
4484 * is taken from the line at the end of the pattern. The lines
4485 * in the match are deleted later, "sub_firstlnum" is adjusted
4486 * accordingly.
4488 * The new text is built up in new_start[]. It has some extra
4489 * room to avoid using alloc()/free() too often. new_start_len is
4490 * the lenght of the allocated memory at new_start.
4492 * Make a copy of the old line, so it won't be taken away when
4493 * updating the screen or handling a multi-line match. The "old_"
4494 * pointers point into this copy.
4496 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4497 if (sub_firstline == NULL)
4499 vim_free(new_start);
4500 goto outofmem;
4502 copycol = 0;
4503 matchcol = 0;
4505 /* At first match, remember current cursor position. */
4506 if (!got_match)
4508 setpcmark();
4509 got_match = TRUE;
4513 * Loop until nothing more to replace in this line.
4514 * 1. Handle match with empty string.
4515 * 2. If do_ask is set, ask for confirmation.
4516 * 3. substitute the string.
4517 * 4. if do_all is set, find next match
4518 * 5. break if there isn't another match in this line
4520 for (;;)
4522 /* Save the line number of the last change for the final
4523 * cursor position (just like Vi). */
4524 curwin->w_cursor.lnum = lnum;
4525 do_again = FALSE;
4528 * 1. Match empty string does not count, except for first
4529 * match. This reproduces the strange vi behaviour.
4530 * This also catches endless loops.
4532 if (matchcol == prev_matchcol
4533 && regmatch.endpos[0].lnum == 0
4534 && matchcol == regmatch.endpos[0].col)
4536 if (sub_firstline[matchcol] == NUL)
4537 /* We already were at the end of the line. Don't look
4538 * for a match in this line again. */
4539 skip_match = TRUE;
4540 else
4541 ++matchcol; /* search for a match at next column */
4542 goto skip;
4545 /* Normally we continue searching for a match just after the
4546 * previous match. */
4547 matchcol = regmatch.endpos[0].col;
4548 prev_matchcol = matchcol;
4551 * 2. If do_count is set only increase the counter.
4552 * If do_ask is set, ask for confirmation.
4554 if (do_count)
4556 /* For a multi-line match, put matchcol at the NUL at
4557 * the end of the line and set nmatch to one, so that
4558 * we continue looking for a match on the next line.
4559 * Avoids that ":s/\nB\@=//gc" get stuck. */
4560 if (nmatch > 1)
4562 matchcol = (colnr_T)STRLEN(sub_firstline);
4563 nmatch = 1;
4565 sub_nsubs++;
4566 did_sub = TRUE;
4567 goto skip;
4570 if (do_ask)
4572 /* change State to CONFIRM, so that the mouse works
4573 * properly */
4574 save_State = State;
4575 State = CONFIRM;
4576 #ifdef FEAT_MOUSE
4577 setmouse(); /* disable mouse in xterm */
4578 #endif
4579 curwin->w_cursor.col = regmatch.startpos[0].col;
4581 /* When 'cpoptions' contains "u" don't sync undo when
4582 * asking for confirmation. */
4583 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4584 ++no_u_sync;
4587 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4589 while (do_ask)
4591 if (exmode_active)
4593 char_u *resp;
4594 colnr_T sc, ec;
4596 print_line_no_prefix(lnum, FALSE, FALSE);
4598 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4599 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4600 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4601 msg_start();
4602 for (i = 0; i < (long)sc; ++i)
4603 msg_putchar(' ');
4604 for ( ; i <= (long)ec; ++i)
4605 msg_putchar('^');
4607 resp = getexmodeline('?', NULL, 0);
4608 if (resp != NULL)
4610 i = *resp;
4611 vim_free(resp);
4614 else
4616 #ifdef FEAT_FOLDING
4617 int save_p_fen = curwin->w_p_fen;
4619 curwin->w_p_fen = FALSE;
4620 #endif
4621 /* Invert the matched string.
4622 * Remove the inversion afterwards. */
4623 temp = RedrawingDisabled;
4624 RedrawingDisabled = 0;
4626 search_match_lines = regmatch.endpos[0].lnum;
4627 search_match_endcol = regmatch.endpos[0].col;
4628 highlight_match = TRUE;
4630 update_topline();
4631 validate_cursor();
4632 update_screen(SOME_VALID);
4633 highlight_match = FALSE;
4634 redraw_later(SOME_VALID);
4636 #ifdef FEAT_FOLDING
4637 curwin->w_p_fen = save_p_fen;
4638 #endif
4639 if (msg_row == Rows - 1)
4640 msg_didout = FALSE; /* avoid a scroll-up */
4641 msg_starthere();
4642 i = msg_scroll;
4643 msg_scroll = 0; /* truncate msg when
4644 needed */
4645 msg_no_more = TRUE;
4646 /* write message same highlighting as for
4647 * wait_return */
4648 smsg_attr(hl_attr(HLF_R),
4649 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4650 msg_no_more = FALSE;
4651 msg_scroll = i;
4652 showruler(TRUE);
4653 windgoto(msg_row, msg_col);
4654 RedrawingDisabled = temp;
4656 #ifdef USE_ON_FLY_SCROLL
4657 dont_scroll = FALSE; /* allow scrolling here */
4658 #endif
4659 ++no_mapping; /* don't map this key */
4660 ++allow_keys; /* allow special keys */
4661 i = safe_vgetc();
4662 --allow_keys;
4663 --no_mapping;
4665 /* clear the question */
4666 msg_didout = FALSE; /* don't scroll up */
4667 msg_col = 0;
4668 gotocmdline(TRUE);
4671 need_wait_return = FALSE; /* no hit-return prompt */
4672 if (i == 'q' || i == ESC || i == Ctrl_C
4673 #ifdef UNIX
4674 || i == intr_char
4675 #endif
4678 got_quit = TRUE;
4679 break;
4681 if (i == 'n')
4682 break;
4683 if (i == 'y')
4684 break;
4685 if (i == 'l')
4687 /* last: replace and then stop */
4688 do_all = FALSE;
4689 line2 = lnum;
4690 break;
4692 if (i == 'a')
4694 do_ask = FALSE;
4695 break;
4697 #ifdef FEAT_INS_EXPAND
4698 if (i == Ctrl_E)
4699 scrollup_clamp();
4700 else if (i == Ctrl_Y)
4701 scrolldown_clamp();
4702 #endif
4704 State = save_State;
4705 #ifdef FEAT_MOUSE
4706 setmouse();
4707 #endif
4708 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4709 --no_u_sync;
4711 if (i == 'n')
4713 /* For a multi-line match, put matchcol at the NUL at
4714 * the end of the line and set nmatch to one, so that
4715 * we continue looking for a match on the next line.
4716 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4717 * get stuck when pressing 'n'. */
4718 if (nmatch > 1)
4720 matchcol = (colnr_T)STRLEN(sub_firstline);
4721 skip_match = TRUE;
4723 goto skip;
4725 if (got_quit)
4726 break;
4729 /* Move the cursor to the start of the match, so that we can
4730 * use "\=col("."). */
4731 curwin->w_cursor.col = regmatch.startpos[0].col;
4734 * 3. substitute the string.
4736 /* get length of substitution part */
4737 sublen = vim_regsub_multi(&regmatch, sub_firstlnum,
4738 sub, sub_firstline, FALSE, p_magic, TRUE);
4740 /* When the match included the "$" of the last line it may
4741 * go beyond the last line of the buffer. */
4742 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4744 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4745 skip_match = TRUE;
4748 /* Need room for:
4749 * - result so far in new_start (not for first sub in line)
4750 * - original text up to match
4751 * - length of substituted part
4752 * - original text after match
4754 if (nmatch == 1)
4755 p1 = sub_firstline;
4756 else
4758 p1 = ml_get(sub_firstlnum + nmatch - 1);
4759 nmatch_tl += nmatch - 1;
4761 i = regmatch.startpos[0].col - copycol;
4762 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4763 + sublen + 1;
4764 if (new_start == NULL)
4767 * Get some space for a temporary buffer to do the
4768 * substitution into (and some extra space to avoid
4769 * too many calls to alloc()/free()).
4771 new_start_len = needed_len + 50;
4772 if ((new_start = alloc_check(new_start_len)) == NULL)
4773 goto outofmem;
4774 *new_start = NUL;
4775 new_end = new_start;
4777 else
4780 * Check if the temporary buffer is long enough to do the
4781 * substitution into. If not, make it larger (with a bit
4782 * extra to avoid too many calls to alloc()/free()).
4784 len = (unsigned)STRLEN(new_start);
4785 needed_len += len;
4786 if (needed_len > new_start_len)
4788 new_start_len = needed_len + 50;
4789 if ((p1 = alloc_check(new_start_len)) == NULL)
4791 vim_free(new_start);
4792 goto outofmem;
4794 mch_memmove(p1, new_start, (size_t)(len + 1));
4795 vim_free(new_start);
4796 new_start = p1;
4798 new_end = new_start + len;
4802 * copy the text up to the part that matched
4804 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4805 new_end += i;
4807 (void)vim_regsub_multi(&regmatch, sub_firstlnum,
4808 sub, new_end, TRUE, p_magic, TRUE);
4809 sub_nsubs++;
4810 did_sub = TRUE;
4812 /* Move the cursor to the start of the line, to avoid that it
4813 * is beyond the end of the line after the substitution. */
4814 curwin->w_cursor.col = 0;
4816 /* For a multi-line match, make a copy of the last matched
4817 * line and continue in that one. */
4818 if (nmatch > 1)
4820 sub_firstlnum += nmatch - 1;
4821 vim_free(sub_firstline);
4822 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4823 /* When going beyond the last line, stop substituting. */
4824 if (sub_firstlnum <= line2)
4825 do_again = TRUE;
4826 else
4827 do_all = FALSE;
4830 /* Remember next character to be copied. */
4831 copycol = regmatch.endpos[0].col;
4833 if (skip_match)
4835 /* Already hit end of the buffer, sub_firstlnum is one
4836 * less than what it ought to be. */
4837 vim_free(sub_firstline);
4838 sub_firstline = vim_strsave((char_u *)"");
4839 copycol = 0;
4843 * Now the trick is to replace CTRL-M chars with a real line
4844 * break. This would make it impossible to insert a CTRL-M in
4845 * the text. The line break can be avoided by preceding the
4846 * CTRL-M with a backslash. To be able to insert a backslash,
4847 * they must be doubled in the string and are halved here.
4848 * That is Vi compatible.
4850 for (p1 = new_end; *p1; ++p1)
4852 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4853 mch_memmove(p1, p1 + 1, STRLEN(p1));
4854 else if (*p1 == CAR)
4856 if (u_inssub(lnum) == OK) /* prepare for undo */
4858 *p1 = NUL; /* truncate up to the CR */
4859 ml_append(lnum - 1, new_start,
4860 (colnr_T)(p1 - new_start + 1), FALSE);
4861 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4862 if (do_ask)
4863 appended_lines(lnum - 1, 1L);
4864 else
4866 if (first_line == 0)
4867 first_line = lnum;
4868 last_line = lnum + 1;
4870 /* All line numbers increase. */
4871 ++sub_firstlnum;
4872 ++lnum;
4873 ++line2;
4874 /* move the cursor to the new line, like Vi */
4875 ++curwin->w_cursor.lnum;
4876 STRCPY(new_start, p1 + 1); /* copy the rest */
4877 p1 = new_start - 1;
4880 #ifdef FEAT_MBYTE
4881 else if (has_mbyte)
4882 p1 += (*mb_ptr2len)(p1) - 1;
4883 #endif
4887 * 4. If do_all is set, find next match.
4888 * Prevent endless loop with patterns that match empty
4889 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4890 * But ":s/\n/#/" is OK.
4892 skip:
4893 /* We already know that we did the last subst when we are at
4894 * the end of the line, except that a pattern like
4895 * "bar\|\nfoo" may match at the NUL. */
4896 lastone = (skip_match
4897 || got_int
4898 || got_quit
4899 || !(do_all || do_again)
4900 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4901 && !re_multiline(regmatch.regprog)));
4902 nmatch = -1;
4905 * Replace the line in the buffer when needed. This is
4906 * skipped when there are more matches.
4907 * The check for nmatch_tl is needed for when multi-line
4908 * matching must replace the lines before trying to do another
4909 * match, otherwise "\@<=" won't work.
4910 * When asking the user we like to show the already replaced
4911 * text, but don't do it when "\<@=" or "\<@!" is used, it
4912 * changes what matches.
4914 if (lastone
4915 || (do_ask && !re_lookbehind(regmatch.regprog))
4916 || nmatch_tl > 0
4917 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4918 curbuf, sub_firstlnum, matchcol)) == 0)
4920 if (new_start != NULL)
4923 * Copy the rest of the line, that didn't match.
4924 * "matchcol" has to be adjusted, we use the end of
4925 * the line as reference, because the substitute may
4926 * have changed the number of characters. Same for
4927 * "prev_matchcol".
4929 STRCAT(new_start, sub_firstline + copycol);
4930 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4931 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4932 - prev_matchcol;
4934 if (u_savesub(lnum) != OK)
4935 break;
4936 ml_replace(lnum, new_start, TRUE);
4938 if (nmatch_tl > 0)
4941 * Matched lines have now been substituted and are
4942 * useless, delete them. The part after the match
4943 * has been appended to new_start, we don't need
4944 * it in the buffer.
4946 ++lnum;
4947 if (u_savedel(lnum, nmatch_tl) != OK)
4948 break;
4949 for (i = 0; i < nmatch_tl; ++i)
4950 ml_delete(lnum, (int)FALSE);
4951 mark_adjust(lnum, lnum + nmatch_tl - 1,
4952 (long)MAXLNUM, -nmatch_tl);
4953 if (do_ask)
4954 deleted_lines(lnum, nmatch_tl);
4955 --lnum;
4956 line2 -= nmatch_tl; /* nr of lines decreases */
4957 nmatch_tl = 0;
4960 /* When asking, undo is saved each time, must also set
4961 * changed flag each time. */
4962 if (do_ask)
4963 changed_bytes(lnum, 0);
4964 else
4966 if (first_line == 0)
4967 first_line = lnum;
4968 last_line = lnum + 1;
4971 sub_firstlnum = lnum;
4972 vim_free(sub_firstline); /* free the temp buffer */
4973 sub_firstline = new_start;
4974 new_start = NULL;
4975 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4976 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4977 - prev_matchcol;
4978 copycol = 0;
4980 if (nmatch == -1 && !lastone)
4981 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
4982 sub_firstlnum, matchcol);
4985 * 5. break if there isn't another match in this line
4987 if (nmatch <= 0)
4988 break;
4991 line_breakcheck();
4994 if (did_sub)
4995 ++sub_nlines;
4996 vim_free(sub_firstline); /* free the copy of the original line */
4997 sub_firstline = NULL;
5000 line_breakcheck();
5003 if (first_line != 0)
5005 /* Need to subtract the number of added lines from "last_line" to get
5006 * the line number before the change (same as adding the number of
5007 * deleted lines). */
5008 i = curbuf->b_ml.ml_line_count - old_line_count;
5009 changed_lines(first_line, 0, last_line - i, i);
5012 outofmem:
5013 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5015 /* ":s/pat//n" doesn't move the cursor */
5016 if (do_count)
5017 curwin->w_cursor = old_cursor;
5019 if (sub_nsubs)
5021 /* Set the '[ and '] marks. */
5022 curbuf->b_op_start.lnum = eap->line1;
5023 curbuf->b_op_end.lnum = line2;
5024 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5026 if (!global_busy)
5028 if (endcolumn)
5029 coladvance((colnr_T)MAXCOL);
5030 else
5031 beginline(BL_WHITE | BL_FIX);
5032 if (!do_sub_msg(do_count) && do_ask)
5033 MSG("");
5035 else
5036 global_need_beginline = TRUE;
5037 if (do_print)
5038 print_line(curwin->w_cursor.lnum, do_number, do_list);
5040 else if (!global_busy)
5042 if (got_int) /* interrupted */
5043 EMSG(_(e_interr));
5044 else if (got_match) /* did find something but nothing substituted */
5045 MSG("");
5046 else if (do_error) /* nothing found */
5047 EMSG2(_(e_patnotf2), get_search_pat());
5050 vim_free(regmatch.regprog);
5054 * Give message for number of substitutions.
5055 * Can also be used after a ":global" command.
5056 * Return TRUE if a message was given.
5059 do_sub_msg(count_only)
5060 int count_only; /* used 'n' flag for ":s" */
5062 int len = 0;
5065 * Only report substitutions when:
5066 * - more than 'report' substitutions
5067 * - command was typed by user, or number of changed lines > 'report'
5068 * - giving messages is not disabled by 'lazyredraw'
5070 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5071 || count_only)
5072 && messaging())
5074 if (got_int)
5076 STRCPY(msg_buf, _("(Interrupted) "));
5077 len = (int)STRLEN(msg_buf);
5079 if (sub_nsubs == 1)
5080 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5081 "%s", count_only ? _("1 match") : _("1 substitution"));
5082 else
5083 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5084 count_only ? _("%ld matches") : _("%ld substitutions"),
5085 sub_nsubs);
5086 len = (int)STRLEN(msg_buf);
5087 if (sub_nlines == 1)
5088 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5089 "%s", _(" on 1 line"));
5090 else
5091 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5092 _(" on %ld lines"), (long)sub_nlines);
5093 if (msg(msg_buf))
5094 /* save message to display it after redraw */
5095 set_keep_msg(msg_buf, 0);
5096 return TRUE;
5098 if (got_int)
5100 EMSG(_(e_interr));
5101 return TRUE;
5103 return FALSE;
5107 * Execute a global command of the form:
5109 * g/pattern/X : execute X on all lines where pattern matches
5110 * v/pattern/X : execute X on all lines where pattern does not match
5112 * where 'X' is an EX command
5114 * The command character (as well as the trailing slash) is optional, and
5115 * is assumed to be 'p' if missing.
5117 * This is implemented in two passes: first we scan the file for the pattern and
5118 * set a mark for each line that (not) matches. secondly we execute the command
5119 * for each line that has a mark. This is required because after deleting
5120 * lines we do not know where to search for the next match.
5122 void
5123 ex_global(eap)
5124 exarg_T *eap;
5126 linenr_T lnum; /* line number according to old situation */
5127 int ndone = 0;
5128 int type; /* first char of cmd: 'v' or 'g' */
5129 char_u *cmd; /* command argument */
5131 char_u delim; /* delimiter, normally '/' */
5132 char_u *pat;
5133 regmmatch_T regmatch;
5134 int match;
5135 int which_pat;
5137 if (global_busy)
5139 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5140 return;
5143 if (eap->forceit) /* ":global!" is like ":vglobal" */
5144 type = 'v';
5145 else
5146 type = *eap->cmd;
5147 cmd = eap->arg;
5148 which_pat = RE_LAST; /* default: use last used regexp */
5149 sub_nsubs = 0;
5150 sub_nlines = 0;
5153 * undocumented vi feature:
5154 * "\/" and "\?": use previous search pattern.
5155 * "\&": use previous substitute pattern.
5157 if (*cmd == '\\')
5159 ++cmd;
5160 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5162 EMSG(_(e_backslash));
5163 return;
5165 if (*cmd == '&')
5166 which_pat = RE_SUBST; /* use previous substitute pattern */
5167 else
5168 which_pat = RE_SEARCH; /* use previous search pattern */
5169 ++cmd;
5170 pat = (char_u *)"";
5172 else if (*cmd == NUL)
5174 EMSG(_("E148: Regular expression missing from global"));
5175 return;
5177 else
5179 delim = *cmd; /* get the delimiter */
5180 if (delim)
5181 ++cmd; /* skip delimiter if there is one */
5182 pat = cmd; /* remember start of pattern */
5183 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5184 if (cmd[0] == delim) /* end delimiter found */
5185 *cmd++ = NUL; /* replace it with a NUL */
5188 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5189 if (p_altkeymap && curwin->w_p_rl)
5190 lrFswap(pat,0);
5191 #endif
5193 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5195 EMSG(_(e_invcmd));
5196 return;
5200 * pass 1: set marks for each (not) matching line
5202 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5204 /* a match on this line? */
5205 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
5206 if ((type == 'g' && match) || (type == 'v' && !match))
5208 ml_setmarked(lnum);
5209 ndone++;
5211 line_breakcheck();
5215 * pass 2: execute the command for each line that has been marked
5217 if (got_int)
5218 MSG(_(e_interr));
5219 else if (ndone == 0)
5221 if (type == 'v')
5222 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5223 else
5224 smsg((char_u *)_(e_patnotf2), pat);
5226 else
5227 global_exe(cmd);
5229 ml_clearmarked(); /* clear rest of the marks */
5230 vim_free(regmatch.regprog);
5234 * Execute "cmd" on lines marked with ml_setmarked().
5236 void
5237 global_exe(cmd)
5238 char_u *cmd;
5240 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5241 linenr_T lnum; /* line number according to old situation */
5244 * Set current position only once for a global command.
5245 * If global_busy is set, setpcmark() will not do anything.
5246 * If there is an error, global_busy will be incremented.
5248 setpcmark();
5250 /* When the command writes a message, don't overwrite the command. */
5251 msg_didout = TRUE;
5253 global_need_beginline = FALSE;
5254 global_busy = 1;
5255 old_lcount = curbuf->b_ml.ml_line_count;
5256 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5258 curwin->w_cursor.lnum = lnum;
5259 curwin->w_cursor.col = 0;
5260 if (*cmd == NUL || *cmd == '\n')
5261 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5262 else
5263 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5264 ui_breakcheck();
5267 global_busy = 0;
5268 if (global_need_beginline)
5269 beginline(BL_WHITE | BL_FIX);
5270 else
5271 check_cursor(); /* cursor may be beyond the end of the line */
5273 /* the cursor may not have moved in the text but a change in a previous
5274 * line may move it on the screen */
5275 changed_line_abv_curs();
5277 /* If it looks like no message was written, allow overwriting the
5278 * command with the report for number of changes. */
5279 if (msg_col == 0 && msg_scrolled == 0)
5280 msg_didout = FALSE;
5282 /* If substitutes done, report number of substitutes, otherwise report
5283 * number of extra or deleted lines. */
5284 if (!do_sub_msg(FALSE))
5285 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5288 #ifdef FEAT_VIMINFO
5290 read_viminfo_sub_string(virp, force)
5291 vir_T *virp;
5292 int force;
5294 if (old_sub != NULL && force)
5295 vim_free(old_sub);
5296 if (force || old_sub == NULL)
5297 old_sub = viminfo_readstring(virp, 1, TRUE);
5298 return viminfo_readline(virp);
5301 void
5302 write_viminfo_sub_string(fp)
5303 FILE *fp;
5305 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5307 fprintf(fp, _("\n# Last Substitute String:\n$"));
5308 viminfo_writestring(fp, old_sub);
5311 #endif /* FEAT_VIMINFO */
5313 #if defined(EXITFREE) || defined(PROTO)
5314 void
5315 free_old_sub()
5317 vim_free(old_sub);
5319 #endif
5321 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5323 * Set up for a tagpreview.
5324 * Return TRUE when it was created.
5327 prepare_tagpreview(undo_sync)
5328 int undo_sync; /* sync undo when leaving the window */
5330 win_T *wp;
5332 # ifdef FEAT_GUI
5333 need_mouse_correct = TRUE;
5334 # endif
5337 * If there is already a preview window open, use that one.
5339 if (!curwin->w_p_pvw)
5341 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5342 if (wp->w_p_pvw)
5343 break;
5344 if (wp != NULL)
5345 win_enter(wp, undo_sync);
5346 else
5349 * There is no preview window open yet. Create one.
5351 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5352 == FAIL)
5353 return FALSE;
5354 curwin->w_p_pvw = TRUE;
5355 curwin->w_p_wfh = TRUE;
5356 # ifdef FEAT_SCROLLBIND
5357 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5358 # endif
5359 # ifdef FEAT_DIFF
5360 curwin->w_p_diff = FALSE; /* no 'diff' */
5361 # endif
5362 # ifdef FEAT_FOLDING
5363 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5364 # endif
5365 return TRUE;
5368 return FALSE;
5371 #endif
5375 * ":help": open a read-only window on a help file
5377 void
5378 ex_help(eap)
5379 exarg_T *eap;
5381 char_u *arg;
5382 char_u *tag;
5383 FILE *helpfd; /* file descriptor of help file */
5384 int n;
5385 int i;
5386 #ifdef FEAT_WINDOWS
5387 win_T *wp;
5388 #endif
5389 int num_matches;
5390 char_u **matches;
5391 char_u *p;
5392 int empty_fnum = 0;
5393 int alt_fnum = 0;
5394 buf_T *buf;
5395 #ifdef FEAT_MULTI_LANG
5396 int len;
5397 char_u *lang;
5398 #endif
5400 if (eap != NULL)
5403 * A ":help" command ends at the first LF, or at a '|' that is
5404 * followed by some text. Set nextcmd to the following command.
5406 for (arg = eap->arg; *arg; ++arg)
5408 if (*arg == '\n' || *arg == '\r'
5409 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5411 *arg++ = NUL;
5412 eap->nextcmd = arg;
5413 break;
5416 arg = eap->arg;
5418 if (eap->forceit && *arg == NUL)
5420 EMSG(_("E478: Don't panic!"));
5421 return;
5424 if (eap->skip) /* not executing commands */
5425 return;
5427 else
5428 arg = (char_u *)"";
5430 /* remove trailing blanks */
5431 p = arg + STRLEN(arg) - 1;
5432 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5433 *p-- = NUL;
5435 #ifdef FEAT_MULTI_LANG
5436 /* Check for a specified language */
5437 lang = check_help_lang(arg);
5438 #endif
5440 /* When no argument given go to the index. */
5441 if (*arg == NUL)
5442 arg = (char_u *)"help.txt";
5445 * Check if there is a match for the argument.
5447 n = find_help_tags(arg, &num_matches, &matches,
5448 eap != NULL && eap->forceit);
5450 i = 0;
5451 #ifdef FEAT_MULTI_LANG
5452 if (n != FAIL && lang != NULL)
5453 /* Find first item with the requested language. */
5454 for (i = 0; i < num_matches; ++i)
5456 len = (int)STRLEN(matches[i]);
5457 if (len > 3 && matches[i][len - 3] == '@'
5458 && STRICMP(matches[i] + len - 2, lang) == 0)
5459 break;
5461 #endif
5462 if (i >= num_matches || n == FAIL)
5464 #ifdef FEAT_MULTI_LANG
5465 if (lang != NULL)
5466 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5467 else
5468 #endif
5469 EMSG2(_("E149: Sorry, no help for %s"), arg);
5470 if (n != FAIL)
5471 FreeWild(num_matches, matches);
5472 return;
5475 /* The first match (in the requested language) is the best match. */
5476 tag = vim_strsave(matches[i]);
5477 FreeWild(num_matches, matches);
5479 #ifdef FEAT_GUI
5480 need_mouse_correct = TRUE;
5481 #endif
5484 * Re-use an existing help window or open a new one.
5485 * Always open a new one for ":tab help".
5487 if (!curwin->w_buffer->b_help
5488 #ifdef FEAT_WINDOWS
5489 || cmdmod.tab != 0
5490 #endif
5493 #ifdef FEAT_WINDOWS
5494 if (cmdmod.tab != 0)
5495 wp = NULL;
5496 else
5497 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5498 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5499 break;
5500 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5501 win_enter(wp, TRUE);
5502 else
5503 #endif
5506 * There is no help window yet.
5507 * Try to open the file specified by the "helpfile" option.
5509 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5511 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5512 goto erret;
5514 fclose(helpfd);
5516 #ifdef FEAT_WINDOWS
5517 /* Split off help window; put it at far top if no position
5518 * specified, the current window is vertically split and
5519 * narrow. */
5520 n = WSP_HELP;
5521 # ifdef FEAT_VERTSPLIT
5522 if (cmdmod.split == 0 && curwin->w_width != Columns
5523 && curwin->w_width < 80)
5524 n |= WSP_TOP;
5525 # endif
5526 if (win_split(0, n) == FAIL)
5527 goto erret;
5528 #else
5529 /* use current window */
5530 if (!can_abandon(curbuf, FALSE))
5531 goto erret;
5532 #endif
5534 #ifdef FEAT_WINDOWS
5535 if (curwin->w_height < p_hh)
5536 win_setheight((int)p_hh);
5537 #endif
5540 * Open help file (do_ecmd() will set b_help flag, readfile() will
5541 * set b_p_ro flag).
5542 * Set the alternate file to the previously edited file.
5544 alt_fnum = curbuf->b_fnum;
5545 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5546 ECMD_HIDE + ECMD_SET_HELP);
5547 if (!cmdmod.keepalt)
5548 curwin->w_alt_fnum = alt_fnum;
5549 empty_fnum = curbuf->b_fnum;
5553 if (!p_im)
5554 restart_edit = 0; /* don't want insert mode in help file */
5556 if (tag != NULL)
5557 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5559 /* Delete the empty buffer if we're not using it. Careful: autocommands
5560 * may have jumped to another window, check that the buffer is not in a
5561 * window. */
5562 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5564 buf = buflist_findnr(empty_fnum);
5565 if (buf != NULL && buf->b_nwindows == 0)
5566 wipe_buffer(buf, TRUE);
5569 /* keep the previous alternate file */
5570 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5571 curwin->w_alt_fnum = alt_fnum;
5573 erret:
5574 vim_free(tag);
5578 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5580 * In an argument search for a language specifiers in the form "@xx".
5581 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5582 * Returns NULL if not found.
5584 char_u *
5585 check_help_lang(arg)
5586 char_u *arg;
5588 int len = (int)STRLEN(arg);
5590 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5591 && ASCII_ISALPHA(arg[len - 1]))
5593 arg[len - 3] = NUL; /* remove the '@' */
5594 return arg + len - 2;
5596 return NULL;
5598 #endif
5601 * Return a heuristic indicating how well the given string matches. The
5602 * smaller the number, the better the match. This is the order of priorities,
5603 * from best match to worst match:
5604 * - Match with least alpha-numeric characters is better.
5605 * - Match with least total characters is better.
5606 * - Match towards the start is better.
5607 * - Match starting with "+" is worse (feature instead of command)
5608 * Assumption is made that the matched_string passed has already been found to
5609 * match some string for which help is requested. webb.
5612 help_heuristic(matched_string, offset, wrong_case)
5613 char_u *matched_string;
5614 int offset; /* offset for match */
5615 int wrong_case; /* no matching case */
5617 int num_letters;
5618 char_u *p;
5620 num_letters = 0;
5621 for (p = matched_string; *p; p++)
5622 if (ASCII_ISALNUM(*p))
5623 num_letters++;
5626 * Multiply the number of letters by 100 to give it a much bigger
5627 * weighting than the number of characters.
5628 * If there only is a match while ignoring case, add 5000.
5629 * If the match starts in the middle of a word, add 10000 to put it
5630 * somewhere in the last half.
5631 * If the match is more than 2 chars from the start, multiply by 200 to
5632 * put it after matches at the start.
5634 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5635 && ASCII_ISALNUM(matched_string[offset - 1]))
5636 offset += 10000;
5637 else if (offset > 2)
5638 offset *= 200;
5639 if (wrong_case)
5640 offset += 5000;
5641 /* Features are less interesting than the subjects themselves, but "+"
5642 * alone is not a feature. */
5643 if (matched_string[0] == '+' && matched_string[1] != NUL)
5644 offset += 100;
5645 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5649 * Compare functions for qsort() below, that checks the help heuristics number
5650 * that has been put after the tagname by find_tags().
5652 static int
5653 #ifdef __BORLANDC__
5654 _RTLENTRYF
5655 #endif
5656 help_compare(s1, s2)
5657 const void *s1;
5658 const void *s2;
5660 char *p1;
5661 char *p2;
5663 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5664 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5665 return strcmp(p1, p2);
5669 * Find all help tags matching "arg", sort them and return in matches[], with
5670 * the number of matches in num_matches.
5671 * The matches will be sorted with a "best" match algorithm.
5672 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5675 find_help_tags(arg, num_matches, matches, keep_lang)
5676 char_u *arg;
5677 int *num_matches;
5678 char_u ***matches;
5679 int keep_lang;
5681 char_u *s, *d;
5682 int i;
5683 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5684 "/*", "/\\*", "\"*", "**",
5685 "/\\(\\)",
5686 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5687 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5688 "[count]", "[quotex]", "[range]",
5689 "[pattern]", "\\|", "\\%$"};
5690 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5691 "/star", "/\\\\star", "quotestar", "starstar",
5692 "/\\\\(\\\\)",
5693 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5694 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5695 "\\[count]", "\\[quotex]", "\\[range]",
5696 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5697 int flags;
5699 d = IObuff; /* assume IObuff is long enough! */
5702 * Recognize a few exceptions to the rule. Some strings that contain '*'
5703 * with "star". Otherwise '*' is recognized as a wildcard.
5705 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5706 if (STRCMP(arg, mtable[i]) == 0)
5708 STRCPY(d, rtable[i]);
5709 break;
5712 if (i < 0) /* no match in table */
5714 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5715 * Also replace "\%^" and "\%(", they match every tag too.
5716 * Also "\zs", "\z1", etc.
5717 * Also "\@<", "\@=", "\@<=", etc.
5718 * And also "\_$" and "\_^". */
5719 if (arg[0] == '\\'
5720 && ((arg[1] != NUL && arg[2] == NUL)
5721 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5722 && arg[2] != NUL)))
5724 STRCPY(d, "/\\\\");
5725 STRCPY(d + 3, arg + 1);
5726 /* Check for "/\\_$", should be "/\\_\$" */
5727 if (d[3] == '_' && d[4] == '$')
5728 STRCPY(d + 4, "\\$");
5730 else
5732 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5733 if (arg[0] == '[' && (arg[1] == ':'
5734 || (arg[1] == '+' && arg[2] == '+')))
5735 *d++ = '\\';
5737 for (s = arg; *s; ++s)
5740 * Replace "|" with "bar" and '"' with "quote" to match the name of
5741 * the tags for these commands.
5742 * Replace "*" with ".*" and "?" with "." to match command line
5743 * completion.
5744 * Insert a backslash before '~', '$' and '.' to avoid their
5745 * special meaning.
5747 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5748 break;
5749 switch (*s)
5751 case '|': STRCPY(d, "bar");
5752 d += 3;
5753 continue;
5754 case '"': STRCPY(d, "quote");
5755 d += 5;
5756 continue;
5757 case '*': *d++ = '.';
5758 break;
5759 case '?': *d++ = '.';
5760 continue;
5761 case '$':
5762 case '.':
5763 case '~': *d++ = '\\';
5764 break;
5768 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5769 * ":help i_^_CTRL-D" work.
5770 * Insert '-' before and after "CTRL-X" when applicable.
5772 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5773 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5775 if (d > IObuff && d[-1] != '_')
5776 *d++ = '_'; /* prepend a '_' */
5777 STRCPY(d, "CTRL-");
5778 d += 5;
5779 if (*s < ' ')
5781 #ifdef EBCDIC
5782 *d++ = CtrlChar(*s);
5783 #else
5784 *d++ = *s + '@';
5785 #endif
5786 if (d[-1] == '\\')
5787 *d++ = '\\'; /* double a backslash */
5789 else
5790 *d++ = *++s;
5791 if (s[1] != NUL && s[1] != '_')
5792 *d++ = '_'; /* append a '_' */
5793 continue;
5795 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5796 *d++ = '\\';
5799 * Insert a backslash before a backslash after a slash, for search
5800 * pattern tags: "/\|" --> "/\\|".
5802 else if (s[0] == '\\' && s[1] != '\\'
5803 && *arg == '/' && s == arg + 1)
5804 *d++ = '\\';
5806 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5807 * "CTRL-\_CTRL-N" */
5808 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5810 STRCPY(d, "CTRL-\\\\");
5811 d += 7;
5812 s += 6;
5815 *d++ = *s;
5818 * If tag starts with ', toss everything after a second '. Fixes
5819 * CTRL-] on 'option'. (would include the trailing '.').
5821 if (*s == '\'' && s > arg && *arg == '\'')
5822 break;
5824 *d = NUL;
5828 *matches = (char_u **)"";
5829 *num_matches = 0;
5830 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5831 if (keep_lang)
5832 flags |= TAG_KEEP_LANG;
5833 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5834 && *num_matches > 0)
5835 /* Sort the matches found on the heuristic number that is after the
5836 * tag name. */
5837 qsort((void *)*matches, (size_t)*num_matches,
5838 sizeof(char_u *), help_compare);
5839 return OK;
5843 * After reading a help file: May cleanup a help buffer when syntax
5844 * highlighting is not used.
5846 void
5847 fix_help_buffer()
5849 linenr_T lnum;
5850 char_u *line;
5851 int in_example = FALSE;
5852 int len;
5853 char_u *p;
5854 char_u *rt;
5855 int mustfree;
5857 /* set filetype to "help". */
5858 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5860 #ifdef FEAT_SYN_HL
5861 if (!syntax_present(curbuf))
5862 #endif
5864 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5866 line = ml_get_buf(curbuf, lnum, FALSE);
5867 len = (int)STRLEN(line);
5868 if (in_example && len > 0 && !vim_iswhite(line[0]))
5870 /* End of example: non-white or '<' in first column. */
5871 if (line[0] == '<')
5873 /* blank-out a '<' in the first column */
5874 line = ml_get_buf(curbuf, lnum, TRUE);
5875 line[0] = ' ';
5877 in_example = FALSE;
5879 if (!in_example && len > 0)
5881 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5883 /* blank-out a '>' in the last column (start of example) */
5884 line = ml_get_buf(curbuf, lnum, TRUE);
5885 line[len - 1] = ' ';
5886 in_example = TRUE;
5888 else if (line[len - 1] == '~')
5890 /* blank-out a '~' at the end of line (header marker) */
5891 line = ml_get_buf(curbuf, lnum, TRUE);
5892 line[len - 1] = ' ';
5899 * In the "help.txt" file, add the locally added help files.
5900 * This uses the very first line in the help file.
5902 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5904 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5906 line = ml_get_buf(curbuf, lnum, FALSE);
5907 if (strstr((char *)line, "*local-additions*") != NULL)
5909 /* Go through all directories in 'runtimepath', skipping
5910 * $VIMRUNTIME. */
5911 p = p_rtp;
5912 while (*p != NUL)
5914 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5915 mustfree = FALSE;
5916 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5917 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5919 int fcount;
5920 char_u **fnames;
5921 FILE *fd;
5922 char_u *s;
5923 int fi;
5924 #ifdef FEAT_MBYTE
5925 vimconv_T vc;
5926 char_u *cp;
5927 #endif
5929 /* Find all "doc/ *.txt" files in this directory. */
5930 add_pathsep(NameBuff);
5931 STRCAT(NameBuff, "doc/*.txt");
5932 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5933 &fnames, EW_FILE|EW_SILENT) == OK
5934 && fcount > 0)
5936 for (fi = 0; fi < fcount; ++fi)
5938 fd = mch_fopen((char *)fnames[fi], "r");
5939 if (fd != NULL)
5941 vim_fgets(IObuff, IOSIZE, fd);
5942 if (IObuff[0] == '*'
5943 && (s = vim_strchr(IObuff + 1, '*'))
5944 != NULL)
5946 #ifdef FEAT_MBYTE
5947 int this_utf = MAYBE;
5948 #endif
5949 /* Change tag definition to a
5950 * reference and remove <CR>/<NL>. */
5951 IObuff[0] = '|';
5952 *s = '|';
5953 while (*s != NUL)
5955 if (*s == '\r' || *s == '\n')
5956 *s = NUL;
5957 #ifdef FEAT_MBYTE
5958 /* The text is utf-8 when a byte
5959 * above 127 is found and no
5960 * illegal byte sequence is found.
5962 if (*s >= 0x80 && this_utf != FALSE)
5964 int l;
5966 this_utf = TRUE;
5967 l = utf_ptr2len(s);
5968 if (l == 1)
5969 this_utf = FALSE;
5970 s += l - 1;
5972 #endif
5973 ++s;
5975 #ifdef FEAT_MBYTE
5976 /* The help file is latin1 or utf-8;
5977 * conversion to the current
5978 * 'encoding' may be required. */
5979 vc.vc_type = CONV_NONE;
5980 convert_setup(&vc, (char_u *)(
5981 this_utf == TRUE ? "utf-8"
5982 : "latin1"), p_enc);
5983 if (vc.vc_type == CONV_NONE)
5984 /* No conversion needed. */
5985 cp = IObuff;
5986 else
5988 /* Do the conversion. If it fails
5989 * use the unconverted text. */
5990 cp = string_convert(&vc, IObuff,
5991 NULL);
5992 if (cp == NULL)
5993 cp = IObuff;
5995 convert_setup(&vc, NULL, NULL);
5997 ml_append(lnum, cp, (colnr_T)0, FALSE);
5998 if (cp != IObuff)
5999 vim_free(cp);
6000 #else
6001 ml_append(lnum, IObuff, (colnr_T)0,
6002 FALSE);
6003 #endif
6004 ++lnum;
6006 fclose(fd);
6009 FreeWild(fcount, fnames);
6012 if (mustfree)
6013 vim_free(rt);
6015 break;
6022 * ":exusage"
6024 /*ARGSUSED*/
6025 void
6026 ex_exusage(eap)
6027 exarg_T *eap;
6029 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6033 * ":viusage"
6035 /*ARGSUSED*/
6036 void
6037 ex_viusage(eap)
6038 exarg_T *eap;
6040 do_cmdline_cmd((char_u *)"help normal-index");
6043 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6044 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang));
6047 * ":helptags"
6049 void
6050 ex_helptags(eap)
6051 exarg_T *eap;
6053 garray_T ga;
6054 int i, j;
6055 int len;
6056 #ifdef FEAT_MULTI_LANG
6057 char_u lang[2];
6058 #endif
6059 char_u ext[5];
6060 char_u fname[8];
6061 int filecount;
6062 char_u **files;
6064 if (!mch_isdir(eap->arg))
6066 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6067 return;
6070 #ifdef FEAT_MULTI_LANG
6071 /* Get a list of all files in the directory. */
6072 STRCPY(NameBuff, eap->arg);
6073 add_pathsep(NameBuff);
6074 STRCAT(NameBuff, "*");
6075 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6076 EW_FILE|EW_SILENT) == FAIL
6077 || filecount == 0)
6079 EMSG2("E151: No match: %s", NameBuff);
6080 return;
6083 /* Go over all files in the directory to find out what languages are
6084 * present. */
6085 ga_init2(&ga, 1, 10);
6086 for (i = 0; i < filecount; ++i)
6088 len = (int)STRLEN(files[i]);
6089 if (len > 4)
6091 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6093 /* ".txt" -> language "en" */
6094 lang[0] = 'e';
6095 lang[1] = 'n';
6097 else if (files[i][len - 4] == '.'
6098 && ASCII_ISALPHA(files[i][len - 3])
6099 && ASCII_ISALPHA(files[i][len - 2])
6100 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6102 /* ".abx" -> language "ab" */
6103 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6104 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6106 else
6107 continue;
6109 /* Did we find this language already? */
6110 for (j = 0; j < ga.ga_len; j += 2)
6111 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6112 break;
6113 if (j == ga.ga_len)
6115 /* New language, add it. */
6116 if (ga_grow(&ga, 2) == FAIL)
6117 break;
6118 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6119 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6125 * Loop over the found languages to generate a tags file for each one.
6127 for (j = 0; j < ga.ga_len; j += 2)
6129 STRCPY(fname, "tags-xx");
6130 fname[5] = ((char_u *)ga.ga_data)[j];
6131 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6132 if (fname[5] == 'e' && fname[6] == 'n')
6134 /* English is an exception: use ".txt" and "tags". */
6135 fname[4] = NUL;
6136 STRCPY(ext, ".txt");
6138 else
6140 /* Language "ab" uses ".abx" and "tags-ab". */
6141 STRCPY(ext, ".xxx");
6142 ext[1] = fname[5];
6143 ext[2] = fname[6];
6145 helptags_one(eap->arg, ext, fname);
6148 ga_clear(&ga);
6149 FreeWild(filecount, files);
6151 #else
6152 /* No language support, just use "*.txt" and "tags". */
6153 helptags_one(eap->arg, (char_u *)".txt", (char_u *)"tags");
6154 #endif
6157 static void
6158 helptags_one(dir, ext, tagfname)
6159 char_u *dir; /* doc directory */
6160 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6161 char_u *tagfname; /* "tags" for English, "tags-it" for Italian. */
6163 FILE *fd_tags;
6164 FILE *fd;
6165 garray_T ga;
6166 int filecount;
6167 char_u **files;
6168 char_u *p1, *p2;
6169 int fi;
6170 char_u *s;
6171 int i;
6172 char_u *fname;
6173 # ifdef FEAT_MBYTE
6174 int utf8 = MAYBE;
6175 int this_utf8;
6176 int firstline;
6177 int mix = FALSE; /* detected mixed encodings */
6178 # endif
6181 * Find all *.txt files.
6183 STRCPY(NameBuff, dir);
6184 add_pathsep(NameBuff);
6185 STRCAT(NameBuff, "*");
6186 STRCAT(NameBuff, ext);
6187 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6188 EW_FILE|EW_SILENT) == FAIL
6189 || filecount == 0)
6191 if (!got_int)
6192 EMSG2("E151: No match: %s", NameBuff);
6193 return;
6197 * Open the tags file for writing.
6198 * Do this before scanning through all the files.
6200 STRCPY(NameBuff, dir);
6201 add_pathsep(NameBuff);
6202 STRCAT(NameBuff, tagfname);
6203 fd_tags = mch_fopen((char *)NameBuff, "w");
6204 if (fd_tags == NULL)
6206 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6207 FreeWild(filecount, files);
6208 return;
6212 * If generating tags for "$VIMRUNTIME/doc" add the "help-tags" tag.
6214 ga_init2(&ga, (int)sizeof(char_u *), 100);
6215 if (fullpathcmp((char_u *)"$VIMRUNTIME/doc", dir, FALSE) == FPC_SAME)
6217 if (ga_grow(&ga, 1) == FAIL)
6218 got_int = TRUE;
6219 else
6221 s = alloc(18 + (unsigned)STRLEN(tagfname));
6222 if (s == NULL)
6223 got_int = TRUE;
6224 else
6226 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6227 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6228 ++ga.ga_len;
6234 * Go over all the files and extract the tags.
6236 for (fi = 0; fi < filecount && !got_int; ++fi)
6238 fd = mch_fopen((char *)files[fi], "r");
6239 if (fd == NULL)
6241 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6242 continue;
6244 fname = gettail(files[fi]);
6246 # ifdef FEAT_MBYTE
6247 firstline = TRUE;
6248 # endif
6249 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6251 # ifdef FEAT_MBYTE
6252 if (firstline)
6254 /* Detect utf-8 file by a non-ASCII char in the first line. */
6255 this_utf8 = MAYBE;
6256 for (s = IObuff; *s != NUL; ++s)
6257 if (*s >= 0x80)
6259 int l;
6261 this_utf8 = TRUE;
6262 l = utf_ptr2len(s);
6263 if (l == 1)
6265 /* Illegal UTF-8 byte sequence. */
6266 this_utf8 = FALSE;
6267 break;
6269 s += l - 1;
6271 if (this_utf8 == MAYBE) /* only ASCII characters found */
6272 this_utf8 = FALSE;
6273 if (utf8 == MAYBE) /* first file */
6274 utf8 = this_utf8;
6275 else if (utf8 != this_utf8)
6277 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6278 mix = !got_int;
6279 got_int = TRUE;
6281 firstline = FALSE;
6283 # endif
6284 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6285 while (p1 != NULL)
6287 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6288 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6290 for (s = p1 + 1; s < p2; ++s)
6291 if (*s == ' ' || *s == '\t' || *s == '|')
6292 break;
6295 * Only accept a *tag* when it consists of valid
6296 * characters, there is white space before it and is
6297 * followed by a white character or end-of-line.
6299 if (s == p2
6300 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6301 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6302 || s[1] == '\0'))
6304 *p2 = '\0';
6305 ++p1;
6306 if (ga_grow(&ga, 1) == FAIL)
6308 got_int = TRUE;
6309 break;
6311 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6312 if (s == NULL)
6314 got_int = TRUE;
6315 break;
6317 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6318 ++ga.ga_len;
6319 sprintf((char *)s, "%s\t%s", p1, fname);
6321 /* find next '*' */
6322 p2 = vim_strchr(p2 + 1, '*');
6325 p1 = p2;
6327 line_breakcheck();
6330 fclose(fd);
6333 FreeWild(filecount, files);
6335 if (!got_int)
6338 * Sort the tags.
6340 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6343 * Check for duplicates.
6345 for (i = 1; i < ga.ga_len; ++i)
6347 p1 = ((char_u **)ga.ga_data)[i - 1];
6348 p2 = ((char_u **)ga.ga_data)[i];
6349 while (*p1 == *p2)
6351 if (*p2 == '\t')
6353 *p2 = NUL;
6354 vim_snprintf((char *)NameBuff, MAXPATHL,
6355 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6356 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6357 EMSG(NameBuff);
6358 *p2 = '\t';
6359 break;
6361 ++p1;
6362 ++p2;
6366 # ifdef FEAT_MBYTE
6367 if (utf8 == TRUE)
6368 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6369 # endif
6372 * Write the tags into the file.
6374 for (i = 0; i < ga.ga_len; ++i)
6376 s = ((char_u **)ga.ga_data)[i];
6377 if (STRNCMP(s, "help-tags\t", 10) == 0)
6378 /* help-tags entry was added in formatted form */
6379 fputs((char *)s, fd_tags);
6380 else
6382 fprintf(fd_tags, "%s\t/*", s);
6383 for (p1 = s; *p1 != '\t'; ++p1)
6385 /* insert backslash before '\\' and '/' */
6386 if (*p1 == '\\' || *p1 == '/')
6387 putc('\\', fd_tags);
6388 putc(*p1, fd_tags);
6390 fprintf(fd_tags, "*\n");
6394 #ifdef FEAT_MBYTE
6395 if (mix)
6396 got_int = FALSE; /* continue with other languages */
6397 #endif
6399 for (i = 0; i < ga.ga_len; ++i)
6400 vim_free(((char_u **)ga.ga_data)[i]);
6401 ga_clear(&ga);
6402 fclose(fd_tags); /* there is no check for an error... */
6404 #endif
6406 #if defined(FEAT_SIGNS) || defined(PROTO)
6409 * Struct to hold the sign properties.
6411 typedef struct sign sign_T;
6413 struct sign
6415 sign_T *sn_next; /* next sign in list */
6416 int sn_typenr; /* type number of sign (negative if not equal
6417 to name) */
6418 char_u *sn_name; /* name of sign */
6419 char_u *sn_icon; /* name of pixmap */
6420 #ifdef FEAT_SIGN_ICONS
6421 void *sn_image; /* icon image */
6422 #endif
6423 char_u *sn_text; /* text used instead of pixmap */
6424 int sn_line_hl; /* highlight ID for line */
6425 int sn_text_hl; /* highlight ID for text */
6428 static sign_T *first_sign = NULL;
6429 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6431 static void sign_list_defined __ARGS((sign_T *sp));
6434 * ":sign" command
6436 void
6437 ex_sign(eap)
6438 exarg_T *eap;
6440 char_u *arg = eap->arg;
6441 char_u *p;
6442 int idx;
6443 sign_T *sp;
6444 sign_T *sp_prev;
6445 buf_T *buf;
6446 static char *cmds[] = {
6447 "define",
6448 #define SIGNCMD_DEFINE 0
6449 "undefine",
6450 #define SIGNCMD_UNDEFINE 1
6451 "list",
6452 #define SIGNCMD_LIST 2
6453 "place",
6454 #define SIGNCMD_PLACE 3
6455 "unplace",
6456 #define SIGNCMD_UNPLACE 4
6457 "jump",
6458 #define SIGNCMD_JUMP 5
6459 #define SIGNCMD_LAST 6
6462 /* Parse the subcommand. */
6463 p = skiptowhite(arg);
6464 if (*p != NUL)
6465 *p++ = NUL;
6466 for (idx = 0; ; ++idx)
6468 if (idx == SIGNCMD_LAST)
6470 EMSG2(_("E160: Unknown sign command: %s"), arg);
6471 return;
6473 if (STRCMP(arg, cmds[idx]) == 0)
6474 break;
6476 arg = skipwhite(p);
6478 if (idx <= SIGNCMD_LIST)
6481 * Define, undefine or list signs.
6483 if (idx == SIGNCMD_LIST && *arg == NUL)
6485 /* ":sign list": list all defined signs */
6486 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6487 sign_list_defined(sp);
6489 else if (*arg == NUL)
6490 EMSG(_("E156: Missing sign name"));
6491 else
6493 p = skiptowhite(arg);
6494 if (*p != NUL)
6495 *p++ = NUL;
6496 sp_prev = NULL;
6497 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6499 if (STRCMP(sp->sn_name, arg) == 0)
6500 break;
6501 sp_prev = sp;
6503 if (idx == SIGNCMD_DEFINE)
6505 /* ":sign define {name} ...": define a sign */
6506 if (sp == NULL)
6508 /* Allocate a new sign. */
6509 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6510 if (sp == NULL)
6511 return;
6512 if (sp_prev == NULL)
6513 first_sign = sp;
6514 else
6515 sp_prev->sn_next = sp;
6516 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6518 /* If the name is a number use that for the typenr,
6519 * otherwise use a negative number. */
6520 if (VIM_ISDIGIT(*arg))
6521 sp->sn_typenr = atoi((char *)arg);
6522 else
6524 sign_T *lp;
6525 int start = last_sign_typenr;
6527 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6529 if (lp->sn_typenr == last_sign_typenr)
6531 --last_sign_typenr;
6532 if (last_sign_typenr == 0)
6533 last_sign_typenr = MAX_TYPENR;
6534 if (last_sign_typenr == start)
6536 EMSG(_("E612: Too many signs defined"));
6537 return;
6539 lp = first_sign;
6540 continue;
6544 sp->sn_typenr = last_sign_typenr--;
6545 if (last_sign_typenr == 0)
6546 last_sign_typenr = MAX_TYPENR; /* wrap around */
6550 /* set values for a defined sign. */
6551 for (;;)
6553 arg = skipwhite(p);
6554 if (*arg == NUL)
6555 break;
6556 p = skiptowhite_esc(arg);
6557 if (STRNCMP(arg, "icon=", 5) == 0)
6559 arg += 5;
6560 vim_free(sp->sn_icon);
6561 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6562 backslash_halve(sp->sn_icon);
6563 #ifdef FEAT_SIGN_ICONS
6564 if (gui.in_use)
6566 out_flush();
6567 if (sp->sn_image != NULL)
6568 gui_mch_destroy_sign(sp->sn_image);
6569 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6571 #endif
6573 else if (STRNCMP(arg, "text=", 5) == 0)
6575 char_u *s;
6576 int cells;
6577 int len;
6579 arg += 5;
6580 #ifdef FEAT_MBYTE
6581 /* Count cells and check for non-printable chars */
6582 if (has_mbyte)
6584 cells = 0;
6585 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6587 if (!vim_isprintc((*mb_ptr2char)(s)))
6588 break;
6589 cells += (*mb_ptr2cells)(s);
6592 else
6593 #endif
6595 for (s = arg; s < p; ++s)
6596 if (!vim_isprintc(*s))
6597 break;
6598 cells = (int)(s - arg);
6600 /* Currently must be one or two display cells */
6601 if (s != p || cells < 1 || cells > 2)
6603 *p = NUL;
6604 EMSG2(_("E239: Invalid sign text: %s"), arg);
6605 return;
6608 vim_free(sp->sn_text);
6609 /* Allocate one byte more if we need to pad up
6610 * with a space. */
6611 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6612 sp->sn_text = vim_strnsave(arg, len);
6614 if (sp->sn_text != NULL && cells == 1)
6615 STRCPY(sp->sn_text + len - 1, " ");
6617 else if (STRNCMP(arg, "linehl=", 7) == 0)
6619 arg += 7;
6620 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6622 else if (STRNCMP(arg, "texthl=", 7) == 0)
6624 arg += 7;
6625 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6627 else
6629 EMSG2(_(e_invarg2), arg);
6630 return;
6634 else if (sp == NULL)
6635 EMSG2(_("E155: Unknown sign: %s"), arg);
6636 else if (idx == SIGNCMD_LIST)
6637 /* ":sign list {name}" */
6638 sign_list_defined(sp);
6639 else
6641 /* ":sign undefine {name}" */
6642 vim_free(sp->sn_name);
6643 vim_free(sp->sn_icon);
6644 #ifdef FEAT_SIGN_ICONS
6645 if (sp->sn_image != NULL)
6647 out_flush();
6648 gui_mch_destroy_sign(sp->sn_image);
6650 #endif
6651 vim_free(sp->sn_text);
6652 if (sp_prev == NULL)
6653 first_sign = sp->sn_next;
6654 else
6655 sp_prev->sn_next = sp->sn_next;
6656 vim_free(sp);
6660 else
6662 int id = -1;
6663 linenr_T lnum = -1;
6664 char_u *sign_name = NULL;
6665 char_u *arg1;
6667 if (*arg == NUL)
6669 if (idx == SIGNCMD_PLACE)
6671 /* ":sign place": list placed signs in all buffers */
6672 sign_list_placed(NULL);
6674 else if (idx == SIGNCMD_UNPLACE)
6676 /* ":sign unplace": remove placed sign at cursor */
6677 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6678 if (id > 0)
6680 buf_delsign(curwin->w_buffer, id);
6681 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6683 else
6684 EMSG(_("E159: Missing sign number"));
6686 else
6687 EMSG(_(e_argreq));
6688 return;
6691 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6693 /* ":sign unplace *": remove all placed signs */
6694 buf_delete_all_signs();
6695 return;
6698 /* first arg could be placed sign id */
6699 arg1 = arg;
6700 if (VIM_ISDIGIT(*arg))
6702 id = getdigits(&arg);
6703 if (!vim_iswhite(*arg) && *arg != NUL)
6705 id = -1;
6706 arg = arg1;
6708 else
6710 arg = skipwhite(arg);
6711 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6713 /* ":sign unplace {id}": remove placed sign by number */
6714 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6715 if ((lnum = buf_delsign(buf, id)) != 0)
6716 update_debug_sign(buf, lnum);
6717 return;
6723 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6724 * Leave "arg" pointing to {fname}.
6726 for (;;)
6728 if (STRNCMP(arg, "line=", 5) == 0)
6730 arg += 5;
6731 lnum = atoi((char *)arg);
6732 arg = skiptowhite(arg);
6734 else if (STRNCMP(arg, "name=", 5) == 0)
6736 arg += 5;
6737 sign_name = arg;
6738 arg = skiptowhite(arg);
6739 if (*arg != NUL)
6740 *arg++ = NUL;
6742 else if (STRNCMP(arg, "file=", 5) == 0)
6744 arg += 5;
6745 buf = buflist_findname(arg);
6746 break;
6748 else if (STRNCMP(arg, "buffer=", 7) == 0)
6750 arg += 7;
6751 buf = buflist_findnr((int)getdigits(&arg));
6752 if (*skipwhite(arg) != NUL)
6753 EMSG(_(e_trailing));
6754 break;
6756 else
6758 EMSG(_(e_invarg));
6759 return;
6761 arg = skipwhite(arg);
6764 if (buf == NULL)
6766 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6768 else if (id <= 0)
6770 if (lnum >= 0 || sign_name != NULL)
6771 EMSG(_(e_invarg));
6772 else
6773 /* ":sign place file={fname}": list placed signs in one file */
6774 sign_list_placed(buf);
6776 else if (idx == SIGNCMD_JUMP)
6778 /* ":sign jump {id} file={fname}" */
6779 if (lnum >= 0 || sign_name != NULL)
6780 EMSG(_(e_invarg));
6781 else if ((lnum = buf_findsign(buf, id)) > 0)
6782 { /* goto a sign ... */
6783 if (buf_jump_open_win(buf) != NULL)
6784 { /* ... in a current window */
6785 curwin->w_cursor.lnum = lnum;
6786 check_cursor_lnum();
6787 beginline(BL_WHITE);
6789 else
6790 { /* ... not currently in a window */
6791 char_u *cmd;
6793 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6794 if (cmd == NULL)
6795 return;
6796 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6797 do_cmdline_cmd(cmd);
6798 vim_free(cmd);
6800 #ifdef FEAT_FOLDING
6801 foldOpenCursor();
6802 #endif
6804 else
6805 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6807 else if (idx == SIGNCMD_UNPLACE)
6809 /* ":sign unplace {id} file={fname}" */
6810 if (lnum >= 0 || sign_name != NULL)
6811 EMSG(_(e_invarg));
6812 else
6814 lnum = buf_delsign(buf, id);
6815 update_debug_sign(buf, lnum);
6818 /* idx == SIGNCMD_PLACE */
6819 else if (sign_name != NULL)
6821 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6822 if (STRCMP(sp->sn_name, sign_name) == 0)
6823 break;
6824 if (sp == NULL)
6826 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6827 return;
6829 if (lnum > 0)
6830 /* ":sign place {id} line={lnum} name={name} file={fname}":
6831 * place a sign */
6832 buf_addsign(buf, id, lnum, sp->sn_typenr);
6833 else
6834 /* ":sign place {id} file={fname}": change sign type */
6835 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6836 update_debug_sign(buf, lnum);
6838 else
6839 EMSG(_(e_invarg));
6843 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6845 * Allocate the icons. Called when the GUI has started. Allows defining
6846 * signs before it starts.
6848 void
6849 sign_gui_started()
6851 sign_T *sp;
6853 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6854 if (sp->sn_icon != NULL)
6855 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6857 #endif
6860 * List one sign.
6862 static void
6863 sign_list_defined(sp)
6864 sign_T *sp;
6866 char_u *p;
6868 smsg((char_u *)"sign %s", sp->sn_name);
6869 if (sp->sn_icon != NULL)
6871 MSG_PUTS(" icon=");
6872 msg_outtrans(sp->sn_icon);
6873 #ifdef FEAT_SIGN_ICONS
6874 if (sp->sn_image == NULL)
6875 MSG_PUTS(_(" (NOT FOUND)"));
6876 #else
6877 MSG_PUTS(_(" (not supported)"));
6878 #endif
6880 if (sp->sn_text != NULL)
6882 MSG_PUTS(" text=");
6883 msg_outtrans(sp->sn_text);
6885 if (sp->sn_line_hl > 0)
6887 MSG_PUTS(" linehl=");
6888 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6889 if (p == NULL)
6890 MSG_PUTS("NONE");
6891 else
6892 msg_puts(p);
6894 if (sp->sn_text_hl > 0)
6896 MSG_PUTS(" texthl=");
6897 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6898 if (p == NULL)
6899 MSG_PUTS("NONE");
6900 else
6901 msg_puts(p);
6906 * Get highlighting attribute for sign "typenr".
6907 * If "line" is TRUE: line highl, if FALSE: text highl.
6910 sign_get_attr(typenr, line)
6911 int typenr;
6912 int line;
6914 sign_T *sp;
6916 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6917 if (sp->sn_typenr == typenr)
6919 if (line)
6921 if (sp->sn_line_hl > 0)
6922 return syn_id2attr(sp->sn_line_hl);
6924 else
6926 if (sp->sn_text_hl > 0)
6927 return syn_id2attr(sp->sn_text_hl);
6929 break;
6931 return 0;
6935 * Get text mark for sign "typenr".
6936 * Returns NULL if there isn't one.
6938 char_u *
6939 sign_get_text(typenr)
6940 int typenr;
6942 sign_T *sp;
6944 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6945 if (sp->sn_typenr == typenr)
6946 return sp->sn_text;
6947 return NULL;
6950 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6951 void *
6952 sign_get_image(typenr)
6953 int typenr; /* the attribute which may have a sign */
6955 sign_T *sp;
6957 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6958 if (sp->sn_typenr == typenr)
6959 return sp->sn_image;
6960 return NULL;
6962 #endif
6965 * Get the name of a sign by its typenr.
6967 char_u *
6968 sign_typenr2name(typenr)
6969 int typenr;
6971 sign_T *sp;
6973 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6974 if (sp->sn_typenr == typenr)
6975 return sp->sn_name;
6976 return (char_u *)_("[Deleted]");
6979 #endif
6981 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
6983 * ":drop"
6984 * Opens the first argument in a window. When there are two or more arguments
6985 * the argument list is redefined.
6987 void
6988 ex_drop(eap)
6989 exarg_T *eap;
6991 int split = FALSE;
6992 win_T *wp;
6993 buf_T *buf;
6994 # ifdef FEAT_WINDOWS
6995 tabpage_T *tp;
6996 # endif
6999 * Check if the first argument is already being edited in a window. If
7000 * so, jump to that window.
7001 * We would actually need to check all arguments, but that's complicated
7002 * and mostly only one file is dropped.
7003 * This also ignores wildcards, since it is very unlikely the user is
7004 * editing a file name with a wildcard character.
7006 set_arglist(eap->arg);
7009 * Expanding wildcards may result in an empty argument list. E.g. when
7010 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7011 * already did an error message for this.
7013 if (ARGCOUNT == 0)
7014 return;
7016 # ifdef FEAT_WINDOWS
7017 if (cmdmod.tab)
7019 /* ":tab drop file ...": open a tab for each argument that isn't
7020 * edited in a window yet. It's like ":tab all" but without closing
7021 * windows or tabs. */
7022 ex_all(eap);
7024 else
7025 # endif
7027 /* ":drop file ...": Edit the first argument. Jump to an existing
7028 * window if possible, edit in current window if the current buffer
7029 * can be abandoned, otherwise open a new window. */
7030 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7032 FOR_ALL_TAB_WINDOWS(tp, wp)
7034 if (wp->w_buffer == buf)
7036 # ifdef FEAT_WINDOWS
7037 goto_tabpage_win(tp, wp);
7038 # endif
7039 curwin->w_arg_idx = 0;
7040 return;
7045 * Check whether the current buffer is changed. If so, we will need
7046 * to split the current window or data could be lost.
7047 * Skip the check if the 'hidden' option is set, as in this case the
7048 * buffer won't be lost.
7050 if (!P_HID(curbuf))
7052 # ifdef FEAT_WINDOWS
7053 ++emsg_off;
7054 # endif
7055 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7056 # ifdef FEAT_WINDOWS
7057 --emsg_off;
7058 # else
7059 if (split)
7060 return;
7061 # endif
7064 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7065 if (split)
7067 eap->cmdidx = CMD_sfirst;
7068 eap->cmd[0] = 's';
7070 else
7071 eap->cmdidx = CMD_first;
7072 ex_rewind(eap);
7075 #endif