Update Help menu
[MacVim.git] / src / ex_cmds.c
bloba87dab6a6fdffc24f039ad41575cd167a08862cb
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 /* Sorting one line is really quick! */
369 if (count <= 1)
370 return;
372 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
373 return;
374 sortbuf1 = NULL;
375 sortbuf2 = NULL;
376 regmatch.regprog = NULL;
377 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
378 if (nrs == NULL)
379 goto sortend;
381 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
383 for (p = eap->arg; *p != NUL; ++p)
385 if (vim_iswhite(*p))
387 else if (*p == 'i')
388 sort_ic = TRUE;
389 else if (*p == 'r')
390 sort_rx = TRUE;
391 else if (*p == 'n')
392 sort_nr = 2;
393 else if (*p == 'o')
394 sort_oct = 2;
395 else if (*p == 'x')
396 sort_hex = 2;
397 else if (*p == 'u')
398 unique = TRUE;
399 else if (*p == '"') /* comment start */
400 break;
401 else if (check_nextcmd(p) != NULL)
403 eap->nextcmd = check_nextcmd(p);
404 break;
406 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
408 s = skip_regexp(p + 1, *p, TRUE, NULL);
409 if (*s != *p)
411 EMSG(_(e_invalpat));
412 goto sortend;
414 *s = NUL;
415 /* Use last search pattern if sort pattern is empty. */
416 if (s == p + 1 && last_search_pat() != NULL)
417 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
418 else
419 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
420 if (regmatch.regprog == NULL)
421 goto sortend;
422 p = s; /* continue after the regexp */
423 regmatch.rm_ic = p_ic;
425 else
427 EMSG2(_(e_invarg2), p);
428 goto sortend;
432 /* Can only have one of 'n', 'o' and 'x'. */
433 if (sort_nr + sort_oct + sort_hex > 2)
435 EMSG(_(e_invarg));
436 goto sortend;
439 /* From here on "sort_nr" is used as a flag for any number sorting. */
440 sort_nr += sort_oct + sort_hex;
443 * Make an array with all line numbers. This avoids having to copy all
444 * the lines into allocated memory.
445 * When sorting on strings "start_col_nr" is the offset in the line, for
446 * numbers sorting it's the number to sort on. This means the pattern
447 * matching and number conversion only has to be done once per line.
448 * Also get the longest line length for allocating "sortbuf".
450 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
452 s = ml_get(lnum);
453 len = (int)STRLEN(s);
454 if (maxlen < len)
455 maxlen = len;
457 start_col = 0;
458 end_col = len;
459 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
461 if (sort_rx)
463 start_col = (colnr_T)(regmatch.startp[0] - s);
464 end_col = (colnr_T)(regmatch.endp[0] - s);
466 else
467 start_col = (colnr_T)(regmatch.endp[0] - s);
469 else
470 if (regmatch.regprog != NULL)
471 end_col = 0;
473 if (sort_nr)
475 /* Make sure vim_str2nr doesn't read any digits past the end
476 * of the match, by temporarily terminating the string there */
477 s2 = s + end_col;
478 c = *s2;
479 (*s2) = 0;
480 /* Sorting on number: Store the number itself. */
481 if (sort_hex)
482 s = skiptohex(s + start_col);
483 else
484 s = skiptodigit(s + start_col);
485 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
486 &nrs[lnum - eap->line1].start_col_nr, NULL);
487 (*s2) = c;
489 else
491 /* Store the column to sort at. */
492 nrs[lnum - eap->line1].start_col_nr = start_col;
493 nrs[lnum - eap->line1].end_col_nr = end_col;
496 nrs[lnum - eap->line1].lnum = lnum;
498 if (regmatch.regprog != NULL)
499 fast_breakcheck();
500 if (got_int)
501 goto sortend;
504 /* Allocate a buffer that can hold the longest line. */
505 sortbuf1 = alloc((unsigned)maxlen + 1);
506 if (sortbuf1 == NULL)
507 goto sortend;
508 sortbuf2 = alloc((unsigned)maxlen + 1);
509 if (sortbuf2 == NULL)
510 goto sortend;
512 /* Sort the array of line numbers. Note: can't be interrupted! */
513 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
515 if (sort_abort)
516 goto sortend;
518 /* Insert the lines in the sorted order below the last one. */
519 lnum = eap->line2;
520 for (i = 0; i < count; ++i)
522 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
523 if (!unique || i == 0
524 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
526 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
527 break;
528 if (unique)
529 STRCPY(sortbuf1, s);
531 fast_breakcheck();
532 if (got_int)
533 goto sortend;
536 /* delete the original lines if appending worked */
537 if (i == count)
538 for (i = 0; i < count; ++i)
539 ml_delete(eap->line1, FALSE);
540 else
541 count = 0;
543 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
544 deleted = (long)(count - (lnum - eap->line2));
545 if (deleted > 0)
546 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
547 else if (deleted < 0)
548 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
549 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
551 curwin->w_cursor.lnum = eap->line1;
552 beginline(BL_WHITE | BL_FIX);
554 sortend:
555 vim_free(nrs);
556 vim_free(sortbuf1);
557 vim_free(sortbuf2);
558 vim_free(regmatch.regprog);
559 if (got_int)
560 EMSG(_(e_interr));
564 * ":retab".
566 void
567 ex_retab(eap)
568 exarg_T *eap;
570 linenr_T lnum;
571 int got_tab = FALSE;
572 long num_spaces = 0;
573 long num_tabs;
574 long len;
575 long col;
576 long vcol;
577 long start_col = 0; /* For start of white-space string */
578 long start_vcol = 0; /* For start of white-space string */
579 int temp;
580 long old_len;
581 char_u *ptr;
582 char_u *new_line = (char_u *)1; /* init to non-NULL */
583 int did_undo; /* called u_save for current line */
584 int new_ts;
585 int save_list;
586 linenr_T first_line = 0; /* first changed line */
587 linenr_T last_line = 0; /* last changed line */
589 save_list = curwin->w_p_list;
590 curwin->w_p_list = 0; /* don't want list mode here */
592 new_ts = getdigits(&(eap->arg));
593 if (new_ts < 0)
595 EMSG(_(e_positive));
596 return;
598 if (new_ts == 0)
599 new_ts = curbuf->b_p_ts;
600 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
602 ptr = ml_get(lnum);
603 col = 0;
604 vcol = 0;
605 did_undo = FALSE;
606 for (;;)
608 if (vim_iswhite(ptr[col]))
610 if (!got_tab && num_spaces == 0)
612 /* First consecutive white-space */
613 start_vcol = vcol;
614 start_col = col;
616 if (ptr[col] == ' ')
617 num_spaces++;
618 else
619 got_tab = TRUE;
621 else
623 if (got_tab || (eap->forceit && num_spaces > 1))
625 /* Retabulate this string of white-space */
627 /* len is virtual length of white string */
628 len = num_spaces = vcol - start_vcol;
629 num_tabs = 0;
630 if (!curbuf->b_p_et)
632 temp = new_ts - (start_vcol % new_ts);
633 if (num_spaces >= temp)
635 num_spaces -= temp;
636 num_tabs++;
638 num_tabs += num_spaces / new_ts;
639 num_spaces -= (num_spaces / new_ts) * new_ts;
641 if (curbuf->b_p_et || got_tab ||
642 (num_spaces + num_tabs < len))
644 if (did_undo == FALSE)
646 did_undo = TRUE;
647 if (u_save((linenr_T)(lnum - 1),
648 (linenr_T)(lnum + 1)) == FAIL)
650 new_line = NULL; /* flag out-of-memory */
651 break;
655 /* len is actual number of white characters used */
656 len = num_spaces + num_tabs;
657 old_len = (long)STRLEN(ptr);
658 new_line = lalloc(old_len - col + start_col + len + 1,
659 TRUE);
660 if (new_line == NULL)
661 break;
662 if (start_col > 0)
663 mch_memmove(new_line, ptr, (size_t)start_col);
664 mch_memmove(new_line + start_col + len,
665 ptr + col, (size_t)(old_len - col + 1));
666 ptr = new_line + start_col;
667 for (col = 0; col < len; col++)
668 ptr[col] = (col < num_tabs) ? '\t' : ' ';
669 ml_replace(lnum, new_line, FALSE);
670 if (first_line == 0)
671 first_line = lnum;
672 last_line = lnum;
673 ptr = new_line;
674 col = start_col + len;
677 got_tab = FALSE;
678 num_spaces = 0;
680 if (ptr[col] == NUL)
681 break;
682 vcol += chartabsize(ptr + col, (colnr_T)vcol);
683 #ifdef FEAT_MBYTE
684 if (has_mbyte)
685 col += (*mb_ptr2len)(ptr + col);
686 else
687 #endif
688 ++col;
690 if (new_line == NULL) /* out of memory */
691 break;
692 line_breakcheck();
694 if (got_int)
695 EMSG(_(e_interr));
697 if (curbuf->b_p_ts != new_ts)
698 redraw_curbuf_later(NOT_VALID);
699 if (first_line != 0)
700 changed_lines(first_line, 0, last_line + 1, 0L);
702 curwin->w_p_list = save_list; /* restore 'list' */
704 curbuf->b_p_ts = new_ts;
705 coladvance(curwin->w_curswant);
707 u_clearline();
709 #endif
712 * :move command - move lines line1-line2 to line dest
714 * return FAIL for failure, OK otherwise
717 do_move(line1, line2, dest)
718 linenr_T line1;
719 linenr_T line2;
720 linenr_T dest;
722 char_u *str;
723 linenr_T l;
724 linenr_T extra; /* Num lines added before line1 */
725 linenr_T num_lines; /* Num lines moved */
726 linenr_T last_line; /* Last line in file after adding new text */
728 if (dest >= line1 && dest < line2)
730 EMSG(_("E134: Move lines into themselves"));
731 return FAIL;
734 num_lines = line2 - line1 + 1;
737 * First we copy the old text to its new location -- webb
738 * Also copy the flag that ":global" command uses.
740 if (u_save(dest, dest + 1) == FAIL)
741 return FAIL;
742 for (extra = 0, l = line1; l <= line2; l++)
744 str = vim_strsave(ml_get(l + extra));
745 if (str != NULL)
747 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
748 vim_free(str);
749 if (dest < line1)
750 extra++;
755 * Now we must be careful adjusting our marks so that we don't overlap our
756 * mark_adjust() calls.
758 * We adjust the marks within the old text so that they refer to the
759 * last lines of the file (temporarily), because we know no other marks
760 * will be set there since these line numbers did not exist until we added
761 * our new lines.
763 * Then we adjust the marks on lines between the old and new text positions
764 * (either forwards or backwards).
766 * And Finally we adjust the marks we put at the end of the file back to
767 * their final destination at the new text position -- webb
769 last_line = curbuf->b_ml.ml_line_count;
770 mark_adjust(line1, line2, last_line - line2, 0L);
771 if (dest >= line2)
773 mark_adjust(line2 + 1, dest, -num_lines, 0L);
774 curbuf->b_op_start.lnum = dest - num_lines + 1;
775 curbuf->b_op_end.lnum = dest;
777 else
779 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
780 curbuf->b_op_start.lnum = dest + 1;
781 curbuf->b_op_end.lnum = dest + num_lines;
783 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
784 mark_adjust(last_line - num_lines + 1, last_line,
785 -(last_line - dest - extra), 0L);
788 * Now we delete the original text -- webb
790 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
791 return FAIL;
793 for (l = line1; l <= line2; l++)
794 ml_delete(line1 + extra, TRUE);
796 if (!global_busy && num_lines > p_report)
798 if (num_lines == 1)
799 MSG(_("1 line moved"));
800 else
801 smsg((char_u *)_("%ld lines moved"), num_lines);
805 * Leave the cursor on the last of the moved lines.
807 if (dest >= line1)
808 curwin->w_cursor.lnum = dest;
809 else
810 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
812 if (line1 < dest)
813 changed_lines(line1, 0, dest + num_lines + 1, 0L);
814 else
815 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
817 return OK;
821 * ":copy"
823 void
824 ex_copy(line1, line2, n)
825 linenr_T line1;
826 linenr_T line2;
827 linenr_T n;
829 linenr_T count;
830 char_u *p;
832 count = line2 - line1 + 1;
833 curbuf->b_op_start.lnum = n + 1;
834 curbuf->b_op_end.lnum = n + count;
835 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
838 * there are three situations:
839 * 1. destination is above line1
840 * 2. destination is between line1 and line2
841 * 3. destination is below line2
843 * n = destination (when starting)
844 * curwin->w_cursor.lnum = destination (while copying)
845 * line1 = start of source (while copying)
846 * line2 = end of source (while copying)
848 if (u_save(n, n + 1) == FAIL)
849 return;
851 curwin->w_cursor.lnum = n;
852 while (line1 <= line2)
854 /* need to use vim_strsave() because the line will be unlocked within
855 * ml_append() */
856 p = vim_strsave(ml_get(line1));
857 if (p != NULL)
859 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
860 vim_free(p);
862 /* situation 2: skip already copied lines */
863 if (line1 == n)
864 line1 = curwin->w_cursor.lnum;
865 ++line1;
866 if (curwin->w_cursor.lnum < line1)
867 ++line1;
868 if (curwin->w_cursor.lnum < line2)
869 ++line2;
870 ++curwin->w_cursor.lnum;
873 appended_lines_mark(n, count);
875 msgmore((long)count);
878 static char_u *prevcmd = NULL; /* the previous command */
880 #if defined(EXITFREE) || defined(PROTO)
881 void
882 free_prev_shellcmd()
884 vim_free(prevcmd);
886 #endif
889 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
890 * Bangs in the argument are replaced with the previously entered command.
891 * Remember the argument.
893 * RISCOS: Bangs only replaced when followed by a space, since many
894 * pathnames contain one.
896 void
897 do_bang(addr_count, eap, forceit, do_in, do_out)
898 int addr_count;
899 exarg_T *eap;
900 int forceit;
901 int do_in, do_out;
903 char_u *arg = eap->arg; /* command */
904 linenr_T line1 = eap->line1; /* start of range */
905 linenr_T line2 = eap->line2; /* end of range */
906 char_u *newcmd = NULL; /* the new command */
907 int free_newcmd = FALSE; /* need to free() newcmd */
908 int ins_prevcmd;
909 char_u *t;
910 char_u *p;
911 char_u *trailarg;
912 int len;
913 int scroll_save = msg_scroll;
916 * Disallow shell commands for "rvim".
917 * Disallow shell commands from .exrc and .vimrc in current directory for
918 * security reasons.
920 if (check_restricted() || check_secure())
921 return;
923 if (addr_count == 0) /* :! */
925 msg_scroll = FALSE; /* don't scroll here */
926 autowrite_all();
927 msg_scroll = scroll_save;
931 * Try to find an embedded bang, like in :!<cmd> ! [args]
932 * (:!! is indicated by the 'forceit' variable)
934 ins_prevcmd = forceit;
935 trailarg = arg;
938 len = (int)STRLEN(trailarg) + 1;
939 if (newcmd != NULL)
940 len += (int)STRLEN(newcmd);
941 if (ins_prevcmd)
943 if (prevcmd == NULL)
945 EMSG(_(e_noprev));
946 vim_free(newcmd);
947 return;
949 len += (int)STRLEN(prevcmd);
951 if ((t = alloc(len)) == NULL)
953 vim_free(newcmd);
954 return;
956 *t = NUL;
957 if (newcmd != NULL)
958 STRCAT(t, newcmd);
959 if (ins_prevcmd)
960 STRCAT(t, prevcmd);
961 p = t + STRLEN(t);
962 STRCAT(t, trailarg);
963 vim_free(newcmd);
964 newcmd = t;
967 * Scan the rest of the argument for '!', which is replaced by the
968 * previous command. "\!" is replaced by "!" (this is vi compatible).
970 trailarg = NULL;
971 while (*p)
973 if (*p == '!'
974 #ifdef RISCOS
975 && (p[1] == ' ' || p[1] == NUL)
976 #endif
979 if (p > newcmd && p[-1] == '\\')
980 mch_memmove(p - 1, p, (size_t)(STRLEN(p) + 1));
981 else
983 trailarg = p;
984 *trailarg++ = NUL;
985 ins_prevcmd = TRUE;
986 break;
989 ++p;
991 } while (trailarg != NULL);
993 vim_free(prevcmd);
994 prevcmd = newcmd;
996 if (bangredo) /* put cmd in redo buffer for ! command */
998 AppendToRedobuffLit(prevcmd, -1);
999 AppendToRedobuff((char_u *)"\n");
1000 bangredo = FALSE;
1003 * Add quotes around the command, for shells that need them.
1005 if (*p_shq != NUL)
1007 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1008 if (newcmd == NULL)
1009 return;
1010 STRCPY(newcmd, p_shq);
1011 STRCAT(newcmd, prevcmd);
1012 STRCAT(newcmd, p_shq);
1013 free_newcmd = TRUE;
1015 if (addr_count == 0) /* :! */
1017 /* echo the command */
1018 msg_start();
1019 msg_putchar(':');
1020 msg_putchar('!');
1021 msg_outtrans(newcmd);
1022 msg_clr_eos();
1023 windgoto(msg_row, msg_col);
1025 do_shell(newcmd, 0);
1027 else /* :range! */
1029 /* Careful: This may recursively call do_bang() again! (because of
1030 * autocommands) */
1031 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1032 #ifdef FEAT_AUTOCMD
1033 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1034 #endif
1036 if (free_newcmd)
1037 vim_free(newcmd);
1041 * do_filter: filter lines through a command given by the user
1043 * We mostly use temp files and the call_shell() routine here. This would
1044 * normally be done using pipes on a UNIX machine, but this is more portable
1045 * to non-unix machines. The call_shell() routine needs to be able
1046 * to deal with redirection somehow, and should handle things like looking
1047 * at the PATH env. variable, and adding reasonable extensions to the
1048 * command name given by the user. All reasonable versions of call_shell()
1049 * do this.
1050 * Alternatively, if on Unix and redirecting input or output, but not both,
1051 * and the 'shelltemp' option isn't set, use pipes.
1052 * We use input redirection if do_in is TRUE.
1053 * We use output redirection if do_out is TRUE.
1055 static void
1056 do_filter(line1, line2, eap, cmd, do_in, do_out)
1057 linenr_T line1, line2;
1058 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1059 char_u *cmd;
1060 int do_in, do_out;
1062 char_u *itmp = NULL;
1063 char_u *otmp = NULL;
1064 linenr_T linecount;
1065 linenr_T read_linecount;
1066 pos_T cursor_save;
1067 char_u *cmd_buf;
1068 #ifdef FEAT_AUTOCMD
1069 buf_T *old_curbuf = curbuf;
1070 #endif
1071 int shell_flags = 0;
1073 if (*cmd == NUL) /* no filter command */
1074 return;
1076 #ifdef WIN3264
1078 * Check if external commands are allowed now.
1080 if (can_end_termcap_mode(TRUE) == FALSE)
1081 return;
1082 #endif
1084 cursor_save = curwin->w_cursor;
1085 linecount = line2 - line1 + 1;
1086 curwin->w_cursor.lnum = line1;
1087 curwin->w_cursor.col = 0;
1088 changed_line_abv_curs();
1089 invalidate_botline();
1092 * When using temp files:
1093 * 1. * Form temp file names
1094 * 2. * Write the lines to a temp file
1095 * 3. Run the filter command on the temp file
1096 * 4. * Read the output of the command into the buffer
1097 * 5. * Delete the original lines to be filtered
1098 * 6. * Remove the temp files
1100 * When writing the input with a pipe or when catching the output with a
1101 * pipe only need to do 3.
1104 if (do_out)
1105 shell_flags |= SHELL_DOOUT;
1107 #if !defined(USE_SYSTEM) && defined(UNIX)
1108 if (!do_in && do_out && !p_stmp)
1110 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1111 shell_flags |= SHELL_READ;
1112 curwin->w_cursor.lnum = line2;
1114 else if (do_in && !do_out && !p_stmp)
1116 /* Use a pipe to write stdin of the command, do not use a temp file. */
1117 shell_flags |= SHELL_WRITE;
1118 curbuf->b_op_start.lnum = line1;
1119 curbuf->b_op_end.lnum = line2;
1121 else if (do_in && do_out && !p_stmp)
1123 /* Use a pipe to write stdin and fetch stdout of the command, do not
1124 * use a temp file. */
1125 shell_flags |= SHELL_READ|SHELL_WRITE;
1126 curbuf->b_op_start.lnum = line1;
1127 curbuf->b_op_end.lnum = line2;
1128 curwin->w_cursor.lnum = line2;
1130 else
1131 #endif
1132 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1133 || (do_out && (otmp = vim_tempname('o')) == NULL))
1135 EMSG(_(e_notmp));
1136 goto filterend;
1140 * The writing and reading of temp files will not be shown.
1141 * Vi also doesn't do this and the messages are not very informative.
1143 ++no_wait_return; /* don't call wait_return() while busy */
1144 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1145 FALSE, FALSE, FALSE, TRUE) == FAIL)
1147 msg_putchar('\n'); /* keep message from buf_write() */
1148 --no_wait_return;
1149 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1150 if (!aborting())
1151 #endif
1152 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1153 goto filterend;
1155 #ifdef FEAT_AUTOCMD
1156 if (curbuf != old_curbuf)
1157 goto filterend;
1158 #endif
1160 if (!do_out)
1161 msg_putchar('\n');
1163 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1164 if (cmd_buf == NULL)
1165 goto filterend;
1167 windgoto((int)Rows - 1, 0);
1168 cursor_on();
1171 * When not redirecting the output the command can write anything to the
1172 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1173 * stderr output of external command. Clear the screen later.
1174 * If do_in is FALSE, this could be something like ":r !cat", which may
1175 * also mess up the screen, clear it later.
1177 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1178 redraw_later_clear();
1180 if (do_out)
1182 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1183 goto error;
1184 redraw_curbuf_later(VALID);
1186 read_linecount = curbuf->b_ml.ml_line_count;
1189 * When call_shell() fails wait_return() is called to give the user a
1190 * chance to read the error messages. Otherwise errors are ignored, so you
1191 * can see the error messages from the command that appear on stdout; use
1192 * 'u' to fix the text
1193 * Switch to cooked mode when not redirecting stdin, avoids that something
1194 * like ":r !cat" hangs.
1195 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1197 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1199 redraw_later_clear();
1200 wait_return(FALSE);
1202 vim_free(cmd_buf);
1204 did_check_timestamps = FALSE;
1205 need_check_timestamps = TRUE;
1207 /* When interrupting the shell command, it may still have produced some
1208 * useful output. Reset got_int here, so that readfile() won't cancel
1209 * reading. */
1210 ui_breakcheck();
1211 got_int = FALSE;
1213 if (do_out)
1215 if (otmp != NULL)
1217 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1218 eap, READ_FILTER) == FAIL)
1220 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1221 if (!aborting())
1222 #endif
1224 msg_putchar('\n');
1225 EMSG2(_(e_notread), otmp);
1227 goto error;
1229 #ifdef FEAT_AUTOCMD
1230 if (curbuf != old_curbuf)
1231 goto filterend;
1232 #endif
1235 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1237 if (shell_flags & SHELL_READ)
1239 curbuf->b_op_start.lnum = line2 + 1;
1240 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1241 appended_lines_mark(line2, read_linecount);
1244 if (do_in)
1246 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1248 if (read_linecount >= linecount)
1249 /* move all marks from old lines to new lines */
1250 mark_adjust(line1, line2, linecount, 0L);
1251 else
1253 /* move marks from old lines to new lines, delete marks
1254 * that are in deleted lines */
1255 mark_adjust(line1, line1 + read_linecount - 1,
1256 linecount, 0L);
1257 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1262 * Put cursor on first filtered line for ":range!cmd".
1263 * Adjust '[ and '] (set by buf_write()).
1265 curwin->w_cursor.lnum = line1;
1266 del_lines(linecount, TRUE);
1267 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1268 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1269 write_lnum_adjust(-linecount); /* adjust last line
1270 for next write */
1271 #ifdef FEAT_FOLDING
1272 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1273 #endif
1275 else
1278 * Put cursor on last new line for ":r !cmd".
1280 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1281 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1284 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1285 --no_wait_return;
1287 if (linecount > p_report)
1289 if (do_in)
1291 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1292 _("%ld lines filtered"), (long)linecount);
1293 if (msg(msg_buf) && !msg_scroll)
1294 /* save message to display it after redraw */
1295 set_keep_msg(msg_buf, 0);
1297 else
1298 msgmore((long)linecount);
1301 else
1303 error:
1304 /* put cursor back in same position for ":w !cmd" */
1305 curwin->w_cursor = cursor_save;
1306 --no_wait_return;
1307 wait_return(FALSE);
1310 filterend:
1312 #ifdef FEAT_AUTOCMD
1313 if (curbuf != old_curbuf)
1315 --no_wait_return;
1316 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1318 #endif
1319 if (itmp != NULL)
1320 mch_remove(itmp);
1321 if (otmp != NULL)
1322 mch_remove(otmp);
1323 vim_free(itmp);
1324 vim_free(otmp);
1328 * Call a shell to execute a command.
1329 * When "cmd" is NULL start an interactive shell.
1331 void
1332 do_shell(cmd, flags)
1333 char_u *cmd;
1334 int flags; /* may be SHELL_DOOUT when output is redirected */
1336 buf_T *buf;
1337 #ifndef FEAT_GUI_MSWIN
1338 int save_nwr;
1339 #endif
1340 #ifdef MSWIN
1341 int winstart = FALSE;
1342 #endif
1345 * Disallow shell commands for "rvim".
1346 * Disallow shell commands from .exrc and .vimrc in current directory for
1347 * security reasons.
1349 if (check_restricted() || check_secure())
1351 msg_end();
1352 return;
1355 #ifdef MSWIN
1357 * Check if external commands are allowed now.
1359 if (can_end_termcap_mode(TRUE) == FALSE)
1360 return;
1363 * Check if ":!start" is used.
1365 if (cmd != NULL)
1366 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1367 #endif
1370 * For autocommands we want to get the output on the current screen, to
1371 * avoid having to type return below.
1373 msg_putchar('\r'); /* put cursor at start of line */
1374 #ifdef FEAT_AUTOCMD
1375 if (!autocmd_busy)
1376 #endif
1378 #ifdef MSWIN
1379 if (!winstart)
1380 #endif
1381 stoptermcap();
1383 #ifdef MSWIN
1384 if (!winstart)
1385 #endif
1386 msg_putchar('\n'); /* may shift screen one line up */
1388 /* warning message before calling the shell */
1389 if (p_warn
1390 #ifdef FEAT_AUTOCMD
1391 && !autocmd_busy
1392 #endif
1393 && msg_silent == 0)
1394 for (buf = firstbuf; buf; buf = buf->b_next)
1395 if (bufIsChanged(buf))
1397 #ifdef FEAT_GUI_MSWIN
1398 if (!winstart)
1399 starttermcap(); /* don't want a message box here */
1400 #endif
1401 MSG_PUTS(_("[No write since last change]\n"));
1402 #ifdef FEAT_GUI_MSWIN
1403 if (!winstart)
1404 stoptermcap();
1405 #endif
1406 break;
1409 /* This windgoto is required for when the '\n' resulted in a "delete line
1410 * 1" command to the terminal. */
1411 if (!swapping_screen())
1412 windgoto(msg_row, msg_col);
1413 cursor_on();
1414 (void)call_shell(cmd, SHELL_COOKED | flags);
1415 did_check_timestamps = FALSE;
1416 need_check_timestamps = TRUE;
1419 * put the message cursor at the end of the screen, avoids wait_return()
1420 * to overwrite the text that the external command showed
1422 if (!swapping_screen())
1424 msg_row = Rows - 1;
1425 msg_col = 0;
1428 #ifdef FEAT_AUTOCMD
1429 if (autocmd_busy)
1431 if (msg_silent == 0)
1432 redraw_later_clear();
1434 else
1435 #endif
1438 * For ":sh" there is no need to call wait_return(), just redraw.
1439 * Also for the Win32 GUI (the output is in a console window).
1440 * Otherwise there is probably text on the screen that the user wants
1441 * to read before redrawing, so call wait_return().
1443 #ifndef FEAT_GUI_MSWIN
1444 if (cmd == NULL
1445 # ifdef WIN3264
1446 || (winstart && !need_wait_return)
1447 # endif
1450 if (msg_silent == 0)
1451 redraw_later_clear();
1452 need_wait_return = FALSE;
1454 else
1457 * If we switch screens when starttermcap() is called, we really
1458 * want to wait for "hit return to continue".
1460 save_nwr = no_wait_return;
1461 if (swapping_screen())
1462 no_wait_return = FALSE;
1463 # ifdef AMIGA
1464 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1465 # else
1466 wait_return(msg_silent == 0);
1467 # endif
1468 no_wait_return = save_nwr;
1470 #endif /* FEAT_GUI_W32 */
1472 #ifdef MSWIN
1473 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1474 #endif
1475 starttermcap(); /* start termcap if not done by wait_return() */
1478 * In an Amiga window redrawing is caused by asking the window size.
1479 * If we got an interrupt this will not work. The chance that the
1480 * window size is wrong is very small, but we need to redraw the
1481 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1482 * but it saves an extra redraw.
1484 #ifdef AMIGA
1485 if (skip_redraw) /* ':' hit in wait_return() */
1487 if (msg_silent == 0)
1488 redraw_later_clear();
1490 else if (term_console)
1492 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1493 if (got_int && msg_silent == 0)
1494 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1495 else
1496 must_redraw = 0; /* no extra redraw needed */
1498 #endif
1501 /* display any error messages now */
1502 display_errors();
1504 #ifdef FEAT_AUTOCMD
1505 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1506 #endif
1510 * Create a shell command from a command string, input redirection file and
1511 * output redirection file.
1512 * Returns an allocated string with the shell command, or NULL for failure.
1514 char_u *
1515 make_filter_cmd(cmd, itmp, otmp)
1516 char_u *cmd; /* command */
1517 char_u *itmp; /* NULL or name of input file */
1518 char_u *otmp; /* NULL or name of output file */
1520 char_u *buf;
1521 long_u len;
1523 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1524 if (itmp != NULL)
1525 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1526 if (otmp != NULL)
1527 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1528 buf = lalloc(len, TRUE);
1529 if (buf == NULL)
1530 return NULL;
1532 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1534 * Put braces around the command (for concatenated commands) when
1535 * redirecting input and/or output.
1537 if (itmp != NULL || otmp != NULL)
1538 sprintf((char *)buf, "(%s)", (char *)cmd);
1539 else
1540 STRCPY(buf, cmd);
1541 if (itmp != NULL)
1543 STRCAT(buf, " < ");
1544 STRCAT(buf, itmp);
1546 #else
1548 * for shells that don't understand braces around commands, at least allow
1549 * the use of commands in a pipe.
1551 STRCPY(buf, cmd);
1552 if (itmp != NULL)
1554 char_u *p;
1557 * If there is a pipe, we have to put the '<' in front of it.
1558 * Don't do this when 'shellquote' is not empty, otherwise the
1559 * redirection would be inside the quotes.
1561 if (*p_shq == NUL)
1563 p = vim_strchr(buf, '|');
1564 if (p != NULL)
1565 *p = NUL;
1567 # ifdef RISCOS
1568 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1569 STRCAT(buf, itmp);
1570 STRCAT(buf, " } ");
1571 # else
1572 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1573 STRCAT(buf, itmp);
1574 # endif
1575 if (*p_shq == NUL)
1577 p = vim_strchr(cmd, '|');
1578 if (p != NULL)
1580 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1581 STRCAT(buf, p);
1585 #endif
1586 if (otmp != NULL)
1587 append_redir(buf, p_srr, otmp);
1589 return buf;
1593 * Append output redirection for file "fname" to the end of string buffer "buf"
1594 * Works with the 'shellredir' and 'shellpipe' options.
1595 * The caller should make sure that there is enough room:
1596 * STRLEN(opt) + STRLEN(fname) + 3
1598 void
1599 append_redir(buf, opt, fname)
1600 char_u *buf;
1601 char_u *opt;
1602 char_u *fname;
1604 char_u *p;
1606 buf += STRLEN(buf);
1607 /* find "%s", skipping "%%" */
1608 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1609 if (p[1] == 's')
1610 break;
1611 if (p != NULL)
1613 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1614 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1616 else
1617 sprintf((char *)buf,
1618 #ifdef FEAT_QUICKFIX
1619 # ifndef RISCOS
1620 opt != p_sp ? " %s%s" :
1621 # endif
1622 " %s %s",
1623 #else
1624 # ifndef RISCOS
1625 " %s%s", /* " > %s" causes problems on Amiga */
1626 # else
1627 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1628 # endif
1629 #endif
1630 (char *)opt, (char *)fname);
1633 #ifdef FEAT_VIMINFO
1635 static int no_viminfo __ARGS((void));
1636 static int viminfo_errcnt;
1638 static int
1639 no_viminfo()
1641 /* "vim -i NONE" does not read or write a viminfo file */
1642 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1646 * Report an error for reading a viminfo file.
1647 * Count the number of errors. When there are more than 10, return TRUE.
1650 viminfo_error(errnum, message, line)
1651 char *errnum;
1652 char *message;
1653 char_u *line;
1655 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1656 errnum, message);
1657 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1658 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1659 IObuff[STRLEN(IObuff) - 1] = NUL;
1660 emsg(IObuff);
1661 if (++viminfo_errcnt >= 10)
1663 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1664 return TRUE;
1666 return FALSE;
1670 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1671 * set are not over-written unless force is TRUE. -- webb
1674 read_viminfo(file, want_info, want_marks, forceit)
1675 char_u *file;
1676 int want_info;
1677 int want_marks;
1678 int forceit;
1680 FILE *fp;
1681 char_u *fname;
1683 if (no_viminfo())
1684 return FAIL;
1686 fname = viminfo_filename(file); /* may set to default if NULL */
1687 if (fname == NULL)
1688 return FAIL;
1689 fp = mch_fopen((char *)fname, READBIN);
1691 if (p_verbose > 0)
1693 verbose_enter();
1694 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1695 fname,
1696 want_info ? _(" info") : "",
1697 want_marks ? _(" marks") : "",
1698 fp == NULL ? _(" FAILED") : "");
1699 verbose_leave();
1702 vim_free(fname);
1703 if (fp == NULL)
1704 return FAIL;
1706 viminfo_errcnt = 0;
1707 do_viminfo(fp, NULL, want_info, want_marks, forceit);
1709 fclose(fp);
1711 return OK;
1715 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1716 * that effectively a merge of current info and old info is done. This allows
1717 * multiple vims to run simultaneously, without losing any marks etc. If
1718 * forceit is TRUE, then the old file is not read in, and only internal info is
1719 * written to the file. -- webb
1721 void
1722 write_viminfo(file, forceit)
1723 char_u *file;
1724 int forceit;
1726 char_u *fname;
1727 FILE *fp_in = NULL; /* input viminfo file, if any */
1728 FILE *fp_out = NULL; /* output viminfo file */
1729 char_u *tempname = NULL; /* name of temp viminfo file */
1730 struct stat st_new; /* mch_stat() of potential new file */
1731 char_u *wp;
1732 #if defined(UNIX) || defined(VMS)
1733 mode_t umask_save;
1734 #endif
1735 #ifdef UNIX
1736 int shortname = FALSE; /* use 8.3 file name */
1737 struct stat st_old; /* mch_stat() of existing viminfo file */
1738 #endif
1739 #ifdef WIN3264
1740 long perm = -1;
1741 #endif
1743 if (no_viminfo())
1744 return;
1746 fname = viminfo_filename(file); /* may set to default if NULL */
1747 if (fname == NULL)
1748 return;
1750 fp_in = mch_fopen((char *)fname, READBIN);
1751 if (fp_in == NULL)
1753 /* if it does exist, but we can't read it, don't try writing */
1754 if (mch_stat((char *)fname, &st_new) == 0)
1755 goto end;
1756 #if defined(UNIX) || defined(VMS)
1758 * For Unix we create the .viminfo non-accessible for others,
1759 * because it may contain text from non-accessible documents.
1761 umask_save = umask(077);
1762 #endif
1763 fp_out = mch_fopen((char *)fname, WRITEBIN);
1764 #if defined(UNIX) || defined(VMS)
1765 (void)umask(umask_save);
1766 #endif
1768 else
1771 * There is an existing viminfo file. Create a temporary file to
1772 * write the new viminfo into, in the same directory as the
1773 * existing viminfo file, which will be renamed later.
1775 #ifdef UNIX
1777 * For Unix we check the owner of the file. It's not very nice to
1778 * overwrite a user's viminfo file after a "su root", with a
1779 * viminfo file that the user can't read.
1781 st_old.st_dev = 0;
1782 st_old.st_ino = 0;
1783 st_old.st_mode = 0600;
1784 if (mch_stat((char *)fname, &st_old) == 0
1785 && getuid() != ROOT_UID
1786 && !(st_old.st_uid == getuid()
1787 ? (st_old.st_mode & 0200)
1788 : (st_old.st_gid == getgid()
1789 ? (st_old.st_mode & 0020)
1790 : (st_old.st_mode & 0002))))
1792 int tt = msg_didany;
1794 /* avoid a wait_return for this message, it's annoying */
1795 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1796 msg_didany = tt;
1797 fclose(fp_in);
1798 goto end;
1800 #endif
1801 #ifdef WIN3264
1802 /* Get the file attributes of the existing viminfo file. */
1803 perm = mch_getperm(fname);
1804 #endif
1807 * Make tempname.
1808 * May try twice: Once normal and once with shortname set, just in
1809 * case somebody puts his viminfo file in an 8.3 filesystem.
1811 for (;;)
1813 tempname = buf_modname(
1814 #ifdef UNIX
1815 shortname,
1816 #else
1817 # ifdef SHORT_FNAME
1818 TRUE,
1819 # else
1820 # ifdef FEAT_GUI_W32
1821 gui_is_win32s(),
1822 # else
1823 FALSE,
1824 # endif
1825 # endif
1826 #endif
1827 fname,
1828 #ifdef VMS
1829 (char_u *)"-tmp",
1830 #else
1831 # ifdef RISCOS
1832 (char_u *)"/tmp",
1833 # else
1834 (char_u *)".tmp",
1835 # endif
1836 #endif
1837 FALSE);
1838 if (tempname == NULL) /* out of memory */
1839 break;
1842 * Check if tempfile already exists. Never overwrite an
1843 * existing file!
1845 if (mch_stat((char *)tempname, &st_new) == 0)
1847 #ifdef UNIX
1849 * Check if tempfile is same as original file. May happen
1850 * when modname() gave the same file back. E.g. silly
1851 * link, or file name-length reached. Try again with
1852 * shortname set.
1854 if (!shortname && st_new.st_dev == st_old.st_dev
1855 && st_new.st_ino == st_old.st_ino)
1857 vim_free(tempname);
1858 tempname = NULL;
1859 shortname = TRUE;
1860 continue;
1862 #endif
1864 * Try another name. Change one character, just before
1865 * the extension. This should also work for an 8.3
1866 * file name, when after adding the extension it still is
1867 * the same file as the original.
1869 wp = tempname + STRLEN(tempname) - 5;
1870 if (wp < gettail(tempname)) /* empty file name? */
1871 wp = gettail(tempname);
1872 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1873 --*wp)
1876 * They all exist? Must be something wrong! Don't
1877 * write the viminfo file then.
1879 if (*wp == 'a')
1881 vim_free(tempname);
1882 tempname = NULL;
1883 break;
1887 break;
1890 if (tempname != NULL)
1892 #ifdef VMS
1893 /* fdopen() fails for some reason */
1894 umask_save = umask(077);
1895 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1896 (void)umask(umask_save);
1897 #else
1898 int fd;
1900 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1901 * protection:
1902 * Unix: same as original file, but strip s-bit. Reset umask to
1903 * avoid it getting in the way.
1904 * Others: r&w for user only. */
1905 # ifdef UNIX
1906 umask_save = umask(0);
1907 fd = mch_open((char *)tempname,
1908 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1909 (int)((st_old.st_mode & 0777) | 0600));
1910 (void)umask(umask_save);
1911 # else
1912 fd = mch_open((char *)tempname,
1913 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1914 # endif
1915 if (fd < 0)
1916 fp_out = NULL;
1917 else
1918 fp_out = fdopen(fd, WRITEBIN);
1919 #endif /* VMS */
1922 * If we can't create in the same directory, try creating a
1923 * "normal" temp file.
1925 if (fp_out == NULL)
1927 vim_free(tempname);
1928 if ((tempname = vim_tempname('o')) != NULL)
1929 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1932 #if defined(UNIX) && defined(HAVE_FCHOWN)
1934 * Make sure the owner can read/write it. This only works for
1935 * root.
1937 if (fp_out != NULL)
1938 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1939 #endif
1944 * Check if the new viminfo file can be written to.
1946 if (fp_out == NULL)
1948 EMSG2(_("E138: Can't write viminfo file %s!"),
1949 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1950 if (fp_in != NULL)
1951 fclose(fp_in);
1952 goto end;
1955 if (p_verbose > 0)
1957 verbose_enter();
1958 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1959 verbose_leave();
1962 viminfo_errcnt = 0;
1963 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1965 fclose(fp_out); /* errors are ignored !? */
1966 if (fp_in != NULL)
1968 fclose(fp_in);
1971 * In case of an error keep the original viminfo file.
1972 * Otherwise rename the newly written file.
1974 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1975 mch_remove(tempname);
1977 #ifdef WIN3264
1978 /* If the viminfo file was hidden then also hide the new file. */
1979 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1980 mch_hide(fname);
1981 #endif
1984 end:
1985 vim_free(fname);
1986 vim_free(tempname);
1990 * Get the viminfo file name to use.
1991 * If "file" is given and not empty, use it (has already been expanded by
1992 * cmdline functions).
1993 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1994 * expand environment variables.
1995 * Returns an allocated string. NULL when out of memory.
1997 static char_u *
1998 viminfo_filename(file)
1999 char_u *file;
2001 if (file == NULL || *file == NUL)
2003 if (use_viminfo != NULL)
2004 file = use_viminfo;
2005 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2007 #ifdef VIMINFO_FILE2
2008 /* don't use $HOME when not defined (turned into "c:/"!). */
2009 # ifdef VMS
2010 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2011 # else
2012 if (mch_getenv((char_u *)"HOME") == NULL)
2013 # endif
2015 /* don't use $VIM when not available. */
2016 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2017 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2018 file = (char_u *)VIMINFO_FILE2;
2019 else
2020 file = (char_u *)VIMINFO_FILE;
2022 else
2023 #endif
2024 file = (char_u *)VIMINFO_FILE;
2026 expand_env(file, NameBuff, MAXPATHL);
2027 file = NameBuff;
2029 return vim_strsave(file);
2033 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2035 static void
2036 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2037 FILE *fp_in;
2038 FILE *fp_out;
2039 int want_info;
2040 int want_marks;
2041 int force_read;
2043 int count = 0;
2044 int eof = FALSE;
2045 vir_T vir;
2047 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2048 return;
2049 vir.vir_fd = fp_in;
2050 #ifdef FEAT_MBYTE
2051 vir.vir_conv.vc_type = CONV_NONE;
2052 #endif
2054 if (fp_in != NULL)
2056 if (want_info)
2057 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2058 else
2059 /* Skip info, find start of marks */
2060 while (!(eof = viminfo_readline(&vir))
2061 && vir.vir_line[0] != '>')
2064 if (fp_out != NULL)
2066 /* Write the info: */
2067 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2068 VIM_VERSION_MEDIUM);
2069 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2070 #ifdef FEAT_MBYTE
2071 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2072 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2073 #endif
2074 write_viminfo_search_pattern(fp_out);
2075 write_viminfo_sub_string(fp_out);
2076 #ifdef FEAT_CMDHIST
2077 write_viminfo_history(fp_out);
2078 #endif
2079 write_viminfo_registers(fp_out);
2080 #ifdef FEAT_EVAL
2081 write_viminfo_varlist(fp_out);
2082 #endif
2083 write_viminfo_filemarks(fp_out);
2084 write_viminfo_bufferlist(fp_out);
2085 count = write_viminfo_marks(fp_out);
2087 if (fp_in != NULL && want_marks)
2088 copy_viminfo_marks(&vir, fp_out, count, eof);
2090 vim_free(vir.vir_line);
2091 #ifdef FEAT_MBYTE
2092 if (vir.vir_conv.vc_type != CONV_NONE)
2093 convert_setup(&vir.vir_conv, NULL, NULL);
2094 #endif
2098 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2099 * first part of the viminfo file which contains everything but the marks that
2100 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2102 static int
2103 read_viminfo_up_to_marks(virp, forceit, writing)
2104 vir_T *virp;
2105 int forceit;
2106 int writing;
2108 int eof;
2109 buf_T *buf;
2111 #ifdef FEAT_CMDHIST
2112 prepare_viminfo_history(forceit ? 9999 : 0);
2113 #endif
2114 eof = viminfo_readline(virp);
2115 while (!eof && virp->vir_line[0] != '>')
2117 switch (virp->vir_line[0])
2119 /* Characters reserved for future expansion, ignored now */
2120 case '+': /* "+40 /path/dir file", for running vim without args */
2121 case '|': /* to be defined */
2122 case '^': /* to be defined */
2123 case '<': /* long line - ignored */
2124 /* A comment or empty line. */
2125 case NUL:
2126 case '\r':
2127 case '\n':
2128 case '#':
2129 eof = viminfo_readline(virp);
2130 break;
2131 case '*': /* "*encoding=value" */
2132 eof = viminfo_encoding(virp);
2133 break;
2134 case '!': /* global variable */
2135 #ifdef FEAT_EVAL
2136 eof = read_viminfo_varlist(virp, writing);
2137 #else
2138 eof = viminfo_readline(virp);
2139 #endif
2140 break;
2141 case '%': /* entry for buffer list */
2142 eof = read_viminfo_bufferlist(virp, writing);
2143 break;
2144 case '"':
2145 eof = read_viminfo_register(virp, forceit);
2146 break;
2147 case '/': /* Search string */
2148 case '&': /* Substitute search string */
2149 case '~': /* Last search string, followed by '/' or '&' */
2150 eof = read_viminfo_search_pattern(virp, forceit);
2151 break;
2152 case '$':
2153 eof = read_viminfo_sub_string(virp, forceit);
2154 break;
2155 case ':':
2156 case '?':
2157 case '=':
2158 case '@':
2159 #ifdef FEAT_CMDHIST
2160 eof = read_viminfo_history(virp);
2161 #else
2162 eof = viminfo_readline(virp);
2163 #endif
2164 break;
2165 case '-':
2166 case '\'':
2167 eof = read_viminfo_filemark(virp, forceit);
2168 break;
2169 default:
2170 if (viminfo_error("E575: ", _("Illegal starting char"),
2171 virp->vir_line))
2172 eof = TRUE;
2173 else
2174 eof = viminfo_readline(virp);
2175 break;
2179 #ifdef FEAT_CMDHIST
2180 /* Finish reading history items. */
2181 finish_viminfo_history();
2182 #endif
2184 /* Change file names to buffer numbers for fmarks. */
2185 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2186 fmarks_check_names(buf);
2188 return eof;
2192 * Compare the 'encoding' value in the viminfo file with the current value of
2193 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2194 * conversion of text with iconv() in viminfo_readstring().
2196 static int
2197 viminfo_encoding(virp)
2198 vir_T *virp;
2200 #ifdef FEAT_MBYTE
2201 char_u *p;
2202 int i;
2204 if (get_viminfo_parameter('c') != 0)
2206 p = vim_strchr(virp->vir_line, '=');
2207 if (p != NULL)
2209 /* remove trailing newline */
2210 ++p;
2211 for (i = 0; vim_isprintc(p[i]); ++i)
2213 p[i] = NUL;
2215 convert_setup(&virp->vir_conv, p, p_enc);
2218 #endif
2219 return viminfo_readline(virp);
2223 * Read a line from the viminfo file.
2224 * Returns TRUE for end-of-file;
2227 viminfo_readline(virp)
2228 vir_T *virp;
2230 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2234 * check string read from viminfo file
2235 * remove '\n' at the end of the line
2236 * - replace CTRL-V CTRL-V with CTRL-V
2237 * - replace CTRL-V 'n' with '\n'
2239 * Check for a long line as written by viminfo_writestring().
2241 * Return the string in allocated memory (NULL when out of memory).
2243 /*ARGSUSED*/
2244 char_u *
2245 viminfo_readstring(virp, off, convert)
2246 vir_T *virp;
2247 int off; /* offset for virp->vir_line */
2248 int convert; /* convert the string */
2250 char_u *retval;
2251 char_u *s, *d;
2252 long len;
2254 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2256 len = atol((char *)virp->vir_line + off + 1);
2257 retval = lalloc(len, TRUE);
2258 if (retval == NULL)
2260 /* Line too long? File messed up? Skip next line. */
2261 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2262 return NULL;
2264 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2265 s = retval + 1; /* Skip the leading '<' */
2267 else
2269 retval = vim_strsave(virp->vir_line + off);
2270 if (retval == NULL)
2271 return NULL;
2272 s = retval;
2275 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2276 d = retval;
2277 while (*s != NUL && *s != '\n')
2279 if (s[0] == Ctrl_V && s[1] != NUL)
2281 if (s[1] == 'n')
2282 *d++ = '\n';
2283 else
2284 *d++ = Ctrl_V;
2285 s += 2;
2287 else
2288 *d++ = *s++;
2290 *d = NUL;
2292 #ifdef FEAT_MBYTE
2293 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2295 d = string_convert(&virp->vir_conv, retval, NULL);
2296 if (d != NULL)
2298 vim_free(retval);
2299 retval = d;
2302 #endif
2304 return retval;
2308 * write string to viminfo file
2309 * - replace CTRL-V with CTRL-V CTRL-V
2310 * - replace '\n' with CTRL-V 'n'
2311 * - add a '\n' at the end
2313 * For a long line:
2314 * - write " CTRL-V <length> \n " in first line
2315 * - write " < <string> \n " in second line
2317 void
2318 viminfo_writestring(fd, p)
2319 FILE *fd;
2320 char_u *p;
2322 int c;
2323 char_u *s;
2324 int len = 0;
2326 for (s = p; *s != NUL; ++s)
2328 if (*s == Ctrl_V || *s == '\n')
2329 ++len;
2330 ++len;
2333 /* If the string will be too long, write its length and put it in the next
2334 * line. Take into account that some room is needed for what comes before
2335 * the string (e.g., variable name). Add something to the length for the
2336 * '<', NL and trailing NUL. */
2337 if (len > LSIZE / 2)
2338 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2340 while ((c = *p++) != NUL)
2342 if (c == Ctrl_V || c == '\n')
2344 putc(Ctrl_V, fd);
2345 if (c == '\n')
2346 c = 'n';
2348 putc(c, fd);
2350 putc('\n', fd);
2352 #endif /* FEAT_VIMINFO */
2355 * Implementation of ":fixdel", also used by get_stty().
2356 * <BS> resulting <Del>
2357 * ^? ^H
2358 * not ^? ^?
2360 /*ARGSUSED*/
2361 void
2362 do_fixdel(eap)
2363 exarg_T *eap;
2365 char_u *p;
2367 p = find_termcode((char_u *)"kb");
2368 add_termcode((char_u *)"kD", p != NULL
2369 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2372 void
2373 print_line_no_prefix(lnum, use_number, list)
2374 linenr_T lnum;
2375 int use_number;
2376 int list;
2378 char_u numbuf[30];
2380 if (curwin->w_p_nu || use_number)
2382 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2383 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2385 msg_prt_line(ml_get(lnum), list);
2389 * Print a text line. Also in silent mode ("ex -s").
2391 void
2392 print_line(lnum, use_number, list)
2393 linenr_T lnum;
2394 int use_number;
2395 int list;
2397 int save_silent = silent_mode;
2399 msg_start();
2400 silent_mode = FALSE;
2401 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2402 print_line_no_prefix(lnum, use_number, list);
2403 if (save_silent)
2405 msg_putchar('\n');
2406 cursor_on(); /* msg_start() switches it off */
2407 out_flush();
2408 silent_mode = save_silent;
2409 info_message = FALSE;
2414 * ":file[!] [fname]".
2416 void
2417 ex_file(eap)
2418 exarg_T *eap;
2420 char_u *fname, *sfname, *xfname;
2421 buf_T *buf;
2423 /* ":0file" removes the file name. Check for illegal uses ":3file",
2424 * "0file name", etc. */
2425 if (eap->addr_count > 0
2426 && (*eap->arg != NUL
2427 || eap->line2 > 0
2428 || eap->addr_count > 1))
2430 EMSG(_(e_invarg));
2431 return;
2434 if (*eap->arg != NUL || eap->addr_count == 1)
2436 #ifdef FEAT_AUTOCMD
2437 buf = curbuf;
2438 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2439 /* buffer changed, don't change name now */
2440 if (buf != curbuf)
2441 return;
2442 # ifdef FEAT_EVAL
2443 if (aborting()) /* autocmds may abort script processing */
2444 return;
2445 # endif
2446 #endif
2448 * The name of the current buffer will be changed.
2449 * A new (unlisted) buffer entry needs to be made to hold the old file
2450 * name, which will become the alternate file name.
2451 * But don't set the alternate file name if the buffer didn't have a
2452 * name.
2454 fname = curbuf->b_ffname;
2455 sfname = curbuf->b_sfname;
2456 xfname = curbuf->b_fname;
2457 curbuf->b_ffname = NULL;
2458 curbuf->b_sfname = NULL;
2459 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2461 curbuf->b_ffname = fname;
2462 curbuf->b_sfname = sfname;
2463 return;
2465 curbuf->b_flags |= BF_NOTEDITED;
2466 if (xfname != NULL && *xfname != NUL)
2468 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2469 if (buf != NULL && !cmdmod.keepalt)
2470 curwin->w_alt_fnum = buf->b_fnum;
2472 vim_free(fname);
2473 vim_free(sfname);
2474 #ifdef FEAT_AUTOCMD
2475 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2476 #endif
2477 /* Change directories when the 'acd' option is set. */
2478 DO_AUTOCHDIR
2480 /* print full file name if :cd used */
2481 fileinfo(FALSE, FALSE, eap->forceit);
2485 * ":update".
2487 void
2488 ex_update(eap)
2489 exarg_T *eap;
2491 if (curbufIsChanged())
2492 (void)do_write(eap);
2496 * ":write" and ":saveas".
2498 void
2499 ex_write(eap)
2500 exarg_T *eap;
2502 if (eap->usefilter) /* input lines to shell command */
2503 do_bang(1, eap, FALSE, TRUE, FALSE);
2504 else
2505 (void)do_write(eap);
2509 * write current buffer to file 'eap->arg'
2510 * if 'eap->append' is TRUE, append to the file
2512 * if *eap->arg == NUL write to current file
2514 * return FAIL for failure, OK otherwise
2517 do_write(eap)
2518 exarg_T *eap;
2520 int other;
2521 char_u *fname = NULL; /* init to shut up gcc */
2522 char_u *ffname;
2523 int retval = FAIL;
2524 char_u *free_fname = NULL;
2525 #ifdef FEAT_BROWSE
2526 char_u *browse_file = NULL;
2527 #endif
2528 buf_T *alt_buf = NULL;
2530 if (not_writing()) /* check 'write' option */
2531 return FAIL;
2533 ffname = eap->arg;
2534 #ifdef FEAT_BROWSE
2535 if (cmdmod.browse)
2537 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2538 NULL, NULL, NULL, curbuf);
2539 if (browse_file == NULL)
2540 goto theend;
2541 ffname = browse_file;
2543 #endif
2544 if (*ffname == NUL)
2546 if (eap->cmdidx == CMD_saveas)
2548 EMSG(_(e_argreq));
2549 goto theend;
2551 other = FALSE;
2553 else
2555 fname = ffname;
2556 free_fname = fix_fname(ffname);
2558 * When out-of-memory, keep unexpanded file name, because we MUST be
2559 * able to write the file in this situation.
2561 if (free_fname != NULL)
2562 ffname = free_fname;
2563 other = otherfile(ffname);
2567 * If we have a new file, put its name in the list of alternate file names.
2569 if (other)
2571 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2572 || eap->cmdidx == CMD_saveas)
2573 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2574 else
2575 alt_buf = buflist_findname(ffname);
2576 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2578 /* Overwriting a file that is loaded in another buffer is not a
2579 * good idea. */
2580 EMSG(_(e_bufloaded));
2581 goto theend;
2586 * Writing to the current file is not allowed in readonly mode
2587 * and a file name is required.
2588 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2590 if (!other && (
2591 #ifdef FEAT_QUICKFIX
2592 bt_dontwrite_msg(curbuf) ||
2593 #endif
2594 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2595 goto theend;
2597 if (!other)
2599 ffname = curbuf->b_ffname;
2600 fname = curbuf->b_fname;
2602 * Not writing the whole file is only allowed with '!'.
2604 if ( (eap->line1 != 1
2605 || eap->line2 != curbuf->b_ml.ml_line_count)
2606 && !eap->forceit
2607 && !eap->append
2608 && !p_wa)
2610 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2611 if (p_confirm || cmdmod.confirm)
2613 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2614 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2615 goto theend;
2616 eap->forceit = TRUE;
2618 else
2619 #endif
2621 EMSG(_("E140: Use ! to write partial buffer"));
2622 goto theend;
2627 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2629 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2631 #ifdef FEAT_AUTOCMD
2632 buf_T *was_curbuf = curbuf;
2634 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2635 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2636 # ifdef FEAT_EVAL
2637 if (curbuf != was_curbuf || aborting())
2638 # else
2639 if (curbuf != was_curbuf)
2640 # endif
2642 /* buffer changed, don't change name now */
2643 retval = FAIL;
2644 goto theend;
2646 #endif
2647 /* Exchange the file names for the current and the alternate
2648 * buffer. This makes it look like we are now editing the buffer
2649 * under the new name. Must be done before buf_write(), because
2650 * if there is no file name and 'cpo' contains 'F', it will set
2651 * the file name. */
2652 fname = alt_buf->b_fname;
2653 alt_buf->b_fname = curbuf->b_fname;
2654 curbuf->b_fname = fname;
2655 fname = alt_buf->b_ffname;
2656 alt_buf->b_ffname = curbuf->b_ffname;
2657 curbuf->b_ffname = fname;
2658 fname = alt_buf->b_sfname;
2659 alt_buf->b_sfname = curbuf->b_sfname;
2660 curbuf->b_sfname = fname;
2661 buf_name_changed(curbuf);
2662 #ifdef FEAT_AUTOCMD
2663 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2664 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2665 if (!alt_buf->b_p_bl)
2667 alt_buf->b_p_bl = TRUE;
2668 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2670 # ifdef FEAT_EVAL
2671 if (curbuf != was_curbuf || aborting())
2672 # else
2673 if (curbuf != was_curbuf)
2674 # endif
2676 /* buffer changed, don't write the file */
2677 retval = FAIL;
2678 goto theend;
2681 /* If 'filetype' was empty try detecting it now. */
2682 if (*curbuf->b_p_ft == NUL)
2684 if (au_has_group((char_u *)"filetypedetect"))
2685 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2686 TRUE);
2687 do_modelines(0);
2689 #endif
2692 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2693 eap, eap->append, eap->forceit, TRUE, FALSE);
2695 /* After ":saveas fname" reset 'readonly'. */
2696 if (eap->cmdidx == CMD_saveas)
2698 if (retval == OK)
2699 curbuf->b_p_ro = FALSE;
2700 /* Change directories when the 'acd' option is set. */
2701 DO_AUTOCHDIR
2705 theend:
2706 #ifdef FEAT_BROWSE
2707 vim_free(browse_file);
2708 #endif
2709 vim_free(free_fname);
2710 return retval;
2714 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2715 * BF_NEW or BF_READERR, check for overwriting current file.
2716 * May set eap->forceit if a dialog says it's OK to overwrite.
2717 * Return OK if it's OK, FAIL if it is not.
2719 /*ARGSUSED*/
2720 static int
2721 check_overwrite(eap, buf, fname, ffname, other)
2722 exarg_T *eap;
2723 buf_T *buf;
2724 char_u *fname; /* file name to be used (can differ from
2725 buf->ffname) */
2726 char_u *ffname; /* full path version of fname */
2727 int other; /* writing under other name */
2730 * write to other file or b_flags set or not writing the whole file:
2731 * overwriting only allowed with '!'
2733 if ( (other
2734 || (buf->b_flags & BF_NOTEDITED)
2735 || ((buf->b_flags & BF_NEW)
2736 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2737 || (buf->b_flags & BF_READERR))
2738 && !p_wa
2739 #ifdef FEAT_QUICKFIX
2740 && !bt_nofile(buf)
2741 #endif
2742 && vim_fexists(ffname))
2744 if (!eap->forceit && !eap->append)
2746 #ifdef UNIX
2747 /* with UNIX it is possible to open a directory */
2748 if (mch_isdir(ffname))
2750 EMSG2(_(e_isadir2), ffname);
2751 return FAIL;
2753 #endif
2754 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2755 if (p_confirm || cmdmod.confirm)
2757 char_u buff[IOSIZE];
2759 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2760 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2761 return FAIL;
2762 eap->forceit = TRUE;
2764 else
2765 #endif
2767 EMSG(_(e_exists));
2768 return FAIL;
2772 /* For ":w! filename" check that no swap file exists for "filename". */
2773 if (other && !emsg_silent)
2775 char_u dir[MAXPATHL];
2776 char_u *p;
2777 int r;
2778 char_u *swapname;
2780 /* We only try the first entry in 'directory', without checking if
2781 * it's writable. If the "." directory is not writable the write
2782 * will probably fail anyway.
2783 * Use 'shortname' of the current buffer, since there is no buffer
2784 * for the written file. */
2785 if (*p_dir == NUL)
2786 STRCPY(dir, ".");
2787 else
2789 p = p_dir;
2790 copy_option_part(&p, dir, MAXPATHL, ",");
2792 swapname = makeswapname(fname, ffname, curbuf, dir);
2793 r = vim_fexists(swapname);
2794 if (r)
2796 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2797 if (p_confirm || cmdmod.confirm)
2799 char_u buff[IOSIZE];
2801 dialog_msg(buff,
2802 _("Swap file \"%s\" exists, overwrite anyway?"),
2803 swapname);
2804 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2805 != VIM_YES)
2807 vim_free(swapname);
2808 return FAIL;
2810 eap->forceit = TRUE;
2812 else
2813 #endif
2815 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2816 swapname);
2817 vim_free(swapname);
2818 return FAIL;
2821 vim_free(swapname);
2824 return OK;
2828 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2830 void
2831 ex_wnext(eap)
2832 exarg_T *eap;
2834 int i;
2836 if (eap->cmd[1] == 'n')
2837 i = curwin->w_arg_idx + (int)eap->line2;
2838 else
2839 i = curwin->w_arg_idx - (int)eap->line2;
2840 eap->line1 = 1;
2841 eap->line2 = curbuf->b_ml.ml_line_count;
2842 if (do_write(eap) != FAIL)
2843 do_argfile(eap, i);
2847 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2849 void
2850 do_wqall(eap)
2851 exarg_T *eap;
2853 buf_T *buf;
2854 int error = 0;
2855 int save_forceit = eap->forceit;
2857 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2858 exiting = TRUE;
2860 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2862 if (bufIsChanged(buf))
2865 * Check if there is a reason the buffer cannot be written:
2866 * 1. if the 'write' option is set
2867 * 2. if there is no file name (even after browsing)
2868 * 3. if the 'readonly' is set (even after a dialog)
2869 * 4. if overwriting is allowed (even after a dialog)
2871 if (not_writing())
2873 ++error;
2874 break;
2876 #ifdef FEAT_BROWSE
2877 /* ":browse wall": ask for file name if there isn't one */
2878 if (buf->b_ffname == NULL && cmdmod.browse)
2879 browse_save_fname(buf);
2880 #endif
2881 if (buf->b_ffname == NULL)
2883 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2884 ++error;
2886 else if (check_readonly(&eap->forceit, buf)
2887 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2888 FALSE) == FAIL)
2890 ++error;
2892 else
2894 if (buf_write_all(buf, eap->forceit) == FAIL)
2895 ++error;
2896 #ifdef FEAT_AUTOCMD
2897 /* an autocommand may have deleted the buffer */
2898 if (!buf_valid(buf))
2899 buf = firstbuf;
2900 #endif
2902 eap->forceit = save_forceit; /* check_overwrite() may set it */
2905 if (exiting)
2907 if (!error)
2908 getout(0); /* exit Vim */
2909 not_exiting();
2914 * Check the 'write' option.
2915 * Return TRUE and give a message when it's not st.
2918 not_writing()
2920 if (p_write)
2921 return FALSE;
2922 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2923 return TRUE;
2927 * Check if a buffer is read-only (either 'readonly' option is set or file is
2928 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2929 * message when the buffer is readonly.
2931 static int
2932 check_readonly(forceit, buf)
2933 int *forceit;
2934 buf_T *buf;
2936 struct stat st;
2938 /* Handle a file being readonly when the 'readonly' option is set or when
2939 * the file exists and permissions are read-only.
2940 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2941 * important for device checks but not here. */
2942 if (!*forceit && (buf->b_p_ro
2943 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2944 && check_file_readonly(buf->b_ffname, 0777))))
2946 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2947 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2949 char_u buff[IOSIZE];
2951 if (buf->b_p_ro)
2952 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2953 buf->b_fname);
2954 else
2955 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2956 buf->b_fname);
2958 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2960 /* Set forceit, to force the writing of a readonly file */
2961 *forceit = TRUE;
2962 return FALSE;
2964 else
2965 return TRUE;
2967 else
2968 #endif
2969 if (buf->b_p_ro)
2970 EMSG(_(e_readonly));
2971 else
2972 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2973 buf->b_fname);
2974 return TRUE;
2977 return FALSE;
2981 * Try to abandon current file and edit a new or existing file.
2982 * 'fnum' is the number of the file, if zero use ffname/sfname.
2984 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2985 * -1 for successfully opening another file.
2986 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2989 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2990 int fnum;
2991 char_u *ffname;
2992 char_u *sfname;
2993 int setpm;
2994 linenr_T lnum;
2995 int forceit;
2997 int other;
2998 int retval;
2999 char_u *free_me = NULL;
3001 if (text_locked())
3002 return 1;
3003 #ifdef FEAT_AUTOCMD
3004 if (curbuf_locked())
3005 return 1;
3006 #endif
3008 if (fnum == 0)
3010 /* make ffname full path, set sfname */
3011 fname_expand(curbuf, &ffname, &sfname);
3012 other = otherfile(ffname);
3013 free_me = ffname; /* has been allocated, free() later */
3015 else
3016 other = (fnum != curbuf->b_fnum);
3018 if (other)
3019 ++no_wait_return; /* don't wait for autowrite message */
3020 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3021 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3023 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3024 if (p_confirm && p_write)
3025 dialog_changed(curbuf, FALSE);
3026 if (curbufIsChanged())
3027 #endif
3029 if (other)
3030 --no_wait_return;
3031 EMSG(_(e_nowrtmsg));
3032 retval = 2; /* file has been changed */
3033 goto theend;
3036 if (other)
3037 --no_wait_return;
3038 if (setpm)
3039 setpcmark();
3040 if (!other)
3042 if (lnum != 0)
3043 curwin->w_cursor.lnum = lnum;
3044 check_cursor_lnum();
3045 beginline(BL_SOL | BL_FIX);
3046 retval = 0; /* it's in the same file */
3048 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3049 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3050 retval = -1; /* opened another file */
3051 else
3052 retval = 1; /* error encountered */
3054 theend:
3055 vim_free(free_me);
3056 return retval;
3060 * start editing a new file
3062 * fnum: file number; if zero use ffname/sfname
3063 * ffname: the file name
3064 * - full path if sfname used,
3065 * - any file name if sfname is NULL
3066 * - empty string to re-edit with the same file name (but may be
3067 * in a different directory)
3068 * - NULL to start an empty buffer
3069 * sfname: the short file name (or NULL)
3070 * eap: contains the command to be executed after loading the file and
3071 * forced 'ff' and 'fenc'
3072 * newlnum: if > 0: put cursor on this line number (if possible)
3073 * if ECMD_LASTL: use last position in loaded file
3074 * if ECMD_LAST: use last position in all files
3075 * if ECMD_ONE: use first line
3076 * flags:
3077 * ECMD_HIDE: if TRUE don't free the current buffer
3078 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3079 * ECMD_OLDBUF: use existing buffer if it exists
3080 * ECMD_FORCEIT: ! used for Ex command
3081 * ECMD_ADDBUF: don't edit, just add to buffer list
3083 * return FAIL for failure, OK otherwise
3086 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3087 int fnum;
3088 char_u *ffname;
3089 char_u *sfname;
3090 exarg_T *eap; /* can be NULL! */
3091 linenr_T newlnum;
3092 int flags;
3094 int other_file; /* TRUE if editing another file */
3095 int oldbuf; /* TRUE if using existing buffer */
3096 #ifdef FEAT_AUTOCMD
3097 int auto_buf = FALSE; /* TRUE if autocommands brought us
3098 into the buffer unexpectedly */
3099 char_u *new_name = NULL;
3100 int did_set_swapcommand = FALSE;
3101 #endif
3102 buf_T *buf;
3103 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3104 buf_T *old_curbuf = curbuf;
3105 #endif
3106 char_u *free_fname = NULL;
3107 #ifdef FEAT_BROWSE
3108 char_u *browse_file = NULL;
3109 #endif
3110 int retval = FAIL;
3111 long n;
3112 linenr_T lnum;
3113 linenr_T topline = 0;
3114 int newcol = -1;
3115 int solcol = -1;
3116 pos_T *pos;
3117 #ifdef FEAT_SUN_WORKSHOP
3118 char_u *cp;
3119 #endif
3120 char_u *command = NULL;
3121 #ifdef FEAT_SPELL
3122 int did_get_winopts = FALSE;
3123 #endif
3125 if (eap != NULL)
3126 command = eap->do_ecmd_cmd;
3128 if (fnum != 0)
3130 if (fnum == curbuf->b_fnum) /* file is already being edited */
3131 return OK; /* nothing to do */
3132 other_file = TRUE;
3134 else
3136 #ifdef FEAT_BROWSE
3137 if (cmdmod.browse)
3139 if (
3140 # ifdef FEAT_GUI
3141 !gui.in_use &&
3142 # endif
3143 au_has_group((char_u *)"FileExplorer"))
3145 /* No browsing supported but we do have the file explorer:
3146 * Edit the directory. */
3147 if (ffname == NULL || !mch_isdir(ffname))
3148 ffname = (char_u *)".";
3150 else
3152 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3153 NULL, NULL, NULL, curbuf);
3154 if (browse_file == NULL)
3155 goto theend;
3156 ffname = browse_file;
3159 #endif
3160 /* if no short name given, use ffname for short name */
3161 if (sfname == NULL)
3162 sfname = ffname;
3163 #ifdef USE_FNAME_CASE
3164 # ifdef USE_LONG_FNAME
3165 if (USE_LONG_FNAME)
3166 # endif
3167 if (sfname != NULL)
3168 fname_case(sfname, 0); /* set correct case for sfname */
3169 #endif
3171 #ifdef FEAT_LISTCMDS
3172 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3173 goto theend;
3174 #endif
3176 if (ffname == NULL)
3177 other_file = TRUE;
3178 /* there is no file name */
3179 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3180 other_file = FALSE;
3181 else
3183 if (*ffname == NUL) /* re-edit with same file name */
3185 ffname = curbuf->b_ffname;
3186 sfname = curbuf->b_fname;
3188 free_fname = fix_fname(ffname); /* may expand to full path name */
3189 if (free_fname != NULL)
3190 ffname = free_fname;
3191 other_file = otherfile(ffname);
3192 #ifdef FEAT_SUN_WORKSHOP
3193 if (usingSunWorkShop && p_acd
3194 && (cp = vim_strrchr(sfname, '/')) != NULL)
3195 sfname = ++cp;
3196 #endif
3201 * if the file was changed we may not be allowed to abandon it
3202 * - if we are going to re-edit the same file
3203 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3205 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3206 || (curbuf->b_nwindows == 1
3207 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3208 && check_changed(curbuf, p_awa, !other_file,
3209 (flags & ECMD_FORCEIT), FALSE))
3211 if (fnum == 0 && other_file && ffname != NULL)
3212 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3213 goto theend;
3216 #ifdef FEAT_VISUAL
3218 * End Visual mode before switching to another buffer, so the text can be
3219 * copied into the GUI selection buffer.
3221 reset_VIsual();
3222 #endif
3224 #ifdef FEAT_AUTOCMD
3225 if ((command != NULL || newlnum > (linenr_T)0)
3226 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3228 int len;
3229 char_u *p;
3231 /* Set v:swapcommand for the SwapExists autocommands. */
3232 if (command != NULL)
3233 len = (int)STRLEN(command) + 3;
3234 else
3235 len = 30;
3236 p = alloc((unsigned)len);
3237 if (p != NULL)
3239 if (command != NULL)
3240 vim_snprintf((char *)p, len, ":%s\r", command);
3241 else
3242 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3243 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3244 did_set_swapcommand = TRUE;
3245 vim_free(p);
3248 #endif
3251 * If we are starting to edit another file, open a (new) buffer.
3252 * Otherwise we re-use the current buffer.
3254 if (other_file)
3256 #ifdef FEAT_LISTCMDS
3257 if (!(flags & ECMD_ADDBUF))
3258 #endif
3260 if (!cmdmod.keepalt)
3261 curwin->w_alt_fnum = curbuf->b_fnum;
3262 buflist_altfpos();
3265 if (fnum)
3266 buf = buflist_findnr(fnum);
3267 else
3269 #ifdef FEAT_LISTCMDS
3270 if (flags & ECMD_ADDBUF)
3272 linenr_T tlnum = 1L;
3274 if (command != NULL)
3276 tlnum = atol((char *)command);
3277 if (tlnum <= 0)
3278 tlnum = 1L;
3280 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3281 goto theend;
3283 #endif
3284 buf = buflist_new(ffname, sfname, 0L,
3285 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3287 if (buf == NULL)
3288 goto theend;
3289 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3291 oldbuf = FALSE;
3292 buf->b_nwindows = 0;
3294 else /* existing memfile */
3296 oldbuf = TRUE;
3297 (void)buf_check_timestamp(buf, FALSE);
3298 /* Check if autocommands made buffer invalid or changed the current
3299 * buffer. */
3300 if (!buf_valid(buf)
3301 #ifdef FEAT_AUTOCMD
3302 || curbuf != old_curbuf
3303 #endif
3305 goto theend;
3306 #ifdef FEAT_EVAL
3307 if (aborting()) /* autocmds may abort script processing */
3308 goto theend;
3309 #endif
3312 /* May jump to last used line number for a loaded buffer or when asked
3313 * for explicitly */
3314 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3316 pos = buflist_findfpos(buf);
3317 newlnum = pos->lnum;
3318 solcol = pos->col;
3322 * Make the (new) buffer the one used by the current window.
3323 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3324 * If the current buffer was empty and has no file name, curbuf
3325 * is returned by buflist_new().
3327 if (buf != curbuf)
3329 #ifdef FEAT_AUTOCMD
3331 * Be careful: The autocommands may delete any buffer and change
3332 * the current buffer.
3333 * - If the buffer we are going to edit is deleted, give up.
3334 * - If the current buffer is deleted, prefer to load the new
3335 * buffer when loading a buffer is required. This avoids
3336 * loading another buffer which then must be closed again.
3337 * - If we ended up in the new buffer already, need to skip a few
3338 * things, set auto_buf.
3340 if (buf->b_fname != NULL)
3341 new_name = vim_strsave(buf->b_fname);
3342 au_new_curbuf = buf;
3343 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3344 if (!buf_valid(buf)) /* new buffer has been deleted */
3346 delbuf_msg(new_name); /* frees new_name */
3347 goto theend;
3349 # ifdef FEAT_EVAL
3350 if (aborting()) /* autocmds may abort script processing */
3352 vim_free(new_name);
3353 goto theend;
3355 # endif
3356 if (buf == curbuf) /* already in new buffer */
3357 auto_buf = TRUE;
3358 else
3360 if (curbuf == old_curbuf)
3361 #endif
3362 buf_copy_options(buf, BCO_ENTER);
3364 /* close the link to the current buffer */
3365 u_sync(FALSE);
3366 close_buffer(curwin, curbuf,
3367 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3369 #ifdef FEAT_AUTOCMD
3370 # ifdef FEAT_EVAL
3371 if (aborting()) /* autocmds may abort script processing */
3373 vim_free(new_name);
3374 goto theend;
3376 # endif
3377 /* Be careful again, like above. */
3378 if (!buf_valid(buf)) /* new buffer has been deleted */
3380 delbuf_msg(new_name); /* frees new_name */
3381 goto theend;
3383 if (buf == curbuf) /* already in new buffer */
3384 auto_buf = TRUE;
3385 else
3386 #endif
3388 curwin->w_buffer = buf;
3389 curbuf = buf;
3390 ++curbuf->b_nwindows;
3391 /* set 'fileformat' */
3392 if (*p_ffs && !oldbuf)
3393 set_fileformat(default_fileformat(), OPT_LOCAL);
3396 /* May get the window options from the last time this buffer
3397 * was in this window (or another window). If not used
3398 * before, reset the local window options to the global
3399 * values. Also restores old folding stuff. */
3400 get_winopts(curbuf);
3401 #ifdef FEAT_SPELL
3402 did_get_winopts = TRUE;
3403 #endif
3405 #ifdef FEAT_AUTOCMD
3407 vim_free(new_name);
3408 au_new_curbuf = NULL;
3409 #endif
3411 else
3412 ++curbuf->b_nwindows;
3414 curwin->w_pcmark.lnum = 1;
3415 curwin->w_pcmark.col = 0;
3417 else /* !other_file */
3419 if (
3420 #ifdef FEAT_LISTCMDS
3421 (flags & ECMD_ADDBUF) ||
3422 #endif
3423 check_fname() == FAIL)
3424 goto theend;
3425 oldbuf = (flags & ECMD_OLDBUF);
3428 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3430 char_u *p;
3432 curbuf->b_help = TRUE;
3433 #ifdef FEAT_QUICKFIX
3434 set_string_option_direct((char_u *)"buftype", -1,
3435 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3436 #endif
3439 * Always set these options after jumping to a help tag, because the
3440 * user may have an autocommand that gets in the way.
3441 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3442 * latin1 word characters (for translated help files).
3443 * Only set it when needed, buf_init_chartab() is some work.
3446 #ifdef EBCDIC
3447 (char_u *)"65-255,^*,^|,^\"";
3448 #else
3449 (char_u *)"!-~,^*,^|,^\",192-255";
3450 #endif
3451 if (STRCMP(curbuf->b_p_isk, p) != 0)
3453 set_string_option_direct((char_u *)"isk", -1, p,
3454 OPT_FREE|OPT_LOCAL, 0);
3455 check_buf_options(curbuf);
3456 (void)buf_init_chartab(curbuf, FALSE);
3459 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3460 curwin->w_p_list = FALSE; /* no list mode */
3462 curbuf->b_p_ma = FALSE; /* not modifiable */
3463 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3464 curwin->w_p_nu = 0; /* no line numbers */
3465 #ifdef FEAT_SCROLLBIND
3466 curwin->w_p_scb = FALSE; /* no scroll binding */
3467 #endif
3468 #ifdef FEAT_ARABIC
3469 curwin->w_p_arab = FALSE; /* no arabic mode */
3470 #endif
3471 #ifdef FEAT_RIGHTLEFT
3472 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3473 #endif
3474 #ifdef FEAT_FOLDING
3475 curwin->w_p_fen = FALSE; /* No folding in the help window */
3476 #endif
3477 #ifdef FEAT_DIFF
3478 curwin->w_p_diff = FALSE; /* No 'diff' */
3479 #endif
3480 #ifdef FEAT_SPELL
3481 curwin->w_p_spell = FALSE; /* No spell checking */
3482 #endif
3484 #ifdef FEAT_AUTOCMD
3485 buf = curbuf;
3486 #endif
3487 set_buflisted(FALSE);
3489 else
3491 #ifdef FEAT_AUTOCMD
3492 buf = curbuf;
3493 #endif
3494 /* Don't make a buffer listed if it's a help buffer. Useful when
3495 * using CTRL-O to go back to a help file. */
3496 if (!curbuf->b_help)
3497 set_buflisted(TRUE);
3500 #ifdef FEAT_AUTOCMD
3501 /* If autocommands change buffers under our fingers, forget about
3502 * editing the file. */
3503 if (buf != curbuf)
3504 goto theend;
3505 # ifdef FEAT_EVAL
3506 if (aborting()) /* autocmds may abort script processing */
3507 goto theend;
3508 # endif
3510 /* Since we are starting to edit a file, consider the filetype to be
3511 * unset. Helps for when an autocommand changes files and expects syntax
3512 * highlighting to work in the other file. */
3513 did_filetype = FALSE;
3514 #endif
3517 * other_file oldbuf
3518 * FALSE FALSE re-edit same file, buffer is re-used
3519 * FALSE TRUE re-edit same file, nothing changes
3520 * TRUE FALSE start editing new file, new buffer
3521 * TRUE TRUE start editing in existing buffer (nothing to do)
3523 if (!other_file && !oldbuf) /* re-use the buffer */
3525 set_last_cursor(curwin); /* may set b_last_cursor */
3526 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3528 newlnum = curwin->w_cursor.lnum;
3529 solcol = curwin->w_cursor.col;
3531 #ifdef FEAT_AUTOCMD
3532 buf = curbuf;
3533 if (buf->b_fname != NULL)
3534 new_name = vim_strsave(buf->b_fname);
3535 else
3536 new_name = NULL;
3537 #endif
3538 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3539 #ifdef FEAT_AUTOCMD
3540 /* If autocommands deleted the buffer we were going to re-edit, give
3541 * up and jump to the end. */
3542 if (!buf_valid(buf))
3544 delbuf_msg(new_name); /* frees new_name */
3545 goto theend;
3547 vim_free(new_name);
3549 /* If autocommands change buffers under our fingers, forget about
3550 * re-editing the file. Should do the buf_clear_file(), but perhaps
3551 * the autocommands changed the buffer... */
3552 if (buf != curbuf)
3553 goto theend;
3554 # ifdef FEAT_EVAL
3555 if (aborting()) /* autocmds may abort script processing */
3556 goto theend;
3557 # endif
3558 #endif
3559 buf_clear_file(curbuf);
3560 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3561 curbuf->b_op_end.lnum = 0;
3565 * If we get here we are sure to start editing
3567 /* don't redraw until the cursor is in the right line */
3568 ++RedrawingDisabled;
3570 /* Assume success now */
3571 retval = OK;
3574 * Reset cursor position, could be used by autocommands.
3576 check_cursor();
3579 * Check if we are editing the w_arg_idx file in the argument list.
3581 check_arg_idx(curwin);
3583 #ifdef FEAT_AUTOCMD
3584 if (!auto_buf)
3585 #endif
3588 * Set cursor and init window before reading the file and executing
3589 * autocommands. This allows for the autocommands to position the
3590 * cursor.
3592 curwin_init();
3594 #ifdef FEAT_FOLDING
3595 /* It's possible that all lines in the buffer changed. Need to update
3596 * automatic folding for all windows where it's used. */
3597 # ifdef FEAT_WINDOWS
3599 win_T *win;
3600 tabpage_T *tp;
3602 FOR_ALL_TAB_WINDOWS(tp, win)
3603 if (win->w_buffer == curbuf)
3604 foldUpdateAll(win);
3606 # else
3607 foldUpdateAll(curwin);
3608 # endif
3609 #endif
3611 /* Change directories when the 'acd' option is set. */
3612 DO_AUTOCHDIR
3615 * Careful: open_buffer() and apply_autocmds() may change the current
3616 * buffer and window.
3618 lnum = curwin->w_cursor.lnum;
3619 topline = curwin->w_topline;
3620 if (!oldbuf) /* need to read the file */
3622 #if defined(HAS_SWAP_EXISTS_ACTION)
3623 swap_exists_action = SEA_DIALOG;
3624 #endif
3625 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3628 * Open the buffer and read the file.
3630 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3631 if (should_abort(open_buffer(FALSE, eap)))
3632 retval = FAIL;
3633 #else
3634 (void)open_buffer(FALSE, eap);
3635 #endif
3637 #if defined(HAS_SWAP_EXISTS_ACTION)
3638 if (swap_exists_action == SEA_QUIT)
3639 retval = FAIL;
3640 handle_swap_exists(old_curbuf);
3641 #endif
3643 #ifdef FEAT_AUTOCMD
3644 else
3646 /* Read the modelines, but only to set window-local options. Any
3647 * buffer-local options have already been set and may have been
3648 * changed by the user. */
3649 do_modelines(OPT_WINONLY);
3651 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3652 &retval);
3653 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3654 &retval);
3656 check_arg_idx(curwin);
3657 #endif
3660 * If autocommands change the cursor position or topline, we should
3661 * keep it.
3663 if (curwin->w_cursor.lnum != lnum)
3665 newlnum = curwin->w_cursor.lnum;
3666 newcol = curwin->w_cursor.col;
3668 if (curwin->w_topline == topline)
3669 topline = 0;
3671 /* Even when cursor didn't move we need to recompute topline. */
3672 changed_line_abv_curs();
3674 #ifdef FEAT_TITLE
3675 maketitle();
3676 #endif
3679 #ifdef FEAT_DIFF
3680 /* Tell the diff stuff that this buffer is new and/or needs updating.
3681 * Also needed when re-editing the same buffer, because unloading will
3682 * have removed it as a diff buffer. */
3683 if (curwin->w_p_diff)
3685 diff_buf_add(curbuf);
3686 diff_invalidate(curbuf);
3688 #endif
3690 #ifdef FEAT_SPELL
3691 /* If the window options were changed may need to set the spell language.
3692 * Can only do this after the buffer has been properly setup. */
3693 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3694 did_set_spelllang(curbuf);
3695 #endif
3697 if (command == NULL)
3699 if (newcol >= 0) /* position set by autocommands */
3701 curwin->w_cursor.lnum = newlnum;
3702 curwin->w_cursor.col = newcol;
3703 check_cursor();
3705 else if (newlnum > 0) /* line number from caller or old position */
3707 curwin->w_cursor.lnum = newlnum;
3708 check_cursor_lnum();
3709 if (solcol >= 0 && !p_sol)
3711 /* 'sol' is off: Use last known column. */
3712 curwin->w_cursor.col = solcol;
3713 check_cursor_col();
3714 #ifdef FEAT_VIRTUALEDIT
3715 curwin->w_cursor.coladd = 0;
3716 #endif
3717 curwin->w_set_curswant = TRUE;
3719 else
3720 beginline(BL_SOL | BL_FIX);
3722 else /* no line number, go to last line in Ex mode */
3724 if (exmode_active)
3725 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3726 beginline(BL_WHITE | BL_FIX);
3730 #ifdef FEAT_WINDOWS
3731 /* Check if cursors in other windows on the same buffer are still valid */
3732 check_lnums(FALSE);
3733 #endif
3736 * Did not read the file, need to show some info about the file.
3737 * Do this after setting the cursor.
3739 if (oldbuf
3740 #ifdef FEAT_AUTOCMD
3741 && !auto_buf
3742 #endif
3745 int msg_scroll_save = msg_scroll;
3747 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3748 * message. */
3749 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3750 msg_scroll = FALSE;
3751 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3752 check_for_delay(FALSE);
3753 msg_start();
3754 msg_scroll = msg_scroll_save;
3755 msg_scrolled_ign = TRUE;
3757 fileinfo(FALSE, TRUE, FALSE);
3759 msg_scrolled_ign = FALSE;
3762 if (command != NULL)
3763 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3765 #ifdef FEAT_KEYMAP
3766 if (curbuf->b_kmap_state & KEYMAP_INIT)
3767 keymap_init();
3768 #endif
3770 --RedrawingDisabled;
3771 if (!skip_redraw)
3773 n = p_so;
3774 if (topline == 0 && command == NULL)
3775 p_so = 999; /* force cursor halfway the window */
3776 update_topline();
3777 #ifdef FEAT_SCROLLBIND
3778 curwin->w_scbind_pos = curwin->w_topline;
3779 #endif
3780 p_so = n;
3781 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3784 if (p_im)
3785 need_start_insertmode = TRUE;
3787 /* Change directories when the 'acd' option is set. */
3788 DO_AUTOCHDIR
3790 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3791 if (gui.in_use && curbuf->b_ffname != NULL)
3793 # ifdef FEAT_SUN_WORKSHOP
3794 if (usingSunWorkShop)
3795 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3796 # endif
3797 # ifdef FEAT_NETBEANS_INTG
3798 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3799 netbeans_file_opened(curbuf);
3800 # endif
3802 #endif
3804 theend:
3805 #ifdef FEAT_AUTOCMD
3806 if (did_set_swapcommand)
3807 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3808 #endif
3809 #ifdef FEAT_BROWSE
3810 vim_free(browse_file);
3811 #endif
3812 vim_free(free_fname);
3813 return retval;
3816 #ifdef FEAT_AUTOCMD
3817 static void
3818 delbuf_msg(name)
3819 char_u *name;
3821 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3822 name == NULL ? (char_u *)"" : name);
3823 vim_free(name);
3824 au_new_curbuf = NULL;
3826 #endif
3828 static int append_indent = 0; /* autoindent for first line */
3831 * ":insert" and ":append", also used by ":change"
3833 void
3834 ex_append(eap)
3835 exarg_T *eap;
3837 char_u *theline;
3838 int did_undo = FALSE;
3839 linenr_T lnum = eap->line2;
3840 int indent = 0;
3841 char_u *p;
3842 int vcol;
3843 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3845 /* the ! flag toggles autoindent */
3846 if (eap->forceit)
3847 curbuf->b_p_ai = !curbuf->b_p_ai;
3849 /* First autoindent comes from the line we start on */
3850 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3851 append_indent = get_indent_lnum(lnum);
3853 if (eap->cmdidx != CMD_append)
3854 --lnum;
3856 /* when the buffer is empty append to line 0 and delete the dummy line */
3857 if (empty && lnum == 1)
3858 lnum = 0;
3860 State = INSERT; /* behave like in Insert mode */
3861 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3862 State |= LANGMAP;
3864 for (;;)
3866 msg_scroll = TRUE;
3867 need_wait_return = FALSE;
3868 if (curbuf->b_p_ai)
3870 if (append_indent >= 0)
3872 indent = append_indent;
3873 append_indent = -1;
3875 else if (lnum > 0)
3876 indent = get_indent_lnum(lnum);
3878 ex_keep_indent = FALSE;
3879 if (eap->getline == NULL)
3881 /* No getline() function, use the lines that follow. This ends
3882 * when there is no more. */
3883 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3884 break;
3885 p = vim_strchr(eap->nextcmd, NL);
3886 if (p == NULL)
3887 p = eap->nextcmd + STRLEN(eap->nextcmd);
3888 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3889 if (*p != NUL)
3890 ++p;
3891 eap->nextcmd = p;
3893 else
3894 theline = eap->getline(
3895 #ifdef FEAT_EVAL
3896 eap->cstack->cs_looplevel > 0 ? -1 :
3897 #endif
3898 NUL, eap->cookie, indent);
3899 lines_left = Rows - 1;
3900 if (theline == NULL)
3901 break;
3903 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3904 if (ex_keep_indent)
3905 append_indent = indent;
3907 /* Look for the "." after automatic indent. */
3908 vcol = 0;
3909 for (p = theline; indent > vcol; ++p)
3911 if (*p == ' ')
3912 ++vcol;
3913 else if (*p == TAB)
3914 vcol += 8 - vcol % 8;
3915 else
3916 break;
3918 if ((p[0] == '.' && p[1] == NUL)
3919 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3920 == FAIL))
3922 vim_free(theline);
3923 break;
3926 /* don't use autoindent if nothing was typed. */
3927 if (p[0] == NUL)
3928 theline[0] = NUL;
3930 did_undo = TRUE;
3931 ml_append(lnum, theline, (colnr_T)0, FALSE);
3932 appended_lines_mark(lnum, 1L);
3934 vim_free(theline);
3935 ++lnum;
3937 if (empty)
3939 ml_delete(2L, FALSE);
3940 empty = FALSE;
3943 State = NORMAL;
3945 if (eap->forceit)
3946 curbuf->b_p_ai = !curbuf->b_p_ai;
3948 /* "start" is set to eap->line2+1 unless that position is invalid (when
3949 * eap->line2 pointed to the end of the buffer and nothing was appended)
3950 * "end" is set to lnum when something has been appended, otherwise
3951 * it is the same than "start" -- Acevedo */
3952 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3953 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3954 if (eap->cmdidx != CMD_append)
3955 --curbuf->b_op_start.lnum;
3956 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3957 ? lnum : curbuf->b_op_start.lnum;
3958 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3959 curwin->w_cursor.lnum = lnum;
3960 check_cursor_lnum();
3961 beginline(BL_SOL | BL_FIX);
3963 need_wait_return = FALSE; /* don't use wait_return() now */
3964 ex_no_reprint = TRUE;
3968 * ":change"
3970 void
3971 ex_change(eap)
3972 exarg_T *eap;
3974 linenr_T lnum;
3976 if (eap->line2 >= eap->line1
3977 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3978 return;
3980 /* the ! flag toggles autoindent */
3981 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3982 append_indent = get_indent_lnum(eap->line1);
3984 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3986 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3987 break;
3988 ml_delete(eap->line1, FALSE);
3990 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3992 /* ":append" on the line above the deleted lines. */
3993 eap->line2 = eap->line1;
3994 ex_append(eap);
3997 void
3998 ex_z(eap)
3999 exarg_T *eap;
4001 char_u *x;
4002 int bigness;
4003 char_u *kind;
4004 int minus = 0;
4005 linenr_T start, end, curs, i;
4006 int j;
4007 linenr_T lnum = eap->line2;
4009 /* Vi compatible: ":z!" uses display height, without a count uses
4010 * 'scroll' */
4011 if (eap->forceit)
4012 bigness = curwin->w_height;
4013 else if (firstwin == lastwin)
4014 bigness = curwin->w_p_scr * 2;
4015 else
4016 bigness = curwin->w_height - 3;
4017 if (bigness < 1)
4018 bigness = 1;
4020 x = eap->arg;
4021 kind = x;
4022 if (*kind == '-' || *kind == '+' || *kind == '='
4023 || *kind == '^' || *kind == '.')
4024 ++x;
4025 while (*x == '-' || *x == '+')
4026 ++x;
4028 if (*x != 0)
4030 if (!VIM_ISDIGIT(*x))
4032 EMSG(_("E144: non-numeric argument to :z"));
4033 return;
4035 else
4037 bigness = atoi((char *)x);
4038 p_window = bigness;
4039 if (*kind == '=')
4040 bigness += 2;
4044 /* the number of '-' and '+' multiplies the distance */
4045 if (*kind == '-' || *kind == '+')
4046 for (x = kind + 1; *x == *kind; ++x)
4049 switch (*kind)
4051 case '-':
4052 start = lnum - bigness * (linenr_T)(x - kind);
4053 end = start + bigness;
4054 curs = end;
4055 break;
4057 case '=':
4058 start = lnum - (bigness + 1) / 2 + 1;
4059 end = lnum + (bigness + 1) / 2 - 1;
4060 curs = lnum;
4061 minus = 1;
4062 break;
4064 case '^':
4065 start = lnum - bigness * 2;
4066 end = lnum - bigness;
4067 curs = lnum - bigness;
4068 break;
4070 case '.':
4071 start = lnum - (bigness + 1) / 2 + 1;
4072 end = lnum + (bigness + 1) / 2 - 1;
4073 curs = end;
4074 break;
4076 default: /* '+' */
4077 start = lnum;
4078 if (*kind == '+')
4079 start += bigness * (linenr_T)(x - kind - 1) + 1;
4080 else if (eap->addr_count == 0)
4081 ++start;
4082 end = start + bigness - 1;
4083 curs = end;
4084 break;
4087 if (start < 1)
4088 start = 1;
4090 if (end > curbuf->b_ml.ml_line_count)
4091 end = curbuf->b_ml.ml_line_count;
4093 if (curs > curbuf->b_ml.ml_line_count)
4094 curs = curbuf->b_ml.ml_line_count;
4096 for (i = start; i <= end; i++)
4098 if (minus && i == lnum)
4100 msg_putchar('\n');
4102 for (j = 1; j < Columns; j++)
4103 msg_putchar('-');
4106 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4108 if (minus && i == lnum)
4110 msg_putchar('\n');
4112 for (j = 1; j < Columns; j++)
4113 msg_putchar('-');
4117 curwin->w_cursor.lnum = curs;
4118 ex_no_reprint = TRUE;
4122 * Check if the restricted flag is set.
4123 * If so, give an error message and return TRUE.
4124 * Otherwise, return FALSE.
4127 check_restricted()
4129 if (restricted)
4131 EMSG(_("E145: Shell commands not allowed in rvim"));
4132 return TRUE;
4134 return FALSE;
4138 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4139 * If so, give an error message and return TRUE.
4140 * Otherwise, return FALSE.
4143 check_secure()
4145 if (secure)
4147 secure = 2;
4148 EMSG(_(e_curdir));
4149 return TRUE;
4151 #ifdef HAVE_SANDBOX
4153 * In the sandbox more things are not allowed, including the things
4154 * disallowed in secure mode.
4156 if (sandbox != 0)
4158 EMSG(_(e_sandbox));
4159 return TRUE;
4161 #endif
4162 return FALSE;
4165 static char_u *old_sub = NULL; /* previous substitute pattern */
4166 static int global_need_beginline; /* call beginline() after ":g" */
4168 /* do_sub()
4170 * Perform a substitution from line eap->line1 to line eap->line2 using the
4171 * command pointed to by eap->arg which should be of the form:
4173 * /pattern/substitution/{flags}
4175 * The usual escapes are supported as described in the regexp docs.
4177 void
4178 do_sub(eap)
4179 exarg_T *eap;
4181 linenr_T lnum;
4182 long i = 0;
4183 regmmatch_T regmatch;
4184 static int do_all = FALSE; /* do multiple substitutions per line */
4185 static int do_ask = FALSE; /* ask for confirmation */
4186 static int do_count = FALSE; /* count only */
4187 static int do_error = TRUE; /* if false, ignore errors */
4188 static int do_print = FALSE; /* print last line with subs. */
4189 static int do_list = FALSE; /* list last line with subs. */
4190 static int do_number = FALSE; /* list last line with line nr*/
4191 static int do_ic = 0; /* ignore case flag */
4192 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4193 int delimiter;
4194 int sublen;
4195 int got_quit = FALSE;
4196 int got_match = FALSE;
4197 int temp;
4198 int which_pat;
4199 char_u *cmd;
4200 int save_State;
4201 linenr_T first_line = 0; /* first changed line */
4202 linenr_T last_line= 0; /* below last changed line AFTER the
4203 * change */
4204 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4205 linenr_T line2;
4206 long nmatch; /* number of lines in match */
4207 char_u *sub_firstline; /* allocated copy of first sub line */
4208 int endcolumn = FALSE; /* cursor in last column when done */
4209 pos_T old_cursor = curwin->w_cursor;
4211 cmd = eap->arg;
4212 if (!global_busy)
4214 sub_nsubs = 0;
4215 sub_nlines = 0;
4218 if (eap->cmdidx == CMD_tilde)
4219 which_pat = RE_LAST; /* use last used regexp */
4220 else
4221 which_pat = RE_SUBST; /* use last substitute regexp */
4223 /* new pattern and substitution */
4224 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4225 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4227 /* don't accept alphanumeric for separator */
4228 if (isalpha(*cmd))
4230 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4231 return;
4234 * undocumented vi feature:
4235 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4236 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4238 if (*cmd == '\\')
4240 ++cmd;
4241 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4243 EMSG(_(e_backslash));
4244 return;
4246 if (*cmd != '&')
4247 which_pat = RE_SEARCH; /* use last '/' pattern */
4248 pat = (char_u *)""; /* empty search pattern */
4249 delimiter = *cmd++; /* remember delimiter character */
4251 else /* find the end of the regexp */
4253 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4254 if (p_altkeymap && curwin->w_p_rl)
4255 lrF_sub(cmd);
4256 #endif
4257 which_pat = RE_LAST; /* use last used regexp */
4258 delimiter = *cmd++; /* remember delimiter character */
4259 pat = cmd; /* remember start of search pat */
4260 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4261 if (cmd[0] == delimiter) /* end delimiter found */
4262 *cmd++ = NUL; /* replace it with a NUL */
4266 * Small incompatibility: vi sees '\n' as end of the command, but in
4267 * Vim we want to use '\n' to find/substitute a NUL.
4269 sub = cmd; /* remember the start of the substitution */
4271 while (cmd[0])
4273 if (cmd[0] == delimiter) /* end delimiter found */
4275 *cmd++ = NUL; /* replace it with a NUL */
4276 break;
4278 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4279 ++cmd;
4280 mb_ptr_adv(cmd);
4283 if (!eap->skip)
4285 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4286 if (STRCMP(sub, "%") == 0
4287 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4289 if (old_sub == NULL) /* there is no previous command */
4291 EMSG(_(e_nopresub));
4292 return;
4294 sub = old_sub;
4296 else
4298 vim_free(old_sub);
4299 old_sub = vim_strsave(sub);
4303 else if (!eap->skip) /* use previous pattern and substitution */
4305 if (old_sub == NULL) /* there is no previous command */
4307 EMSG(_(e_nopresub));
4308 return;
4310 pat = NULL; /* search_regcomp() will use previous pattern */
4311 sub = old_sub;
4313 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4314 * last column after using "$". */
4315 endcolumn = (curwin->w_curswant == MAXCOL);
4319 * Find trailing options. When '&' is used, keep old options.
4321 if (*cmd == '&')
4322 ++cmd;
4323 else
4325 if (!p_ed)
4327 if (p_gd) /* default is global on */
4328 do_all = TRUE;
4329 else
4330 do_all = FALSE;
4331 do_ask = FALSE;
4333 do_error = TRUE;
4334 do_print = FALSE;
4335 do_count = FALSE;
4336 do_number = FALSE;
4337 do_ic = 0;
4339 while (*cmd)
4342 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4343 * 'r' is never inverted.
4345 if (*cmd == 'g')
4346 do_all = !do_all;
4347 else if (*cmd == 'c')
4348 do_ask = !do_ask;
4349 else if (*cmd == 'n')
4350 do_count = TRUE;
4351 else if (*cmd == 'e')
4352 do_error = !do_error;
4353 else if (*cmd == 'r') /* use last used regexp */
4354 which_pat = RE_LAST;
4355 else if (*cmd == 'p')
4356 do_print = TRUE;
4357 else if (*cmd == '#')
4359 do_print = TRUE;
4360 do_number = TRUE;
4362 else if (*cmd == 'l')
4364 do_print = TRUE;
4365 do_list = TRUE;
4367 else if (*cmd == 'i') /* ignore case */
4368 do_ic = 'i';
4369 else if (*cmd == 'I') /* don't ignore case */
4370 do_ic = 'I';
4371 else
4372 break;
4373 ++cmd;
4375 if (do_count)
4376 do_ask = FALSE;
4379 * check for a trailing count
4381 cmd = skipwhite(cmd);
4382 if (VIM_ISDIGIT(*cmd))
4384 i = getdigits(&cmd);
4385 if (i <= 0 && !eap->skip && do_error)
4387 EMSG(_(e_zerocount));
4388 return;
4390 eap->line1 = eap->line2;
4391 eap->line2 += i - 1;
4392 if (eap->line2 > curbuf->b_ml.ml_line_count)
4393 eap->line2 = curbuf->b_ml.ml_line_count;
4397 * check for trailing command or garbage
4399 cmd = skipwhite(cmd);
4400 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4402 eap->nextcmd = check_nextcmd(cmd);
4403 if (eap->nextcmd == NULL)
4405 EMSG(_(e_trailing));
4406 return;
4410 if (eap->skip) /* not executing commands, only parsing */
4411 return;
4413 if (!do_count && !curbuf->b_p_ma)
4415 /* Substitution is not allowed in non-'modifiable' buffer */
4416 EMSG(_(e_modifiable));
4417 return;
4420 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4422 if (do_error)
4423 EMSG(_(e_invcmd));
4424 return;
4427 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4428 if (do_ic == 'i')
4429 regmatch.rmm_ic = TRUE;
4430 else if (do_ic == 'I')
4431 regmatch.rmm_ic = FALSE;
4433 sub_firstline = NULL;
4436 * ~ in the substitute pattern is replaced with the old pattern.
4437 * We do it here once to avoid it to be replaced over and over again.
4438 * But don't do it when it starts with "\=", then it's an expression.
4440 if (!(sub[0] == '\\' && sub[1] == '='))
4441 sub = regtilde(sub, p_magic);
4444 * Check for a match on each line.
4446 line2 = eap->line2;
4447 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4448 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4449 || aborting()
4450 #endif
4451 ); ++lnum)
4453 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4454 (colnr_T)0, NULL);
4455 if (nmatch)
4457 colnr_T copycol;
4458 colnr_T matchcol;
4459 colnr_T prev_matchcol = MAXCOL;
4460 char_u *new_end, *new_start = NULL;
4461 unsigned new_start_len = 0;
4462 char_u *p1;
4463 int did_sub = FALSE;
4464 int lastone;
4465 unsigned len, needed_len;
4466 long nmatch_tl = 0; /* nr of lines matched below lnum */
4467 int do_again; /* do it again after joining lines */
4468 int skip_match = FALSE;
4469 linenr_T sub_firstlnum; /* nr of first sub line */
4472 * The new text is build up step by step, to avoid too much
4473 * copying. There are these pieces:
4474 * sub_firstline The old text, unmodifed.
4475 * copycol Column in the old text where we started
4476 * looking for a match; from here old text still
4477 * needs to be copied to the new text.
4478 * matchcol Column number of the old text where to look
4479 * for the next match. It's just after the
4480 * previous match or one further.
4481 * prev_matchcol Column just after the previous match (if any).
4482 * Mostly equal to matchcol, except for the first
4483 * match and after skipping an empty match.
4484 * regmatch.*pos Where the pattern matched in the old text.
4485 * new_start The new text, all that has been produced so
4486 * far.
4487 * new_end The new text, where to append new text.
4489 * lnum The line number where we found the start of
4490 * the match. Can be below the line we searched
4491 * when there is a \n before a \zs in the
4492 * pattern.
4493 * sub_firstlnum The line number in the buffer where to look
4494 * for a match. Can be different from "lnum"
4495 * when the pattern or substitute string contains
4496 * line breaks.
4498 * Special situations:
4499 * - When the substitute string contains a line break, the part up
4500 * to the line break is inserted in the text, but the copy of
4501 * the original line is kept. "sub_firstlnum" is adjusted for
4502 * the inserted lines.
4503 * - When the matched pattern contains a line break, the old line
4504 * is taken from the line at the end of the pattern. The lines
4505 * in the match are deleted later, "sub_firstlnum" is adjusted
4506 * accordingly.
4508 * The new text is built up in new_start[]. It has some extra
4509 * room to avoid using alloc()/free() too often. new_start_len is
4510 * the length of the allocated memory at new_start.
4512 * Make a copy of the old line, so it won't be taken away when
4513 * updating the screen or handling a multi-line match. The "old_"
4514 * pointers point into this copy.
4516 sub_firstlnum = lnum;
4517 copycol = 0;
4518 matchcol = 0;
4520 /* At first match, remember current cursor position. */
4521 if (!got_match)
4523 setpcmark();
4524 got_match = TRUE;
4528 * Loop until nothing more to replace in this line.
4529 * 1. Handle match with empty string.
4530 * 2. If do_ask is set, ask for confirmation.
4531 * 3. substitute the string.
4532 * 4. if do_all is set, find next match
4533 * 5. break if there isn't another match in this line
4535 for (;;)
4537 /* Advance "lnum" to the line where the match starts. The
4538 * match does not start in the first line when there is a line
4539 * break before \zs. */
4540 if (regmatch.startpos[0].lnum > 0)
4542 lnum += regmatch.startpos[0].lnum;
4543 sub_firstlnum += regmatch.startpos[0].lnum;
4544 nmatch -= regmatch.startpos[0].lnum;
4545 vim_free(sub_firstline);
4546 sub_firstline = NULL;
4549 if (sub_firstline == NULL)
4551 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4552 if (sub_firstline == NULL)
4554 vim_free(new_start);
4555 goto outofmem;
4559 /* Save the line number of the last change for the final
4560 * cursor position (just like Vi). */
4561 curwin->w_cursor.lnum = lnum;
4562 do_again = FALSE;
4565 * 1. Match empty string does not count, except for first
4566 * match. This reproduces the strange vi behaviour.
4567 * This also catches endless loops.
4569 if (matchcol == prev_matchcol
4570 && regmatch.endpos[0].lnum == 0
4571 && matchcol == regmatch.endpos[0].col)
4573 if (sub_firstline[matchcol] == NUL)
4574 /* We already were at the end of the line. Don't look
4575 * for a match in this line again. */
4576 skip_match = TRUE;
4577 else
4578 ++matchcol; /* search for a match at next column */
4579 goto skip;
4582 /* Normally we continue searching for a match just after the
4583 * previous match. */
4584 matchcol = regmatch.endpos[0].col;
4585 prev_matchcol = matchcol;
4588 * 2. If do_count is set only increase the counter.
4589 * If do_ask is set, ask for confirmation.
4591 if (do_count)
4593 /* For a multi-line match, put matchcol at the NUL at
4594 * the end of the line and set nmatch to one, so that
4595 * we continue looking for a match on the next line.
4596 * Avoids that ":s/\nB\@=//gc" get stuck. */
4597 if (nmatch > 1)
4599 matchcol = (colnr_T)STRLEN(sub_firstline);
4600 nmatch = 1;
4601 skip_match = TRUE;
4603 sub_nsubs++;
4604 did_sub = TRUE;
4605 goto skip;
4608 if (do_ask)
4610 /* change State to CONFIRM, so that the mouse works
4611 * properly */
4612 save_State = State;
4613 State = CONFIRM;
4614 #ifdef FEAT_MOUSE
4615 setmouse(); /* disable mouse in xterm */
4616 #endif
4617 curwin->w_cursor.col = regmatch.startpos[0].col;
4619 /* When 'cpoptions' contains "u" don't sync undo when
4620 * asking for confirmation. */
4621 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4622 ++no_u_sync;
4625 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4627 while (do_ask)
4629 if (exmode_active)
4631 char_u *resp;
4632 colnr_T sc, ec;
4634 print_line_no_prefix(lnum, FALSE, FALSE);
4636 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4637 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4638 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4639 msg_start();
4640 for (i = 0; i < (long)sc; ++i)
4641 msg_putchar(' ');
4642 for ( ; i <= (long)ec; ++i)
4643 msg_putchar('^');
4645 resp = getexmodeline('?', NULL, 0);
4646 if (resp != NULL)
4648 i = *resp;
4649 vim_free(resp);
4652 else
4654 #ifdef FEAT_FOLDING
4655 int save_p_fen = curwin->w_p_fen;
4657 curwin->w_p_fen = FALSE;
4658 #endif
4659 /* Invert the matched string.
4660 * Remove the inversion afterwards. */
4661 temp = RedrawingDisabled;
4662 RedrawingDisabled = 0;
4664 search_match_lines = regmatch.endpos[0].lnum
4665 - regmatch.startpos[0].lnum;
4666 search_match_endcol = regmatch.endpos[0].col;
4667 highlight_match = TRUE;
4669 update_topline();
4670 validate_cursor();
4671 update_screen(SOME_VALID);
4672 highlight_match = FALSE;
4673 redraw_later(SOME_VALID);
4675 #ifdef FEAT_FOLDING
4676 curwin->w_p_fen = save_p_fen;
4677 #endif
4678 if (msg_row == Rows - 1)
4679 msg_didout = FALSE; /* avoid a scroll-up */
4680 msg_starthere();
4681 i = msg_scroll;
4682 msg_scroll = 0; /* truncate msg when
4683 needed */
4684 msg_no_more = TRUE;
4685 /* write message same highlighting as for
4686 * wait_return */
4687 smsg_attr(hl_attr(HLF_R),
4688 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4689 msg_no_more = FALSE;
4690 msg_scroll = i;
4691 showruler(TRUE);
4692 windgoto(msg_row, msg_col);
4693 RedrawingDisabled = temp;
4695 #ifdef USE_ON_FLY_SCROLL
4696 dont_scroll = FALSE; /* allow scrolling here */
4697 #endif
4698 ++no_mapping; /* don't map this key */
4699 ++allow_keys; /* allow special keys */
4700 i = plain_vgetc();
4701 --allow_keys;
4702 --no_mapping;
4704 /* clear the question */
4705 msg_didout = FALSE; /* don't scroll up */
4706 msg_col = 0;
4707 gotocmdline(TRUE);
4710 need_wait_return = FALSE; /* no hit-return prompt */
4711 if (i == 'q' || i == ESC || i == Ctrl_C
4712 #ifdef UNIX
4713 || i == intr_char
4714 #endif
4717 got_quit = TRUE;
4718 break;
4720 if (i == 'n')
4721 break;
4722 if (i == 'y')
4723 break;
4724 if (i == 'l')
4726 /* last: replace and then stop */
4727 do_all = FALSE;
4728 line2 = lnum;
4729 break;
4731 if (i == 'a')
4733 do_ask = FALSE;
4734 break;
4736 #ifdef FEAT_INS_EXPAND
4737 if (i == Ctrl_E)
4738 scrollup_clamp();
4739 else if (i == Ctrl_Y)
4740 scrolldown_clamp();
4741 #endif
4743 State = save_State;
4744 #ifdef FEAT_MOUSE
4745 setmouse();
4746 #endif
4747 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4748 --no_u_sync;
4750 if (i == 'n')
4752 /* For a multi-line match, put matchcol at the NUL at
4753 * the end of the line and set nmatch to one, so that
4754 * we continue looking for a match on the next line.
4755 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4756 * get stuck when pressing 'n'. */
4757 if (nmatch > 1)
4759 matchcol = (colnr_T)STRLEN(sub_firstline);
4760 skip_match = TRUE;
4762 goto skip;
4764 if (got_quit)
4765 break;
4768 /* Move the cursor to the start of the match, so that we can
4769 * use "\=col("."). */
4770 curwin->w_cursor.col = regmatch.startpos[0].col;
4773 * 3. substitute the string.
4775 /* get length of substitution part */
4776 sublen = vim_regsub_multi(&regmatch,
4777 sub_firstlnum - regmatch.startpos[0].lnum,
4778 sub, sub_firstline, FALSE, p_magic, TRUE);
4780 /* When the match included the "$" of the last line it may
4781 * go beyond the last line of the buffer. */
4782 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4784 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4785 skip_match = TRUE;
4788 /* Need room for:
4789 * - result so far in new_start (not for first sub in line)
4790 * - original text up to match
4791 * - length of substituted part
4792 * - original text after match
4794 if (nmatch == 1)
4795 p1 = sub_firstline;
4796 else
4798 p1 = ml_get(sub_firstlnum + nmatch - 1);
4799 nmatch_tl += nmatch - 1;
4801 i = regmatch.startpos[0].col - copycol;
4802 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4803 + sublen + 1;
4804 if (new_start == NULL)
4807 * Get some space for a temporary buffer to do the
4808 * substitution into (and some extra space to avoid
4809 * too many calls to alloc()/free()).
4811 new_start_len = needed_len + 50;
4812 if ((new_start = alloc_check(new_start_len)) == NULL)
4813 goto outofmem;
4814 *new_start = NUL;
4815 new_end = new_start;
4817 else
4820 * Check if the temporary buffer is long enough to do the
4821 * substitution into. If not, make it larger (with a bit
4822 * extra to avoid too many calls to alloc()/free()).
4824 len = (unsigned)STRLEN(new_start);
4825 needed_len += len;
4826 if (needed_len > new_start_len)
4828 new_start_len = needed_len + 50;
4829 if ((p1 = alloc_check(new_start_len)) == NULL)
4831 vim_free(new_start);
4832 goto outofmem;
4834 mch_memmove(p1, new_start, (size_t)(len + 1));
4835 vim_free(new_start);
4836 new_start = p1;
4838 new_end = new_start + len;
4842 * copy the text up to the part that matched
4844 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4845 new_end += i;
4847 (void)vim_regsub_multi(&regmatch,
4848 sub_firstlnum - regmatch.startpos[0].lnum,
4849 sub, new_end, TRUE, p_magic, TRUE);
4850 sub_nsubs++;
4851 did_sub = TRUE;
4853 /* Move the cursor to the start of the line, to avoid that it
4854 * is beyond the end of the line after the substitution. */
4855 curwin->w_cursor.col = 0;
4857 /* For a multi-line match, make a copy of the last matched
4858 * line and continue in that one. */
4859 if (nmatch > 1)
4861 sub_firstlnum += nmatch - 1;
4862 vim_free(sub_firstline);
4863 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4864 /* When going beyond the last line, stop substituting. */
4865 if (sub_firstlnum <= line2)
4866 do_again = TRUE;
4867 else
4868 do_all = FALSE;
4871 /* Remember next character to be copied. */
4872 copycol = regmatch.endpos[0].col;
4874 if (skip_match)
4876 /* Already hit end of the buffer, sub_firstlnum is one
4877 * less than what it ought to be. */
4878 vim_free(sub_firstline);
4879 sub_firstline = vim_strsave((char_u *)"");
4880 copycol = 0;
4884 * Now the trick is to replace CTRL-M chars with a real line
4885 * break. This would make it impossible to insert a CTRL-M in
4886 * the text. The line break can be avoided by preceding the
4887 * CTRL-M with a backslash. To be able to insert a backslash,
4888 * they must be doubled in the string and are halved here.
4889 * That is Vi compatible.
4891 for (p1 = new_end; *p1; ++p1)
4893 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4894 mch_memmove(p1, p1 + 1, STRLEN(p1));
4895 else if (*p1 == CAR)
4897 if (u_inssub(lnum) == OK) /* prepare for undo */
4899 *p1 = NUL; /* truncate up to the CR */
4900 ml_append(lnum - 1, new_start,
4901 (colnr_T)(p1 - new_start + 1), FALSE);
4902 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4903 if (do_ask)
4904 appended_lines(lnum - 1, 1L);
4905 else
4907 if (first_line == 0)
4908 first_line = lnum;
4909 last_line = lnum + 1;
4911 /* All line numbers increase. */
4912 ++sub_firstlnum;
4913 ++lnum;
4914 ++line2;
4915 /* move the cursor to the new line, like Vi */
4916 ++curwin->w_cursor.lnum;
4917 /* copy the rest */
4918 mch_memmove(new_start, p1 + 1, STRLEN(p1 + 1) + 1);
4919 p1 = new_start - 1;
4922 #ifdef FEAT_MBYTE
4923 else if (has_mbyte)
4924 p1 += (*mb_ptr2len)(p1) - 1;
4925 #endif
4929 * 4. If do_all is set, find next match.
4930 * Prevent endless loop with patterns that match empty
4931 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4932 * But ":s/\n/#/" is OK.
4934 skip:
4935 /* We already know that we did the last subst when we are at
4936 * the end of the line, except that a pattern like
4937 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4938 * "line2" when there is a \zs in the pattern after a line
4939 * break. */
4940 lastone = (skip_match
4941 || got_int
4942 || got_quit
4943 || lnum > line2
4944 || !(do_all || do_again)
4945 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4946 && !re_multiline(regmatch.regprog)));
4947 nmatch = -1;
4950 * Replace the line in the buffer when needed. This is
4951 * skipped when there are more matches.
4952 * The check for nmatch_tl is needed for when multi-line
4953 * matching must replace the lines before trying to do another
4954 * match, otherwise "\@<=" won't work.
4955 * When asking the user we like to show the already replaced
4956 * text, but don't do it when "\<@=" or "\<@!" is used, it
4957 * changes what matches.
4958 * When the match starts below where we start searching also
4959 * need to replace the line first (using \zs after \n).
4961 if (lastone
4962 || (do_ask && !re_lookbehind(regmatch.regprog))
4963 || nmatch_tl > 0
4964 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4965 curbuf, sub_firstlnum,
4966 matchcol, NULL)) == 0
4967 || regmatch.startpos[0].lnum > 0)
4969 if (new_start != NULL)
4972 * Copy the rest of the line, that didn't match.
4973 * "matchcol" has to be adjusted, we use the end of
4974 * the line as reference, because the substitute may
4975 * have changed the number of characters. Same for
4976 * "prev_matchcol".
4978 STRCAT(new_start, sub_firstline + copycol);
4979 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4980 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4981 - prev_matchcol;
4983 if (u_savesub(lnum) != OK)
4984 break;
4985 ml_replace(lnum, new_start, TRUE);
4987 if (nmatch_tl > 0)
4990 * Matched lines have now been substituted and are
4991 * useless, delete them. The part after the match
4992 * has been appended to new_start, we don't need
4993 * it in the buffer.
4995 ++lnum;
4996 if (u_savedel(lnum, nmatch_tl) != OK)
4997 break;
4998 for (i = 0; i < nmatch_tl; ++i)
4999 ml_delete(lnum, (int)FALSE);
5000 mark_adjust(lnum, lnum + nmatch_tl - 1,
5001 (long)MAXLNUM, -nmatch_tl);
5002 if (do_ask)
5003 deleted_lines(lnum, nmatch_tl);
5004 --lnum;
5005 line2 -= nmatch_tl; /* nr of lines decreases */
5006 nmatch_tl = 0;
5009 /* When asking, undo is saved each time, must also set
5010 * changed flag each time. */
5011 if (do_ask)
5012 changed_bytes(lnum, 0);
5013 else
5015 if (first_line == 0)
5016 first_line = lnum;
5017 last_line = lnum + 1;
5020 sub_firstlnum = lnum;
5021 vim_free(sub_firstline); /* free the temp buffer */
5022 sub_firstline = new_start;
5023 new_start = NULL;
5024 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5025 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5026 - prev_matchcol;
5027 copycol = 0;
5029 if (nmatch == -1 && !lastone)
5030 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
5031 sub_firstlnum, matchcol, NULL);
5034 * 5. break if there isn't another match in this line
5036 if (nmatch <= 0)
5038 /* If the match found didn't start where we were
5039 * searching, do the next search in the line where we
5040 * found the match. */
5041 if (nmatch == -1)
5042 lnum -= regmatch.startpos[0].lnum;
5043 break;
5047 line_breakcheck();
5050 if (did_sub)
5051 ++sub_nlines;
5052 vim_free(sub_firstline); /* free the copy of the original line */
5053 sub_firstline = NULL;
5056 line_breakcheck();
5059 if (first_line != 0)
5061 /* Need to subtract the number of added lines from "last_line" to get
5062 * the line number before the change (same as adding the number of
5063 * deleted lines). */
5064 i = curbuf->b_ml.ml_line_count - old_line_count;
5065 changed_lines(first_line, 0, last_line - i, i);
5068 outofmem:
5069 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5071 /* ":s/pat//n" doesn't move the cursor */
5072 if (do_count)
5073 curwin->w_cursor = old_cursor;
5075 if (sub_nsubs)
5077 /* Set the '[ and '] marks. */
5078 curbuf->b_op_start.lnum = eap->line1;
5079 curbuf->b_op_end.lnum = line2;
5080 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5082 if (!global_busy)
5084 if (endcolumn)
5085 coladvance((colnr_T)MAXCOL);
5086 else
5087 beginline(BL_WHITE | BL_FIX);
5088 if (!do_sub_msg(do_count) && do_ask)
5089 MSG("");
5091 else
5092 global_need_beginline = TRUE;
5093 if (do_print)
5094 print_line(curwin->w_cursor.lnum, do_number, do_list);
5096 else if (!global_busy)
5098 if (got_int) /* interrupted */
5099 EMSG(_(e_interr));
5100 else if (got_match) /* did find something but nothing substituted */
5101 MSG("");
5102 else if (do_error) /* nothing found */
5103 EMSG2(_(e_patnotf2), get_search_pat());
5106 vim_free(regmatch.regprog);
5110 * Give message for number of substitutions.
5111 * Can also be used after a ":global" command.
5112 * Return TRUE if a message was given.
5115 do_sub_msg(count_only)
5116 int count_only; /* used 'n' flag for ":s" */
5118 int len = 0;
5121 * Only report substitutions when:
5122 * - more than 'report' substitutions
5123 * - command was typed by user, or number of changed lines > 'report'
5124 * - giving messages is not disabled by 'lazyredraw'
5126 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5127 || count_only)
5128 && messaging())
5130 if (got_int)
5132 STRCPY(msg_buf, _("(Interrupted) "));
5133 len = (int)STRLEN(msg_buf);
5135 if (sub_nsubs == 1)
5136 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5137 "%s", count_only ? _("1 match") : _("1 substitution"));
5138 else
5139 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5140 count_only ? _("%ld matches") : _("%ld substitutions"),
5141 sub_nsubs);
5142 len = (int)STRLEN(msg_buf);
5143 if (sub_nlines == 1)
5144 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5145 "%s", _(" on 1 line"));
5146 else
5147 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5148 _(" on %ld lines"), (long)sub_nlines);
5149 if (msg(msg_buf))
5150 /* save message to display it after redraw */
5151 set_keep_msg(msg_buf, 0);
5152 return TRUE;
5154 if (got_int)
5156 EMSG(_(e_interr));
5157 return TRUE;
5159 return FALSE;
5163 * Execute a global command of the form:
5165 * g/pattern/X : execute X on all lines where pattern matches
5166 * v/pattern/X : execute X on all lines where pattern does not match
5168 * where 'X' is an EX command
5170 * The command character (as well as the trailing slash) is optional, and
5171 * is assumed to be 'p' if missing.
5173 * This is implemented in two passes: first we scan the file for the pattern and
5174 * set a mark for each line that (not) matches. secondly we execute the command
5175 * for each line that has a mark. This is required because after deleting
5176 * lines we do not know where to search for the next match.
5178 void
5179 ex_global(eap)
5180 exarg_T *eap;
5182 linenr_T lnum; /* line number according to old situation */
5183 int ndone = 0;
5184 int type; /* first char of cmd: 'v' or 'g' */
5185 char_u *cmd; /* command argument */
5187 char_u delim; /* delimiter, normally '/' */
5188 char_u *pat;
5189 regmmatch_T regmatch;
5190 int match;
5191 int which_pat;
5193 if (global_busy)
5195 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5196 return;
5199 if (eap->forceit) /* ":global!" is like ":vglobal" */
5200 type = 'v';
5201 else
5202 type = *eap->cmd;
5203 cmd = eap->arg;
5204 which_pat = RE_LAST; /* default: use last used regexp */
5205 sub_nsubs = 0;
5206 sub_nlines = 0;
5209 * undocumented vi feature:
5210 * "\/" and "\?": use previous search pattern.
5211 * "\&": use previous substitute pattern.
5213 if (*cmd == '\\')
5215 ++cmd;
5216 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5218 EMSG(_(e_backslash));
5219 return;
5221 if (*cmd == '&')
5222 which_pat = RE_SUBST; /* use previous substitute pattern */
5223 else
5224 which_pat = RE_SEARCH; /* use previous search pattern */
5225 ++cmd;
5226 pat = (char_u *)"";
5228 else if (*cmd == NUL)
5230 EMSG(_("E148: Regular expression missing from global"));
5231 return;
5233 else
5235 delim = *cmd; /* get the delimiter */
5236 if (delim)
5237 ++cmd; /* skip delimiter if there is one */
5238 pat = cmd; /* remember start of pattern */
5239 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5240 if (cmd[0] == delim) /* end delimiter found */
5241 *cmd++ = NUL; /* replace it with a NUL */
5244 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5245 if (p_altkeymap && curwin->w_p_rl)
5246 lrFswap(pat,0);
5247 #endif
5249 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5251 EMSG(_(e_invcmd));
5252 return;
5256 * pass 1: set marks for each (not) matching line
5258 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5260 /* a match on this line? */
5261 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5262 (colnr_T)0, NULL);
5263 if ((type == 'g' && match) || (type == 'v' && !match))
5265 ml_setmarked(lnum);
5266 ndone++;
5268 line_breakcheck();
5272 * pass 2: execute the command for each line that has been marked
5274 if (got_int)
5275 MSG(_(e_interr));
5276 else if (ndone == 0)
5278 if (type == 'v')
5279 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5280 else
5281 smsg((char_u *)_(e_patnotf2), pat);
5283 else
5284 global_exe(cmd);
5286 ml_clearmarked(); /* clear rest of the marks */
5287 vim_free(regmatch.regprog);
5291 * Execute "cmd" on lines marked with ml_setmarked().
5293 void
5294 global_exe(cmd)
5295 char_u *cmd;
5297 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5298 linenr_T lnum; /* line number according to old situation */
5301 * Set current position only once for a global command.
5302 * If global_busy is set, setpcmark() will not do anything.
5303 * If there is an error, global_busy will be incremented.
5305 setpcmark();
5307 /* When the command writes a message, don't overwrite the command. */
5308 msg_didout = TRUE;
5310 global_need_beginline = FALSE;
5311 global_busy = 1;
5312 old_lcount = curbuf->b_ml.ml_line_count;
5313 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5315 curwin->w_cursor.lnum = lnum;
5316 curwin->w_cursor.col = 0;
5317 if (*cmd == NUL || *cmd == '\n')
5318 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5319 else
5320 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5321 ui_breakcheck();
5324 global_busy = 0;
5325 if (global_need_beginline)
5326 beginline(BL_WHITE | BL_FIX);
5327 else
5328 check_cursor(); /* cursor may be beyond the end of the line */
5330 /* the cursor may not have moved in the text but a change in a previous
5331 * line may move it on the screen */
5332 changed_line_abv_curs();
5334 /* If it looks like no message was written, allow overwriting the
5335 * command with the report for number of changes. */
5336 if (msg_col == 0 && msg_scrolled == 0)
5337 msg_didout = FALSE;
5339 /* If substitutes done, report number of substitutes, otherwise report
5340 * number of extra or deleted lines. */
5341 if (!do_sub_msg(FALSE))
5342 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5345 #ifdef FEAT_VIMINFO
5347 read_viminfo_sub_string(virp, force)
5348 vir_T *virp;
5349 int force;
5351 if (old_sub != NULL && force)
5352 vim_free(old_sub);
5353 if (force || old_sub == NULL)
5354 old_sub = viminfo_readstring(virp, 1, TRUE);
5355 return viminfo_readline(virp);
5358 void
5359 write_viminfo_sub_string(fp)
5360 FILE *fp;
5362 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5364 fprintf(fp, _("\n# Last Substitute String:\n$"));
5365 viminfo_writestring(fp, old_sub);
5368 #endif /* FEAT_VIMINFO */
5370 #if defined(EXITFREE) || defined(PROTO)
5371 void
5372 free_old_sub()
5374 vim_free(old_sub);
5376 #endif
5378 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5380 * Set up for a tagpreview.
5381 * Return TRUE when it was created.
5384 prepare_tagpreview(undo_sync)
5385 int undo_sync; /* sync undo when leaving the window */
5387 win_T *wp;
5389 # ifdef FEAT_GUI
5390 need_mouse_correct = TRUE;
5391 # endif
5394 * If there is already a preview window open, use that one.
5396 if (!curwin->w_p_pvw)
5398 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5399 if (wp->w_p_pvw)
5400 break;
5401 if (wp != NULL)
5402 win_enter(wp, undo_sync);
5403 else
5406 * There is no preview window open yet. Create one.
5408 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5409 == FAIL)
5410 return FALSE;
5411 curwin->w_p_pvw = TRUE;
5412 curwin->w_p_wfh = TRUE;
5413 # ifdef FEAT_SCROLLBIND
5414 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5415 # endif
5416 # ifdef FEAT_DIFF
5417 curwin->w_p_diff = FALSE; /* no 'diff' */
5418 # endif
5419 # ifdef FEAT_FOLDING
5420 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5421 # endif
5422 return TRUE;
5425 return FALSE;
5428 #endif
5432 * ":help": open a read-only window on a help file
5434 void
5435 ex_help(eap)
5436 exarg_T *eap;
5438 char_u *arg;
5439 char_u *tag;
5440 FILE *helpfd; /* file descriptor of help file */
5441 int n;
5442 int i;
5443 #ifdef FEAT_WINDOWS
5444 win_T *wp;
5445 #endif
5446 int num_matches;
5447 char_u **matches;
5448 char_u *p;
5449 int empty_fnum = 0;
5450 int alt_fnum = 0;
5451 buf_T *buf;
5452 #ifdef FEAT_MULTI_LANG
5453 int len;
5454 char_u *lang;
5455 #endif
5457 if (eap != NULL)
5460 * A ":help" command ends at the first LF, or at a '|' that is
5461 * followed by some text. Set nextcmd to the following command.
5463 for (arg = eap->arg; *arg; ++arg)
5465 if (*arg == '\n' || *arg == '\r'
5466 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5468 *arg++ = NUL;
5469 eap->nextcmd = arg;
5470 break;
5473 arg = eap->arg;
5475 if (eap->forceit && *arg == NUL)
5477 EMSG(_("E478: Don't panic!"));
5478 return;
5481 if (eap->skip) /* not executing commands */
5482 return;
5484 else
5485 arg = (char_u *)"";
5487 /* remove trailing blanks */
5488 p = arg + STRLEN(arg) - 1;
5489 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5490 *p-- = NUL;
5492 #ifdef FEAT_MULTI_LANG
5493 /* Check for a specified language */
5494 lang = check_help_lang(arg);
5495 #endif
5497 /* When no argument given go to the index. */
5498 if (*arg == NUL)
5499 arg = (char_u *)"help.txt";
5502 * Check if there is a match for the argument.
5504 n = find_help_tags(arg, &num_matches, &matches,
5505 eap != NULL && eap->forceit);
5507 i = 0;
5508 #ifdef FEAT_MULTI_LANG
5509 if (n != FAIL && lang != NULL)
5510 /* Find first item with the requested language. */
5511 for (i = 0; i < num_matches; ++i)
5513 len = (int)STRLEN(matches[i]);
5514 if (len > 3 && matches[i][len - 3] == '@'
5515 && STRICMP(matches[i] + len - 2, lang) == 0)
5516 break;
5518 #endif
5519 if (i >= num_matches || n == FAIL)
5521 #ifdef FEAT_MULTI_LANG
5522 if (lang != NULL)
5523 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5524 else
5525 #endif
5526 EMSG2(_("E149: Sorry, no help for %s"), arg);
5527 if (n != FAIL)
5528 FreeWild(num_matches, matches);
5529 return;
5532 /* The first match (in the requested language) is the best match. */
5533 tag = vim_strsave(matches[i]);
5534 FreeWild(num_matches, matches);
5536 #ifdef FEAT_GUI
5537 need_mouse_correct = TRUE;
5538 #endif
5541 * Re-use an existing help window or open a new one.
5542 * Always open a new one for ":tab help".
5544 if (!curwin->w_buffer->b_help
5545 #ifdef FEAT_WINDOWS
5546 || cmdmod.tab != 0
5547 #endif
5550 #ifdef FEAT_WINDOWS
5551 if (cmdmod.tab != 0)
5552 wp = NULL;
5553 else
5554 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5555 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5556 break;
5557 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5558 win_enter(wp, TRUE);
5559 else
5560 #endif
5563 * There is no help window yet.
5564 * Try to open the file specified by the "helpfile" option.
5566 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5568 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5569 goto erret;
5571 fclose(helpfd);
5573 #ifdef FEAT_WINDOWS
5574 /* Split off help window; put it at far top if no position
5575 * specified, the current window is vertically split and
5576 * narrow. */
5577 n = WSP_HELP;
5578 # ifdef FEAT_VERTSPLIT
5579 if (cmdmod.split == 0 && curwin->w_width != Columns
5580 && curwin->w_width < 80)
5581 n |= WSP_TOP;
5582 # endif
5583 if (win_split(0, n) == FAIL)
5584 goto erret;
5585 #else
5586 /* use current window */
5587 if (!can_abandon(curbuf, FALSE))
5588 goto erret;
5589 #endif
5591 #ifdef FEAT_WINDOWS
5592 if (curwin->w_height < p_hh)
5593 win_setheight((int)p_hh);
5594 #endif
5597 * Open help file (do_ecmd() will set b_help flag, readfile() will
5598 * set b_p_ro flag).
5599 * Set the alternate file to the previously edited file.
5601 alt_fnum = curbuf->b_fnum;
5602 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5603 ECMD_HIDE + ECMD_SET_HELP);
5604 if (!cmdmod.keepalt)
5605 curwin->w_alt_fnum = alt_fnum;
5606 empty_fnum = curbuf->b_fnum;
5610 if (!p_im)
5611 restart_edit = 0; /* don't want insert mode in help file */
5613 if (tag != NULL)
5614 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5616 /* Delete the empty buffer if we're not using it. Careful: autocommands
5617 * may have jumped to another window, check that the buffer is not in a
5618 * window. */
5619 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5621 buf = buflist_findnr(empty_fnum);
5622 if (buf != NULL && buf->b_nwindows == 0)
5623 wipe_buffer(buf, TRUE);
5626 /* keep the previous alternate file */
5627 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5628 curwin->w_alt_fnum = alt_fnum;
5630 erret:
5631 vim_free(tag);
5635 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5637 * In an argument search for a language specifiers in the form "@xx".
5638 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5639 * Returns NULL if not found.
5641 char_u *
5642 check_help_lang(arg)
5643 char_u *arg;
5645 int len = (int)STRLEN(arg);
5647 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5648 && ASCII_ISALPHA(arg[len - 1]))
5650 arg[len - 3] = NUL; /* remove the '@' */
5651 return arg + len - 2;
5653 return NULL;
5655 #endif
5658 * Return a heuristic indicating how well the given string matches. The
5659 * smaller the number, the better the match. This is the order of priorities,
5660 * from best match to worst match:
5661 * - Match with least alpha-numeric characters is better.
5662 * - Match with least total characters is better.
5663 * - Match towards the start is better.
5664 * - Match starting with "+" is worse (feature instead of command)
5665 * Assumption is made that the matched_string passed has already been found to
5666 * match some string for which help is requested. webb.
5669 help_heuristic(matched_string, offset, wrong_case)
5670 char_u *matched_string;
5671 int offset; /* offset for match */
5672 int wrong_case; /* no matching case */
5674 int num_letters;
5675 char_u *p;
5677 num_letters = 0;
5678 for (p = matched_string; *p; p++)
5679 if (ASCII_ISALNUM(*p))
5680 num_letters++;
5683 * Multiply the number of letters by 100 to give it a much bigger
5684 * weighting than the number of characters.
5685 * If there only is a match while ignoring case, add 5000.
5686 * If the match starts in the middle of a word, add 10000 to put it
5687 * somewhere in the last half.
5688 * If the match is more than 2 chars from the start, multiply by 200 to
5689 * put it after matches at the start.
5691 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5692 && ASCII_ISALNUM(matched_string[offset - 1]))
5693 offset += 10000;
5694 else if (offset > 2)
5695 offset *= 200;
5696 if (wrong_case)
5697 offset += 5000;
5698 /* Features are less interesting than the subjects themselves, but "+"
5699 * alone is not a feature. */
5700 if (matched_string[0] == '+' && matched_string[1] != NUL)
5701 offset += 100;
5702 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5706 * Compare functions for qsort() below, that checks the help heuristics number
5707 * that has been put after the tagname by find_tags().
5709 static int
5710 #ifdef __BORLANDC__
5711 _RTLENTRYF
5712 #endif
5713 help_compare(s1, s2)
5714 const void *s1;
5715 const void *s2;
5717 char *p1;
5718 char *p2;
5720 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5721 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5722 return strcmp(p1, p2);
5726 * Find all help tags matching "arg", sort them and return in matches[], with
5727 * the number of matches in num_matches.
5728 * The matches will be sorted with a "best" match algorithm.
5729 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5732 find_help_tags(arg, num_matches, matches, keep_lang)
5733 char_u *arg;
5734 int *num_matches;
5735 char_u ***matches;
5736 int keep_lang;
5738 char_u *s, *d;
5739 int i;
5740 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5741 "/*", "/\\*", "\"*", "**",
5742 "/\\(\\)",
5743 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5744 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5745 "[count]", "[quotex]", "[range]",
5746 "[pattern]", "\\|", "\\%$"};
5747 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5748 "/star", "/\\\\star", "quotestar", "starstar",
5749 "/\\\\(\\\\)",
5750 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5751 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5752 "\\[count]", "\\[quotex]", "\\[range]",
5753 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5754 int flags;
5756 d = IObuff; /* assume IObuff is long enough! */
5759 * Recognize a few exceptions to the rule. Some strings that contain '*'
5760 * with "star". Otherwise '*' is recognized as a wildcard.
5762 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5763 if (STRCMP(arg, mtable[i]) == 0)
5765 STRCPY(d, rtable[i]);
5766 break;
5769 if (i < 0) /* no match in table */
5771 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5772 * Also replace "\%^" and "\%(", they match every tag too.
5773 * Also "\zs", "\z1", etc.
5774 * Also "\@<", "\@=", "\@<=", etc.
5775 * And also "\_$" and "\_^". */
5776 if (arg[0] == '\\'
5777 && ((arg[1] != NUL && arg[2] == NUL)
5778 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5779 && arg[2] != NUL)))
5781 STRCPY(d, "/\\\\");
5782 STRCPY(d + 3, arg + 1);
5783 /* Check for "/\\_$", should be "/\\_\$" */
5784 if (d[3] == '_' && d[4] == '$')
5785 STRCPY(d + 4, "\\$");
5787 else
5789 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5790 if (arg[0] == '[' && (arg[1] == ':'
5791 || (arg[1] == '+' && arg[2] == '+')))
5792 *d++ = '\\';
5794 for (s = arg; *s; ++s)
5797 * Replace "|" with "bar" and '"' with "quote" to match the name of
5798 * the tags for these commands.
5799 * Replace "*" with ".*" and "?" with "." to match command line
5800 * completion.
5801 * Insert a backslash before '~', '$' and '.' to avoid their
5802 * special meaning.
5804 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5805 break;
5806 switch (*s)
5808 case '|': STRCPY(d, "bar");
5809 d += 3;
5810 continue;
5811 case '"': STRCPY(d, "quote");
5812 d += 5;
5813 continue;
5814 case '*': *d++ = '.';
5815 break;
5816 case '?': *d++ = '.';
5817 continue;
5818 case '$':
5819 case '.':
5820 case '~': *d++ = '\\';
5821 break;
5825 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5826 * ":help i_^_CTRL-D" work.
5827 * Insert '-' before and after "CTRL-X" when applicable.
5829 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5830 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5832 if (d > IObuff && d[-1] != '_')
5833 *d++ = '_'; /* prepend a '_' */
5834 STRCPY(d, "CTRL-");
5835 d += 5;
5836 if (*s < ' ')
5838 #ifdef EBCDIC
5839 *d++ = CtrlChar(*s);
5840 #else
5841 *d++ = *s + '@';
5842 #endif
5843 if (d[-1] == '\\')
5844 *d++ = '\\'; /* double a backslash */
5846 else
5847 *d++ = *++s;
5848 if (s[1] != NUL && s[1] != '_')
5849 *d++ = '_'; /* append a '_' */
5850 continue;
5852 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5853 *d++ = '\\';
5856 * Insert a backslash before a backslash after a slash, for search
5857 * pattern tags: "/\|" --> "/\\|".
5859 else if (s[0] == '\\' && s[1] != '\\'
5860 && *arg == '/' && s == arg + 1)
5861 *d++ = '\\';
5863 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5864 * "CTRL-\_CTRL-N" */
5865 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5867 STRCPY(d, "CTRL-\\\\");
5868 d += 7;
5869 s += 6;
5872 *d++ = *s;
5875 * If tag starts with ', toss everything after a second '. Fixes
5876 * CTRL-] on 'option'. (would include the trailing '.').
5878 if (*s == '\'' && s > arg && *arg == '\'')
5879 break;
5881 *d = NUL;
5885 *matches = (char_u **)"";
5886 *num_matches = 0;
5887 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5888 if (keep_lang)
5889 flags |= TAG_KEEP_LANG;
5890 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5891 && *num_matches > 0)
5892 /* Sort the matches found on the heuristic number that is after the
5893 * tag name. */
5894 qsort((void *)*matches, (size_t)*num_matches,
5895 sizeof(char_u *), help_compare);
5896 return OK;
5900 * After reading a help file: May cleanup a help buffer when syntax
5901 * highlighting is not used.
5903 void
5904 fix_help_buffer()
5906 linenr_T lnum;
5907 char_u *line;
5908 int in_example = FALSE;
5909 int len;
5910 char_u *p;
5911 char_u *rt;
5912 int mustfree;
5914 /* set filetype to "help". */
5915 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5917 #ifdef FEAT_SYN_HL
5918 if (!syntax_present(curbuf))
5919 #endif
5921 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5923 line = ml_get_buf(curbuf, lnum, FALSE);
5924 len = (int)STRLEN(line);
5925 if (in_example && len > 0 && !vim_iswhite(line[0]))
5927 /* End of example: non-white or '<' in first column. */
5928 if (line[0] == '<')
5930 /* blank-out a '<' in the first column */
5931 line = ml_get_buf(curbuf, lnum, TRUE);
5932 line[0] = ' ';
5934 in_example = FALSE;
5936 if (!in_example && len > 0)
5938 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5940 /* blank-out a '>' in the last column (start of example) */
5941 line = ml_get_buf(curbuf, lnum, TRUE);
5942 line[len - 1] = ' ';
5943 in_example = TRUE;
5945 else if (line[len - 1] == '~')
5947 /* blank-out a '~' at the end of line (header marker) */
5948 line = ml_get_buf(curbuf, lnum, TRUE);
5949 line[len - 1] = ' ';
5956 * In the "help.txt" file, add the locally added help files.
5957 * This uses the very first line in the help file.
5959 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5961 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5963 line = ml_get_buf(curbuf, lnum, FALSE);
5964 if (strstr((char *)line, "*local-additions*") != NULL)
5966 /* Go through all directories in 'runtimepath', skipping
5967 * $VIMRUNTIME. */
5968 p = p_rtp;
5969 while (*p != NUL)
5971 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5972 mustfree = FALSE;
5973 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5974 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5976 int fcount;
5977 char_u **fnames;
5978 FILE *fd;
5979 char_u *s;
5980 int fi;
5981 #ifdef FEAT_MBYTE
5982 vimconv_T vc;
5983 char_u *cp;
5984 #endif
5986 /* Find all "doc/ *.txt" files in this directory. */
5987 add_pathsep(NameBuff);
5988 STRCAT(NameBuff, "doc/*.txt");
5989 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5990 &fnames, EW_FILE|EW_SILENT) == OK
5991 && fcount > 0)
5993 for (fi = 0; fi < fcount; ++fi)
5995 fd = mch_fopen((char *)fnames[fi], "r");
5996 if (fd != NULL)
5998 vim_fgets(IObuff, IOSIZE, fd);
5999 if (IObuff[0] == '*'
6000 && (s = vim_strchr(IObuff + 1, '*'))
6001 != NULL)
6003 #ifdef FEAT_MBYTE
6004 int this_utf = MAYBE;
6005 #endif
6006 /* Change tag definition to a
6007 * reference and remove <CR>/<NL>. */
6008 IObuff[0] = '|';
6009 *s = '|';
6010 while (*s != NUL)
6012 if (*s == '\r' || *s == '\n')
6013 *s = NUL;
6014 #ifdef FEAT_MBYTE
6015 /* The text is utf-8 when a byte
6016 * above 127 is found and no
6017 * illegal byte sequence is found.
6019 if (*s >= 0x80 && this_utf != FALSE)
6021 int l;
6023 this_utf = TRUE;
6024 l = utf_ptr2len(s);
6025 if (l == 1)
6026 this_utf = FALSE;
6027 s += l - 1;
6029 #endif
6030 ++s;
6032 #ifdef FEAT_MBYTE
6033 /* The help file is latin1 or utf-8;
6034 * conversion to the current
6035 * 'encoding' may be required. */
6036 vc.vc_type = CONV_NONE;
6037 convert_setup(&vc, (char_u *)(
6038 this_utf == TRUE ? "utf-8"
6039 : "latin1"), p_enc);
6040 if (vc.vc_type == CONV_NONE)
6041 /* No conversion needed. */
6042 cp = IObuff;
6043 else
6045 /* Do the conversion. If it fails
6046 * use the unconverted text. */
6047 cp = string_convert(&vc, IObuff,
6048 NULL);
6049 if (cp == NULL)
6050 cp = IObuff;
6052 convert_setup(&vc, NULL, NULL);
6054 ml_append(lnum, cp, (colnr_T)0, FALSE);
6055 if (cp != IObuff)
6056 vim_free(cp);
6057 #else
6058 ml_append(lnum, IObuff, (colnr_T)0,
6059 FALSE);
6060 #endif
6061 ++lnum;
6063 fclose(fd);
6066 FreeWild(fcount, fnames);
6069 if (mustfree)
6070 vim_free(rt);
6072 break;
6079 * ":exusage"
6081 /*ARGSUSED*/
6082 void
6083 ex_exusage(eap)
6084 exarg_T *eap;
6086 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6090 * ":viusage"
6092 /*ARGSUSED*/
6093 void
6094 ex_viusage(eap)
6095 exarg_T *eap;
6097 do_cmdline_cmd((char_u *)"help normal-index");
6100 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6101 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
6104 * ":helptags"
6106 void
6107 ex_helptags(eap)
6108 exarg_T *eap;
6110 garray_T ga;
6111 int i, j;
6112 int len;
6113 #ifdef FEAT_MULTI_LANG
6114 char_u lang[2];
6115 #endif
6116 expand_T xpc;
6117 char_u *dirname;
6118 char_u ext[5];
6119 char_u fname[8];
6120 int filecount;
6121 char_u **files;
6122 int add_help_tags = FALSE;
6124 /* Check for ":helptags ++t {dir}". */
6125 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6127 add_help_tags = TRUE;
6128 eap->arg = skipwhite(eap->arg + 3);
6131 ExpandInit(&xpc);
6132 xpc.xp_context = EXPAND_DIRECTORIES;
6133 dirname = ExpandOne(&xpc, eap->arg, NULL,
6134 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6135 if (dirname == NULL || !mch_isdir(dirname))
6137 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6138 return;
6141 #ifdef FEAT_MULTI_LANG
6142 /* Get a list of all files in the directory. */
6143 STRCPY(NameBuff, dirname);
6144 add_pathsep(NameBuff);
6145 STRCAT(NameBuff, "*");
6146 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6147 EW_FILE|EW_SILENT) == FAIL
6148 || filecount == 0)
6150 EMSG2("E151: No match: %s", NameBuff);
6151 vim_free(dirname);
6152 return;
6155 /* Go over all files in the directory to find out what languages are
6156 * present. */
6157 ga_init2(&ga, 1, 10);
6158 for (i = 0; i < filecount; ++i)
6160 len = (int)STRLEN(files[i]);
6161 if (len > 4)
6163 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6165 /* ".txt" -> language "en" */
6166 lang[0] = 'e';
6167 lang[1] = 'n';
6169 else if (files[i][len - 4] == '.'
6170 && ASCII_ISALPHA(files[i][len - 3])
6171 && ASCII_ISALPHA(files[i][len - 2])
6172 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6174 /* ".abx" -> language "ab" */
6175 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6176 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6178 else
6179 continue;
6181 /* Did we find this language already? */
6182 for (j = 0; j < ga.ga_len; j += 2)
6183 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6184 break;
6185 if (j == ga.ga_len)
6187 /* New language, add it. */
6188 if (ga_grow(&ga, 2) == FAIL)
6189 break;
6190 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6191 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6197 * Loop over the found languages to generate a tags file for each one.
6199 for (j = 0; j < ga.ga_len; j += 2)
6201 STRCPY(fname, "tags-xx");
6202 fname[5] = ((char_u *)ga.ga_data)[j];
6203 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6204 if (fname[5] == 'e' && fname[6] == 'n')
6206 /* English is an exception: use ".txt" and "tags". */
6207 fname[4] = NUL;
6208 STRCPY(ext, ".txt");
6210 else
6212 /* Language "ab" uses ".abx" and "tags-ab". */
6213 STRCPY(ext, ".xxx");
6214 ext[1] = fname[5];
6215 ext[2] = fname[6];
6217 helptags_one(dirname, ext, fname, add_help_tags);
6220 ga_clear(&ga);
6221 FreeWild(filecount, files);
6223 #else
6224 /* No language support, just use "*.txt" and "tags". */
6225 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6226 #endif
6227 vim_free(dirname);
6230 static void
6231 helptags_one(dir, ext, tagfname, add_help_tags)
6232 char_u *dir; /* doc directory */
6233 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6234 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6235 int add_help_tags; /* add "help-tags" tag */
6237 FILE *fd_tags;
6238 FILE *fd;
6239 garray_T ga;
6240 int filecount;
6241 char_u **files;
6242 char_u *p1, *p2;
6243 int fi;
6244 char_u *s;
6245 int i;
6246 char_u *fname;
6247 # ifdef FEAT_MBYTE
6248 int utf8 = MAYBE;
6249 int this_utf8;
6250 int firstline;
6251 int mix = FALSE; /* detected mixed encodings */
6252 # endif
6255 * Find all *.txt files.
6257 STRCPY(NameBuff, dir);
6258 add_pathsep(NameBuff);
6259 STRCAT(NameBuff, "*");
6260 STRCAT(NameBuff, ext);
6261 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6262 EW_FILE|EW_SILENT) == FAIL
6263 || filecount == 0)
6265 if (!got_int)
6266 EMSG2("E151: No match: %s", NameBuff);
6267 return;
6271 * Open the tags file for writing.
6272 * Do this before scanning through all the files.
6274 STRCPY(NameBuff, dir);
6275 add_pathsep(NameBuff);
6276 STRCAT(NameBuff, tagfname);
6277 fd_tags = mch_fopen((char *)NameBuff, "w");
6278 if (fd_tags == NULL)
6280 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6281 FreeWild(filecount, files);
6282 return;
6286 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6287 * add the "help-tags" tag.
6289 ga_init2(&ga, (int)sizeof(char_u *), 100);
6290 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6291 dir, FALSE) == FPC_SAME)
6293 if (ga_grow(&ga, 1) == FAIL)
6294 got_int = TRUE;
6295 else
6297 s = alloc(18 + (unsigned)STRLEN(tagfname));
6298 if (s == NULL)
6299 got_int = TRUE;
6300 else
6302 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6303 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6304 ++ga.ga_len;
6310 * Go over all the files and extract the tags.
6312 for (fi = 0; fi < filecount && !got_int; ++fi)
6314 fd = mch_fopen((char *)files[fi], "r");
6315 if (fd == NULL)
6317 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6318 continue;
6320 fname = gettail(files[fi]);
6322 # ifdef FEAT_MBYTE
6323 firstline = TRUE;
6324 # endif
6325 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6327 # ifdef FEAT_MBYTE
6328 if (firstline)
6330 /* Detect utf-8 file by a non-ASCII char in the first line. */
6331 this_utf8 = MAYBE;
6332 for (s = IObuff; *s != NUL; ++s)
6333 if (*s >= 0x80)
6335 int l;
6337 this_utf8 = TRUE;
6338 l = utf_ptr2len(s);
6339 if (l == 1)
6341 /* Illegal UTF-8 byte sequence. */
6342 this_utf8 = FALSE;
6343 break;
6345 s += l - 1;
6347 if (this_utf8 == MAYBE) /* only ASCII characters found */
6348 this_utf8 = FALSE;
6349 if (utf8 == MAYBE) /* first file */
6350 utf8 = this_utf8;
6351 else if (utf8 != this_utf8)
6353 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6354 mix = !got_int;
6355 got_int = TRUE;
6357 firstline = FALSE;
6359 # endif
6360 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6361 while (p1 != NULL)
6363 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6364 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6366 for (s = p1 + 1; s < p2; ++s)
6367 if (*s == ' ' || *s == '\t' || *s == '|')
6368 break;
6371 * Only accept a *tag* when it consists of valid
6372 * characters, there is white space before it and is
6373 * followed by a white character or end-of-line.
6375 if (s == p2
6376 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6377 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6378 || s[1] == '\0'))
6380 *p2 = '\0';
6381 ++p1;
6382 if (ga_grow(&ga, 1) == FAIL)
6384 got_int = TRUE;
6385 break;
6387 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6388 if (s == NULL)
6390 got_int = TRUE;
6391 break;
6393 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6394 ++ga.ga_len;
6395 sprintf((char *)s, "%s\t%s", p1, fname);
6397 /* find next '*' */
6398 p2 = vim_strchr(p2 + 1, '*');
6401 p1 = p2;
6403 line_breakcheck();
6406 fclose(fd);
6409 FreeWild(filecount, files);
6411 if (!got_int)
6414 * Sort the tags.
6416 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6419 * Check for duplicates.
6421 for (i = 1; i < ga.ga_len; ++i)
6423 p1 = ((char_u **)ga.ga_data)[i - 1];
6424 p2 = ((char_u **)ga.ga_data)[i];
6425 while (*p1 == *p2)
6427 if (*p2 == '\t')
6429 *p2 = NUL;
6430 vim_snprintf((char *)NameBuff, MAXPATHL,
6431 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6432 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6433 EMSG(NameBuff);
6434 *p2 = '\t';
6435 break;
6437 ++p1;
6438 ++p2;
6442 # ifdef FEAT_MBYTE
6443 if (utf8 == TRUE)
6444 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6445 # endif
6448 * Write the tags into the file.
6450 for (i = 0; i < ga.ga_len; ++i)
6452 s = ((char_u **)ga.ga_data)[i];
6453 if (STRNCMP(s, "help-tags\t", 10) == 0)
6454 /* help-tags entry was added in formatted form */
6455 fputs((char *)s, fd_tags);
6456 else
6458 fprintf(fd_tags, "%s\t/*", s);
6459 for (p1 = s; *p1 != '\t'; ++p1)
6461 /* insert backslash before '\\' and '/' */
6462 if (*p1 == '\\' || *p1 == '/')
6463 putc('\\', fd_tags);
6464 putc(*p1, fd_tags);
6466 fprintf(fd_tags, "*\n");
6470 #ifdef FEAT_MBYTE
6471 if (mix)
6472 got_int = FALSE; /* continue with other languages */
6473 #endif
6475 for (i = 0; i < ga.ga_len; ++i)
6476 vim_free(((char_u **)ga.ga_data)[i]);
6477 ga_clear(&ga);
6478 fclose(fd_tags); /* there is no check for an error... */
6480 #endif
6482 #if defined(FEAT_SIGNS) || defined(PROTO)
6485 * Struct to hold the sign properties.
6487 typedef struct sign sign_T;
6489 struct sign
6491 sign_T *sn_next; /* next sign in list */
6492 int sn_typenr; /* type number of sign (negative if not equal
6493 to name) */
6494 char_u *sn_name; /* name of sign */
6495 char_u *sn_icon; /* name of pixmap */
6496 #ifdef FEAT_SIGN_ICONS
6497 void *sn_image; /* icon image */
6498 #endif
6499 char_u *sn_text; /* text used instead of pixmap */
6500 int sn_line_hl; /* highlight ID for line */
6501 int sn_text_hl; /* highlight ID for text */
6504 static sign_T *first_sign = NULL;
6505 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6507 static void sign_list_defined __ARGS((sign_T *sp));
6510 * ":sign" command
6512 void
6513 ex_sign(eap)
6514 exarg_T *eap;
6516 char_u *arg = eap->arg;
6517 char_u *p;
6518 int idx;
6519 sign_T *sp;
6520 sign_T *sp_prev;
6521 buf_T *buf;
6522 static char *cmds[] = {
6523 "define",
6524 #define SIGNCMD_DEFINE 0
6525 "undefine",
6526 #define SIGNCMD_UNDEFINE 1
6527 "list",
6528 #define SIGNCMD_LIST 2
6529 "place",
6530 #define SIGNCMD_PLACE 3
6531 "unplace",
6532 #define SIGNCMD_UNPLACE 4
6533 "jump",
6534 #define SIGNCMD_JUMP 5
6535 #define SIGNCMD_LAST 6
6538 /* Parse the subcommand. */
6539 p = skiptowhite(arg);
6540 if (*p != NUL)
6541 *p++ = NUL;
6542 for (idx = 0; ; ++idx)
6544 if (idx == SIGNCMD_LAST)
6546 EMSG2(_("E160: Unknown sign command: %s"), arg);
6547 return;
6549 if (STRCMP(arg, cmds[idx]) == 0)
6550 break;
6552 arg = skipwhite(p);
6554 if (idx <= SIGNCMD_LIST)
6557 * Define, undefine or list signs.
6559 if (idx == SIGNCMD_LIST && *arg == NUL)
6561 /* ":sign list": list all defined signs */
6562 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6563 sign_list_defined(sp);
6565 else if (*arg == NUL)
6566 EMSG(_("E156: Missing sign name"));
6567 else
6569 p = skiptowhite(arg);
6570 if (*p != NUL)
6571 *p++ = NUL;
6572 sp_prev = NULL;
6573 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6575 if (STRCMP(sp->sn_name, arg) == 0)
6576 break;
6577 sp_prev = sp;
6579 if (idx == SIGNCMD_DEFINE)
6581 /* ":sign define {name} ...": define a sign */
6582 if (sp == NULL)
6584 /* Allocate a new sign. */
6585 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6586 if (sp == NULL)
6587 return;
6588 if (sp_prev == NULL)
6589 first_sign = sp;
6590 else
6591 sp_prev->sn_next = sp;
6592 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6594 /* If the name is a number use that for the typenr,
6595 * otherwise use a negative number. */
6596 if (VIM_ISDIGIT(*arg))
6597 sp->sn_typenr = atoi((char *)arg);
6598 else
6600 sign_T *lp;
6601 int start = last_sign_typenr;
6603 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6605 if (lp->sn_typenr == last_sign_typenr)
6607 --last_sign_typenr;
6608 if (last_sign_typenr == 0)
6609 last_sign_typenr = MAX_TYPENR;
6610 if (last_sign_typenr == start)
6612 EMSG(_("E612: Too many signs defined"));
6613 return;
6615 lp = first_sign;
6616 continue;
6620 sp->sn_typenr = last_sign_typenr--;
6621 if (last_sign_typenr == 0)
6622 last_sign_typenr = MAX_TYPENR; /* wrap around */
6626 /* set values for a defined sign. */
6627 for (;;)
6629 arg = skipwhite(p);
6630 if (*arg == NUL)
6631 break;
6632 p = skiptowhite_esc(arg);
6633 if (STRNCMP(arg, "icon=", 5) == 0)
6635 arg += 5;
6636 vim_free(sp->sn_icon);
6637 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6638 backslash_halve(sp->sn_icon);
6639 #ifdef FEAT_SIGN_ICONS
6640 if (gui.in_use)
6642 out_flush();
6643 if (sp->sn_image != NULL)
6644 gui_mch_destroy_sign(sp->sn_image);
6645 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6647 #endif
6649 else if (STRNCMP(arg, "text=", 5) == 0)
6651 char_u *s;
6652 int cells;
6653 int len;
6655 arg += 5;
6656 #ifdef FEAT_MBYTE
6657 /* Count cells and check for non-printable chars */
6658 if (has_mbyte)
6660 cells = 0;
6661 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6663 if (!vim_isprintc((*mb_ptr2char)(s)))
6664 break;
6665 cells += (*mb_ptr2cells)(s);
6668 else
6669 #endif
6671 for (s = arg; s < p; ++s)
6672 if (!vim_isprintc(*s))
6673 break;
6674 cells = (int)(s - arg);
6676 /* Currently must be one or two display cells */
6677 if (s != p || cells < 1 || cells > 2)
6679 *p = NUL;
6680 EMSG2(_("E239: Invalid sign text: %s"), arg);
6681 return;
6684 vim_free(sp->sn_text);
6685 /* Allocate one byte more if we need to pad up
6686 * with a space. */
6687 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6688 sp->sn_text = vim_strnsave(arg, len);
6690 if (sp->sn_text != NULL && cells == 1)
6691 STRCPY(sp->sn_text + len - 1, " ");
6693 else if (STRNCMP(arg, "linehl=", 7) == 0)
6695 arg += 7;
6696 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6698 else if (STRNCMP(arg, "texthl=", 7) == 0)
6700 arg += 7;
6701 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6703 else
6705 EMSG2(_(e_invarg2), arg);
6706 return;
6710 else if (sp == NULL)
6711 EMSG2(_("E155: Unknown sign: %s"), arg);
6712 else if (idx == SIGNCMD_LIST)
6713 /* ":sign list {name}" */
6714 sign_list_defined(sp);
6715 else
6717 /* ":sign undefine {name}" */
6718 vim_free(sp->sn_name);
6719 vim_free(sp->sn_icon);
6720 #ifdef FEAT_SIGN_ICONS
6721 if (sp->sn_image != NULL)
6723 out_flush();
6724 gui_mch_destroy_sign(sp->sn_image);
6726 #endif
6727 vim_free(sp->sn_text);
6728 if (sp_prev == NULL)
6729 first_sign = sp->sn_next;
6730 else
6731 sp_prev->sn_next = sp->sn_next;
6732 vim_free(sp);
6736 else
6738 int id = -1;
6739 linenr_T lnum = -1;
6740 char_u *sign_name = NULL;
6741 char_u *arg1;
6743 if (*arg == NUL)
6745 if (idx == SIGNCMD_PLACE)
6747 /* ":sign place": list placed signs in all buffers */
6748 sign_list_placed(NULL);
6750 else if (idx == SIGNCMD_UNPLACE)
6752 /* ":sign unplace": remove placed sign at cursor */
6753 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6754 if (id > 0)
6756 buf_delsign(curwin->w_buffer, id);
6757 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6759 else
6760 EMSG(_("E159: Missing sign number"));
6762 else
6763 EMSG(_(e_argreq));
6764 return;
6767 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6769 /* ":sign unplace *": remove all placed signs */
6770 buf_delete_all_signs();
6771 return;
6774 /* first arg could be placed sign id */
6775 arg1 = arg;
6776 if (VIM_ISDIGIT(*arg))
6778 id = getdigits(&arg);
6779 if (!vim_iswhite(*arg) && *arg != NUL)
6781 id = -1;
6782 arg = arg1;
6784 else
6786 arg = skipwhite(arg);
6787 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6789 /* ":sign unplace {id}": remove placed sign by number */
6790 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6791 if ((lnum = buf_delsign(buf, id)) != 0)
6792 update_debug_sign(buf, lnum);
6793 return;
6799 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6800 * Leave "arg" pointing to {fname}.
6802 for (;;)
6804 if (STRNCMP(arg, "line=", 5) == 0)
6806 arg += 5;
6807 lnum = atoi((char *)arg);
6808 arg = skiptowhite(arg);
6810 else if (STRNCMP(arg, "name=", 5) == 0)
6812 arg += 5;
6813 sign_name = arg;
6814 arg = skiptowhite(arg);
6815 if (*arg != NUL)
6816 *arg++ = NUL;
6818 else if (STRNCMP(arg, "file=", 5) == 0)
6820 arg += 5;
6821 buf = buflist_findname(arg);
6822 break;
6824 else if (STRNCMP(arg, "buffer=", 7) == 0)
6826 arg += 7;
6827 buf = buflist_findnr((int)getdigits(&arg));
6828 if (*skipwhite(arg) != NUL)
6829 EMSG(_(e_trailing));
6830 break;
6832 else
6834 EMSG(_(e_invarg));
6835 return;
6837 arg = skipwhite(arg);
6840 if (buf == NULL)
6842 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6844 else if (id <= 0)
6846 if (lnum >= 0 || sign_name != NULL)
6847 EMSG(_(e_invarg));
6848 else
6849 /* ":sign place file={fname}": list placed signs in one file */
6850 sign_list_placed(buf);
6852 else if (idx == SIGNCMD_JUMP)
6854 /* ":sign jump {id} file={fname}" */
6855 if (lnum >= 0 || sign_name != NULL)
6856 EMSG(_(e_invarg));
6857 else if ((lnum = buf_findsign(buf, id)) > 0)
6858 { /* goto a sign ... */
6859 if (buf_jump_open_win(buf) != NULL)
6860 { /* ... in a current window */
6861 curwin->w_cursor.lnum = lnum;
6862 check_cursor_lnum();
6863 beginline(BL_WHITE);
6865 else
6866 { /* ... not currently in a window */
6867 char_u *cmd;
6869 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6870 if (cmd == NULL)
6871 return;
6872 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6873 do_cmdline_cmd(cmd);
6874 vim_free(cmd);
6876 #ifdef FEAT_FOLDING
6877 foldOpenCursor();
6878 #endif
6880 else
6881 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6883 else if (idx == SIGNCMD_UNPLACE)
6885 /* ":sign unplace {id} file={fname}" */
6886 if (lnum >= 0 || sign_name != NULL)
6887 EMSG(_(e_invarg));
6888 else
6890 lnum = buf_delsign(buf, id);
6891 update_debug_sign(buf, lnum);
6894 /* idx == SIGNCMD_PLACE */
6895 else if (sign_name != NULL)
6897 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6898 if (STRCMP(sp->sn_name, sign_name) == 0)
6899 break;
6900 if (sp == NULL)
6902 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6903 return;
6905 if (lnum > 0)
6906 /* ":sign place {id} line={lnum} name={name} file={fname}":
6907 * place a sign */
6908 buf_addsign(buf, id, lnum, sp->sn_typenr);
6909 else
6910 /* ":sign place {id} file={fname}": change sign type */
6911 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6912 update_debug_sign(buf, lnum);
6914 else
6915 EMSG(_(e_invarg));
6919 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6921 * Allocate the icons. Called when the GUI has started. Allows defining
6922 * signs before it starts.
6924 void
6925 sign_gui_started()
6927 sign_T *sp;
6929 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6930 if (sp->sn_icon != NULL)
6931 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6933 #endif
6936 * List one sign.
6938 static void
6939 sign_list_defined(sp)
6940 sign_T *sp;
6942 char_u *p;
6944 smsg((char_u *)"sign %s", sp->sn_name);
6945 if (sp->sn_icon != NULL)
6947 MSG_PUTS(" icon=");
6948 msg_outtrans(sp->sn_icon);
6949 #ifdef FEAT_SIGN_ICONS
6950 if (sp->sn_image == NULL)
6951 MSG_PUTS(_(" (NOT FOUND)"));
6952 #else
6953 MSG_PUTS(_(" (not supported)"));
6954 #endif
6956 if (sp->sn_text != NULL)
6958 MSG_PUTS(" text=");
6959 msg_outtrans(sp->sn_text);
6961 if (sp->sn_line_hl > 0)
6963 MSG_PUTS(" linehl=");
6964 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6965 if (p == NULL)
6966 MSG_PUTS("NONE");
6967 else
6968 msg_puts(p);
6970 if (sp->sn_text_hl > 0)
6972 MSG_PUTS(" texthl=");
6973 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6974 if (p == NULL)
6975 MSG_PUTS("NONE");
6976 else
6977 msg_puts(p);
6982 * Get highlighting attribute for sign "typenr".
6983 * If "line" is TRUE: line highl, if FALSE: text highl.
6986 sign_get_attr(typenr, line)
6987 int typenr;
6988 int line;
6990 sign_T *sp;
6992 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6993 if (sp->sn_typenr == typenr)
6995 if (line)
6997 if (sp->sn_line_hl > 0)
6998 return syn_id2attr(sp->sn_line_hl);
7000 else
7002 if (sp->sn_text_hl > 0)
7003 return syn_id2attr(sp->sn_text_hl);
7005 break;
7007 return 0;
7011 * Get text mark for sign "typenr".
7012 * Returns NULL if there isn't one.
7014 char_u *
7015 sign_get_text(typenr)
7016 int typenr;
7018 sign_T *sp;
7020 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7021 if (sp->sn_typenr == typenr)
7022 return sp->sn_text;
7023 return NULL;
7026 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7027 void *
7028 sign_get_image(typenr)
7029 int typenr; /* the attribute which may have a sign */
7031 sign_T *sp;
7033 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7034 if (sp->sn_typenr == typenr)
7035 return sp->sn_image;
7036 return NULL;
7038 #endif
7041 * Get the name of a sign by its typenr.
7043 char_u *
7044 sign_typenr2name(typenr)
7045 int typenr;
7047 sign_T *sp;
7049 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7050 if (sp->sn_typenr == typenr)
7051 return sp->sn_name;
7052 return (char_u *)_("[Deleted]");
7055 #endif
7057 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7059 * ":drop"
7060 * Opens the first argument in a window. When there are two or more arguments
7061 * the argument list is redefined.
7063 void
7064 ex_drop(eap)
7065 exarg_T *eap;
7067 int split = FALSE;
7068 win_T *wp;
7069 buf_T *buf;
7070 # ifdef FEAT_WINDOWS
7071 tabpage_T *tp;
7072 # endif
7075 * Check if the first argument is already being edited in a window. If
7076 * so, jump to that window.
7077 * We would actually need to check all arguments, but that's complicated
7078 * and mostly only one file is dropped.
7079 * This also ignores wildcards, since it is very unlikely the user is
7080 * editing a file name with a wildcard character.
7082 set_arglist(eap->arg);
7085 * Expanding wildcards may result in an empty argument list. E.g. when
7086 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7087 * already did an error message for this.
7089 if (ARGCOUNT == 0)
7090 return;
7092 # ifdef FEAT_WINDOWS
7093 if (cmdmod.tab)
7095 /* ":tab drop file ...": open a tab for each argument that isn't
7096 * edited in a window yet. It's like ":tab all" but without closing
7097 * windows or tabs. */
7098 ex_all(eap);
7100 else
7101 # endif
7103 /* ":drop file ...": Edit the first argument. Jump to an existing
7104 * window if possible, edit in current window if the current buffer
7105 * can be abandoned, otherwise open a new window. */
7106 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7108 FOR_ALL_TAB_WINDOWS(tp, wp)
7110 if (wp->w_buffer == buf)
7112 # ifdef FEAT_WINDOWS
7113 goto_tabpage_win(tp, wp);
7114 # endif
7115 curwin->w_arg_idx = 0;
7116 return;
7121 * Check whether the current buffer is changed. If so, we will need
7122 * to split the current window or data could be lost.
7123 * Skip the check if the 'hidden' option is set, as in this case the
7124 * buffer won't be lost.
7126 if (!P_HID(curbuf))
7128 # ifdef FEAT_WINDOWS
7129 ++emsg_off;
7130 # endif
7131 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7132 # ifdef FEAT_WINDOWS
7133 --emsg_off;
7134 # else
7135 if (split)
7136 return;
7137 # endif
7140 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7141 if (split)
7143 eap->cmdidx = CMD_sfirst;
7144 eap->cmd[0] = 's';
7146 else
7147 eap->cmdidx = CMD_first;
7148 ex_rewind(eap);
7151 #endif