Improved support for Ctrl-mappings
[MacVim.git] / src / ex_cmds.c
blobede122cc8a271a2cd38c19c891d9846f5111379b
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 = 0;
1778 st_old.st_ino = 0;
1779 st_old.st_mode = 0600;
1780 if (mch_stat((char *)fname, &st_old) == 0
1781 && getuid() != ROOT_UID
1782 && !(st_old.st_uid == getuid()
1783 ? (st_old.st_mode & 0200)
1784 : (st_old.st_gid == getgid()
1785 ? (st_old.st_mode & 0020)
1786 : (st_old.st_mode & 0002))))
1788 int tt = msg_didany;
1790 /* avoid a wait_return for this message, it's annoying */
1791 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1792 msg_didany = tt;
1793 fclose(fp_in);
1794 goto end;
1796 #endif
1797 #ifdef WIN3264
1798 /* Get the file attributes of the existing viminfo file. */
1799 perm = mch_getperm(fname);
1800 #endif
1803 * Make tempname.
1804 * May try twice: Once normal and once with shortname set, just in
1805 * case somebody puts his viminfo file in an 8.3 filesystem.
1807 for (;;)
1809 tempname = buf_modname(
1810 #ifdef UNIX
1811 shortname,
1812 #else
1813 # ifdef SHORT_FNAME
1814 TRUE,
1815 # else
1816 # ifdef FEAT_GUI_W32
1817 gui_is_win32s(),
1818 # else
1819 FALSE,
1820 # endif
1821 # endif
1822 #endif
1823 fname,
1824 #ifdef VMS
1825 (char_u *)"-tmp",
1826 #else
1827 # ifdef RISCOS
1828 (char_u *)"/tmp",
1829 # else
1830 (char_u *)".tmp",
1831 # endif
1832 #endif
1833 FALSE);
1834 if (tempname == NULL) /* out of memory */
1835 break;
1838 * Check if tempfile already exists. Never overwrite an
1839 * existing file!
1841 if (mch_stat((char *)tempname, &st_new) == 0)
1843 #ifdef UNIX
1845 * Check if tempfile is same as original file. May happen
1846 * when modname() gave the same file back. E.g. silly
1847 * link, or file name-length reached. Try again with
1848 * shortname set.
1850 if (!shortname && st_new.st_dev == st_old.st_dev
1851 && st_new.st_ino == st_old.st_ino)
1853 vim_free(tempname);
1854 tempname = NULL;
1855 shortname = TRUE;
1856 continue;
1858 #endif
1860 * Try another name. Change one character, just before
1861 * the extension. This should also work for an 8.3
1862 * file name, when after adding the extension it still is
1863 * the same file as the original.
1865 wp = tempname + STRLEN(tempname) - 5;
1866 if (wp < gettail(tempname)) /* empty file name? */
1867 wp = gettail(tempname);
1868 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1869 --*wp)
1872 * They all exist? Must be something wrong! Don't
1873 * write the viminfo file then.
1875 if (*wp == 'a')
1877 vim_free(tempname);
1878 tempname = NULL;
1879 break;
1883 break;
1886 if (tempname != NULL)
1888 #ifdef VMS
1889 /* fdopen() fails for some reason */
1890 umask_save = umask(077);
1891 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1892 (void)umask(umask_save);
1893 #else
1894 int fd;
1896 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1897 * protection:
1898 * Unix: same as original file, but strip s-bit. Reset umask to
1899 * avoid it getting in the way.
1900 * Others: r&w for user only. */
1901 # ifdef UNIX
1902 umask_save = umask(0);
1903 fd = mch_open((char *)tempname,
1904 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1905 (int)((st_old.st_mode & 0777) | 0600));
1906 (void)umask(umask_save);
1907 # else
1908 fd = mch_open((char *)tempname,
1909 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1910 # endif
1911 if (fd < 0)
1912 fp_out = NULL;
1913 else
1914 fp_out = fdopen(fd, WRITEBIN);
1915 #endif /* VMS */
1918 * If we can't create in the same directory, try creating a
1919 * "normal" temp file.
1921 if (fp_out == NULL)
1923 vim_free(tempname);
1924 if ((tempname = vim_tempname('o')) != NULL)
1925 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1928 #if defined(UNIX) && defined(HAVE_FCHOWN)
1930 * Make sure the owner can read/write it. This only works for
1931 * root.
1933 if (fp_out != NULL)
1934 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1935 #endif
1940 * Check if the new viminfo file can be written to.
1942 if (fp_out == NULL)
1944 EMSG2(_("E138: Can't write viminfo file %s!"),
1945 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1946 if (fp_in != NULL)
1947 fclose(fp_in);
1948 goto end;
1951 if (p_verbose > 0)
1953 verbose_enter();
1954 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1955 verbose_leave();
1958 viminfo_errcnt = 0;
1959 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1961 fclose(fp_out); /* errors are ignored !? */
1962 if (fp_in != NULL)
1964 fclose(fp_in);
1967 * In case of an error keep the original viminfo file.
1968 * Otherwise rename the newly written file.
1970 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1971 mch_remove(tempname);
1973 #ifdef WIN3264
1974 /* If the viminfo file was hidden then also hide the new file. */
1975 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1976 mch_hide(fname);
1977 #endif
1980 end:
1981 vim_free(fname);
1982 vim_free(tempname);
1986 * Get the viminfo file name to use.
1987 * If "file" is given and not empty, use it (has already been expanded by
1988 * cmdline functions).
1989 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1990 * expand environment variables.
1991 * Returns an allocated string. NULL when out of memory.
1993 static char_u *
1994 viminfo_filename(file)
1995 char_u *file;
1997 if (file == NULL || *file == NUL)
1999 if (use_viminfo != NULL)
2000 file = use_viminfo;
2001 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2003 #ifdef VIMINFO_FILE2
2004 /* don't use $HOME when not defined (turned into "c:/"!). */
2005 # ifdef VMS
2006 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2007 # else
2008 if (mch_getenv((char_u *)"HOME") == NULL)
2009 # endif
2011 /* don't use $VIM when not available. */
2012 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2013 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2014 file = (char_u *)VIMINFO_FILE2;
2015 else
2016 file = (char_u *)VIMINFO_FILE;
2018 else
2019 #endif
2020 file = (char_u *)VIMINFO_FILE;
2022 expand_env(file, NameBuff, MAXPATHL);
2023 file = NameBuff;
2025 return vim_strsave(file);
2029 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2031 static void
2032 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2033 FILE *fp_in;
2034 FILE *fp_out;
2035 int want_info;
2036 int want_marks;
2037 int force_read;
2039 int count = 0;
2040 int eof = FALSE;
2041 vir_T vir;
2043 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2044 return;
2045 vir.vir_fd = fp_in;
2046 #ifdef FEAT_MBYTE
2047 vir.vir_conv.vc_type = CONV_NONE;
2048 #endif
2050 if (fp_in != NULL)
2052 if (want_info)
2053 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2054 else
2055 /* Skip info, find start of marks */
2056 while (!(eof = viminfo_readline(&vir))
2057 && vir.vir_line[0] != '>')
2060 if (fp_out != NULL)
2062 /* Write the info: */
2063 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2064 VIM_VERSION_MEDIUM);
2065 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2066 #ifdef FEAT_MBYTE
2067 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2068 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2069 #endif
2070 write_viminfo_search_pattern(fp_out);
2071 write_viminfo_sub_string(fp_out);
2072 #ifdef FEAT_CMDHIST
2073 write_viminfo_history(fp_out);
2074 #endif
2075 write_viminfo_registers(fp_out);
2076 #ifdef FEAT_EVAL
2077 write_viminfo_varlist(fp_out);
2078 #endif
2079 write_viminfo_filemarks(fp_out);
2080 write_viminfo_bufferlist(fp_out);
2081 count = write_viminfo_marks(fp_out);
2083 if (fp_in != NULL && want_marks)
2084 copy_viminfo_marks(&vir, fp_out, count, eof);
2086 vim_free(vir.vir_line);
2087 #ifdef FEAT_MBYTE
2088 if (vir.vir_conv.vc_type != CONV_NONE)
2089 convert_setup(&vir.vir_conv, NULL, NULL);
2090 #endif
2094 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2095 * first part of the viminfo file which contains everything but the marks that
2096 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2098 static int
2099 read_viminfo_up_to_marks(virp, forceit, writing)
2100 vir_T *virp;
2101 int forceit;
2102 int writing;
2104 int eof;
2105 buf_T *buf;
2107 #ifdef FEAT_CMDHIST
2108 prepare_viminfo_history(forceit ? 9999 : 0);
2109 #endif
2110 eof = viminfo_readline(virp);
2111 while (!eof && virp->vir_line[0] != '>')
2113 switch (virp->vir_line[0])
2115 /* Characters reserved for future expansion, ignored now */
2116 case '+': /* "+40 /path/dir file", for running vim without args */
2117 case '|': /* to be defined */
2118 case '^': /* to be defined */
2119 case '<': /* long line - ignored */
2120 /* A comment or empty line. */
2121 case NUL:
2122 case '\r':
2123 case '\n':
2124 case '#':
2125 eof = viminfo_readline(virp);
2126 break;
2127 case '*': /* "*encoding=value" */
2128 eof = viminfo_encoding(virp);
2129 break;
2130 case '!': /* global variable */
2131 #ifdef FEAT_EVAL
2132 eof = read_viminfo_varlist(virp, writing);
2133 #else
2134 eof = viminfo_readline(virp);
2135 #endif
2136 break;
2137 case '%': /* entry for buffer list */
2138 eof = read_viminfo_bufferlist(virp, writing);
2139 break;
2140 case '"':
2141 eof = read_viminfo_register(virp, forceit);
2142 break;
2143 case '/': /* Search string */
2144 case '&': /* Substitute search string */
2145 case '~': /* Last search string, followed by '/' or '&' */
2146 eof = read_viminfo_search_pattern(virp, forceit);
2147 break;
2148 case '$':
2149 eof = read_viminfo_sub_string(virp, forceit);
2150 break;
2151 case ':':
2152 case '?':
2153 case '=':
2154 case '@':
2155 #ifdef FEAT_CMDHIST
2156 eof = read_viminfo_history(virp);
2157 #else
2158 eof = viminfo_readline(virp);
2159 #endif
2160 break;
2161 case '-':
2162 case '\'':
2163 eof = read_viminfo_filemark(virp, forceit);
2164 break;
2165 default:
2166 if (viminfo_error("E575: ", _("Illegal starting char"),
2167 virp->vir_line))
2168 eof = TRUE;
2169 else
2170 eof = viminfo_readline(virp);
2171 break;
2175 #ifdef FEAT_CMDHIST
2176 /* Finish reading history items. */
2177 finish_viminfo_history();
2178 #endif
2180 /* Change file names to buffer numbers for fmarks. */
2181 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2182 fmarks_check_names(buf);
2184 return eof;
2188 * Compare the 'encoding' value in the viminfo file with the current value of
2189 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2190 * conversion of text with iconv() in viminfo_readstring().
2192 static int
2193 viminfo_encoding(virp)
2194 vir_T *virp;
2196 #ifdef FEAT_MBYTE
2197 char_u *p;
2198 int i;
2200 if (get_viminfo_parameter('c') != 0)
2202 p = vim_strchr(virp->vir_line, '=');
2203 if (p != NULL)
2205 /* remove trailing newline */
2206 ++p;
2207 for (i = 0; vim_isprintc(p[i]); ++i)
2209 p[i] = NUL;
2211 convert_setup(&virp->vir_conv, p, p_enc);
2214 #endif
2215 return viminfo_readline(virp);
2219 * Read a line from the viminfo file.
2220 * Returns TRUE for end-of-file;
2223 viminfo_readline(virp)
2224 vir_T *virp;
2226 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2230 * check string read from viminfo file
2231 * remove '\n' at the end of the line
2232 * - replace CTRL-V CTRL-V with CTRL-V
2233 * - replace CTRL-V 'n' with '\n'
2235 * Check for a long line as written by viminfo_writestring().
2237 * Return the string in allocated memory (NULL when out of memory).
2239 /*ARGSUSED*/
2240 char_u *
2241 viminfo_readstring(virp, off, convert)
2242 vir_T *virp;
2243 int off; /* offset for virp->vir_line */
2244 int convert; /* convert the string */
2246 char_u *retval;
2247 char_u *s, *d;
2248 long len;
2250 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2252 len = atol((char *)virp->vir_line + off + 1);
2253 retval = lalloc(len, TRUE);
2254 if (retval == NULL)
2256 /* Line too long? File messed up? Skip next line. */
2257 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2258 return NULL;
2260 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2261 s = retval + 1; /* Skip the leading '<' */
2263 else
2265 retval = vim_strsave(virp->vir_line + off);
2266 if (retval == NULL)
2267 return NULL;
2268 s = retval;
2271 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2272 d = retval;
2273 while (*s != NUL && *s != '\n')
2275 if (s[0] == Ctrl_V && s[1] != NUL)
2277 if (s[1] == 'n')
2278 *d++ = '\n';
2279 else
2280 *d++ = Ctrl_V;
2281 s += 2;
2283 else
2284 *d++ = *s++;
2286 *d = NUL;
2288 #ifdef FEAT_MBYTE
2289 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2291 d = string_convert(&virp->vir_conv, retval, NULL);
2292 if (d != NULL)
2294 vim_free(retval);
2295 retval = d;
2298 #endif
2300 return retval;
2304 * write string to viminfo file
2305 * - replace CTRL-V with CTRL-V CTRL-V
2306 * - replace '\n' with CTRL-V 'n'
2307 * - add a '\n' at the end
2309 * For a long line:
2310 * - write " CTRL-V <length> \n " in first line
2311 * - write " < <string> \n " in second line
2313 void
2314 viminfo_writestring(fd, p)
2315 FILE *fd;
2316 char_u *p;
2318 int c;
2319 char_u *s;
2320 int len = 0;
2322 for (s = p; *s != NUL; ++s)
2324 if (*s == Ctrl_V || *s == '\n')
2325 ++len;
2326 ++len;
2329 /* If the string will be too long, write its length and put it in the next
2330 * line. Take into account that some room is needed for what comes before
2331 * the string (e.g., variable name). Add something to the length for the
2332 * '<', NL and trailing NUL. */
2333 if (len > LSIZE / 2)
2334 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2336 while ((c = *p++) != NUL)
2338 if (c == Ctrl_V || c == '\n')
2340 putc(Ctrl_V, fd);
2341 if (c == '\n')
2342 c = 'n';
2344 putc(c, fd);
2346 putc('\n', fd);
2348 #endif /* FEAT_VIMINFO */
2351 * Implementation of ":fixdel", also used by get_stty().
2352 * <BS> resulting <Del>
2353 * ^? ^H
2354 * not ^? ^?
2356 /*ARGSUSED*/
2357 void
2358 do_fixdel(eap)
2359 exarg_T *eap;
2361 char_u *p;
2363 p = find_termcode((char_u *)"kb");
2364 add_termcode((char_u *)"kD", p != NULL
2365 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2368 void
2369 print_line_no_prefix(lnum, use_number, list)
2370 linenr_T lnum;
2371 int use_number;
2372 int list;
2374 char_u numbuf[30];
2376 if (curwin->w_p_nu || use_number)
2378 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2379 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2381 msg_prt_line(ml_get(lnum), list);
2385 * Print a text line. Also in silent mode ("ex -s").
2387 void
2388 print_line(lnum, use_number, list)
2389 linenr_T lnum;
2390 int use_number;
2391 int list;
2393 int save_silent = silent_mode;
2395 msg_start();
2396 silent_mode = FALSE;
2397 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2398 print_line_no_prefix(lnum, use_number, list);
2399 if (save_silent)
2401 msg_putchar('\n');
2402 cursor_on(); /* msg_start() switches it off */
2403 out_flush();
2404 silent_mode = save_silent;
2405 info_message = FALSE;
2410 * ":file[!] [fname]".
2412 void
2413 ex_file(eap)
2414 exarg_T *eap;
2416 char_u *fname, *sfname, *xfname;
2417 buf_T *buf;
2419 /* ":0file" removes the file name. Check for illegal uses ":3file",
2420 * "0file name", etc. */
2421 if (eap->addr_count > 0
2422 && (*eap->arg != NUL
2423 || eap->line2 > 0
2424 || eap->addr_count > 1))
2426 EMSG(_(e_invarg));
2427 return;
2430 if (*eap->arg != NUL || eap->addr_count == 1)
2432 #ifdef FEAT_AUTOCMD
2433 buf = curbuf;
2434 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2435 /* buffer changed, don't change name now */
2436 if (buf != curbuf)
2437 return;
2438 # ifdef FEAT_EVAL
2439 if (aborting()) /* autocmds may abort script processing */
2440 return;
2441 # endif
2442 #endif
2444 * The name of the current buffer will be changed.
2445 * A new (unlisted) buffer entry needs to be made to hold the old file
2446 * name, which will become the alternate file name.
2447 * But don't set the alternate file name if the buffer didn't have a
2448 * name.
2450 fname = curbuf->b_ffname;
2451 sfname = curbuf->b_sfname;
2452 xfname = curbuf->b_fname;
2453 curbuf->b_ffname = NULL;
2454 curbuf->b_sfname = NULL;
2455 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2457 curbuf->b_ffname = fname;
2458 curbuf->b_sfname = sfname;
2459 return;
2461 curbuf->b_flags |= BF_NOTEDITED;
2462 if (xfname != NULL && *xfname != NUL)
2464 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2465 if (buf != NULL && !cmdmod.keepalt)
2466 curwin->w_alt_fnum = buf->b_fnum;
2468 vim_free(fname);
2469 vim_free(sfname);
2470 #ifdef FEAT_AUTOCMD
2471 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2472 #endif
2473 /* Change directories when the 'acd' option is set. */
2474 DO_AUTOCHDIR
2476 /* print full file name if :cd used */
2477 fileinfo(FALSE, FALSE, eap->forceit);
2481 * ":update".
2483 void
2484 ex_update(eap)
2485 exarg_T *eap;
2487 if (curbufIsChanged())
2488 (void)do_write(eap);
2492 * ":write" and ":saveas".
2494 void
2495 ex_write(eap)
2496 exarg_T *eap;
2498 if (eap->usefilter) /* input lines to shell command */
2499 do_bang(1, eap, FALSE, TRUE, FALSE);
2500 else
2501 (void)do_write(eap);
2505 * write current buffer to file 'eap->arg'
2506 * if 'eap->append' is TRUE, append to the file
2508 * if *eap->arg == NUL write to current file
2510 * return FAIL for failure, OK otherwise
2513 do_write(eap)
2514 exarg_T *eap;
2516 int other;
2517 char_u *fname = NULL; /* init to shut up gcc */
2518 char_u *ffname;
2519 int retval = FAIL;
2520 char_u *free_fname = NULL;
2521 #ifdef FEAT_BROWSE
2522 char_u *browse_file = NULL;
2523 #endif
2524 buf_T *alt_buf = NULL;
2526 if (not_writing()) /* check 'write' option */
2527 return FAIL;
2529 ffname = eap->arg;
2530 #ifdef FEAT_BROWSE
2531 if (cmdmod.browse)
2533 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2534 NULL, NULL, NULL, curbuf);
2535 if (browse_file == NULL)
2536 goto theend;
2537 ffname = browse_file;
2539 #endif
2540 if (*ffname == NUL)
2542 if (eap->cmdidx == CMD_saveas)
2544 EMSG(_(e_argreq));
2545 goto theend;
2547 other = FALSE;
2549 else
2551 fname = ffname;
2552 free_fname = fix_fname(ffname);
2554 * When out-of-memory, keep unexpanded file name, because we MUST be
2555 * able to write the file in this situation.
2557 if (free_fname != NULL)
2558 ffname = free_fname;
2559 other = otherfile(ffname);
2563 * If we have a new file, put its name in the list of alternate file names.
2565 if (other)
2567 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2568 || eap->cmdidx == CMD_saveas)
2569 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2570 else
2571 alt_buf = buflist_findname(ffname);
2572 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2574 /* Overwriting a file that is loaded in another buffer is not a
2575 * good idea. */
2576 EMSG(_(e_bufloaded));
2577 goto theend;
2582 * Writing to the current file is not allowed in readonly mode
2583 * and a file name is required.
2584 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2586 if (!other && (
2587 #ifdef FEAT_QUICKFIX
2588 bt_dontwrite_msg(curbuf) ||
2589 #endif
2590 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2591 goto theend;
2593 if (!other)
2595 ffname = curbuf->b_ffname;
2596 fname = curbuf->b_fname;
2598 * Not writing the whole file is only allowed with '!'.
2600 if ( (eap->line1 != 1
2601 || eap->line2 != curbuf->b_ml.ml_line_count)
2602 && !eap->forceit
2603 && !eap->append
2604 && !p_wa)
2606 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2607 if (p_confirm || cmdmod.confirm)
2609 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2610 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2611 goto theend;
2612 eap->forceit = TRUE;
2614 else
2615 #endif
2617 EMSG(_("E140: Use ! to write partial buffer"));
2618 goto theend;
2623 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2625 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2627 #ifdef FEAT_AUTOCMD
2628 buf_T *was_curbuf = curbuf;
2630 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2631 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2632 # ifdef FEAT_EVAL
2633 if (curbuf != was_curbuf || aborting())
2634 # else
2635 if (curbuf != was_curbuf)
2636 # endif
2638 /* buffer changed, don't change name now */
2639 retval = FAIL;
2640 goto theend;
2642 #endif
2643 /* Exchange the file names for the current and the alternate
2644 * buffer. This makes it look like we are now editing the buffer
2645 * under the new name. Must be done before buf_write(), because
2646 * if there is no file name and 'cpo' contains 'F', it will set
2647 * the file name. */
2648 fname = alt_buf->b_fname;
2649 alt_buf->b_fname = curbuf->b_fname;
2650 curbuf->b_fname = fname;
2651 fname = alt_buf->b_ffname;
2652 alt_buf->b_ffname = curbuf->b_ffname;
2653 curbuf->b_ffname = fname;
2654 fname = alt_buf->b_sfname;
2655 alt_buf->b_sfname = curbuf->b_sfname;
2656 curbuf->b_sfname = fname;
2657 buf_name_changed(curbuf);
2658 #ifdef FEAT_AUTOCMD
2659 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2660 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2661 if (!alt_buf->b_p_bl)
2663 alt_buf->b_p_bl = TRUE;
2664 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2666 # ifdef FEAT_EVAL
2667 if (curbuf != was_curbuf || aborting())
2668 # else
2669 if (curbuf != was_curbuf)
2670 # endif
2672 /* buffer changed, don't write the file */
2673 retval = FAIL;
2674 goto theend;
2677 /* If 'filetype' was empty try detecting it now. */
2678 if (*curbuf->b_p_ft == NUL)
2680 if (au_has_group((char_u *)"filetypedetect"))
2681 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2682 TRUE);
2683 do_modelines(0);
2685 #endif
2688 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2689 eap, eap->append, eap->forceit, TRUE, FALSE);
2691 /* After ":saveas fname" reset 'readonly'. */
2692 if (eap->cmdidx == CMD_saveas)
2694 if (retval == OK)
2695 curbuf->b_p_ro = FALSE;
2696 /* Change directories when the 'acd' option is set. */
2697 DO_AUTOCHDIR
2701 theend:
2702 #ifdef FEAT_BROWSE
2703 vim_free(browse_file);
2704 #endif
2705 vim_free(free_fname);
2706 return retval;
2710 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2711 * BF_NEW or BF_READERR, check for overwriting current file.
2712 * May set eap->forceit if a dialog says it's OK to overwrite.
2713 * Return OK if it's OK, FAIL if it is not.
2715 /*ARGSUSED*/
2716 static int
2717 check_overwrite(eap, buf, fname, ffname, other)
2718 exarg_T *eap;
2719 buf_T *buf;
2720 char_u *fname; /* file name to be used (can differ from
2721 buf->ffname) */
2722 char_u *ffname; /* full path version of fname */
2723 int other; /* writing under other name */
2726 * write to other file or b_flags set or not writing the whole file:
2727 * overwriting only allowed with '!'
2729 if ( (other
2730 || (buf->b_flags & BF_NOTEDITED)
2731 || ((buf->b_flags & BF_NEW)
2732 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2733 || (buf->b_flags & BF_READERR))
2734 && !p_wa
2735 && vim_fexists(ffname))
2737 if (!eap->forceit && !eap->append)
2739 #ifdef UNIX
2740 /* with UNIX it is possible to open a directory */
2741 if (mch_isdir(ffname))
2743 EMSG2(_(e_isadir2), ffname);
2744 return FAIL;
2746 #endif
2747 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2748 if (p_confirm || cmdmod.confirm)
2750 char_u buff[IOSIZE];
2752 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2753 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2754 return FAIL;
2755 eap->forceit = TRUE;
2757 else
2758 #endif
2760 EMSG(_(e_exists));
2761 return FAIL;
2765 /* For ":w! filename" check that no swap file exists for "filename". */
2766 if (other && !emsg_silent)
2768 char_u dir[MAXPATHL];
2769 char_u *p;
2770 int r;
2771 char_u *swapname;
2773 /* We only try the first entry in 'directory', without checking if
2774 * it's writable. If the "." directory is not writable the write
2775 * will probably fail anyway.
2776 * Use 'shortname' of the current buffer, since there is no buffer
2777 * for the written file. */
2778 if (*p_dir == NUL)
2779 STRCPY(dir, ".");
2780 else
2782 p = p_dir;
2783 copy_option_part(&p, dir, MAXPATHL, ",");
2785 swapname = makeswapname(fname, ffname, curbuf, dir);
2786 r = vim_fexists(swapname);
2787 if (r)
2789 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2790 if (p_confirm || cmdmod.confirm)
2792 char_u buff[IOSIZE];
2794 dialog_msg(buff,
2795 _("Swap file \"%s\" exists, overwrite anyway?"),
2796 swapname);
2797 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2798 != VIM_YES)
2800 vim_free(swapname);
2801 return FAIL;
2803 eap->forceit = TRUE;
2805 else
2806 #endif
2808 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2809 swapname);
2810 vim_free(swapname);
2811 return FAIL;
2814 vim_free(swapname);
2817 return OK;
2821 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2823 void
2824 ex_wnext(eap)
2825 exarg_T *eap;
2827 int i;
2829 if (eap->cmd[1] == 'n')
2830 i = curwin->w_arg_idx + (int)eap->line2;
2831 else
2832 i = curwin->w_arg_idx - (int)eap->line2;
2833 eap->line1 = 1;
2834 eap->line2 = curbuf->b_ml.ml_line_count;
2835 if (do_write(eap) != FAIL)
2836 do_argfile(eap, i);
2840 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2842 void
2843 do_wqall(eap)
2844 exarg_T *eap;
2846 buf_T *buf;
2847 int error = 0;
2848 int save_forceit = eap->forceit;
2850 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2851 exiting = TRUE;
2853 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2855 if (bufIsChanged(buf))
2858 * Check if there is a reason the buffer cannot be written:
2859 * 1. if the 'write' option is set
2860 * 2. if there is no file name (even after browsing)
2861 * 3. if the 'readonly' is set (even after a dialog)
2862 * 4. if overwriting is allowed (even after a dialog)
2864 if (not_writing())
2866 ++error;
2867 break;
2869 #ifdef FEAT_BROWSE
2870 /* ":browse wall": ask for file name if there isn't one */
2871 if (buf->b_ffname == NULL && cmdmod.browse)
2872 browse_save_fname(buf);
2873 #endif
2874 if (buf->b_ffname == NULL)
2876 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2877 ++error;
2879 else if (check_readonly(&eap->forceit, buf)
2880 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2881 FALSE) == FAIL)
2883 ++error;
2885 else
2887 if (buf_write_all(buf, eap->forceit) == FAIL)
2888 ++error;
2889 #ifdef FEAT_AUTOCMD
2890 /* an autocommand may have deleted the buffer */
2891 if (!buf_valid(buf))
2892 buf = firstbuf;
2893 #endif
2895 eap->forceit = save_forceit; /* check_overwrite() may set it */
2898 if (exiting)
2900 if (!error)
2901 getout(0); /* exit Vim */
2902 not_exiting();
2907 * Check the 'write' option.
2908 * Return TRUE and give a message when it's not st.
2911 not_writing()
2913 if (p_write)
2914 return FALSE;
2915 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2916 return TRUE;
2920 * Check if a buffer is read-only (either 'readonly' option is set or file is
2921 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2922 * message when the buffer is readonly.
2924 static int
2925 check_readonly(forceit, buf)
2926 int *forceit;
2927 buf_T *buf;
2929 struct stat st;
2931 /* Handle a file being readonly when the 'readonly' option is set or when
2932 * the file exists and permissions are read-only.
2933 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2934 * important for device checks but not here. */
2935 if (!*forceit && (buf->b_p_ro
2936 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2937 && check_file_readonly(buf->b_ffname, 0777))))
2939 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2940 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2942 char_u buff[IOSIZE];
2944 if (buf->b_p_ro)
2945 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2946 buf->b_fname);
2947 else
2948 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2949 buf->b_fname);
2951 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2953 /* Set forceit, to force the writing of a readonly file */
2954 *forceit = TRUE;
2955 return FALSE;
2957 else
2958 return TRUE;
2960 else
2961 #endif
2962 if (buf->b_p_ro)
2963 EMSG(_(e_readonly));
2964 else
2965 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2966 buf->b_fname);
2967 return TRUE;
2970 return FALSE;
2974 * Try to abandon current file and edit a new or existing file.
2975 * 'fnum' is the number of the file, if zero use ffname/sfname.
2977 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2978 * -1 for successfully opening another file.
2979 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2982 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2983 int fnum;
2984 char_u *ffname;
2985 char_u *sfname;
2986 int setpm;
2987 linenr_T lnum;
2988 int forceit;
2990 int other;
2991 int retval;
2992 char_u *free_me = NULL;
2994 if (text_locked())
2995 return 1;
2996 #ifdef FEAT_AUTOCMD
2997 if (curbuf_locked())
2998 return 1;
2999 #endif
3001 if (fnum == 0)
3003 /* make ffname full path, set sfname */
3004 fname_expand(curbuf, &ffname, &sfname);
3005 other = otherfile(ffname);
3006 free_me = ffname; /* has been allocated, free() later */
3008 else
3009 other = (fnum != curbuf->b_fnum);
3011 if (other)
3012 ++no_wait_return; /* don't wait for autowrite message */
3013 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3014 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3016 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3017 if (p_confirm && p_write)
3018 dialog_changed(curbuf, FALSE);
3019 if (curbufIsChanged())
3020 #endif
3022 if (other)
3023 --no_wait_return;
3024 EMSG(_(e_nowrtmsg));
3025 retval = 2; /* file has been changed */
3026 goto theend;
3029 if (other)
3030 --no_wait_return;
3031 if (setpm)
3032 setpcmark();
3033 if (!other)
3035 if (lnum != 0)
3036 curwin->w_cursor.lnum = lnum;
3037 check_cursor_lnum();
3038 beginline(BL_SOL | BL_FIX);
3039 retval = 0; /* it's in the same file */
3041 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3042 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3043 retval = -1; /* opened another file */
3044 else
3045 retval = 1; /* error encountered */
3047 theend:
3048 vim_free(free_me);
3049 return retval;
3053 * start editing a new file
3055 * fnum: file number; if zero use ffname/sfname
3056 * ffname: the file name
3057 * - full path if sfname used,
3058 * - any file name if sfname is NULL
3059 * - empty string to re-edit with the same file name (but may be
3060 * in a different directory)
3061 * - NULL to start an empty buffer
3062 * sfname: the short file name (or NULL)
3063 * eap: contains the command to be executed after loading the file and
3064 * forced 'ff' and 'fenc'
3065 * newlnum: if > 0: put cursor on this line number (if possible)
3066 * if ECMD_LASTL: use last position in loaded file
3067 * if ECMD_LAST: use last position in all files
3068 * if ECMD_ONE: use first line
3069 * flags:
3070 * ECMD_HIDE: if TRUE don't free the current buffer
3071 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3072 * ECMD_OLDBUF: use existing buffer if it exists
3073 * ECMD_FORCEIT: ! used for Ex command
3074 * ECMD_ADDBUF: don't edit, just add to buffer list
3076 * return FAIL for failure, OK otherwise
3079 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3080 int fnum;
3081 char_u *ffname;
3082 char_u *sfname;
3083 exarg_T *eap; /* can be NULL! */
3084 linenr_T newlnum;
3085 int flags;
3087 int other_file; /* TRUE if editing another file */
3088 int oldbuf; /* TRUE if using existing buffer */
3089 #ifdef FEAT_AUTOCMD
3090 int auto_buf = FALSE; /* TRUE if autocommands brought us
3091 into the buffer unexpectedly */
3092 char_u *new_name = NULL;
3093 int did_set_swapcommand = FALSE;
3094 #endif
3095 buf_T *buf;
3096 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3097 buf_T *old_curbuf = curbuf;
3098 #endif
3099 char_u *free_fname = NULL;
3100 #ifdef FEAT_BROWSE
3101 char_u *browse_file = NULL;
3102 #endif
3103 int retval = FAIL;
3104 long n;
3105 linenr_T lnum;
3106 linenr_T topline = 0;
3107 int newcol = -1;
3108 int solcol = -1;
3109 pos_T *pos;
3110 #ifdef FEAT_SUN_WORKSHOP
3111 char_u *cp;
3112 #endif
3113 char_u *command = NULL;
3114 #ifdef FEAT_SPELL
3115 int did_get_winopts = FALSE;
3116 #endif
3118 if (eap != NULL)
3119 command = eap->do_ecmd_cmd;
3121 if (fnum != 0)
3123 if (fnum == curbuf->b_fnum) /* file is already being edited */
3124 return OK; /* nothing to do */
3125 other_file = TRUE;
3127 else
3129 #ifdef FEAT_BROWSE
3130 if (cmdmod.browse)
3132 if (
3133 # ifdef FEAT_GUI
3134 !gui.in_use &&
3135 # endif
3136 au_has_group((char_u *)"FileExplorer"))
3138 /* No browsing supported but we do have the file explorer:
3139 * Edit the directory. */
3140 if (ffname == NULL || !mch_isdir(ffname))
3141 ffname = (char_u *)".";
3143 else
3145 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3146 NULL, NULL, NULL, curbuf);
3147 if (browse_file == NULL)
3148 goto theend;
3149 ffname = browse_file;
3152 #endif
3153 /* if no short name given, use ffname for short name */
3154 if (sfname == NULL)
3155 sfname = ffname;
3156 #ifdef USE_FNAME_CASE
3157 # ifdef USE_LONG_FNAME
3158 if (USE_LONG_FNAME)
3159 # endif
3160 if (sfname != NULL)
3161 fname_case(sfname, 0); /* set correct case for sfname */
3162 #endif
3164 #ifdef FEAT_LISTCMDS
3165 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3166 goto theend;
3167 #endif
3169 if (ffname == NULL)
3170 other_file = TRUE;
3171 /* there is no file name */
3172 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3173 other_file = FALSE;
3174 else
3176 if (*ffname == NUL) /* re-edit with same file name */
3178 ffname = curbuf->b_ffname;
3179 sfname = curbuf->b_fname;
3181 free_fname = fix_fname(ffname); /* may expand to full path name */
3182 if (free_fname != NULL)
3183 ffname = free_fname;
3184 other_file = otherfile(ffname);
3185 #ifdef FEAT_SUN_WORKSHOP
3186 if (usingSunWorkShop && p_acd
3187 && (cp = vim_strrchr(sfname, '/')) != NULL)
3188 sfname = ++cp;
3189 #endif
3194 * if the file was changed we may not be allowed to abandon it
3195 * - if we are going to re-edit the same file
3196 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3198 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3199 || (curbuf->b_nwindows == 1
3200 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3201 && check_changed(curbuf, p_awa, !other_file,
3202 (flags & ECMD_FORCEIT), FALSE))
3204 if (fnum == 0 && other_file && ffname != NULL)
3205 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3206 goto theend;
3209 #ifdef FEAT_VISUAL
3211 * End Visual mode before switching to another buffer, so the text can be
3212 * copied into the GUI selection buffer.
3214 reset_VIsual();
3215 #endif
3217 #ifdef FEAT_AUTOCMD
3218 if ((command != NULL || newlnum > (linenr_T)0)
3219 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3221 int len;
3222 char_u *p;
3224 /* Set v:swapcommand for the SwapExists autocommands. */
3225 if (command != NULL)
3226 len = (int)STRLEN(command) + 3;
3227 else
3228 len = 30;
3229 p = alloc((unsigned)len);
3230 if (p != NULL)
3232 if (command != NULL)
3233 vim_snprintf((char *)p, len, ":%s\r", command);
3234 else
3235 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3236 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3237 did_set_swapcommand = TRUE;
3238 vim_free(p);
3241 #endif
3244 * If we are starting to edit another file, open a (new) buffer.
3245 * Otherwise we re-use the current buffer.
3247 if (other_file)
3249 #ifdef FEAT_LISTCMDS
3250 if (!(flags & ECMD_ADDBUF))
3251 #endif
3253 if (!cmdmod.keepalt)
3254 curwin->w_alt_fnum = curbuf->b_fnum;
3255 buflist_altfpos();
3258 if (fnum)
3259 buf = buflist_findnr(fnum);
3260 else
3262 #ifdef FEAT_LISTCMDS
3263 if (flags & ECMD_ADDBUF)
3265 linenr_T tlnum = 1L;
3267 if (command != NULL)
3269 tlnum = atol((char *)command);
3270 if (tlnum <= 0)
3271 tlnum = 1L;
3273 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3274 goto theend;
3276 #endif
3277 buf = buflist_new(ffname, sfname, 0L,
3278 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3280 if (buf == NULL)
3281 goto theend;
3282 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3284 oldbuf = FALSE;
3285 buf->b_nwindows = 0;
3287 else /* existing memfile */
3289 oldbuf = TRUE;
3290 (void)buf_check_timestamp(buf, FALSE);
3291 /* Check if autocommands made buffer invalid or changed the current
3292 * buffer. */
3293 if (!buf_valid(buf)
3294 #ifdef FEAT_AUTOCMD
3295 || curbuf != old_curbuf
3296 #endif
3298 goto theend;
3299 #ifdef FEAT_EVAL
3300 if (aborting()) /* autocmds may abort script processing */
3301 goto theend;
3302 #endif
3305 /* May jump to last used line number for a loaded buffer or when asked
3306 * for explicitly */
3307 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3309 pos = buflist_findfpos(buf);
3310 newlnum = pos->lnum;
3311 solcol = pos->col;
3315 * Make the (new) buffer the one used by the current window.
3316 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3317 * If the current buffer was empty and has no file name, curbuf
3318 * is returned by buflist_new().
3320 if (buf != curbuf)
3322 #ifdef FEAT_AUTOCMD
3324 * Be careful: The autocommands may delete any buffer and change
3325 * the current buffer.
3326 * - If the buffer we are going to edit is deleted, give up.
3327 * - If the current buffer is deleted, prefer to load the new
3328 * buffer when loading a buffer is required. This avoids
3329 * loading another buffer which then must be closed again.
3330 * - If we ended up in the new buffer already, need to skip a few
3331 * things, set auto_buf.
3333 if (buf->b_fname != NULL)
3334 new_name = vim_strsave(buf->b_fname);
3335 au_new_curbuf = buf;
3336 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3337 if (!buf_valid(buf)) /* new buffer has been deleted */
3339 delbuf_msg(new_name); /* frees new_name */
3340 goto theend;
3342 # ifdef FEAT_EVAL
3343 if (aborting()) /* autocmds may abort script processing */
3345 vim_free(new_name);
3346 goto theend;
3348 # endif
3349 if (buf == curbuf) /* already in new buffer */
3350 auto_buf = TRUE;
3351 else
3353 if (curbuf == old_curbuf)
3354 #endif
3355 buf_copy_options(buf, BCO_ENTER);
3357 /* close the link to the current buffer */
3358 u_sync(FALSE);
3359 close_buffer(curwin, curbuf,
3360 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3362 #ifdef FEAT_AUTOCMD
3363 # ifdef FEAT_EVAL
3364 if (aborting()) /* autocmds may abort script processing */
3366 vim_free(new_name);
3367 goto theend;
3369 # endif
3370 /* Be careful again, like above. */
3371 if (!buf_valid(buf)) /* new buffer has been deleted */
3373 delbuf_msg(new_name); /* frees new_name */
3374 goto theend;
3376 if (buf == curbuf) /* already in new buffer */
3377 auto_buf = TRUE;
3378 else
3379 #endif
3381 curwin->w_buffer = buf;
3382 curbuf = buf;
3383 ++curbuf->b_nwindows;
3384 /* set 'fileformat' */
3385 if (*p_ffs && !oldbuf)
3386 set_fileformat(default_fileformat(), OPT_LOCAL);
3389 /* May get the window options from the last time this buffer
3390 * was in this window (or another window). If not used
3391 * before, reset the local window options to the global
3392 * values. Also restores old folding stuff. */
3393 get_winopts(curbuf);
3394 #ifdef FEAT_SPELL
3395 did_get_winopts = TRUE;
3396 #endif
3398 #ifdef FEAT_AUTOCMD
3400 vim_free(new_name);
3401 au_new_curbuf = NULL;
3402 #endif
3404 else
3405 ++curbuf->b_nwindows;
3407 curwin->w_pcmark.lnum = 1;
3408 curwin->w_pcmark.col = 0;
3410 else /* !other_file */
3412 if (
3413 #ifdef FEAT_LISTCMDS
3414 (flags & ECMD_ADDBUF) ||
3415 #endif
3416 check_fname() == FAIL)
3417 goto theend;
3418 oldbuf = (flags & ECMD_OLDBUF);
3421 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3423 char_u *p;
3425 curbuf->b_help = TRUE;
3426 #ifdef FEAT_QUICKFIX
3427 set_string_option_direct((char_u *)"buftype", -1,
3428 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3429 #endif
3432 * Always set these options after jumping to a help tag, because the
3433 * user may have an autocommand that gets in the way.
3434 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3435 * latin1 word characters (for translated help files).
3436 * Only set it when needed, buf_init_chartab() is some work.
3439 #ifdef EBCDIC
3440 (char_u *)"65-255,^*,^|,^\"";
3441 #else
3442 (char_u *)"!-~,^*,^|,^\",192-255";
3443 #endif
3444 if (STRCMP(curbuf->b_p_isk, p) != 0)
3446 set_string_option_direct((char_u *)"isk", -1, p,
3447 OPT_FREE|OPT_LOCAL, 0);
3448 check_buf_options(curbuf);
3449 (void)buf_init_chartab(curbuf, FALSE);
3452 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3453 curwin->w_p_list = FALSE; /* no list mode */
3455 curbuf->b_p_ma = FALSE; /* not modifiable */
3456 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3457 curwin->w_p_nu = 0; /* no line numbers */
3458 #ifdef FEAT_SCROLLBIND
3459 curwin->w_p_scb = FALSE; /* no scroll binding */
3460 #endif
3461 #ifdef FEAT_ARABIC
3462 curwin->w_p_arab = FALSE; /* no arabic mode */
3463 #endif
3464 #ifdef FEAT_RIGHTLEFT
3465 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3466 #endif
3467 #ifdef FEAT_FOLDING
3468 curwin->w_p_fen = FALSE; /* No folding in the help window */
3469 #endif
3470 #ifdef FEAT_DIFF
3471 curwin->w_p_diff = FALSE; /* No 'diff' */
3472 #endif
3473 #ifdef FEAT_SPELL
3474 curwin->w_p_spell = FALSE; /* No spell checking */
3475 #endif
3477 #ifdef FEAT_AUTOCMD
3478 buf = curbuf;
3479 #endif
3480 set_buflisted(FALSE);
3482 else
3484 #ifdef FEAT_AUTOCMD
3485 buf = curbuf;
3486 #endif
3487 /* Don't make a buffer listed if it's a help buffer. Useful when
3488 * using CTRL-O to go back to a help file. */
3489 if (!curbuf->b_help)
3490 set_buflisted(TRUE);
3493 #ifdef FEAT_AUTOCMD
3494 /* If autocommands change buffers under our fingers, forget about
3495 * editing the file. */
3496 if (buf != curbuf)
3497 goto theend;
3498 # ifdef FEAT_EVAL
3499 if (aborting()) /* autocmds may abort script processing */
3500 goto theend;
3501 # endif
3503 /* Since we are starting to edit a file, consider the filetype to be
3504 * unset. Helps for when an autocommand changes files and expects syntax
3505 * highlighting to work in the other file. */
3506 did_filetype = FALSE;
3507 #endif
3510 * other_file oldbuf
3511 * FALSE FALSE re-edit same file, buffer is re-used
3512 * FALSE TRUE re-edit same file, nothing changes
3513 * TRUE FALSE start editing new file, new buffer
3514 * TRUE TRUE start editing in existing buffer (nothing to do)
3516 if (!other_file && !oldbuf) /* re-use the buffer */
3518 set_last_cursor(curwin); /* may set b_last_cursor */
3519 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3521 newlnum = curwin->w_cursor.lnum;
3522 solcol = curwin->w_cursor.col;
3524 #ifdef FEAT_AUTOCMD
3525 buf = curbuf;
3526 if (buf->b_fname != NULL)
3527 new_name = vim_strsave(buf->b_fname);
3528 else
3529 new_name = NULL;
3530 #endif
3531 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3532 #ifdef FEAT_AUTOCMD
3533 /* If autocommands deleted the buffer we were going to re-edit, give
3534 * up and jump to the end. */
3535 if (!buf_valid(buf))
3537 delbuf_msg(new_name); /* frees new_name */
3538 goto theend;
3540 vim_free(new_name);
3542 /* If autocommands change buffers under our fingers, forget about
3543 * re-editing the file. Should do the buf_clear_file(), but perhaps
3544 * the autocommands changed the buffer... */
3545 if (buf != curbuf)
3546 goto theend;
3547 # ifdef FEAT_EVAL
3548 if (aborting()) /* autocmds may abort script processing */
3549 goto theend;
3550 # endif
3551 #endif
3552 buf_clear_file(curbuf);
3553 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3554 curbuf->b_op_end.lnum = 0;
3558 * If we get here we are sure to start editing
3560 /* don't redraw until the cursor is in the right line */
3561 ++RedrawingDisabled;
3563 /* Assume success now */
3564 retval = OK;
3567 * Reset cursor position, could be used by autocommands.
3569 check_cursor();
3572 * Check if we are editing the w_arg_idx file in the argument list.
3574 check_arg_idx(curwin);
3576 #ifdef FEAT_AUTOCMD
3577 if (!auto_buf)
3578 #endif
3581 * Set cursor and init window before reading the file and executing
3582 * autocommands. This allows for the autocommands to position the
3583 * cursor.
3585 curwin_init();
3587 #ifdef FEAT_FOLDING
3588 /* It's possible that all lines in the buffer changed. Need to update
3589 * automatic folding for all windows where it's used. */
3590 # ifdef FEAT_WINDOWS
3592 win_T *win;
3593 tabpage_T *tp;
3595 FOR_ALL_TAB_WINDOWS(tp, win)
3596 if (win->w_buffer == curbuf)
3597 foldUpdateAll(win);
3599 # else
3600 foldUpdateAll(curwin);
3601 # endif
3602 #endif
3604 /* Change directories when the 'acd' option is set. */
3605 DO_AUTOCHDIR
3608 * Careful: open_buffer() and apply_autocmds() may change the current
3609 * buffer and window.
3611 lnum = curwin->w_cursor.lnum;
3612 topline = curwin->w_topline;
3613 if (!oldbuf) /* need to read the file */
3615 #if defined(HAS_SWAP_EXISTS_ACTION)
3616 swap_exists_action = SEA_DIALOG;
3617 #endif
3618 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3621 * Open the buffer and read the file.
3623 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3624 if (should_abort(open_buffer(FALSE, eap)))
3625 retval = FAIL;
3626 #else
3627 (void)open_buffer(FALSE, eap);
3628 #endif
3630 #if defined(HAS_SWAP_EXISTS_ACTION)
3631 if (swap_exists_action == SEA_QUIT)
3632 retval = FAIL;
3633 handle_swap_exists(old_curbuf);
3634 #endif
3636 #ifdef FEAT_AUTOCMD
3637 else
3639 /* Read the modelines, but only to set window-local options. Any
3640 * buffer-local options have already been set and may have been
3641 * changed by the user. */
3642 do_modelines(OPT_WINONLY);
3644 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3645 &retval);
3646 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3647 &retval);
3649 check_arg_idx(curwin);
3650 #endif
3653 * If autocommands change the cursor position or topline, we should
3654 * keep it.
3656 if (curwin->w_cursor.lnum != lnum)
3658 newlnum = curwin->w_cursor.lnum;
3659 newcol = curwin->w_cursor.col;
3661 if (curwin->w_topline == topline)
3662 topline = 0;
3664 /* Even when cursor didn't move we need to recompute topline. */
3665 changed_line_abv_curs();
3667 #ifdef FEAT_TITLE
3668 maketitle();
3669 #endif
3672 #ifdef FEAT_DIFF
3673 /* Tell the diff stuff that this buffer is new and/or needs updating.
3674 * Also needed when re-editing the same buffer, because unloading will
3675 * have removed it as a diff buffer. */
3676 if (curwin->w_p_diff)
3678 diff_buf_add(curbuf);
3679 diff_invalidate(curbuf);
3681 #endif
3683 #ifdef FEAT_SPELL
3684 /* If the window options were changed may need to set the spell language.
3685 * Can only do this after the buffer has been properly setup. */
3686 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3687 did_set_spelllang(curbuf);
3688 #endif
3690 if (command == NULL)
3692 if (newcol >= 0) /* position set by autocommands */
3694 curwin->w_cursor.lnum = newlnum;
3695 curwin->w_cursor.col = newcol;
3696 check_cursor();
3698 else if (newlnum > 0) /* line number from caller or old position */
3700 curwin->w_cursor.lnum = newlnum;
3701 check_cursor_lnum();
3702 if (solcol >= 0 && !p_sol)
3704 /* 'sol' is off: Use last known column. */
3705 curwin->w_cursor.col = solcol;
3706 check_cursor_col();
3707 #ifdef FEAT_VIRTUALEDIT
3708 curwin->w_cursor.coladd = 0;
3709 #endif
3710 curwin->w_set_curswant = TRUE;
3712 else
3713 beginline(BL_SOL | BL_FIX);
3715 else /* no line number, go to last line in Ex mode */
3717 if (exmode_active)
3718 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3719 beginline(BL_WHITE | BL_FIX);
3723 #ifdef FEAT_WINDOWS
3724 /* Check if cursors in other windows on the same buffer are still valid */
3725 check_lnums(FALSE);
3726 #endif
3729 * Did not read the file, need to show some info about the file.
3730 * Do this after setting the cursor.
3732 if (oldbuf
3733 #ifdef FEAT_AUTOCMD
3734 && !auto_buf
3735 #endif
3738 int msg_scroll_save = msg_scroll;
3740 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3741 * message. */
3742 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3743 msg_scroll = FALSE;
3744 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3745 check_for_delay(FALSE);
3746 msg_start();
3747 msg_scroll = msg_scroll_save;
3748 msg_scrolled_ign = TRUE;
3750 fileinfo(FALSE, TRUE, FALSE);
3752 msg_scrolled_ign = FALSE;
3755 if (command != NULL)
3756 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3758 #ifdef FEAT_KEYMAP
3759 if (curbuf->b_kmap_state & KEYMAP_INIT)
3760 keymap_init();
3761 #endif
3763 --RedrawingDisabled;
3764 if (!skip_redraw)
3766 n = p_so;
3767 if (topline == 0 && command == NULL)
3768 p_so = 999; /* force cursor halfway the window */
3769 update_topline();
3770 #ifdef FEAT_SCROLLBIND
3771 curwin->w_scbind_pos = curwin->w_topline;
3772 #endif
3773 p_so = n;
3774 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3777 if (p_im)
3778 need_start_insertmode = TRUE;
3780 /* Change directories when the 'acd' option is set. */
3781 DO_AUTOCHDIR
3783 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3784 if (gui.in_use && curbuf->b_ffname != NULL)
3786 # ifdef FEAT_SUN_WORKSHOP
3787 if (usingSunWorkShop)
3788 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3789 # endif
3790 # ifdef FEAT_NETBEANS_INTG
3791 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3792 netbeans_file_opened(curbuf);
3793 # endif
3795 #endif
3797 theend:
3798 #ifdef FEAT_AUTOCMD
3799 if (did_set_swapcommand)
3800 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3801 #endif
3802 #ifdef FEAT_BROWSE
3803 vim_free(browse_file);
3804 #endif
3805 vim_free(free_fname);
3806 return retval;
3809 #ifdef FEAT_AUTOCMD
3810 static void
3811 delbuf_msg(name)
3812 char_u *name;
3814 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3815 name == NULL ? (char_u *)"" : name);
3816 vim_free(name);
3817 au_new_curbuf = NULL;
3819 #endif
3821 static int append_indent = 0; /* autoindent for first line */
3824 * ":insert" and ":append", also used by ":change"
3826 void
3827 ex_append(eap)
3828 exarg_T *eap;
3830 char_u *theline;
3831 int did_undo = FALSE;
3832 linenr_T lnum = eap->line2;
3833 int indent = 0;
3834 char_u *p;
3835 int vcol;
3836 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3838 /* the ! flag toggles autoindent */
3839 if (eap->forceit)
3840 curbuf->b_p_ai = !curbuf->b_p_ai;
3842 /* First autoindent comes from the line we start on */
3843 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3844 append_indent = get_indent_lnum(lnum);
3846 if (eap->cmdidx != CMD_append)
3847 --lnum;
3849 /* when the buffer is empty append to line 0 and delete the dummy line */
3850 if (empty && lnum == 1)
3851 lnum = 0;
3853 State = INSERT; /* behave like in Insert mode */
3854 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3855 State |= LANGMAP;
3857 for (;;)
3859 msg_scroll = TRUE;
3860 need_wait_return = FALSE;
3861 if (curbuf->b_p_ai)
3863 if (append_indent >= 0)
3865 indent = append_indent;
3866 append_indent = -1;
3868 else if (lnum > 0)
3869 indent = get_indent_lnum(lnum);
3871 ex_keep_indent = FALSE;
3872 if (eap->getline == NULL)
3874 /* No getline() function, use the lines that follow. This ends
3875 * when there is no more. */
3876 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3877 break;
3878 p = vim_strchr(eap->nextcmd, NL);
3879 if (p == NULL)
3880 p = eap->nextcmd + STRLEN(eap->nextcmd);
3881 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3882 if (*p != NUL)
3883 ++p;
3884 eap->nextcmd = p;
3886 else
3887 theline = eap->getline(
3888 #ifdef FEAT_EVAL
3889 eap->cstack->cs_looplevel > 0 ? -1 :
3890 #endif
3891 NUL, eap->cookie, indent);
3892 lines_left = Rows - 1;
3893 if (theline == NULL)
3894 break;
3896 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3897 if (ex_keep_indent)
3898 append_indent = indent;
3900 /* Look for the "." after automatic indent. */
3901 vcol = 0;
3902 for (p = theline; indent > vcol; ++p)
3904 if (*p == ' ')
3905 ++vcol;
3906 else if (*p == TAB)
3907 vcol += 8 - vcol % 8;
3908 else
3909 break;
3911 if ((p[0] == '.' && p[1] == NUL)
3912 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3913 == FAIL))
3915 vim_free(theline);
3916 break;
3919 /* don't use autoindent if nothing was typed. */
3920 if (p[0] == NUL)
3921 theline[0] = NUL;
3923 did_undo = TRUE;
3924 ml_append(lnum, theline, (colnr_T)0, FALSE);
3925 appended_lines_mark(lnum, 1L);
3927 vim_free(theline);
3928 ++lnum;
3930 if (empty)
3932 ml_delete(2L, FALSE);
3933 empty = FALSE;
3936 State = NORMAL;
3938 if (eap->forceit)
3939 curbuf->b_p_ai = !curbuf->b_p_ai;
3941 /* "start" is set to eap->line2+1 unless that position is invalid (when
3942 * eap->line2 pointed to the end of the buffer and nothing was appended)
3943 * "end" is set to lnum when something has been appended, otherwise
3944 * it is the same than "start" -- Acevedo */
3945 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3946 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3947 if (eap->cmdidx != CMD_append)
3948 --curbuf->b_op_start.lnum;
3949 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3950 ? lnum : curbuf->b_op_start.lnum;
3951 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3952 curwin->w_cursor.lnum = lnum;
3953 check_cursor_lnum();
3954 beginline(BL_SOL | BL_FIX);
3956 need_wait_return = FALSE; /* don't use wait_return() now */
3957 ex_no_reprint = TRUE;
3961 * ":change"
3963 void
3964 ex_change(eap)
3965 exarg_T *eap;
3967 linenr_T lnum;
3969 if (eap->line2 >= eap->line1
3970 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3971 return;
3973 /* the ! flag toggles autoindent */
3974 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3975 append_indent = get_indent_lnum(eap->line1);
3977 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3979 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3980 break;
3981 ml_delete(eap->line1, FALSE);
3983 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3985 /* ":append" on the line above the deleted lines. */
3986 eap->line2 = eap->line1;
3987 ex_append(eap);
3990 void
3991 ex_z(eap)
3992 exarg_T *eap;
3994 char_u *x;
3995 int bigness;
3996 char_u *kind;
3997 int minus = 0;
3998 linenr_T start, end, curs, i;
3999 int j;
4000 linenr_T lnum = eap->line2;
4002 /* Vi compatible: ":z!" uses display height, without a count uses
4003 * 'scroll' */
4004 if (eap->forceit)
4005 bigness = curwin->w_height;
4006 else if (firstwin == lastwin)
4007 bigness = curwin->w_p_scr * 2;
4008 else
4009 bigness = curwin->w_height - 3;
4010 if (bigness < 1)
4011 bigness = 1;
4013 x = eap->arg;
4014 kind = x;
4015 if (*kind == '-' || *kind == '+' || *kind == '='
4016 || *kind == '^' || *kind == '.')
4017 ++x;
4018 while (*x == '-' || *x == '+')
4019 ++x;
4021 if (*x != 0)
4023 if (!VIM_ISDIGIT(*x))
4025 EMSG(_("E144: non-numeric argument to :z"));
4026 return;
4028 else
4030 bigness = atoi((char *)x);
4031 p_window = bigness;
4032 if (*kind == '=')
4033 bigness += 2;
4037 /* the number of '-' and '+' multiplies the distance */
4038 if (*kind == '-' || *kind == '+')
4039 for (x = kind + 1; *x == *kind; ++x)
4042 switch (*kind)
4044 case '-':
4045 start = lnum - bigness * (linenr_T)(x - kind);
4046 end = start + bigness;
4047 curs = end;
4048 break;
4050 case '=':
4051 start = lnum - (bigness + 1) / 2 + 1;
4052 end = lnum + (bigness + 1) / 2 - 1;
4053 curs = lnum;
4054 minus = 1;
4055 break;
4057 case '^':
4058 start = lnum - bigness * 2;
4059 end = lnum - bigness;
4060 curs = lnum - bigness;
4061 break;
4063 case '.':
4064 start = lnum - (bigness + 1) / 2 + 1;
4065 end = lnum + (bigness + 1) / 2 - 1;
4066 curs = end;
4067 break;
4069 default: /* '+' */
4070 start = lnum;
4071 if (*kind == '+')
4072 start += bigness * (linenr_T)(x - kind - 1) + 1;
4073 else if (eap->addr_count == 0)
4074 ++start;
4075 end = start + bigness - 1;
4076 curs = end;
4077 break;
4080 if (start < 1)
4081 start = 1;
4083 if (end > curbuf->b_ml.ml_line_count)
4084 end = curbuf->b_ml.ml_line_count;
4086 if (curs > curbuf->b_ml.ml_line_count)
4087 curs = curbuf->b_ml.ml_line_count;
4089 for (i = start; i <= end; i++)
4091 if (minus && i == lnum)
4093 msg_putchar('\n');
4095 for (j = 1; j < Columns; j++)
4096 msg_putchar('-');
4099 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4101 if (minus && i == lnum)
4103 msg_putchar('\n');
4105 for (j = 1; j < Columns; j++)
4106 msg_putchar('-');
4110 curwin->w_cursor.lnum = curs;
4111 ex_no_reprint = TRUE;
4115 * Check if the restricted flag is set.
4116 * If so, give an error message and return TRUE.
4117 * Otherwise, return FALSE.
4120 check_restricted()
4122 if (restricted)
4124 EMSG(_("E145: Shell commands not allowed in rvim"));
4125 return TRUE;
4127 return FALSE;
4131 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4132 * If so, give an error message and return TRUE.
4133 * Otherwise, return FALSE.
4136 check_secure()
4138 if (secure)
4140 secure = 2;
4141 EMSG(_(e_curdir));
4142 return TRUE;
4144 #ifdef HAVE_SANDBOX
4146 * In the sandbox more things are not allowed, including the things
4147 * disallowed in secure mode.
4149 if (sandbox != 0)
4151 EMSG(_(e_sandbox));
4152 return TRUE;
4154 #endif
4155 return FALSE;
4158 static char_u *old_sub = NULL; /* previous substitute pattern */
4159 static int global_need_beginline; /* call beginline() after ":g" */
4161 /* do_sub()
4163 * Perform a substitution from line eap->line1 to line eap->line2 using the
4164 * command pointed to by eap->arg which should be of the form:
4166 * /pattern/substitution/{flags}
4168 * The usual escapes are supported as described in the regexp docs.
4170 void
4171 do_sub(eap)
4172 exarg_T *eap;
4174 linenr_T lnum;
4175 long i = 0;
4176 regmmatch_T regmatch;
4177 static int do_all = FALSE; /* do multiple substitutions per line */
4178 static int do_ask = FALSE; /* ask for confirmation */
4179 static int do_count = FALSE; /* count only */
4180 static int do_error = TRUE; /* if false, ignore errors */
4181 static int do_print = FALSE; /* print last line with subs. */
4182 static int do_list = FALSE; /* list last line with subs. */
4183 static int do_number = FALSE; /* list last line with line nr*/
4184 static int do_ic = 0; /* ignore case flag */
4185 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4186 int delimiter;
4187 int sublen;
4188 int got_quit = FALSE;
4189 int got_match = FALSE;
4190 int temp;
4191 int which_pat;
4192 char_u *cmd;
4193 int save_State;
4194 linenr_T first_line = 0; /* first changed line */
4195 linenr_T last_line= 0; /* below last changed line AFTER the
4196 * change */
4197 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4198 linenr_T line2;
4199 long nmatch; /* number of lines in match */
4200 linenr_T sub_firstlnum; /* nr of first sub line */
4201 char_u *sub_firstline; /* allocated copy of first sub line */
4202 int endcolumn = FALSE; /* cursor in last column when done */
4203 pos_T old_cursor = curwin->w_cursor;
4205 cmd = eap->arg;
4206 if (!global_busy)
4208 sub_nsubs = 0;
4209 sub_nlines = 0;
4212 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4213 if (p_altkeymap && curwin->w_p_rl)
4214 lrF_sub(cmd);
4215 #endif
4217 if (eap->cmdidx == CMD_tilde)
4218 which_pat = RE_LAST; /* use last used regexp */
4219 else
4220 which_pat = RE_SUBST; /* use last substitute regexp */
4222 /* new pattern and substitution */
4223 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4224 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4226 /* don't accept alphanumeric for separator */
4227 if (isalpha(*cmd))
4229 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4230 return;
4233 * undocumented vi feature:
4234 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4235 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4237 if (*cmd == '\\')
4239 ++cmd;
4240 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4242 EMSG(_(e_backslash));
4243 return;
4245 if (*cmd != '&')
4246 which_pat = RE_SEARCH; /* use last '/' pattern */
4247 pat = (char_u *)""; /* empty search pattern */
4248 delimiter = *cmd++; /* remember delimiter character */
4250 else /* find the end of the regexp */
4252 which_pat = RE_LAST; /* use last used regexp */
4253 delimiter = *cmd++; /* remember delimiter character */
4254 pat = cmd; /* remember start of search pat */
4255 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4256 if (cmd[0] == delimiter) /* end delimiter found */
4257 *cmd++ = NUL; /* replace it with a NUL */
4261 * Small incompatibility: vi sees '\n' as end of the command, but in
4262 * Vim we want to use '\n' to find/substitute a NUL.
4264 sub = cmd; /* remember the start of the substitution */
4266 while (cmd[0])
4268 if (cmd[0] == delimiter) /* end delimiter found */
4270 *cmd++ = NUL; /* replace it with a NUL */
4271 break;
4273 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4274 ++cmd;
4275 mb_ptr_adv(cmd);
4278 if (!eap->skip)
4280 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4281 if (STRCMP(sub, "%") == 0
4282 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4284 if (old_sub == NULL) /* there is no previous command */
4286 EMSG(_(e_nopresub));
4287 return;
4289 sub = old_sub;
4291 else
4293 vim_free(old_sub);
4294 old_sub = vim_strsave(sub);
4298 else if (!eap->skip) /* use previous pattern and substitution */
4300 if (old_sub == NULL) /* there is no previous command */
4302 EMSG(_(e_nopresub));
4303 return;
4305 pat = NULL; /* search_regcomp() will use previous pattern */
4306 sub = old_sub;
4308 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4309 * last column after using "$". */
4310 endcolumn = (curwin->w_curswant == MAXCOL);
4314 * Find trailing options. When '&' is used, keep old options.
4316 if (*cmd == '&')
4317 ++cmd;
4318 else
4320 if (!p_ed)
4322 if (p_gd) /* default is global on */
4323 do_all = TRUE;
4324 else
4325 do_all = FALSE;
4326 do_ask = FALSE;
4328 do_error = TRUE;
4329 do_print = FALSE;
4330 do_count = FALSE;
4331 do_number = FALSE;
4332 do_ic = 0;
4334 while (*cmd)
4337 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4338 * 'r' is never inverted.
4340 if (*cmd == 'g')
4341 do_all = !do_all;
4342 else if (*cmd == 'c')
4343 do_ask = !do_ask;
4344 else if (*cmd == 'n')
4345 do_count = TRUE;
4346 else if (*cmd == 'e')
4347 do_error = !do_error;
4348 else if (*cmd == 'r') /* use last used regexp */
4349 which_pat = RE_LAST;
4350 else if (*cmd == 'p')
4351 do_print = TRUE;
4352 else if (*cmd == '#')
4354 do_print = TRUE;
4355 do_number = TRUE;
4357 else if (*cmd == 'l')
4359 do_print = TRUE;
4360 do_list = TRUE;
4362 else if (*cmd == 'i') /* ignore case */
4363 do_ic = 'i';
4364 else if (*cmd == 'I') /* don't ignore case */
4365 do_ic = 'I';
4366 else
4367 break;
4368 ++cmd;
4370 if (do_count)
4371 do_ask = FALSE;
4374 * check for a trailing count
4376 cmd = skipwhite(cmd);
4377 if (VIM_ISDIGIT(*cmd))
4379 i = getdigits(&cmd);
4380 if (i <= 0 && !eap->skip && do_error)
4382 EMSG(_(e_zerocount));
4383 return;
4385 eap->line1 = eap->line2;
4386 eap->line2 += i - 1;
4387 if (eap->line2 > curbuf->b_ml.ml_line_count)
4388 eap->line2 = curbuf->b_ml.ml_line_count;
4392 * check for trailing command or garbage
4394 cmd = skipwhite(cmd);
4395 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4397 eap->nextcmd = check_nextcmd(cmd);
4398 if (eap->nextcmd == NULL)
4400 EMSG(_(e_trailing));
4401 return;
4405 if (eap->skip) /* not executing commands, only parsing */
4406 return;
4408 if (!do_count && !curbuf->b_p_ma)
4410 /* Substitution is not allowed in non-'modifiable' buffer */
4411 EMSG(_(e_modifiable));
4412 return;
4415 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4417 if (do_error)
4418 EMSG(_(e_invcmd));
4419 return;
4422 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4423 if (do_ic == 'i')
4424 regmatch.rmm_ic = TRUE;
4425 else if (do_ic == 'I')
4426 regmatch.rmm_ic = FALSE;
4428 sub_firstline = NULL;
4431 * ~ in the substitute pattern is replaced with the old pattern.
4432 * We do it here once to avoid it to be replaced over and over again.
4433 * But don't do it when it starts with "\=", then it's an expression.
4435 if (!(sub[0] == '\\' && sub[1] == '='))
4436 sub = regtilde(sub, p_magic);
4439 * Check for a match on each line.
4441 line2 = eap->line2;
4442 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4443 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4444 || aborting()
4445 #endif
4446 ); ++lnum)
4448 sub_firstlnum = lnum;
4449 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
4450 if (nmatch)
4452 colnr_T copycol;
4453 colnr_T matchcol;
4454 colnr_T prev_matchcol = MAXCOL;
4455 char_u *new_end, *new_start = NULL;
4456 unsigned new_start_len = 0;
4457 char_u *p1;
4458 int did_sub = FALSE;
4459 int lastone;
4460 unsigned len, needed_len;
4461 long nmatch_tl = 0; /* nr of lines matched below lnum */
4462 int do_again; /* do it again after joining lines */
4463 int skip_match = FALSE;
4466 * The new text is build up step by step, to avoid too much
4467 * copying. There are these pieces:
4468 * sub_firstline The old text, unmodifed.
4469 * copycol Column in the old text where we started
4470 * looking for a match; from here old text still
4471 * needs to be copied to the new text.
4472 * matchcol Column number of the old text where to look
4473 * for the next match. It's just after the
4474 * previous match or one further.
4475 * prev_matchcol Column just after the previous match (if any).
4476 * Mostly equal to matchcol, except for the first
4477 * match and after skipping an empty match.
4478 * regmatch.*pos Where the pattern matched in the old text.
4479 * new_start The new text, all that has been produced so
4480 * far.
4481 * new_end The new text, where to append new text.
4483 * lnum The line number where we were looking for the
4484 * first match in the old line.
4485 * sub_firstlnum The line number in the buffer where to look
4486 * for a match. Can be different from "lnum"
4487 * when the pattern or substitute string contains
4488 * line breaks.
4490 * Special situations:
4491 * - When the substitute string contains a line break, the part up
4492 * to the line break is inserted in the text, but the copy of
4493 * the original line is kept. "sub_firstlnum" is adjusted for
4494 * the inserted lines.
4495 * - When the matched pattern contains a line break, the old line
4496 * is taken from the line at the end of the pattern. The lines
4497 * in the match are deleted later, "sub_firstlnum" is adjusted
4498 * accordingly.
4500 * The new text is built up in new_start[]. It has some extra
4501 * room to avoid using alloc()/free() too often. new_start_len is
4502 * the length of the allocated memory at new_start.
4504 * Make a copy of the old line, so it won't be taken away when
4505 * updating the screen or handling a multi-line match. The "old_"
4506 * pointers point into this copy.
4508 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4509 if (sub_firstline == NULL)
4511 vim_free(new_start);
4512 goto outofmem;
4514 copycol = 0;
4515 matchcol = 0;
4517 /* At first match, remember current cursor position. */
4518 if (!got_match)
4520 setpcmark();
4521 got_match = TRUE;
4525 * Loop until nothing more to replace in this line.
4526 * 1. Handle match with empty string.
4527 * 2. If do_ask is set, ask for confirmation.
4528 * 3. substitute the string.
4529 * 4. if do_all is set, find next match
4530 * 5. break if there isn't another match in this line
4532 for (;;)
4534 /* Save the line number of the last change for the final
4535 * cursor position (just like Vi). */
4536 curwin->w_cursor.lnum = lnum;
4537 do_again = FALSE;
4540 * 1. Match empty string does not count, except for first
4541 * match. This reproduces the strange vi behaviour.
4542 * This also catches endless loops.
4544 if (matchcol == prev_matchcol
4545 && regmatch.endpos[0].lnum == 0
4546 && matchcol == regmatch.endpos[0].col)
4548 if (sub_firstline[matchcol] == NUL)
4549 /* We already were at the end of the line. Don't look
4550 * for a match in this line again. */
4551 skip_match = TRUE;
4552 else
4553 ++matchcol; /* search for a match at next column */
4554 goto skip;
4557 /* Normally we continue searching for a match just after the
4558 * previous match. */
4559 matchcol = regmatch.endpos[0].col;
4560 prev_matchcol = matchcol;
4563 * 2. If do_count is set only increase the counter.
4564 * If do_ask is set, ask for confirmation.
4566 if (do_count)
4568 /* For a multi-line match, put matchcol at the NUL at
4569 * the end of the line and set nmatch to one, so that
4570 * we continue looking for a match on the next line.
4571 * Avoids that ":s/\nB\@=//gc" get stuck. */
4572 if (nmatch > 1)
4574 matchcol = (colnr_T)STRLEN(sub_firstline);
4575 nmatch = 1;
4577 sub_nsubs++;
4578 did_sub = TRUE;
4579 goto skip;
4582 if (do_ask)
4584 /* change State to CONFIRM, so that the mouse works
4585 * properly */
4586 save_State = State;
4587 State = CONFIRM;
4588 #ifdef FEAT_MOUSE
4589 setmouse(); /* disable mouse in xterm */
4590 #endif
4591 curwin->w_cursor.col = regmatch.startpos[0].col;
4593 /* When 'cpoptions' contains "u" don't sync undo when
4594 * asking for confirmation. */
4595 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4596 ++no_u_sync;
4599 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4601 while (do_ask)
4603 if (exmode_active)
4605 char_u *resp;
4606 colnr_T sc, ec;
4608 print_line_no_prefix(lnum, FALSE, FALSE);
4610 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4611 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4612 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4613 msg_start();
4614 for (i = 0; i < (long)sc; ++i)
4615 msg_putchar(' ');
4616 for ( ; i <= (long)ec; ++i)
4617 msg_putchar('^');
4619 resp = getexmodeline('?', NULL, 0);
4620 if (resp != NULL)
4622 i = *resp;
4623 vim_free(resp);
4626 else
4628 #ifdef FEAT_FOLDING
4629 int save_p_fen = curwin->w_p_fen;
4631 curwin->w_p_fen = FALSE;
4632 #endif
4633 /* Invert the matched string.
4634 * Remove the inversion afterwards. */
4635 temp = RedrawingDisabled;
4636 RedrawingDisabled = 0;
4638 search_match_lines = regmatch.endpos[0].lnum;
4639 search_match_endcol = regmatch.endpos[0].col;
4640 highlight_match = TRUE;
4642 update_topline();
4643 validate_cursor();
4644 update_screen(SOME_VALID);
4645 highlight_match = FALSE;
4646 redraw_later(SOME_VALID);
4648 #ifdef FEAT_FOLDING
4649 curwin->w_p_fen = save_p_fen;
4650 #endif
4651 if (msg_row == Rows - 1)
4652 msg_didout = FALSE; /* avoid a scroll-up */
4653 msg_starthere();
4654 i = msg_scroll;
4655 msg_scroll = 0; /* truncate msg when
4656 needed */
4657 msg_no_more = TRUE;
4658 /* write message same highlighting as for
4659 * wait_return */
4660 smsg_attr(hl_attr(HLF_R),
4661 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4662 msg_no_more = FALSE;
4663 msg_scroll = i;
4664 showruler(TRUE);
4665 windgoto(msg_row, msg_col);
4666 RedrawingDisabled = temp;
4668 #ifdef USE_ON_FLY_SCROLL
4669 dont_scroll = FALSE; /* allow scrolling here */
4670 #endif
4671 ++no_mapping; /* don't map this key */
4672 ++allow_keys; /* allow special keys */
4673 i = plain_vgetc();
4674 --allow_keys;
4675 --no_mapping;
4677 /* clear the question */
4678 msg_didout = FALSE; /* don't scroll up */
4679 msg_col = 0;
4680 gotocmdline(TRUE);
4683 need_wait_return = FALSE; /* no hit-return prompt */
4684 if (i == 'q' || i == ESC || i == Ctrl_C
4685 #ifdef UNIX
4686 || i == intr_char
4687 #endif
4690 got_quit = TRUE;
4691 break;
4693 if (i == 'n')
4694 break;
4695 if (i == 'y')
4696 break;
4697 if (i == 'l')
4699 /* last: replace and then stop */
4700 do_all = FALSE;
4701 line2 = lnum;
4702 break;
4704 if (i == 'a')
4706 do_ask = FALSE;
4707 break;
4709 #ifdef FEAT_INS_EXPAND
4710 if (i == Ctrl_E)
4711 scrollup_clamp();
4712 else if (i == Ctrl_Y)
4713 scrolldown_clamp();
4714 #endif
4716 State = save_State;
4717 #ifdef FEAT_MOUSE
4718 setmouse();
4719 #endif
4720 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4721 --no_u_sync;
4723 if (i == 'n')
4725 /* For a multi-line match, put matchcol at the NUL at
4726 * the end of the line and set nmatch to one, so that
4727 * we continue looking for a match on the next line.
4728 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4729 * get stuck when pressing 'n'. */
4730 if (nmatch > 1)
4732 matchcol = (colnr_T)STRLEN(sub_firstline);
4733 skip_match = TRUE;
4735 goto skip;
4737 if (got_quit)
4738 break;
4741 /* Move the cursor to the start of the match, so that we can
4742 * use "\=col("."). */
4743 curwin->w_cursor.col = regmatch.startpos[0].col;
4746 * 3. substitute the string.
4748 /* get length of substitution part */
4749 sublen = vim_regsub_multi(&regmatch, sub_firstlnum,
4750 sub, sub_firstline, FALSE, p_magic, TRUE);
4752 /* When the match included the "$" of the last line it may
4753 * go beyond the last line of the buffer. */
4754 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4756 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4757 skip_match = TRUE;
4760 /* Need room for:
4761 * - result so far in new_start (not for first sub in line)
4762 * - original text up to match
4763 * - length of substituted part
4764 * - original text after match
4766 if (nmatch == 1)
4767 p1 = sub_firstline;
4768 else
4770 p1 = ml_get(sub_firstlnum + nmatch - 1);
4771 nmatch_tl += nmatch - 1;
4773 i = regmatch.startpos[0].col - copycol;
4774 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4775 + sublen + 1;
4776 if (new_start == NULL)
4779 * Get some space for a temporary buffer to do the
4780 * substitution into (and some extra space to avoid
4781 * too many calls to alloc()/free()).
4783 new_start_len = needed_len + 50;
4784 if ((new_start = alloc_check(new_start_len)) == NULL)
4785 goto outofmem;
4786 *new_start = NUL;
4787 new_end = new_start;
4789 else
4792 * Check if the temporary buffer is long enough to do the
4793 * substitution into. If not, make it larger (with a bit
4794 * extra to avoid too many calls to alloc()/free()).
4796 len = (unsigned)STRLEN(new_start);
4797 needed_len += len;
4798 if (needed_len > new_start_len)
4800 new_start_len = needed_len + 50;
4801 if ((p1 = alloc_check(new_start_len)) == NULL)
4803 vim_free(new_start);
4804 goto outofmem;
4806 mch_memmove(p1, new_start, (size_t)(len + 1));
4807 vim_free(new_start);
4808 new_start = p1;
4810 new_end = new_start + len;
4814 * copy the text up to the part that matched
4816 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4817 new_end += i;
4819 (void)vim_regsub_multi(&regmatch, sub_firstlnum,
4820 sub, new_end, TRUE, p_magic, TRUE);
4821 sub_nsubs++;
4822 did_sub = TRUE;
4824 /* Move the cursor to the start of the line, to avoid that it
4825 * is beyond the end of the line after the substitution. */
4826 curwin->w_cursor.col = 0;
4828 /* For a multi-line match, make a copy of the last matched
4829 * line and continue in that one. */
4830 if (nmatch > 1)
4832 sub_firstlnum += nmatch - 1;
4833 vim_free(sub_firstline);
4834 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4835 /* When going beyond the last line, stop substituting. */
4836 if (sub_firstlnum <= line2)
4837 do_again = TRUE;
4838 else
4839 do_all = FALSE;
4842 /* Remember next character to be copied. */
4843 copycol = regmatch.endpos[0].col;
4845 if (skip_match)
4847 /* Already hit end of the buffer, sub_firstlnum is one
4848 * less than what it ought to be. */
4849 vim_free(sub_firstline);
4850 sub_firstline = vim_strsave((char_u *)"");
4851 copycol = 0;
4855 * Now the trick is to replace CTRL-M chars with a real line
4856 * break. This would make it impossible to insert a CTRL-M in
4857 * the text. The line break can be avoided by preceding the
4858 * CTRL-M with a backslash. To be able to insert a backslash,
4859 * they must be doubled in the string and are halved here.
4860 * That is Vi compatible.
4862 for (p1 = new_end; *p1; ++p1)
4864 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4865 mch_memmove(p1, p1 + 1, STRLEN(p1));
4866 else if (*p1 == CAR)
4868 if (u_inssub(lnum) == OK) /* prepare for undo */
4870 *p1 = NUL; /* truncate up to the CR */
4871 ml_append(lnum - 1, new_start,
4872 (colnr_T)(p1 - new_start + 1), FALSE);
4873 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4874 if (do_ask)
4875 appended_lines(lnum - 1, 1L);
4876 else
4878 if (first_line == 0)
4879 first_line = lnum;
4880 last_line = lnum + 1;
4882 /* All line numbers increase. */
4883 ++sub_firstlnum;
4884 ++lnum;
4885 ++line2;
4886 /* move the cursor to the new line, like Vi */
4887 ++curwin->w_cursor.lnum;
4888 STRCPY(new_start, p1 + 1); /* copy the rest */
4889 p1 = new_start - 1;
4892 #ifdef FEAT_MBYTE
4893 else if (has_mbyte)
4894 p1 += (*mb_ptr2len)(p1) - 1;
4895 #endif
4899 * 4. If do_all is set, find next match.
4900 * Prevent endless loop with patterns that match empty
4901 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4902 * But ":s/\n/#/" is OK.
4904 skip:
4905 /* We already know that we did the last subst when we are at
4906 * the end of the line, except that a pattern like
4907 * "bar\|\nfoo" may match at the NUL. */
4908 lastone = (skip_match
4909 || got_int
4910 || got_quit
4911 || !(do_all || do_again)
4912 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4913 && !re_multiline(regmatch.regprog)));
4914 nmatch = -1;
4917 * Replace the line in the buffer when needed. This is
4918 * skipped when there are more matches.
4919 * The check for nmatch_tl is needed for when multi-line
4920 * matching must replace the lines before trying to do another
4921 * match, otherwise "\@<=" won't work.
4922 * When asking the user we like to show the already replaced
4923 * text, but don't do it when "\<@=" or "\<@!" is used, it
4924 * changes what matches.
4926 if (lastone
4927 || (do_ask && !re_lookbehind(regmatch.regprog))
4928 || nmatch_tl > 0
4929 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4930 curbuf, sub_firstlnum, matchcol)) == 0)
4932 if (new_start != NULL)
4935 * Copy the rest of the line, that didn't match.
4936 * "matchcol" has to be adjusted, we use the end of
4937 * the line as reference, because the substitute may
4938 * have changed the number of characters. Same for
4939 * "prev_matchcol".
4941 STRCAT(new_start, sub_firstline + copycol);
4942 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4943 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4944 - prev_matchcol;
4946 if (u_savesub(lnum) != OK)
4947 break;
4948 ml_replace(lnum, new_start, TRUE);
4950 if (nmatch_tl > 0)
4953 * Matched lines have now been substituted and are
4954 * useless, delete them. The part after the match
4955 * has been appended to new_start, we don't need
4956 * it in the buffer.
4958 ++lnum;
4959 if (u_savedel(lnum, nmatch_tl) != OK)
4960 break;
4961 for (i = 0; i < nmatch_tl; ++i)
4962 ml_delete(lnum, (int)FALSE);
4963 mark_adjust(lnum, lnum + nmatch_tl - 1,
4964 (long)MAXLNUM, -nmatch_tl);
4965 if (do_ask)
4966 deleted_lines(lnum, nmatch_tl);
4967 --lnum;
4968 line2 -= nmatch_tl; /* nr of lines decreases */
4969 nmatch_tl = 0;
4972 /* When asking, undo is saved each time, must also set
4973 * changed flag each time. */
4974 if (do_ask)
4975 changed_bytes(lnum, 0);
4976 else
4978 if (first_line == 0)
4979 first_line = lnum;
4980 last_line = lnum + 1;
4983 sub_firstlnum = lnum;
4984 vim_free(sub_firstline); /* free the temp buffer */
4985 sub_firstline = new_start;
4986 new_start = NULL;
4987 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4988 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4989 - prev_matchcol;
4990 copycol = 0;
4992 if (nmatch == -1 && !lastone)
4993 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
4994 sub_firstlnum, matchcol);
4997 * 5. break if there isn't another match in this line
4999 if (nmatch <= 0)
5000 break;
5003 line_breakcheck();
5006 if (did_sub)
5007 ++sub_nlines;
5008 vim_free(sub_firstline); /* free the copy of the original line */
5009 sub_firstline = NULL;
5012 line_breakcheck();
5015 if (first_line != 0)
5017 /* Need to subtract the number of added lines from "last_line" to get
5018 * the line number before the change (same as adding the number of
5019 * deleted lines). */
5020 i = curbuf->b_ml.ml_line_count - old_line_count;
5021 changed_lines(first_line, 0, last_line - i, i);
5024 outofmem:
5025 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5027 /* ":s/pat//n" doesn't move the cursor */
5028 if (do_count)
5029 curwin->w_cursor = old_cursor;
5031 if (sub_nsubs)
5033 /* Set the '[ and '] marks. */
5034 curbuf->b_op_start.lnum = eap->line1;
5035 curbuf->b_op_end.lnum = line2;
5036 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5038 if (!global_busy)
5040 if (endcolumn)
5041 coladvance((colnr_T)MAXCOL);
5042 else
5043 beginline(BL_WHITE | BL_FIX);
5044 if (!do_sub_msg(do_count) && do_ask)
5045 MSG("");
5047 else
5048 global_need_beginline = TRUE;
5049 if (do_print)
5050 print_line(curwin->w_cursor.lnum, do_number, do_list);
5052 else if (!global_busy)
5054 if (got_int) /* interrupted */
5055 EMSG(_(e_interr));
5056 else if (got_match) /* did find something but nothing substituted */
5057 MSG("");
5058 else if (do_error) /* nothing found */
5059 EMSG2(_(e_patnotf2), get_search_pat());
5062 vim_free(regmatch.regprog);
5066 * Give message for number of substitutions.
5067 * Can also be used after a ":global" command.
5068 * Return TRUE if a message was given.
5071 do_sub_msg(count_only)
5072 int count_only; /* used 'n' flag for ":s" */
5074 int len = 0;
5077 * Only report substitutions when:
5078 * - more than 'report' substitutions
5079 * - command was typed by user, or number of changed lines > 'report'
5080 * - giving messages is not disabled by 'lazyredraw'
5082 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5083 || count_only)
5084 && messaging())
5086 if (got_int)
5088 STRCPY(msg_buf, _("(Interrupted) "));
5089 len = (int)STRLEN(msg_buf);
5091 if (sub_nsubs == 1)
5092 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5093 "%s", count_only ? _("1 match") : _("1 substitution"));
5094 else
5095 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5096 count_only ? _("%ld matches") : _("%ld substitutions"),
5097 sub_nsubs);
5098 len = (int)STRLEN(msg_buf);
5099 if (sub_nlines == 1)
5100 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5101 "%s", _(" on 1 line"));
5102 else
5103 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5104 _(" on %ld lines"), (long)sub_nlines);
5105 if (msg(msg_buf))
5106 /* save message to display it after redraw */
5107 set_keep_msg(msg_buf, 0);
5108 return TRUE;
5110 if (got_int)
5112 EMSG(_(e_interr));
5113 return TRUE;
5115 return FALSE;
5119 * Execute a global command of the form:
5121 * g/pattern/X : execute X on all lines where pattern matches
5122 * v/pattern/X : execute X on all lines where pattern does not match
5124 * where 'X' is an EX command
5126 * The command character (as well as the trailing slash) is optional, and
5127 * is assumed to be 'p' if missing.
5129 * This is implemented in two passes: first we scan the file for the pattern and
5130 * set a mark for each line that (not) matches. secondly we execute the command
5131 * for each line that has a mark. This is required because after deleting
5132 * lines we do not know where to search for the next match.
5134 void
5135 ex_global(eap)
5136 exarg_T *eap;
5138 linenr_T lnum; /* line number according to old situation */
5139 int ndone = 0;
5140 int type; /* first char of cmd: 'v' or 'g' */
5141 char_u *cmd; /* command argument */
5143 char_u delim; /* delimiter, normally '/' */
5144 char_u *pat;
5145 regmmatch_T regmatch;
5146 int match;
5147 int which_pat;
5149 if (global_busy)
5151 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5152 return;
5155 if (eap->forceit) /* ":global!" is like ":vglobal" */
5156 type = 'v';
5157 else
5158 type = *eap->cmd;
5159 cmd = eap->arg;
5160 which_pat = RE_LAST; /* default: use last used regexp */
5161 sub_nsubs = 0;
5162 sub_nlines = 0;
5165 * undocumented vi feature:
5166 * "\/" and "\?": use previous search pattern.
5167 * "\&": use previous substitute pattern.
5169 if (*cmd == '\\')
5171 ++cmd;
5172 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5174 EMSG(_(e_backslash));
5175 return;
5177 if (*cmd == '&')
5178 which_pat = RE_SUBST; /* use previous substitute pattern */
5179 else
5180 which_pat = RE_SEARCH; /* use previous search pattern */
5181 ++cmd;
5182 pat = (char_u *)"";
5184 else if (*cmd == NUL)
5186 EMSG(_("E148: Regular expression missing from global"));
5187 return;
5189 else
5191 delim = *cmd; /* get the delimiter */
5192 if (delim)
5193 ++cmd; /* skip delimiter if there is one */
5194 pat = cmd; /* remember start of pattern */
5195 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5196 if (cmd[0] == delim) /* end delimiter found */
5197 *cmd++ = NUL; /* replace it with a NUL */
5200 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5201 if (p_altkeymap && curwin->w_p_rl)
5202 lrFswap(pat,0);
5203 #endif
5205 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5207 EMSG(_(e_invcmd));
5208 return;
5212 * pass 1: set marks for each (not) matching line
5214 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5216 /* a match on this line? */
5217 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
5218 if ((type == 'g' && match) || (type == 'v' && !match))
5220 ml_setmarked(lnum);
5221 ndone++;
5223 line_breakcheck();
5227 * pass 2: execute the command for each line that has been marked
5229 if (got_int)
5230 MSG(_(e_interr));
5231 else if (ndone == 0)
5233 if (type == 'v')
5234 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5235 else
5236 smsg((char_u *)_(e_patnotf2), pat);
5238 else
5239 global_exe(cmd);
5241 ml_clearmarked(); /* clear rest of the marks */
5242 vim_free(regmatch.regprog);
5246 * Execute "cmd" on lines marked with ml_setmarked().
5248 void
5249 global_exe(cmd)
5250 char_u *cmd;
5252 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5253 linenr_T lnum; /* line number according to old situation */
5256 * Set current position only once for a global command.
5257 * If global_busy is set, setpcmark() will not do anything.
5258 * If there is an error, global_busy will be incremented.
5260 setpcmark();
5262 /* When the command writes a message, don't overwrite the command. */
5263 msg_didout = TRUE;
5265 global_need_beginline = FALSE;
5266 global_busy = 1;
5267 old_lcount = curbuf->b_ml.ml_line_count;
5268 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5270 curwin->w_cursor.lnum = lnum;
5271 curwin->w_cursor.col = 0;
5272 if (*cmd == NUL || *cmd == '\n')
5273 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5274 else
5275 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5276 ui_breakcheck();
5279 global_busy = 0;
5280 if (global_need_beginline)
5281 beginline(BL_WHITE | BL_FIX);
5282 else
5283 check_cursor(); /* cursor may be beyond the end of the line */
5285 /* the cursor may not have moved in the text but a change in a previous
5286 * line may move it on the screen */
5287 changed_line_abv_curs();
5289 /* If it looks like no message was written, allow overwriting the
5290 * command with the report for number of changes. */
5291 if (msg_col == 0 && msg_scrolled == 0)
5292 msg_didout = FALSE;
5294 /* If substitutes done, report number of substitutes, otherwise report
5295 * number of extra or deleted lines. */
5296 if (!do_sub_msg(FALSE))
5297 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5300 #ifdef FEAT_VIMINFO
5302 read_viminfo_sub_string(virp, force)
5303 vir_T *virp;
5304 int force;
5306 if (old_sub != NULL && force)
5307 vim_free(old_sub);
5308 if (force || old_sub == NULL)
5309 old_sub = viminfo_readstring(virp, 1, TRUE);
5310 return viminfo_readline(virp);
5313 void
5314 write_viminfo_sub_string(fp)
5315 FILE *fp;
5317 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5319 fprintf(fp, _("\n# Last Substitute String:\n$"));
5320 viminfo_writestring(fp, old_sub);
5323 #endif /* FEAT_VIMINFO */
5325 #if defined(EXITFREE) || defined(PROTO)
5326 void
5327 free_old_sub()
5329 vim_free(old_sub);
5331 #endif
5333 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5335 * Set up for a tagpreview.
5336 * Return TRUE when it was created.
5339 prepare_tagpreview(undo_sync)
5340 int undo_sync; /* sync undo when leaving the window */
5342 win_T *wp;
5344 # ifdef FEAT_GUI
5345 need_mouse_correct = TRUE;
5346 # endif
5349 * If there is already a preview window open, use that one.
5351 if (!curwin->w_p_pvw)
5353 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5354 if (wp->w_p_pvw)
5355 break;
5356 if (wp != NULL)
5357 win_enter(wp, undo_sync);
5358 else
5361 * There is no preview window open yet. Create one.
5363 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5364 == FAIL)
5365 return FALSE;
5366 curwin->w_p_pvw = TRUE;
5367 curwin->w_p_wfh = TRUE;
5368 # ifdef FEAT_SCROLLBIND
5369 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5370 # endif
5371 # ifdef FEAT_DIFF
5372 curwin->w_p_diff = FALSE; /* no 'diff' */
5373 # endif
5374 # ifdef FEAT_FOLDING
5375 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5376 # endif
5377 return TRUE;
5380 return FALSE;
5383 #endif
5387 * ":help": open a read-only window on a help file
5389 void
5390 ex_help(eap)
5391 exarg_T *eap;
5393 char_u *arg;
5394 char_u *tag;
5395 FILE *helpfd; /* file descriptor of help file */
5396 int n;
5397 int i;
5398 #ifdef FEAT_WINDOWS
5399 win_T *wp;
5400 #endif
5401 int num_matches;
5402 char_u **matches;
5403 char_u *p;
5404 int empty_fnum = 0;
5405 int alt_fnum = 0;
5406 buf_T *buf;
5407 #ifdef FEAT_MULTI_LANG
5408 int len;
5409 char_u *lang;
5410 #endif
5412 if (eap != NULL)
5415 * A ":help" command ends at the first LF, or at a '|' that is
5416 * followed by some text. Set nextcmd to the following command.
5418 for (arg = eap->arg; *arg; ++arg)
5420 if (*arg == '\n' || *arg == '\r'
5421 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5423 *arg++ = NUL;
5424 eap->nextcmd = arg;
5425 break;
5428 arg = eap->arg;
5430 if (eap->forceit && *arg == NUL)
5432 EMSG(_("E478: Don't panic!"));
5433 return;
5436 if (eap->skip) /* not executing commands */
5437 return;
5439 else
5440 arg = (char_u *)"";
5442 /* remove trailing blanks */
5443 p = arg + STRLEN(arg) - 1;
5444 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5445 *p-- = NUL;
5447 #ifdef FEAT_MULTI_LANG
5448 /* Check for a specified language */
5449 lang = check_help_lang(arg);
5450 #endif
5452 /* When no argument given go to the index. */
5453 if (*arg == NUL)
5454 arg = (char_u *)"help.txt";
5457 * Check if there is a match for the argument.
5459 n = find_help_tags(arg, &num_matches, &matches,
5460 eap != NULL && eap->forceit);
5462 i = 0;
5463 #ifdef FEAT_MULTI_LANG
5464 if (n != FAIL && lang != NULL)
5465 /* Find first item with the requested language. */
5466 for (i = 0; i < num_matches; ++i)
5468 len = (int)STRLEN(matches[i]);
5469 if (len > 3 && matches[i][len - 3] == '@'
5470 && STRICMP(matches[i] + len - 2, lang) == 0)
5471 break;
5473 #endif
5474 if (i >= num_matches || n == FAIL)
5476 #ifdef FEAT_MULTI_LANG
5477 if (lang != NULL)
5478 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5479 else
5480 #endif
5481 EMSG2(_("E149: Sorry, no help for %s"), arg);
5482 if (n != FAIL)
5483 FreeWild(num_matches, matches);
5484 return;
5487 /* The first match (in the requested language) is the best match. */
5488 tag = vim_strsave(matches[i]);
5489 FreeWild(num_matches, matches);
5491 #ifdef FEAT_GUI
5492 need_mouse_correct = TRUE;
5493 #endif
5496 * Re-use an existing help window or open a new one.
5497 * Always open a new one for ":tab help".
5499 if (!curwin->w_buffer->b_help
5500 #ifdef FEAT_WINDOWS
5501 || cmdmod.tab != 0
5502 #endif
5505 #ifdef FEAT_WINDOWS
5506 if (cmdmod.tab != 0)
5507 wp = NULL;
5508 else
5509 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5510 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5511 break;
5512 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5513 win_enter(wp, TRUE);
5514 else
5515 #endif
5518 * There is no help window yet.
5519 * Try to open the file specified by the "helpfile" option.
5521 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5523 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5524 goto erret;
5526 fclose(helpfd);
5528 #ifdef FEAT_WINDOWS
5529 /* Split off help window; put it at far top if no position
5530 * specified, the current window is vertically split and
5531 * narrow. */
5532 n = WSP_HELP;
5533 # ifdef FEAT_VERTSPLIT
5534 if (cmdmod.split == 0 && curwin->w_width != Columns
5535 && curwin->w_width < 80)
5536 n |= WSP_TOP;
5537 # endif
5538 if (win_split(0, n) == FAIL)
5539 goto erret;
5540 #else
5541 /* use current window */
5542 if (!can_abandon(curbuf, FALSE))
5543 goto erret;
5544 #endif
5546 #ifdef FEAT_WINDOWS
5547 if (curwin->w_height < p_hh)
5548 win_setheight((int)p_hh);
5549 #endif
5552 * Open help file (do_ecmd() will set b_help flag, readfile() will
5553 * set b_p_ro flag).
5554 * Set the alternate file to the previously edited file.
5556 alt_fnum = curbuf->b_fnum;
5557 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5558 ECMD_HIDE + ECMD_SET_HELP);
5559 if (!cmdmod.keepalt)
5560 curwin->w_alt_fnum = alt_fnum;
5561 empty_fnum = curbuf->b_fnum;
5565 if (!p_im)
5566 restart_edit = 0; /* don't want insert mode in help file */
5568 if (tag != NULL)
5569 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5571 /* Delete the empty buffer if we're not using it. Careful: autocommands
5572 * may have jumped to another window, check that the buffer is not in a
5573 * window. */
5574 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5576 buf = buflist_findnr(empty_fnum);
5577 if (buf != NULL && buf->b_nwindows == 0)
5578 wipe_buffer(buf, TRUE);
5581 /* keep the previous alternate file */
5582 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5583 curwin->w_alt_fnum = alt_fnum;
5585 erret:
5586 vim_free(tag);
5590 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5592 * In an argument search for a language specifiers in the form "@xx".
5593 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5594 * Returns NULL if not found.
5596 char_u *
5597 check_help_lang(arg)
5598 char_u *arg;
5600 int len = (int)STRLEN(arg);
5602 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5603 && ASCII_ISALPHA(arg[len - 1]))
5605 arg[len - 3] = NUL; /* remove the '@' */
5606 return arg + len - 2;
5608 return NULL;
5610 #endif
5613 * Return a heuristic indicating how well the given string matches. The
5614 * smaller the number, the better the match. This is the order of priorities,
5615 * from best match to worst match:
5616 * - Match with least alpha-numeric characters is better.
5617 * - Match with least total characters is better.
5618 * - Match towards the start is better.
5619 * - Match starting with "+" is worse (feature instead of command)
5620 * Assumption is made that the matched_string passed has already been found to
5621 * match some string for which help is requested. webb.
5624 help_heuristic(matched_string, offset, wrong_case)
5625 char_u *matched_string;
5626 int offset; /* offset for match */
5627 int wrong_case; /* no matching case */
5629 int num_letters;
5630 char_u *p;
5632 num_letters = 0;
5633 for (p = matched_string; *p; p++)
5634 if (ASCII_ISALNUM(*p))
5635 num_letters++;
5638 * Multiply the number of letters by 100 to give it a much bigger
5639 * weighting than the number of characters.
5640 * If there only is a match while ignoring case, add 5000.
5641 * If the match starts in the middle of a word, add 10000 to put it
5642 * somewhere in the last half.
5643 * If the match is more than 2 chars from the start, multiply by 200 to
5644 * put it after matches at the start.
5646 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5647 && ASCII_ISALNUM(matched_string[offset - 1]))
5648 offset += 10000;
5649 else if (offset > 2)
5650 offset *= 200;
5651 if (wrong_case)
5652 offset += 5000;
5653 /* Features are less interesting than the subjects themselves, but "+"
5654 * alone is not a feature. */
5655 if (matched_string[0] == '+' && matched_string[1] != NUL)
5656 offset += 100;
5657 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5661 * Compare functions for qsort() below, that checks the help heuristics number
5662 * that has been put after the tagname by find_tags().
5664 static int
5665 #ifdef __BORLANDC__
5666 _RTLENTRYF
5667 #endif
5668 help_compare(s1, s2)
5669 const void *s1;
5670 const void *s2;
5672 char *p1;
5673 char *p2;
5675 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5676 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5677 return strcmp(p1, p2);
5681 * Find all help tags matching "arg", sort them and return in matches[], with
5682 * the number of matches in num_matches.
5683 * The matches will be sorted with a "best" match algorithm.
5684 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5687 find_help_tags(arg, num_matches, matches, keep_lang)
5688 char_u *arg;
5689 int *num_matches;
5690 char_u ***matches;
5691 int keep_lang;
5693 char_u *s, *d;
5694 int i;
5695 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5696 "/*", "/\\*", "\"*", "**",
5697 "/\\(\\)",
5698 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5699 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5700 "[count]", "[quotex]", "[range]",
5701 "[pattern]", "\\|", "\\%$"};
5702 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5703 "/star", "/\\\\star", "quotestar", "starstar",
5704 "/\\\\(\\\\)",
5705 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5706 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5707 "\\[count]", "\\[quotex]", "\\[range]",
5708 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5709 int flags;
5711 d = IObuff; /* assume IObuff is long enough! */
5714 * Recognize a few exceptions to the rule. Some strings that contain '*'
5715 * with "star". Otherwise '*' is recognized as a wildcard.
5717 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5718 if (STRCMP(arg, mtable[i]) == 0)
5720 STRCPY(d, rtable[i]);
5721 break;
5724 if (i < 0) /* no match in table */
5726 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5727 * Also replace "\%^" and "\%(", they match every tag too.
5728 * Also "\zs", "\z1", etc.
5729 * Also "\@<", "\@=", "\@<=", etc.
5730 * And also "\_$" and "\_^". */
5731 if (arg[0] == '\\'
5732 && ((arg[1] != NUL && arg[2] == NUL)
5733 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5734 && arg[2] != NUL)))
5736 STRCPY(d, "/\\\\");
5737 STRCPY(d + 3, arg + 1);
5738 /* Check for "/\\_$", should be "/\\_\$" */
5739 if (d[3] == '_' && d[4] == '$')
5740 STRCPY(d + 4, "\\$");
5742 else
5744 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5745 if (arg[0] == '[' && (arg[1] == ':'
5746 || (arg[1] == '+' && arg[2] == '+')))
5747 *d++ = '\\';
5749 for (s = arg; *s; ++s)
5752 * Replace "|" with "bar" and '"' with "quote" to match the name of
5753 * the tags for these commands.
5754 * Replace "*" with ".*" and "?" with "." to match command line
5755 * completion.
5756 * Insert a backslash before '~', '$' and '.' to avoid their
5757 * special meaning.
5759 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5760 break;
5761 switch (*s)
5763 case '|': STRCPY(d, "bar");
5764 d += 3;
5765 continue;
5766 case '"': STRCPY(d, "quote");
5767 d += 5;
5768 continue;
5769 case '*': *d++ = '.';
5770 break;
5771 case '?': *d++ = '.';
5772 continue;
5773 case '$':
5774 case '.':
5775 case '~': *d++ = '\\';
5776 break;
5780 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5781 * ":help i_^_CTRL-D" work.
5782 * Insert '-' before and after "CTRL-X" when applicable.
5784 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5785 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5787 if (d > IObuff && d[-1] != '_')
5788 *d++ = '_'; /* prepend a '_' */
5789 STRCPY(d, "CTRL-");
5790 d += 5;
5791 if (*s < ' ')
5793 #ifdef EBCDIC
5794 *d++ = CtrlChar(*s);
5795 #else
5796 *d++ = *s + '@';
5797 #endif
5798 if (d[-1] == '\\')
5799 *d++ = '\\'; /* double a backslash */
5801 else
5802 *d++ = *++s;
5803 if (s[1] != NUL && s[1] != '_')
5804 *d++ = '_'; /* append a '_' */
5805 continue;
5807 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5808 *d++ = '\\';
5811 * Insert a backslash before a backslash after a slash, for search
5812 * pattern tags: "/\|" --> "/\\|".
5814 else if (s[0] == '\\' && s[1] != '\\'
5815 && *arg == '/' && s == arg + 1)
5816 *d++ = '\\';
5818 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5819 * "CTRL-\_CTRL-N" */
5820 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5822 STRCPY(d, "CTRL-\\\\");
5823 d += 7;
5824 s += 6;
5827 *d++ = *s;
5830 * If tag starts with ', toss everything after a second '. Fixes
5831 * CTRL-] on 'option'. (would include the trailing '.').
5833 if (*s == '\'' && s > arg && *arg == '\'')
5834 break;
5836 *d = NUL;
5840 *matches = (char_u **)"";
5841 *num_matches = 0;
5842 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5843 if (keep_lang)
5844 flags |= TAG_KEEP_LANG;
5845 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5846 && *num_matches > 0)
5847 /* Sort the matches found on the heuristic number that is after the
5848 * tag name. */
5849 qsort((void *)*matches, (size_t)*num_matches,
5850 sizeof(char_u *), help_compare);
5851 return OK;
5855 * After reading a help file: May cleanup a help buffer when syntax
5856 * highlighting is not used.
5858 void
5859 fix_help_buffer()
5861 linenr_T lnum;
5862 char_u *line;
5863 int in_example = FALSE;
5864 int len;
5865 char_u *p;
5866 char_u *rt;
5867 int mustfree;
5869 /* set filetype to "help". */
5870 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5872 #ifdef FEAT_SYN_HL
5873 if (!syntax_present(curbuf))
5874 #endif
5876 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5878 line = ml_get_buf(curbuf, lnum, FALSE);
5879 len = (int)STRLEN(line);
5880 if (in_example && len > 0 && !vim_iswhite(line[0]))
5882 /* End of example: non-white or '<' in first column. */
5883 if (line[0] == '<')
5885 /* blank-out a '<' in the first column */
5886 line = ml_get_buf(curbuf, lnum, TRUE);
5887 line[0] = ' ';
5889 in_example = FALSE;
5891 if (!in_example && len > 0)
5893 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5895 /* blank-out a '>' in the last column (start of example) */
5896 line = ml_get_buf(curbuf, lnum, TRUE);
5897 line[len - 1] = ' ';
5898 in_example = TRUE;
5900 else if (line[len - 1] == '~')
5902 /* blank-out a '~' at the end of line (header marker) */
5903 line = ml_get_buf(curbuf, lnum, TRUE);
5904 line[len - 1] = ' ';
5911 * In the "help.txt" file, add the locally added help files.
5912 * This uses the very first line in the help file.
5914 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5916 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5918 line = ml_get_buf(curbuf, lnum, FALSE);
5919 if (strstr((char *)line, "*local-additions*") != NULL)
5921 /* Go through all directories in 'runtimepath', skipping
5922 * $VIMRUNTIME. */
5923 p = p_rtp;
5924 while (*p != NUL)
5926 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5927 mustfree = FALSE;
5928 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5929 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5931 int fcount;
5932 char_u **fnames;
5933 FILE *fd;
5934 char_u *s;
5935 int fi;
5936 #ifdef FEAT_MBYTE
5937 vimconv_T vc;
5938 char_u *cp;
5939 #endif
5941 /* Find all "doc/ *.txt" files in this directory. */
5942 add_pathsep(NameBuff);
5943 STRCAT(NameBuff, "doc/*.txt");
5944 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5945 &fnames, EW_FILE|EW_SILENT) == OK
5946 && fcount > 0)
5948 for (fi = 0; fi < fcount; ++fi)
5950 fd = mch_fopen((char *)fnames[fi], "r");
5951 if (fd != NULL)
5953 vim_fgets(IObuff, IOSIZE, fd);
5954 if (IObuff[0] == '*'
5955 && (s = vim_strchr(IObuff + 1, '*'))
5956 != NULL)
5958 #ifdef FEAT_MBYTE
5959 int this_utf = MAYBE;
5960 #endif
5961 /* Change tag definition to a
5962 * reference and remove <CR>/<NL>. */
5963 IObuff[0] = '|';
5964 *s = '|';
5965 while (*s != NUL)
5967 if (*s == '\r' || *s == '\n')
5968 *s = NUL;
5969 #ifdef FEAT_MBYTE
5970 /* The text is utf-8 when a byte
5971 * above 127 is found and no
5972 * illegal byte sequence is found.
5974 if (*s >= 0x80 && this_utf != FALSE)
5976 int l;
5978 this_utf = TRUE;
5979 l = utf_ptr2len(s);
5980 if (l == 1)
5981 this_utf = FALSE;
5982 s += l - 1;
5984 #endif
5985 ++s;
5987 #ifdef FEAT_MBYTE
5988 /* The help file is latin1 or utf-8;
5989 * conversion to the current
5990 * 'encoding' may be required. */
5991 vc.vc_type = CONV_NONE;
5992 convert_setup(&vc, (char_u *)(
5993 this_utf == TRUE ? "utf-8"
5994 : "latin1"), p_enc);
5995 if (vc.vc_type == CONV_NONE)
5996 /* No conversion needed. */
5997 cp = IObuff;
5998 else
6000 /* Do the conversion. If it fails
6001 * use the unconverted text. */
6002 cp = string_convert(&vc, IObuff,
6003 NULL);
6004 if (cp == NULL)
6005 cp = IObuff;
6007 convert_setup(&vc, NULL, NULL);
6009 ml_append(lnum, cp, (colnr_T)0, FALSE);
6010 if (cp != IObuff)
6011 vim_free(cp);
6012 #else
6013 ml_append(lnum, IObuff, (colnr_T)0,
6014 FALSE);
6015 #endif
6016 ++lnum;
6018 fclose(fd);
6021 FreeWild(fcount, fnames);
6024 if (mustfree)
6025 vim_free(rt);
6027 break;
6034 * ":exusage"
6036 /*ARGSUSED*/
6037 void
6038 ex_exusage(eap)
6039 exarg_T *eap;
6041 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6045 * ":viusage"
6047 /*ARGSUSED*/
6048 void
6049 ex_viusage(eap)
6050 exarg_T *eap;
6052 do_cmdline_cmd((char_u *)"help normal-index");
6055 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6056 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang));
6059 * ":helptags"
6061 void
6062 ex_helptags(eap)
6063 exarg_T *eap;
6065 garray_T ga;
6066 int i, j;
6067 int len;
6068 #ifdef FEAT_MULTI_LANG
6069 char_u lang[2];
6070 #endif
6071 char_u ext[5];
6072 char_u fname[8];
6073 int filecount;
6074 char_u **files;
6076 if (!mch_isdir(eap->arg))
6078 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6079 return;
6082 #ifdef FEAT_MULTI_LANG
6083 /* Get a list of all files in the directory. */
6084 STRCPY(NameBuff, eap->arg);
6085 add_pathsep(NameBuff);
6086 STRCAT(NameBuff, "*");
6087 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6088 EW_FILE|EW_SILENT) == FAIL
6089 || filecount == 0)
6091 EMSG2("E151: No match: %s", NameBuff);
6092 return;
6095 /* Go over all files in the directory to find out what languages are
6096 * present. */
6097 ga_init2(&ga, 1, 10);
6098 for (i = 0; i < filecount; ++i)
6100 len = (int)STRLEN(files[i]);
6101 if (len > 4)
6103 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6105 /* ".txt" -> language "en" */
6106 lang[0] = 'e';
6107 lang[1] = 'n';
6109 else if (files[i][len - 4] == '.'
6110 && ASCII_ISALPHA(files[i][len - 3])
6111 && ASCII_ISALPHA(files[i][len - 2])
6112 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6114 /* ".abx" -> language "ab" */
6115 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6116 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6118 else
6119 continue;
6121 /* Did we find this language already? */
6122 for (j = 0; j < ga.ga_len; j += 2)
6123 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6124 break;
6125 if (j == ga.ga_len)
6127 /* New language, add it. */
6128 if (ga_grow(&ga, 2) == FAIL)
6129 break;
6130 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6131 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6137 * Loop over the found languages to generate a tags file for each one.
6139 for (j = 0; j < ga.ga_len; j += 2)
6141 STRCPY(fname, "tags-xx");
6142 fname[5] = ((char_u *)ga.ga_data)[j];
6143 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6144 if (fname[5] == 'e' && fname[6] == 'n')
6146 /* English is an exception: use ".txt" and "tags". */
6147 fname[4] = NUL;
6148 STRCPY(ext, ".txt");
6150 else
6152 /* Language "ab" uses ".abx" and "tags-ab". */
6153 STRCPY(ext, ".xxx");
6154 ext[1] = fname[5];
6155 ext[2] = fname[6];
6157 helptags_one(eap->arg, ext, fname);
6160 ga_clear(&ga);
6161 FreeWild(filecount, files);
6163 #else
6164 /* No language support, just use "*.txt" and "tags". */
6165 helptags_one(eap->arg, (char_u *)".txt", (char_u *)"tags");
6166 #endif
6169 static void
6170 helptags_one(dir, ext, tagfname)
6171 char_u *dir; /* doc directory */
6172 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6173 char_u *tagfname; /* "tags" for English, "tags-it" for Italian. */
6175 FILE *fd_tags;
6176 FILE *fd;
6177 garray_T ga;
6178 int filecount;
6179 char_u **files;
6180 char_u *p1, *p2;
6181 int fi;
6182 char_u *s;
6183 int i;
6184 char_u *fname;
6185 # ifdef FEAT_MBYTE
6186 int utf8 = MAYBE;
6187 int this_utf8;
6188 int firstline;
6189 int mix = FALSE; /* detected mixed encodings */
6190 # endif
6193 * Find all *.txt files.
6195 STRCPY(NameBuff, dir);
6196 add_pathsep(NameBuff);
6197 STRCAT(NameBuff, "*");
6198 STRCAT(NameBuff, ext);
6199 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6200 EW_FILE|EW_SILENT) == FAIL
6201 || filecount == 0)
6203 if (!got_int)
6204 EMSG2("E151: No match: %s", NameBuff);
6205 return;
6209 * Open the tags file for writing.
6210 * Do this before scanning through all the files.
6212 STRCPY(NameBuff, dir);
6213 add_pathsep(NameBuff);
6214 STRCAT(NameBuff, tagfname);
6215 fd_tags = mch_fopen((char *)NameBuff, "w");
6216 if (fd_tags == NULL)
6218 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6219 FreeWild(filecount, files);
6220 return;
6224 * If generating tags for "$VIMRUNTIME/doc" add the "help-tags" tag.
6226 ga_init2(&ga, (int)sizeof(char_u *), 100);
6227 if (fullpathcmp((char_u *)"$VIMRUNTIME/doc", dir, FALSE) == FPC_SAME)
6229 if (ga_grow(&ga, 1) == FAIL)
6230 got_int = TRUE;
6231 else
6233 s = alloc(18 + (unsigned)STRLEN(tagfname));
6234 if (s == NULL)
6235 got_int = TRUE;
6236 else
6238 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6239 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6240 ++ga.ga_len;
6246 * Go over all the files and extract the tags.
6248 for (fi = 0; fi < filecount && !got_int; ++fi)
6250 fd = mch_fopen((char *)files[fi], "r");
6251 if (fd == NULL)
6253 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6254 continue;
6256 fname = gettail(files[fi]);
6258 # ifdef FEAT_MBYTE
6259 firstline = TRUE;
6260 # endif
6261 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6263 # ifdef FEAT_MBYTE
6264 if (firstline)
6266 /* Detect utf-8 file by a non-ASCII char in the first line. */
6267 this_utf8 = MAYBE;
6268 for (s = IObuff; *s != NUL; ++s)
6269 if (*s >= 0x80)
6271 int l;
6273 this_utf8 = TRUE;
6274 l = utf_ptr2len(s);
6275 if (l == 1)
6277 /* Illegal UTF-8 byte sequence. */
6278 this_utf8 = FALSE;
6279 break;
6281 s += l - 1;
6283 if (this_utf8 == MAYBE) /* only ASCII characters found */
6284 this_utf8 = FALSE;
6285 if (utf8 == MAYBE) /* first file */
6286 utf8 = this_utf8;
6287 else if (utf8 != this_utf8)
6289 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6290 mix = !got_int;
6291 got_int = TRUE;
6293 firstline = FALSE;
6295 # endif
6296 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6297 while (p1 != NULL)
6299 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6300 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6302 for (s = p1 + 1; s < p2; ++s)
6303 if (*s == ' ' || *s == '\t' || *s == '|')
6304 break;
6307 * Only accept a *tag* when it consists of valid
6308 * characters, there is white space before it and is
6309 * followed by a white character or end-of-line.
6311 if (s == p2
6312 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6313 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6314 || s[1] == '\0'))
6316 *p2 = '\0';
6317 ++p1;
6318 if (ga_grow(&ga, 1) == FAIL)
6320 got_int = TRUE;
6321 break;
6323 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6324 if (s == NULL)
6326 got_int = TRUE;
6327 break;
6329 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6330 ++ga.ga_len;
6331 sprintf((char *)s, "%s\t%s", p1, fname);
6333 /* find next '*' */
6334 p2 = vim_strchr(p2 + 1, '*');
6337 p1 = p2;
6339 line_breakcheck();
6342 fclose(fd);
6345 FreeWild(filecount, files);
6347 if (!got_int)
6350 * Sort the tags.
6352 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6355 * Check for duplicates.
6357 for (i = 1; i < ga.ga_len; ++i)
6359 p1 = ((char_u **)ga.ga_data)[i - 1];
6360 p2 = ((char_u **)ga.ga_data)[i];
6361 while (*p1 == *p2)
6363 if (*p2 == '\t')
6365 *p2 = NUL;
6366 vim_snprintf((char *)NameBuff, MAXPATHL,
6367 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6368 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6369 EMSG(NameBuff);
6370 *p2 = '\t';
6371 break;
6373 ++p1;
6374 ++p2;
6378 # ifdef FEAT_MBYTE
6379 if (utf8 == TRUE)
6380 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6381 # endif
6384 * Write the tags into the file.
6386 for (i = 0; i < ga.ga_len; ++i)
6388 s = ((char_u **)ga.ga_data)[i];
6389 if (STRNCMP(s, "help-tags\t", 10) == 0)
6390 /* help-tags entry was added in formatted form */
6391 fputs((char *)s, fd_tags);
6392 else
6394 fprintf(fd_tags, "%s\t/*", s);
6395 for (p1 = s; *p1 != '\t'; ++p1)
6397 /* insert backslash before '\\' and '/' */
6398 if (*p1 == '\\' || *p1 == '/')
6399 putc('\\', fd_tags);
6400 putc(*p1, fd_tags);
6402 fprintf(fd_tags, "*\n");
6406 #ifdef FEAT_MBYTE
6407 if (mix)
6408 got_int = FALSE; /* continue with other languages */
6409 #endif
6411 for (i = 0; i < ga.ga_len; ++i)
6412 vim_free(((char_u **)ga.ga_data)[i]);
6413 ga_clear(&ga);
6414 fclose(fd_tags); /* there is no check for an error... */
6416 #endif
6418 #if defined(FEAT_SIGNS) || defined(PROTO)
6421 * Struct to hold the sign properties.
6423 typedef struct sign sign_T;
6425 struct sign
6427 sign_T *sn_next; /* next sign in list */
6428 int sn_typenr; /* type number of sign (negative if not equal
6429 to name) */
6430 char_u *sn_name; /* name of sign */
6431 char_u *sn_icon; /* name of pixmap */
6432 #ifdef FEAT_SIGN_ICONS
6433 void *sn_image; /* icon image */
6434 #endif
6435 char_u *sn_text; /* text used instead of pixmap */
6436 int sn_line_hl; /* highlight ID for line */
6437 int sn_text_hl; /* highlight ID for text */
6440 static sign_T *first_sign = NULL;
6441 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6443 static void sign_list_defined __ARGS((sign_T *sp));
6446 * ":sign" command
6448 void
6449 ex_sign(eap)
6450 exarg_T *eap;
6452 char_u *arg = eap->arg;
6453 char_u *p;
6454 int idx;
6455 sign_T *sp;
6456 sign_T *sp_prev;
6457 buf_T *buf;
6458 static char *cmds[] = {
6459 "define",
6460 #define SIGNCMD_DEFINE 0
6461 "undefine",
6462 #define SIGNCMD_UNDEFINE 1
6463 "list",
6464 #define SIGNCMD_LIST 2
6465 "place",
6466 #define SIGNCMD_PLACE 3
6467 "unplace",
6468 #define SIGNCMD_UNPLACE 4
6469 "jump",
6470 #define SIGNCMD_JUMP 5
6471 #define SIGNCMD_LAST 6
6474 /* Parse the subcommand. */
6475 p = skiptowhite(arg);
6476 if (*p != NUL)
6477 *p++ = NUL;
6478 for (idx = 0; ; ++idx)
6480 if (idx == SIGNCMD_LAST)
6482 EMSG2(_("E160: Unknown sign command: %s"), arg);
6483 return;
6485 if (STRCMP(arg, cmds[idx]) == 0)
6486 break;
6488 arg = skipwhite(p);
6490 if (idx <= SIGNCMD_LIST)
6493 * Define, undefine or list signs.
6495 if (idx == SIGNCMD_LIST && *arg == NUL)
6497 /* ":sign list": list all defined signs */
6498 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6499 sign_list_defined(sp);
6501 else if (*arg == NUL)
6502 EMSG(_("E156: Missing sign name"));
6503 else
6505 p = skiptowhite(arg);
6506 if (*p != NUL)
6507 *p++ = NUL;
6508 sp_prev = NULL;
6509 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6511 if (STRCMP(sp->sn_name, arg) == 0)
6512 break;
6513 sp_prev = sp;
6515 if (idx == SIGNCMD_DEFINE)
6517 /* ":sign define {name} ...": define a sign */
6518 if (sp == NULL)
6520 /* Allocate a new sign. */
6521 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6522 if (sp == NULL)
6523 return;
6524 if (sp_prev == NULL)
6525 first_sign = sp;
6526 else
6527 sp_prev->sn_next = sp;
6528 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6530 /* If the name is a number use that for the typenr,
6531 * otherwise use a negative number. */
6532 if (VIM_ISDIGIT(*arg))
6533 sp->sn_typenr = atoi((char *)arg);
6534 else
6536 sign_T *lp;
6537 int start = last_sign_typenr;
6539 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6541 if (lp->sn_typenr == last_sign_typenr)
6543 --last_sign_typenr;
6544 if (last_sign_typenr == 0)
6545 last_sign_typenr = MAX_TYPENR;
6546 if (last_sign_typenr == start)
6548 EMSG(_("E612: Too many signs defined"));
6549 return;
6551 lp = first_sign;
6552 continue;
6556 sp->sn_typenr = last_sign_typenr--;
6557 if (last_sign_typenr == 0)
6558 last_sign_typenr = MAX_TYPENR; /* wrap around */
6562 /* set values for a defined sign. */
6563 for (;;)
6565 arg = skipwhite(p);
6566 if (*arg == NUL)
6567 break;
6568 p = skiptowhite_esc(arg);
6569 if (STRNCMP(arg, "icon=", 5) == 0)
6571 arg += 5;
6572 vim_free(sp->sn_icon);
6573 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6574 backslash_halve(sp->sn_icon);
6575 #ifdef FEAT_SIGN_ICONS
6576 if (gui.in_use)
6578 out_flush();
6579 if (sp->sn_image != NULL)
6580 gui_mch_destroy_sign(sp->sn_image);
6581 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6583 #endif
6585 else if (STRNCMP(arg, "text=", 5) == 0)
6587 char_u *s;
6588 int cells;
6589 int len;
6591 arg += 5;
6592 #ifdef FEAT_MBYTE
6593 /* Count cells and check for non-printable chars */
6594 if (has_mbyte)
6596 cells = 0;
6597 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6599 if (!vim_isprintc((*mb_ptr2char)(s)))
6600 break;
6601 cells += (*mb_ptr2cells)(s);
6604 else
6605 #endif
6607 for (s = arg; s < p; ++s)
6608 if (!vim_isprintc(*s))
6609 break;
6610 cells = (int)(s - arg);
6612 /* Currently must be one or two display cells */
6613 if (s != p || cells < 1 || cells > 2)
6615 *p = NUL;
6616 EMSG2(_("E239: Invalid sign text: %s"), arg);
6617 return;
6620 vim_free(sp->sn_text);
6621 /* Allocate one byte more if we need to pad up
6622 * with a space. */
6623 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6624 sp->sn_text = vim_strnsave(arg, len);
6626 if (sp->sn_text != NULL && cells == 1)
6627 STRCPY(sp->sn_text + len - 1, " ");
6629 else if (STRNCMP(arg, "linehl=", 7) == 0)
6631 arg += 7;
6632 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6634 else if (STRNCMP(arg, "texthl=", 7) == 0)
6636 arg += 7;
6637 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6639 else
6641 EMSG2(_(e_invarg2), arg);
6642 return;
6646 else if (sp == NULL)
6647 EMSG2(_("E155: Unknown sign: %s"), arg);
6648 else if (idx == SIGNCMD_LIST)
6649 /* ":sign list {name}" */
6650 sign_list_defined(sp);
6651 else
6653 /* ":sign undefine {name}" */
6654 vim_free(sp->sn_name);
6655 vim_free(sp->sn_icon);
6656 #ifdef FEAT_SIGN_ICONS
6657 if (sp->sn_image != NULL)
6659 out_flush();
6660 gui_mch_destroy_sign(sp->sn_image);
6662 #endif
6663 vim_free(sp->sn_text);
6664 if (sp_prev == NULL)
6665 first_sign = sp->sn_next;
6666 else
6667 sp_prev->sn_next = sp->sn_next;
6668 vim_free(sp);
6672 else
6674 int id = -1;
6675 linenr_T lnum = -1;
6676 char_u *sign_name = NULL;
6677 char_u *arg1;
6679 if (*arg == NUL)
6681 if (idx == SIGNCMD_PLACE)
6683 /* ":sign place": list placed signs in all buffers */
6684 sign_list_placed(NULL);
6686 else if (idx == SIGNCMD_UNPLACE)
6688 /* ":sign unplace": remove placed sign at cursor */
6689 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6690 if (id > 0)
6692 buf_delsign(curwin->w_buffer, id);
6693 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6695 else
6696 EMSG(_("E159: Missing sign number"));
6698 else
6699 EMSG(_(e_argreq));
6700 return;
6703 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6705 /* ":sign unplace *": remove all placed signs */
6706 buf_delete_all_signs();
6707 return;
6710 /* first arg could be placed sign id */
6711 arg1 = arg;
6712 if (VIM_ISDIGIT(*arg))
6714 id = getdigits(&arg);
6715 if (!vim_iswhite(*arg) && *arg != NUL)
6717 id = -1;
6718 arg = arg1;
6720 else
6722 arg = skipwhite(arg);
6723 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6725 /* ":sign unplace {id}": remove placed sign by number */
6726 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6727 if ((lnum = buf_delsign(buf, id)) != 0)
6728 update_debug_sign(buf, lnum);
6729 return;
6735 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6736 * Leave "arg" pointing to {fname}.
6738 for (;;)
6740 if (STRNCMP(arg, "line=", 5) == 0)
6742 arg += 5;
6743 lnum = atoi((char *)arg);
6744 arg = skiptowhite(arg);
6746 else if (STRNCMP(arg, "name=", 5) == 0)
6748 arg += 5;
6749 sign_name = arg;
6750 arg = skiptowhite(arg);
6751 if (*arg != NUL)
6752 *arg++ = NUL;
6754 else if (STRNCMP(arg, "file=", 5) == 0)
6756 arg += 5;
6757 buf = buflist_findname(arg);
6758 break;
6760 else if (STRNCMP(arg, "buffer=", 7) == 0)
6762 arg += 7;
6763 buf = buflist_findnr((int)getdigits(&arg));
6764 if (*skipwhite(arg) != NUL)
6765 EMSG(_(e_trailing));
6766 break;
6768 else
6770 EMSG(_(e_invarg));
6771 return;
6773 arg = skipwhite(arg);
6776 if (buf == NULL)
6778 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6780 else if (id <= 0)
6782 if (lnum >= 0 || sign_name != NULL)
6783 EMSG(_(e_invarg));
6784 else
6785 /* ":sign place file={fname}": list placed signs in one file */
6786 sign_list_placed(buf);
6788 else if (idx == SIGNCMD_JUMP)
6790 /* ":sign jump {id} file={fname}" */
6791 if (lnum >= 0 || sign_name != NULL)
6792 EMSG(_(e_invarg));
6793 else if ((lnum = buf_findsign(buf, id)) > 0)
6794 { /* goto a sign ... */
6795 if (buf_jump_open_win(buf) != NULL)
6796 { /* ... in a current window */
6797 curwin->w_cursor.lnum = lnum;
6798 check_cursor_lnum();
6799 beginline(BL_WHITE);
6801 else
6802 { /* ... not currently in a window */
6803 char_u *cmd;
6805 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6806 if (cmd == NULL)
6807 return;
6808 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6809 do_cmdline_cmd(cmd);
6810 vim_free(cmd);
6812 #ifdef FEAT_FOLDING
6813 foldOpenCursor();
6814 #endif
6816 else
6817 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6819 else if (idx == SIGNCMD_UNPLACE)
6821 /* ":sign unplace {id} file={fname}" */
6822 if (lnum >= 0 || sign_name != NULL)
6823 EMSG(_(e_invarg));
6824 else
6826 lnum = buf_delsign(buf, id);
6827 update_debug_sign(buf, lnum);
6830 /* idx == SIGNCMD_PLACE */
6831 else if (sign_name != NULL)
6833 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6834 if (STRCMP(sp->sn_name, sign_name) == 0)
6835 break;
6836 if (sp == NULL)
6838 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6839 return;
6841 if (lnum > 0)
6842 /* ":sign place {id} line={lnum} name={name} file={fname}":
6843 * place a sign */
6844 buf_addsign(buf, id, lnum, sp->sn_typenr);
6845 else
6846 /* ":sign place {id} file={fname}": change sign type */
6847 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6848 update_debug_sign(buf, lnum);
6850 else
6851 EMSG(_(e_invarg));
6855 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6857 * Allocate the icons. Called when the GUI has started. Allows defining
6858 * signs before it starts.
6860 void
6861 sign_gui_started()
6863 sign_T *sp;
6865 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6866 if (sp->sn_icon != NULL)
6867 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6869 #endif
6872 * List one sign.
6874 static void
6875 sign_list_defined(sp)
6876 sign_T *sp;
6878 char_u *p;
6880 smsg((char_u *)"sign %s", sp->sn_name);
6881 if (sp->sn_icon != NULL)
6883 MSG_PUTS(" icon=");
6884 msg_outtrans(sp->sn_icon);
6885 #ifdef FEAT_SIGN_ICONS
6886 if (sp->sn_image == NULL)
6887 MSG_PUTS(_(" (NOT FOUND)"));
6888 #else
6889 MSG_PUTS(_(" (not supported)"));
6890 #endif
6892 if (sp->sn_text != NULL)
6894 MSG_PUTS(" text=");
6895 msg_outtrans(sp->sn_text);
6897 if (sp->sn_line_hl > 0)
6899 MSG_PUTS(" linehl=");
6900 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6901 if (p == NULL)
6902 MSG_PUTS("NONE");
6903 else
6904 msg_puts(p);
6906 if (sp->sn_text_hl > 0)
6908 MSG_PUTS(" texthl=");
6909 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6910 if (p == NULL)
6911 MSG_PUTS("NONE");
6912 else
6913 msg_puts(p);
6918 * Get highlighting attribute for sign "typenr".
6919 * If "line" is TRUE: line highl, if FALSE: text highl.
6922 sign_get_attr(typenr, line)
6923 int typenr;
6924 int line;
6926 sign_T *sp;
6928 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6929 if (sp->sn_typenr == typenr)
6931 if (line)
6933 if (sp->sn_line_hl > 0)
6934 return syn_id2attr(sp->sn_line_hl);
6936 else
6938 if (sp->sn_text_hl > 0)
6939 return syn_id2attr(sp->sn_text_hl);
6941 break;
6943 return 0;
6947 * Get text mark for sign "typenr".
6948 * Returns NULL if there isn't one.
6950 char_u *
6951 sign_get_text(typenr)
6952 int typenr;
6954 sign_T *sp;
6956 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6957 if (sp->sn_typenr == typenr)
6958 return sp->sn_text;
6959 return NULL;
6962 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6963 void *
6964 sign_get_image(typenr)
6965 int typenr; /* the attribute which may have a sign */
6967 sign_T *sp;
6969 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6970 if (sp->sn_typenr == typenr)
6971 return sp->sn_image;
6972 return NULL;
6974 #endif
6977 * Get the name of a sign by its typenr.
6979 char_u *
6980 sign_typenr2name(typenr)
6981 int typenr;
6983 sign_T *sp;
6985 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6986 if (sp->sn_typenr == typenr)
6987 return sp->sn_name;
6988 return (char_u *)_("[Deleted]");
6991 #endif
6993 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
6995 * ":drop"
6996 * Opens the first argument in a window. When there are two or more arguments
6997 * the argument list is redefined.
6999 void
7000 ex_drop(eap)
7001 exarg_T *eap;
7003 int split = FALSE;
7004 win_T *wp;
7005 buf_T *buf;
7006 # ifdef FEAT_WINDOWS
7007 tabpage_T *tp;
7008 # endif
7011 * Check if the first argument is already being edited in a window. If
7012 * so, jump to that window.
7013 * We would actually need to check all arguments, but that's complicated
7014 * and mostly only one file is dropped.
7015 * This also ignores wildcards, since it is very unlikely the user is
7016 * editing a file name with a wildcard character.
7018 set_arglist(eap->arg);
7021 * Expanding wildcards may result in an empty argument list. E.g. when
7022 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7023 * already did an error message for this.
7025 if (ARGCOUNT == 0)
7026 return;
7028 # ifdef FEAT_WINDOWS
7029 if (cmdmod.tab)
7031 /* ":tab drop file ...": open a tab for each argument that isn't
7032 * edited in a window yet. It's like ":tab all" but without closing
7033 * windows or tabs. */
7034 ex_all(eap);
7036 else
7037 # endif
7039 /* ":drop file ...": Edit the first argument. Jump to an existing
7040 * window if possible, edit in current window if the current buffer
7041 * can be abandoned, otherwise open a new window. */
7042 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7044 FOR_ALL_TAB_WINDOWS(tp, wp)
7046 if (wp->w_buffer == buf)
7048 # ifdef FEAT_WINDOWS
7049 goto_tabpage_win(tp, wp);
7050 # endif
7051 curwin->w_arg_idx = 0;
7052 return;
7057 * Check whether the current buffer is changed. If so, we will need
7058 * to split the current window or data could be lost.
7059 * Skip the check if the 'hidden' option is set, as in this case the
7060 * buffer won't be lost.
7062 if (!P_HID(curbuf))
7064 # ifdef FEAT_WINDOWS
7065 ++emsg_off;
7066 # endif
7067 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7068 # ifdef FEAT_WINDOWS
7069 --emsg_off;
7070 # else
7071 if (split)
7072 return;
7073 # endif
7076 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7077 if (split)
7079 eap->cmdidx = CMD_sfirst;
7080 eap->cmd[0] = 's';
7082 else
7083 eap->cmdidx = CMD_first;
7084 ex_rewind(eap);
7087 #endif