Merged from the latest developing branch.
[MacVim/KaoriYa.git] / src / ex_cmds.c
blob218ced0f76659bbdc17462bdfd941f4340b0e7e6
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 /* Create the shell command in allocated memory. */
1164 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1165 if (cmd_buf == NULL)
1166 goto filterend;
1168 windgoto((int)Rows - 1, 0);
1169 cursor_on();
1172 * When not redirecting the output the command can write anything to the
1173 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1174 * stderr output of external command. Clear the screen later.
1175 * If do_in is FALSE, this could be something like ":r !cat", which may
1176 * also mess up the screen, clear it later.
1178 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1179 redraw_later_clear();
1181 if (do_out)
1183 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1185 vim_free(cmd_buf);
1186 goto error;
1188 redraw_curbuf_later(VALID);
1190 read_linecount = curbuf->b_ml.ml_line_count;
1193 * When call_shell() fails wait_return() is called to give the user a
1194 * chance to read the error messages. Otherwise errors are ignored, so you
1195 * can see the error messages from the command that appear on stdout; use
1196 * 'u' to fix the text
1197 * Switch to cooked mode when not redirecting stdin, avoids that something
1198 * like ":r !cat" hangs.
1199 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1201 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1203 redraw_later_clear();
1204 wait_return(FALSE);
1206 vim_free(cmd_buf);
1208 did_check_timestamps = FALSE;
1209 need_check_timestamps = TRUE;
1211 /* When interrupting the shell command, it may still have produced some
1212 * useful output. Reset got_int here, so that readfile() won't cancel
1213 * reading. */
1214 ui_breakcheck();
1215 got_int = FALSE;
1217 if (do_out)
1219 if (otmp != NULL)
1221 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1222 eap, READ_FILTER) == FAIL)
1224 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1225 if (!aborting())
1226 #endif
1228 msg_putchar('\n');
1229 EMSG2(_(e_notread), otmp);
1231 goto error;
1233 #ifdef FEAT_AUTOCMD
1234 if (curbuf != old_curbuf)
1235 goto filterend;
1236 #endif
1239 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1241 if (shell_flags & SHELL_READ)
1243 curbuf->b_op_start.lnum = line2 + 1;
1244 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1245 appended_lines_mark(line2, read_linecount);
1248 if (do_in)
1250 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1252 if (read_linecount >= linecount)
1253 /* move all marks from old lines to new lines */
1254 mark_adjust(line1, line2, linecount, 0L);
1255 else
1257 /* move marks from old lines to new lines, delete marks
1258 * that are in deleted lines */
1259 mark_adjust(line1, line1 + read_linecount - 1,
1260 linecount, 0L);
1261 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1266 * Put cursor on first filtered line for ":range!cmd".
1267 * Adjust '[ and '] (set by buf_write()).
1269 curwin->w_cursor.lnum = line1;
1270 del_lines(linecount, TRUE);
1271 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1272 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1273 write_lnum_adjust(-linecount); /* adjust last line
1274 for next write */
1275 #ifdef FEAT_FOLDING
1276 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1277 #endif
1279 else
1282 * Put cursor on last new line for ":r !cmd".
1284 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1285 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1288 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1289 --no_wait_return;
1291 if (linecount > p_report)
1293 if (do_in)
1295 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1296 _("%ld lines filtered"), (long)linecount);
1297 if (msg(msg_buf) && !msg_scroll)
1298 /* save message to display it after redraw */
1299 set_keep_msg(msg_buf, 0);
1301 else
1302 msgmore((long)linecount);
1305 else
1307 error:
1308 /* put cursor back in same position for ":w !cmd" */
1309 curwin->w_cursor = cursor_save;
1310 --no_wait_return;
1311 wait_return(FALSE);
1314 filterend:
1316 #ifdef FEAT_AUTOCMD
1317 if (curbuf != old_curbuf)
1319 --no_wait_return;
1320 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1322 #endif
1323 if (itmp != NULL)
1324 mch_remove(itmp);
1325 if (otmp != NULL)
1326 mch_remove(otmp);
1327 vim_free(itmp);
1328 vim_free(otmp);
1332 * Call a shell to execute a command.
1333 * When "cmd" is NULL start an interactive shell.
1335 void
1336 do_shell(cmd, flags)
1337 char_u *cmd;
1338 int flags; /* may be SHELL_DOOUT when output is redirected */
1340 buf_T *buf;
1341 #ifndef FEAT_GUI_MSWIN
1342 int save_nwr;
1343 #endif
1344 #ifdef MSWIN
1345 int winstart = FALSE;
1346 #endif
1349 * Disallow shell commands for "rvim".
1350 * Disallow shell commands from .exrc and .vimrc in current directory for
1351 * security reasons.
1353 if (check_restricted() || check_secure())
1355 msg_end();
1356 return;
1359 #ifdef MSWIN
1361 * Check if external commands are allowed now.
1363 if (can_end_termcap_mode(TRUE) == FALSE)
1364 return;
1367 * Check if ":!start" is used.
1369 if (cmd != NULL)
1370 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1371 #endif
1374 * For autocommands we want to get the output on the current screen, to
1375 * avoid having to type return below.
1377 msg_putchar('\r'); /* put cursor at start of line */
1378 #ifdef FEAT_AUTOCMD
1379 if (!autocmd_busy)
1380 #endif
1382 #ifdef MSWIN
1383 if (!winstart)
1384 #endif
1385 stoptermcap();
1387 #ifdef MSWIN
1388 if (!winstart)
1389 #endif
1390 msg_putchar('\n'); /* may shift screen one line up */
1392 /* warning message before calling the shell */
1393 if (p_warn
1394 #ifdef FEAT_AUTOCMD
1395 && !autocmd_busy
1396 #endif
1397 && msg_silent == 0)
1398 for (buf = firstbuf; buf; buf = buf->b_next)
1399 if (bufIsChanged(buf))
1401 #ifdef FEAT_GUI_MSWIN
1402 if (!winstart)
1403 starttermcap(); /* don't want a message box here */
1404 #endif
1405 MSG_PUTS(_("[No write since last change]\n"));
1406 #ifdef FEAT_GUI_MSWIN
1407 if (!winstart)
1408 stoptermcap();
1409 #endif
1410 break;
1413 /* This windgoto is required for when the '\n' resulted in a "delete line
1414 * 1" command to the terminal. */
1415 if (!swapping_screen())
1416 windgoto(msg_row, msg_col);
1417 cursor_on();
1418 (void)call_shell(cmd, SHELL_COOKED | flags);
1419 did_check_timestamps = FALSE;
1420 need_check_timestamps = TRUE;
1423 * put the message cursor at the end of the screen, avoids wait_return()
1424 * to overwrite the text that the external command showed
1426 if (!swapping_screen())
1428 msg_row = Rows - 1;
1429 msg_col = 0;
1432 #ifdef FEAT_AUTOCMD
1433 if (autocmd_busy)
1435 if (msg_silent == 0)
1436 redraw_later_clear();
1438 else
1439 #endif
1442 * For ":sh" there is no need to call wait_return(), just redraw.
1443 * Also for the Win32 GUI (the output is in a console window).
1444 * Otherwise there is probably text on the screen that the user wants
1445 * to read before redrawing, so call wait_return().
1447 #ifndef FEAT_GUI_MSWIN
1448 if (cmd == NULL
1449 # ifdef WIN3264
1450 || (winstart && !need_wait_return)
1451 # endif
1454 if (msg_silent == 0)
1455 redraw_later_clear();
1456 need_wait_return = FALSE;
1458 else
1461 * If we switch screens when starttermcap() is called, we really
1462 * want to wait for "hit return to continue".
1464 save_nwr = no_wait_return;
1465 if (swapping_screen())
1466 no_wait_return = FALSE;
1467 # ifdef AMIGA
1468 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1469 # else
1470 wait_return(msg_silent == 0);
1471 # endif
1472 no_wait_return = save_nwr;
1474 #endif /* FEAT_GUI_W32 */
1476 #ifdef MSWIN
1477 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1478 #endif
1479 starttermcap(); /* start termcap if not done by wait_return() */
1482 * In an Amiga window redrawing is caused by asking the window size.
1483 * If we got an interrupt this will not work. The chance that the
1484 * window size is wrong is very small, but we need to redraw the
1485 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1486 * but it saves an extra redraw.
1488 #ifdef AMIGA
1489 if (skip_redraw) /* ':' hit in wait_return() */
1491 if (msg_silent == 0)
1492 redraw_later_clear();
1494 else if (term_console)
1496 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1497 if (got_int && msg_silent == 0)
1498 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1499 else
1500 must_redraw = 0; /* no extra redraw needed */
1502 #endif
1505 /* display any error messages now */
1506 display_errors();
1508 #ifdef FEAT_AUTOCMD
1509 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1510 #endif
1514 * Create a shell command from a command string, input redirection file and
1515 * output redirection file.
1516 * Returns an allocated string with the shell command, or NULL for failure.
1518 char_u *
1519 make_filter_cmd(cmd, itmp, otmp)
1520 char_u *cmd; /* command */
1521 char_u *itmp; /* NULL or name of input file */
1522 char_u *otmp; /* NULL or name of output file */
1524 char_u *buf;
1525 long_u len;
1527 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1528 if (itmp != NULL)
1529 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1530 if (otmp != NULL)
1531 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1532 buf = lalloc(len, TRUE);
1533 if (buf == NULL)
1534 return NULL;
1536 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1538 * Put braces around the command (for concatenated commands) when
1539 * redirecting input and/or output.
1541 if (itmp != NULL || otmp != NULL)
1542 sprintf((char *)buf, "(%s)", (char *)cmd);
1543 else
1544 STRCPY(buf, cmd);
1545 if (itmp != NULL)
1547 STRCAT(buf, " < ");
1548 STRCAT(buf, itmp);
1550 #else
1552 * for shells that don't understand braces around commands, at least allow
1553 * the use of commands in a pipe.
1555 STRCPY(buf, cmd);
1556 if (itmp != NULL)
1558 char_u *p;
1561 * If there is a pipe, we have to put the '<' in front of it.
1562 * Don't do this when 'shellquote' is not empty, otherwise the
1563 * redirection would be inside the quotes.
1565 if (*p_shq == NUL)
1567 p = vim_strchr(buf, '|');
1568 if (p != NULL)
1569 *p = NUL;
1571 # ifdef RISCOS
1572 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1573 STRCAT(buf, itmp);
1574 STRCAT(buf, " } ");
1575 # else
1576 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1577 STRCAT(buf, itmp);
1578 # endif
1579 if (*p_shq == NUL)
1581 p = vim_strchr(cmd, '|');
1582 if (p != NULL)
1584 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1585 STRCAT(buf, p);
1589 #endif
1590 if (otmp != NULL)
1591 append_redir(buf, p_srr, otmp);
1593 return buf;
1597 * Append output redirection for file "fname" to the end of string buffer "buf"
1598 * Works with the 'shellredir' and 'shellpipe' options.
1599 * The caller should make sure that there is enough room:
1600 * STRLEN(opt) + STRLEN(fname) + 3
1602 void
1603 append_redir(buf, opt, fname)
1604 char_u *buf;
1605 char_u *opt;
1606 char_u *fname;
1608 char_u *p;
1610 buf += STRLEN(buf);
1611 /* find "%s", skipping "%%" */
1612 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1613 if (p[1] == 's')
1614 break;
1615 if (p != NULL)
1617 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1618 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1620 else
1621 sprintf((char *)buf,
1622 #ifdef FEAT_QUICKFIX
1623 # ifndef RISCOS
1624 opt != p_sp ? " %s%s" :
1625 # endif
1626 " %s %s",
1627 #else
1628 # ifndef RISCOS
1629 " %s%s", /* " > %s" causes problems on Amiga */
1630 # else
1631 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1632 # endif
1633 #endif
1634 (char *)opt, (char *)fname);
1637 #ifdef FEAT_VIMINFO
1639 static int no_viminfo __ARGS((void));
1640 static int viminfo_errcnt;
1642 static int
1643 no_viminfo()
1645 /* "vim -i NONE" does not read or write a viminfo file */
1646 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1650 * Report an error for reading a viminfo file.
1651 * Count the number of errors. When there are more than 10, return TRUE.
1654 viminfo_error(errnum, message, line)
1655 char *errnum;
1656 char *message;
1657 char_u *line;
1659 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1660 errnum, message);
1661 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1662 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1663 IObuff[STRLEN(IObuff) - 1] = NUL;
1664 emsg(IObuff);
1665 if (++viminfo_errcnt >= 10)
1667 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1668 return TRUE;
1670 return FALSE;
1674 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1675 * set are not over-written unless force is TRUE. -- webb
1678 read_viminfo(file, want_info, want_marks, forceit)
1679 char_u *file;
1680 int want_info;
1681 int want_marks;
1682 int forceit;
1684 FILE *fp;
1685 char_u *fname;
1687 if (no_viminfo())
1688 return FAIL;
1690 fname = viminfo_filename(file); /* may set to default if NULL */
1691 if (fname == NULL)
1692 return FAIL;
1693 fp = mch_fopen((char *)fname, READBIN);
1695 if (p_verbose > 0)
1697 verbose_enter();
1698 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1699 fname,
1700 want_info ? _(" info") : "",
1701 want_marks ? _(" marks") : "",
1702 fp == NULL ? _(" FAILED") : "");
1703 verbose_leave();
1706 vim_free(fname);
1707 if (fp == NULL)
1708 return FAIL;
1710 viminfo_errcnt = 0;
1711 do_viminfo(fp, NULL, want_info, want_marks, forceit);
1713 fclose(fp);
1715 return OK;
1719 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1720 * that effectively a merge of current info and old info is done. This allows
1721 * multiple vims to run simultaneously, without losing any marks etc. If
1722 * forceit is TRUE, then the old file is not read in, and only internal info is
1723 * written to the file. -- webb
1725 void
1726 write_viminfo(file, forceit)
1727 char_u *file;
1728 int forceit;
1730 char_u *fname;
1731 FILE *fp_in = NULL; /* input viminfo file, if any */
1732 FILE *fp_out = NULL; /* output viminfo file */
1733 char_u *tempname = NULL; /* name of temp viminfo file */
1734 struct stat st_new; /* mch_stat() of potential new file */
1735 char_u *wp;
1736 #if defined(UNIX) || defined(VMS)
1737 mode_t umask_save;
1738 #endif
1739 #ifdef UNIX
1740 int shortname = FALSE; /* use 8.3 file name */
1741 struct stat st_old; /* mch_stat() of existing viminfo file */
1742 #endif
1743 #ifdef WIN3264
1744 long perm = -1;
1745 #endif
1747 if (no_viminfo())
1748 return;
1750 fname = viminfo_filename(file); /* may set to default if NULL */
1751 if (fname == NULL)
1752 return;
1754 fp_in = mch_fopen((char *)fname, READBIN);
1755 if (fp_in == NULL)
1757 /* if it does exist, but we can't read it, don't try writing */
1758 if (mch_stat((char *)fname, &st_new) == 0)
1759 goto end;
1760 #if defined(UNIX) || defined(VMS)
1762 * For Unix we create the .viminfo non-accessible for others,
1763 * because it may contain text from non-accessible documents.
1765 umask_save = umask(077);
1766 #endif
1767 fp_out = mch_fopen((char *)fname, WRITEBIN);
1768 #if defined(UNIX) || defined(VMS)
1769 (void)umask(umask_save);
1770 #endif
1772 else
1775 * There is an existing viminfo file. Create a temporary file to
1776 * write the new viminfo into, in the same directory as the
1777 * existing viminfo file, which will be renamed later.
1779 #ifdef UNIX
1781 * For Unix we check the owner of the file. It's not very nice to
1782 * overwrite a user's viminfo file after a "su root", with a
1783 * viminfo file that the user can't read.
1785 st_old.st_dev = 0;
1786 st_old.st_ino = 0;
1787 st_old.st_mode = 0600;
1788 if (mch_stat((char *)fname, &st_old) == 0
1789 && getuid() != ROOT_UID
1790 && !(st_old.st_uid == getuid()
1791 ? (st_old.st_mode & 0200)
1792 : (st_old.st_gid == getgid()
1793 ? (st_old.st_mode & 0020)
1794 : (st_old.st_mode & 0002))))
1796 int tt = msg_didany;
1798 /* avoid a wait_return for this message, it's annoying */
1799 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1800 msg_didany = tt;
1801 fclose(fp_in);
1802 goto end;
1804 #endif
1805 #ifdef WIN3264
1806 /* Get the file attributes of the existing viminfo file. */
1807 perm = mch_getperm(fname);
1808 #endif
1811 * Make tempname.
1812 * May try twice: Once normal and once with shortname set, just in
1813 * case somebody puts his viminfo file in an 8.3 filesystem.
1815 for (;;)
1817 tempname = buf_modname(
1818 #ifdef UNIX
1819 shortname,
1820 #else
1821 # ifdef SHORT_FNAME
1822 TRUE,
1823 # else
1824 # ifdef FEAT_GUI_W32
1825 gui_is_win32s(),
1826 # else
1827 FALSE,
1828 # endif
1829 # endif
1830 #endif
1831 fname,
1832 #ifdef VMS
1833 (char_u *)"-tmp",
1834 #else
1835 # ifdef RISCOS
1836 (char_u *)"/tmp",
1837 # else
1838 (char_u *)".tmp",
1839 # endif
1840 #endif
1841 FALSE);
1842 if (tempname == NULL) /* out of memory */
1843 break;
1846 * Check if tempfile already exists. Never overwrite an
1847 * existing file!
1849 if (mch_stat((char *)tempname, &st_new) == 0)
1851 #ifdef UNIX
1853 * Check if tempfile is same as original file. May happen
1854 * when modname() gave the same file back. E.g. silly
1855 * link, or file name-length reached. Try again with
1856 * shortname set.
1858 if (!shortname && st_new.st_dev == st_old.st_dev
1859 && st_new.st_ino == st_old.st_ino)
1861 vim_free(tempname);
1862 tempname = NULL;
1863 shortname = TRUE;
1864 continue;
1866 #endif
1868 * Try another name. Change one character, just before
1869 * the extension. This should also work for an 8.3
1870 * file name, when after adding the extension it still is
1871 * the same file as the original.
1873 wp = tempname + STRLEN(tempname) - 5;
1874 if (wp < gettail(tempname)) /* empty file name? */
1875 wp = gettail(tempname);
1876 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1877 --*wp)
1880 * They all exist? Must be something wrong! Don't
1881 * write the viminfo file then.
1883 if (*wp == 'a')
1885 vim_free(tempname);
1886 tempname = NULL;
1887 break;
1891 break;
1894 if (tempname != NULL)
1896 #ifdef VMS
1897 /* fdopen() fails for some reason */
1898 umask_save = umask(077);
1899 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1900 (void)umask(umask_save);
1901 #else
1902 int fd;
1904 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1905 * protection:
1906 * Unix: same as original file, but strip s-bit. Reset umask to
1907 * avoid it getting in the way.
1908 * Others: r&w for user only. */
1909 # ifdef UNIX
1910 umask_save = umask(0);
1911 fd = mch_open((char *)tempname,
1912 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1913 (int)((st_old.st_mode & 0777) | 0600));
1914 (void)umask(umask_save);
1915 # else
1916 fd = mch_open((char *)tempname,
1917 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1918 # endif
1919 if (fd < 0)
1920 fp_out = NULL;
1921 else
1922 fp_out = fdopen(fd, WRITEBIN);
1923 #endif /* VMS */
1926 * If we can't create in the same directory, try creating a
1927 * "normal" temp file.
1929 if (fp_out == NULL)
1931 vim_free(tempname);
1932 if ((tempname = vim_tempname('o')) != NULL)
1933 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1936 #if defined(UNIX) && defined(HAVE_FCHOWN)
1938 * Make sure the owner can read/write it. This only works for
1939 * root.
1941 if (fp_out != NULL)
1942 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1943 #endif
1948 * Check if the new viminfo file can be written to.
1950 if (fp_out == NULL)
1952 EMSG2(_("E138: Can't write viminfo file %s!"),
1953 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1954 if (fp_in != NULL)
1955 fclose(fp_in);
1956 goto end;
1959 if (p_verbose > 0)
1961 verbose_enter();
1962 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1963 verbose_leave();
1966 viminfo_errcnt = 0;
1967 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1969 fclose(fp_out); /* errors are ignored !? */
1970 if (fp_in != NULL)
1972 fclose(fp_in);
1975 * In case of an error keep the original viminfo file.
1976 * Otherwise rename the newly written file.
1978 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1979 mch_remove(tempname);
1981 #ifdef WIN3264
1982 /* If the viminfo file was hidden then also hide the new file. */
1983 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1984 mch_hide(fname);
1985 #endif
1988 end:
1989 vim_free(fname);
1990 vim_free(tempname);
1994 * Get the viminfo file name to use.
1995 * If "file" is given and not empty, use it (has already been expanded by
1996 * cmdline functions).
1997 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1998 * expand environment variables.
1999 * Returns an allocated string. NULL when out of memory.
2001 static char_u *
2002 viminfo_filename(file)
2003 char_u *file;
2005 if (file == NULL || *file == NUL)
2007 if (use_viminfo != NULL)
2008 file = use_viminfo;
2009 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2011 #ifdef VIMINFO_FILE2
2012 /* don't use $HOME when not defined (turned into "c:/"!). */
2013 # ifdef VMS
2014 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2015 # else
2016 if (mch_getenv((char_u *)"HOME") == NULL)
2017 # endif
2019 /* don't use $VIM when not available. */
2020 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2021 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2022 file = (char_u *)VIMINFO_FILE2;
2023 else
2024 file = (char_u *)VIMINFO_FILE;
2026 else
2027 #endif
2028 file = (char_u *)VIMINFO_FILE;
2030 expand_env(file, NameBuff, MAXPATHL);
2031 file = NameBuff;
2033 return vim_strsave(file);
2037 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2039 static void
2040 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2041 FILE *fp_in;
2042 FILE *fp_out;
2043 int want_info;
2044 int want_marks;
2045 int force_read;
2047 int count = 0;
2048 int eof = FALSE;
2049 vir_T vir;
2051 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2052 return;
2053 vir.vir_fd = fp_in;
2054 #ifdef FEAT_MBYTE
2055 vir.vir_conv.vc_type = CONV_NONE;
2056 #endif
2058 if (fp_in != NULL)
2060 if (want_info)
2061 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2062 else
2063 /* Skip info, find start of marks */
2064 while (!(eof = viminfo_readline(&vir))
2065 && vir.vir_line[0] != '>')
2068 if (fp_out != NULL)
2070 /* Write the info: */
2071 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2072 VIM_VERSION_MEDIUM);
2073 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2074 #ifdef FEAT_MBYTE
2075 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2076 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2077 #endif
2078 write_viminfo_search_pattern(fp_out);
2079 write_viminfo_sub_string(fp_out);
2080 #ifdef FEAT_CMDHIST
2081 write_viminfo_history(fp_out);
2082 #endif
2083 write_viminfo_registers(fp_out);
2084 #ifdef FEAT_EVAL
2085 write_viminfo_varlist(fp_out);
2086 #endif
2087 write_viminfo_filemarks(fp_out);
2088 write_viminfo_bufferlist(fp_out);
2089 count = write_viminfo_marks(fp_out);
2091 if (fp_in != NULL && want_marks)
2092 copy_viminfo_marks(&vir, fp_out, count, eof);
2094 vim_free(vir.vir_line);
2095 #ifdef FEAT_MBYTE
2096 if (vir.vir_conv.vc_type != CONV_NONE)
2097 convert_setup(&vir.vir_conv, NULL, NULL);
2098 #endif
2102 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2103 * first part of the viminfo file which contains everything but the marks that
2104 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2106 static int
2107 read_viminfo_up_to_marks(virp, forceit, writing)
2108 vir_T *virp;
2109 int forceit;
2110 int writing;
2112 int eof;
2113 buf_T *buf;
2115 #ifdef FEAT_CMDHIST
2116 prepare_viminfo_history(forceit ? 9999 : 0);
2117 #endif
2118 eof = viminfo_readline(virp);
2119 while (!eof && virp->vir_line[0] != '>')
2121 switch (virp->vir_line[0])
2123 /* Characters reserved for future expansion, ignored now */
2124 case '+': /* "+40 /path/dir file", for running vim without args */
2125 case '|': /* to be defined */
2126 case '^': /* to be defined */
2127 case '<': /* long line - ignored */
2128 /* A comment or empty line. */
2129 case NUL:
2130 case '\r':
2131 case '\n':
2132 case '#':
2133 eof = viminfo_readline(virp);
2134 break;
2135 case '*': /* "*encoding=value" */
2136 eof = viminfo_encoding(virp);
2137 break;
2138 case '!': /* global variable */
2139 #ifdef FEAT_EVAL
2140 eof = read_viminfo_varlist(virp, writing);
2141 #else
2142 eof = viminfo_readline(virp);
2143 #endif
2144 break;
2145 case '%': /* entry for buffer list */
2146 eof = read_viminfo_bufferlist(virp, writing);
2147 break;
2148 case '"':
2149 eof = read_viminfo_register(virp, forceit);
2150 break;
2151 case '/': /* Search string */
2152 case '&': /* Substitute search string */
2153 case '~': /* Last search string, followed by '/' or '&' */
2154 eof = read_viminfo_search_pattern(virp, forceit);
2155 break;
2156 case '$':
2157 eof = read_viminfo_sub_string(virp, forceit);
2158 break;
2159 case ':':
2160 case '?':
2161 case '=':
2162 case '@':
2163 #ifdef FEAT_CMDHIST
2164 eof = read_viminfo_history(virp);
2165 #else
2166 eof = viminfo_readline(virp);
2167 #endif
2168 break;
2169 case '-':
2170 case '\'':
2171 eof = read_viminfo_filemark(virp, forceit);
2172 break;
2173 default:
2174 if (viminfo_error("E575: ", _("Illegal starting char"),
2175 virp->vir_line))
2176 eof = TRUE;
2177 else
2178 eof = viminfo_readline(virp);
2179 break;
2183 #ifdef FEAT_CMDHIST
2184 /* Finish reading history items. */
2185 finish_viminfo_history();
2186 #endif
2188 /* Change file names to buffer numbers for fmarks. */
2189 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2190 fmarks_check_names(buf);
2192 return eof;
2196 * Compare the 'encoding' value in the viminfo file with the current value of
2197 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2198 * conversion of text with iconv() in viminfo_readstring().
2200 static int
2201 viminfo_encoding(virp)
2202 vir_T *virp;
2204 #ifdef FEAT_MBYTE
2205 char_u *p;
2206 int i;
2208 if (get_viminfo_parameter('c') != 0)
2210 p = vim_strchr(virp->vir_line, '=');
2211 if (p != NULL)
2213 /* remove trailing newline */
2214 ++p;
2215 for (i = 0; vim_isprintc(p[i]); ++i)
2217 p[i] = NUL;
2219 convert_setup(&virp->vir_conv, p, p_enc);
2222 #endif
2223 return viminfo_readline(virp);
2227 * Read a line from the viminfo file.
2228 * Returns TRUE for end-of-file;
2231 viminfo_readline(virp)
2232 vir_T *virp;
2234 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2238 * check string read from viminfo file
2239 * remove '\n' at the end of the line
2240 * - replace CTRL-V CTRL-V with CTRL-V
2241 * - replace CTRL-V 'n' with '\n'
2243 * Check for a long line as written by viminfo_writestring().
2245 * Return the string in allocated memory (NULL when out of memory).
2247 /*ARGSUSED*/
2248 char_u *
2249 viminfo_readstring(virp, off, convert)
2250 vir_T *virp;
2251 int off; /* offset for virp->vir_line */
2252 int convert; /* convert the string */
2254 char_u *retval;
2255 char_u *s, *d;
2256 long len;
2258 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2260 len = atol((char *)virp->vir_line + off + 1);
2261 retval = lalloc(len, TRUE);
2262 if (retval == NULL)
2264 /* Line too long? File messed up? Skip next line. */
2265 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2266 return NULL;
2268 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2269 s = retval + 1; /* Skip the leading '<' */
2271 else
2273 retval = vim_strsave(virp->vir_line + off);
2274 if (retval == NULL)
2275 return NULL;
2276 s = retval;
2279 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2280 d = retval;
2281 while (*s != NUL && *s != '\n')
2283 if (s[0] == Ctrl_V && s[1] != NUL)
2285 if (s[1] == 'n')
2286 *d++ = '\n';
2287 else
2288 *d++ = Ctrl_V;
2289 s += 2;
2291 else
2292 *d++ = *s++;
2294 *d = NUL;
2296 #ifdef FEAT_MBYTE
2297 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2299 d = string_convert(&virp->vir_conv, retval, NULL);
2300 if (d != NULL)
2302 vim_free(retval);
2303 retval = d;
2306 #endif
2308 return retval;
2312 * write string to viminfo file
2313 * - replace CTRL-V with CTRL-V CTRL-V
2314 * - replace '\n' with CTRL-V 'n'
2315 * - add a '\n' at the end
2317 * For a long line:
2318 * - write " CTRL-V <length> \n " in first line
2319 * - write " < <string> \n " in second line
2321 void
2322 viminfo_writestring(fd, p)
2323 FILE *fd;
2324 char_u *p;
2326 int c;
2327 char_u *s;
2328 int len = 0;
2330 for (s = p; *s != NUL; ++s)
2332 if (*s == Ctrl_V || *s == '\n')
2333 ++len;
2334 ++len;
2337 /* If the string will be too long, write its length and put it in the next
2338 * line. Take into account that some room is needed for what comes before
2339 * the string (e.g., variable name). Add something to the length for the
2340 * '<', NL and trailing NUL. */
2341 if (len > LSIZE / 2)
2342 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2344 while ((c = *p++) != NUL)
2346 if (c == Ctrl_V || c == '\n')
2348 putc(Ctrl_V, fd);
2349 if (c == '\n')
2350 c = 'n';
2352 putc(c, fd);
2354 putc('\n', fd);
2356 #endif /* FEAT_VIMINFO */
2359 * Implementation of ":fixdel", also used by get_stty().
2360 * <BS> resulting <Del>
2361 * ^? ^H
2362 * not ^? ^?
2364 /*ARGSUSED*/
2365 void
2366 do_fixdel(eap)
2367 exarg_T *eap;
2369 char_u *p;
2371 p = find_termcode((char_u *)"kb");
2372 add_termcode((char_u *)"kD", p != NULL
2373 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2376 void
2377 print_line_no_prefix(lnum, use_number, list)
2378 linenr_T lnum;
2379 int use_number;
2380 int list;
2382 char_u numbuf[30];
2384 if (curwin->w_p_nu || use_number)
2386 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2387 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2389 msg_prt_line(ml_get(lnum), list);
2393 * Print a text line. Also in silent mode ("ex -s").
2395 void
2396 print_line(lnum, use_number, list)
2397 linenr_T lnum;
2398 int use_number;
2399 int list;
2401 int save_silent = silent_mode;
2403 msg_start();
2404 silent_mode = FALSE;
2405 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2406 print_line_no_prefix(lnum, use_number, list);
2407 if (save_silent)
2409 msg_putchar('\n');
2410 cursor_on(); /* msg_start() switches it off */
2411 out_flush();
2412 silent_mode = save_silent;
2413 info_message = FALSE;
2418 * ":file[!] [fname]".
2420 void
2421 ex_file(eap)
2422 exarg_T *eap;
2424 char_u *fname, *sfname, *xfname;
2425 buf_T *buf;
2427 /* ":0file" removes the file name. Check for illegal uses ":3file",
2428 * "0file name", etc. */
2429 if (eap->addr_count > 0
2430 && (*eap->arg != NUL
2431 || eap->line2 > 0
2432 || eap->addr_count > 1))
2434 EMSG(_(e_invarg));
2435 return;
2438 if (*eap->arg != NUL || eap->addr_count == 1)
2440 #ifdef FEAT_AUTOCMD
2441 buf = curbuf;
2442 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2443 /* buffer changed, don't change name now */
2444 if (buf != curbuf)
2445 return;
2446 # ifdef FEAT_EVAL
2447 if (aborting()) /* autocmds may abort script processing */
2448 return;
2449 # endif
2450 #endif
2452 * The name of the current buffer will be changed.
2453 * A new (unlisted) buffer entry needs to be made to hold the old file
2454 * name, which will become the alternate file name.
2455 * But don't set the alternate file name if the buffer didn't have a
2456 * name.
2458 fname = curbuf->b_ffname;
2459 sfname = curbuf->b_sfname;
2460 xfname = curbuf->b_fname;
2461 curbuf->b_ffname = NULL;
2462 curbuf->b_sfname = NULL;
2463 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2465 curbuf->b_ffname = fname;
2466 curbuf->b_sfname = sfname;
2467 return;
2469 curbuf->b_flags |= BF_NOTEDITED;
2470 if (xfname != NULL && *xfname != NUL)
2472 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2473 if (buf != NULL && !cmdmod.keepalt)
2474 curwin->w_alt_fnum = buf->b_fnum;
2476 vim_free(fname);
2477 vim_free(sfname);
2478 #ifdef FEAT_AUTOCMD
2479 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2480 #endif
2481 /* Change directories when the 'acd' option is set. */
2482 DO_AUTOCHDIR
2484 /* print full file name if :cd used */
2485 fileinfo(FALSE, FALSE, eap->forceit);
2489 * ":update".
2491 void
2492 ex_update(eap)
2493 exarg_T *eap;
2495 if (curbufIsChanged())
2496 (void)do_write(eap);
2500 * ":write" and ":saveas".
2502 void
2503 ex_write(eap)
2504 exarg_T *eap;
2506 if (eap->usefilter) /* input lines to shell command */
2507 do_bang(1, eap, FALSE, TRUE, FALSE);
2508 else
2509 (void)do_write(eap);
2513 * write current buffer to file 'eap->arg'
2514 * if 'eap->append' is TRUE, append to the file
2516 * if *eap->arg == NUL write to current file
2518 * return FAIL for failure, OK otherwise
2521 do_write(eap)
2522 exarg_T *eap;
2524 int other;
2525 char_u *fname = NULL; /* init to shut up gcc */
2526 char_u *ffname;
2527 int retval = FAIL;
2528 char_u *free_fname = NULL;
2529 #ifdef FEAT_BROWSE
2530 char_u *browse_file = NULL;
2531 #endif
2532 buf_T *alt_buf = NULL;
2534 if (not_writing()) /* check 'write' option */
2535 return FAIL;
2537 ffname = eap->arg;
2538 #ifdef FEAT_BROWSE
2539 if (cmdmod.browse)
2541 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2542 NULL, NULL, NULL, curbuf);
2543 if (browse_file == NULL)
2544 goto theend;
2545 ffname = browse_file;
2547 #endif
2548 if (*ffname == NUL)
2550 if (eap->cmdidx == CMD_saveas)
2552 EMSG(_(e_argreq));
2553 goto theend;
2555 other = FALSE;
2557 else
2559 fname = ffname;
2560 free_fname = fix_fname(ffname);
2562 * When out-of-memory, keep unexpanded file name, because we MUST be
2563 * able to write the file in this situation.
2565 if (free_fname != NULL)
2566 ffname = free_fname;
2567 other = otherfile(ffname);
2571 * If we have a new file, put its name in the list of alternate file names.
2573 if (other)
2575 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2576 || eap->cmdidx == CMD_saveas)
2577 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2578 else
2579 alt_buf = buflist_findname(ffname);
2580 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2582 /* Overwriting a file that is loaded in another buffer is not a
2583 * good idea. */
2584 EMSG(_(e_bufloaded));
2585 goto theend;
2590 * Writing to the current file is not allowed in readonly mode
2591 * and a file name is required.
2592 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2594 if (!other && (
2595 #ifdef FEAT_QUICKFIX
2596 bt_dontwrite_msg(curbuf) ||
2597 #endif
2598 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2599 goto theend;
2601 if (!other)
2603 ffname = curbuf->b_ffname;
2604 fname = curbuf->b_fname;
2606 * Not writing the whole file is only allowed with '!'.
2608 if ( (eap->line1 != 1
2609 || eap->line2 != curbuf->b_ml.ml_line_count)
2610 && !eap->forceit
2611 && !eap->append
2612 && !p_wa)
2614 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2615 if (p_confirm || cmdmod.confirm)
2617 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2618 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2619 goto theend;
2620 eap->forceit = TRUE;
2622 else
2623 #endif
2625 EMSG(_("E140: Use ! to write partial buffer"));
2626 goto theend;
2631 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2633 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2635 #ifdef FEAT_AUTOCMD
2636 buf_T *was_curbuf = curbuf;
2638 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2639 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2640 # ifdef FEAT_EVAL
2641 if (curbuf != was_curbuf || aborting())
2642 # else
2643 if (curbuf != was_curbuf)
2644 # endif
2646 /* buffer changed, don't change name now */
2647 retval = FAIL;
2648 goto theend;
2650 #endif
2651 /* Exchange the file names for the current and the alternate
2652 * buffer. This makes it look like we are now editing the buffer
2653 * under the new name. Must be done before buf_write(), because
2654 * if there is no file name and 'cpo' contains 'F', it will set
2655 * the file name. */
2656 fname = alt_buf->b_fname;
2657 alt_buf->b_fname = curbuf->b_fname;
2658 curbuf->b_fname = fname;
2659 fname = alt_buf->b_ffname;
2660 alt_buf->b_ffname = curbuf->b_ffname;
2661 curbuf->b_ffname = fname;
2662 fname = alt_buf->b_sfname;
2663 alt_buf->b_sfname = curbuf->b_sfname;
2664 curbuf->b_sfname = fname;
2665 buf_name_changed(curbuf);
2666 #ifdef FEAT_AUTOCMD
2667 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2668 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2669 if (!alt_buf->b_p_bl)
2671 alt_buf->b_p_bl = TRUE;
2672 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2674 # ifdef FEAT_EVAL
2675 if (curbuf != was_curbuf || aborting())
2676 # else
2677 if (curbuf != was_curbuf)
2678 # endif
2680 /* buffer changed, don't write the file */
2681 retval = FAIL;
2682 goto theend;
2685 /* If 'filetype' was empty try detecting it now. */
2686 if (*curbuf->b_p_ft == NUL)
2688 if (au_has_group((char_u *)"filetypedetect"))
2689 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2690 TRUE);
2691 do_modelines(0);
2693 #endif
2696 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2697 eap, eap->append, eap->forceit, TRUE, FALSE);
2699 /* After ":saveas fname" reset 'readonly'. */
2700 if (eap->cmdidx == CMD_saveas)
2702 if (retval == OK)
2703 curbuf->b_p_ro = FALSE;
2704 /* Change directories when the 'acd' option is set. */
2705 DO_AUTOCHDIR
2709 theend:
2710 #ifdef FEAT_BROWSE
2711 vim_free(browse_file);
2712 #endif
2713 vim_free(free_fname);
2714 return retval;
2718 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2719 * BF_NEW or BF_READERR, check for overwriting current file.
2720 * May set eap->forceit if a dialog says it's OK to overwrite.
2721 * Return OK if it's OK, FAIL if it is not.
2723 /*ARGSUSED*/
2724 static int
2725 check_overwrite(eap, buf, fname, ffname, other)
2726 exarg_T *eap;
2727 buf_T *buf;
2728 char_u *fname; /* file name to be used (can differ from
2729 buf->ffname) */
2730 char_u *ffname; /* full path version of fname */
2731 int other; /* writing under other name */
2734 * write to other file or b_flags set or not writing the whole file:
2735 * overwriting only allowed with '!'
2737 if ( (other
2738 || (buf->b_flags & BF_NOTEDITED)
2739 || ((buf->b_flags & BF_NEW)
2740 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2741 || (buf->b_flags & BF_READERR))
2742 && !p_wa
2743 #ifdef FEAT_QUICKFIX
2744 && !bt_nofile(buf)
2745 #endif
2746 && vim_fexists(ffname))
2748 if (!eap->forceit && !eap->append)
2750 #ifdef UNIX
2751 /* with UNIX it is possible to open a directory */
2752 if (mch_isdir(ffname))
2754 EMSG2(_(e_isadir2), ffname);
2755 return FAIL;
2757 #endif
2758 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2759 if (p_confirm || cmdmod.confirm)
2761 char_u buff[IOSIZE];
2763 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2764 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2765 return FAIL;
2766 eap->forceit = TRUE;
2768 else
2769 #endif
2771 EMSG(_(e_exists));
2772 return FAIL;
2776 /* For ":w! filename" check that no swap file exists for "filename". */
2777 if (other && !emsg_silent)
2779 char_u dir[MAXPATHL];
2780 char_u *p;
2781 int r;
2782 char_u *swapname;
2784 /* We only try the first entry in 'directory', without checking if
2785 * it's writable. If the "." directory is not writable the write
2786 * will probably fail anyway.
2787 * Use 'shortname' of the current buffer, since there is no buffer
2788 * for the written file. */
2789 if (*p_dir == NUL)
2790 STRCPY(dir, ".");
2791 else
2793 p = p_dir;
2794 copy_option_part(&p, dir, MAXPATHL, ",");
2796 swapname = makeswapname(fname, ffname, curbuf, dir);
2797 r = vim_fexists(swapname);
2798 if (r)
2800 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2801 if (p_confirm || cmdmod.confirm)
2803 char_u buff[IOSIZE];
2805 dialog_msg(buff,
2806 _("Swap file \"%s\" exists, overwrite anyway?"),
2807 swapname);
2808 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2809 != VIM_YES)
2811 vim_free(swapname);
2812 return FAIL;
2814 eap->forceit = TRUE;
2816 else
2817 #endif
2819 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2820 swapname);
2821 vim_free(swapname);
2822 return FAIL;
2825 vim_free(swapname);
2828 return OK;
2832 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2834 void
2835 ex_wnext(eap)
2836 exarg_T *eap;
2838 int i;
2840 if (eap->cmd[1] == 'n')
2841 i = curwin->w_arg_idx + (int)eap->line2;
2842 else
2843 i = curwin->w_arg_idx - (int)eap->line2;
2844 eap->line1 = 1;
2845 eap->line2 = curbuf->b_ml.ml_line_count;
2846 if (do_write(eap) != FAIL)
2847 do_argfile(eap, i);
2851 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2853 void
2854 do_wqall(eap)
2855 exarg_T *eap;
2857 buf_T *buf;
2858 int error = 0;
2859 int save_forceit = eap->forceit;
2861 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2862 exiting = TRUE;
2864 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2866 if (bufIsChanged(buf))
2869 * Check if there is a reason the buffer cannot be written:
2870 * 1. if the 'write' option is set
2871 * 2. if there is no file name (even after browsing)
2872 * 3. if the 'readonly' is set (even after a dialog)
2873 * 4. if overwriting is allowed (even after a dialog)
2875 if (not_writing())
2877 ++error;
2878 break;
2880 #ifdef FEAT_BROWSE
2881 /* ":browse wall": ask for file name if there isn't one */
2882 if (buf->b_ffname == NULL && cmdmod.browse)
2883 browse_save_fname(buf);
2884 #endif
2885 if (buf->b_ffname == NULL)
2887 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2888 ++error;
2890 else if (check_readonly(&eap->forceit, buf)
2891 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2892 FALSE) == FAIL)
2894 ++error;
2896 else
2898 if (buf_write_all(buf, eap->forceit) == FAIL)
2899 ++error;
2900 #ifdef FEAT_AUTOCMD
2901 /* an autocommand may have deleted the buffer */
2902 if (!buf_valid(buf))
2903 buf = firstbuf;
2904 #endif
2906 eap->forceit = save_forceit; /* check_overwrite() may set it */
2909 if (exiting)
2911 if (!error)
2912 getout(0); /* exit Vim */
2913 not_exiting();
2918 * Check the 'write' option.
2919 * Return TRUE and give a message when it's not st.
2922 not_writing()
2924 if (p_write)
2925 return FALSE;
2926 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2927 return TRUE;
2931 * Check if a buffer is read-only (either 'readonly' option is set or file is
2932 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2933 * message when the buffer is readonly.
2935 static int
2936 check_readonly(forceit, buf)
2937 int *forceit;
2938 buf_T *buf;
2940 struct stat st;
2942 /* Handle a file being readonly when the 'readonly' option is set or when
2943 * the file exists and permissions are read-only.
2944 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2945 * important for device checks but not here. */
2946 if (!*forceit && (buf->b_p_ro
2947 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2948 && check_file_readonly(buf->b_ffname, 0777))))
2950 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2951 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2953 char_u buff[IOSIZE];
2955 if (buf->b_p_ro)
2956 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2957 buf->b_fname);
2958 else
2959 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2960 buf->b_fname);
2962 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2964 /* Set forceit, to force the writing of a readonly file */
2965 *forceit = TRUE;
2966 return FALSE;
2968 else
2969 return TRUE;
2971 else
2972 #endif
2973 if (buf->b_p_ro)
2974 EMSG(_(e_readonly));
2975 else
2976 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2977 buf->b_fname);
2978 return TRUE;
2981 return FALSE;
2985 * Try to abandon current file and edit a new or existing file.
2986 * 'fnum' is the number of the file, if zero use ffname/sfname.
2988 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2989 * -1 for successfully opening another file.
2990 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2993 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2994 int fnum;
2995 char_u *ffname;
2996 char_u *sfname;
2997 int setpm;
2998 linenr_T lnum;
2999 int forceit;
3001 int other;
3002 int retval;
3003 char_u *free_me = NULL;
3005 if (text_locked())
3006 return 1;
3007 #ifdef FEAT_AUTOCMD
3008 if (curbuf_locked())
3009 return 1;
3010 #endif
3012 if (fnum == 0)
3014 /* make ffname full path, set sfname */
3015 fname_expand(curbuf, &ffname, &sfname);
3016 other = otherfile(ffname);
3017 free_me = ffname; /* has been allocated, free() later */
3019 else
3020 other = (fnum != curbuf->b_fnum);
3022 if (other)
3023 ++no_wait_return; /* don't wait for autowrite message */
3024 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3025 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3027 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3028 if (p_confirm && p_write)
3029 dialog_changed(curbuf, FALSE);
3030 if (curbufIsChanged())
3031 #endif
3033 if (other)
3034 --no_wait_return;
3035 EMSG(_(e_nowrtmsg));
3036 retval = 2; /* file has been changed */
3037 goto theend;
3040 if (other)
3041 --no_wait_return;
3042 if (setpm)
3043 setpcmark();
3044 if (!other)
3046 if (lnum != 0)
3047 curwin->w_cursor.lnum = lnum;
3048 check_cursor_lnum();
3049 beginline(BL_SOL | BL_FIX);
3050 retval = 0; /* it's in the same file */
3052 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3053 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3054 retval = -1; /* opened another file */
3055 else
3056 retval = 1; /* error encountered */
3058 theend:
3059 vim_free(free_me);
3060 return retval;
3064 * start editing a new file
3066 * fnum: file number; if zero use ffname/sfname
3067 * ffname: the file name
3068 * - full path if sfname used,
3069 * - any file name if sfname is NULL
3070 * - empty string to re-edit with the same file name (but may be
3071 * in a different directory)
3072 * - NULL to start an empty buffer
3073 * sfname: the short file name (or NULL)
3074 * eap: contains the command to be executed after loading the file and
3075 * forced 'ff' and 'fenc'
3076 * newlnum: if > 0: put cursor on this line number (if possible)
3077 * if ECMD_LASTL: use last position in loaded file
3078 * if ECMD_LAST: use last position in all files
3079 * if ECMD_ONE: use first line
3080 * flags:
3081 * ECMD_HIDE: if TRUE don't free the current buffer
3082 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3083 * ECMD_OLDBUF: use existing buffer if it exists
3084 * ECMD_FORCEIT: ! used for Ex command
3085 * ECMD_ADDBUF: don't edit, just add to buffer list
3087 * return FAIL for failure, OK otherwise
3090 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3091 int fnum;
3092 char_u *ffname;
3093 char_u *sfname;
3094 exarg_T *eap; /* can be NULL! */
3095 linenr_T newlnum;
3096 int flags;
3098 int other_file; /* TRUE if editing another file */
3099 int oldbuf; /* TRUE if using existing buffer */
3100 #ifdef FEAT_AUTOCMD
3101 int auto_buf = FALSE; /* TRUE if autocommands brought us
3102 into the buffer unexpectedly */
3103 char_u *new_name = NULL;
3104 int did_set_swapcommand = FALSE;
3105 #endif
3106 buf_T *buf;
3107 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3108 buf_T *old_curbuf = curbuf;
3109 #endif
3110 char_u *free_fname = NULL;
3111 #ifdef FEAT_BROWSE
3112 char_u *browse_file = NULL;
3113 #endif
3114 int retval = FAIL;
3115 long n;
3116 linenr_T lnum;
3117 linenr_T topline = 0;
3118 int newcol = -1;
3119 int solcol = -1;
3120 pos_T *pos;
3121 #ifdef FEAT_SUN_WORKSHOP
3122 char_u *cp;
3123 #endif
3124 char_u *command = NULL;
3125 #ifdef FEAT_SPELL
3126 int did_get_winopts = FALSE;
3127 #endif
3129 if (eap != NULL)
3130 command = eap->do_ecmd_cmd;
3132 if (fnum != 0)
3134 if (fnum == curbuf->b_fnum) /* file is already being edited */
3135 return OK; /* nothing to do */
3136 other_file = TRUE;
3138 else
3140 #ifdef FEAT_BROWSE
3141 if (cmdmod.browse)
3143 if (
3144 # ifdef FEAT_GUI
3145 !gui.in_use &&
3146 # endif
3147 au_has_group((char_u *)"FileExplorer"))
3149 /* No browsing supported but we do have the file explorer:
3150 * Edit the directory. */
3151 if (ffname == NULL || !mch_isdir(ffname))
3152 ffname = (char_u *)".";
3154 else
3156 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3157 NULL, NULL, NULL, curbuf);
3158 if (browse_file == NULL)
3159 goto theend;
3160 ffname = browse_file;
3163 #endif
3164 /* if no short name given, use ffname for short name */
3165 if (sfname == NULL)
3166 sfname = ffname;
3167 #ifdef USE_FNAME_CASE
3168 # ifdef USE_LONG_FNAME
3169 if (USE_LONG_FNAME)
3170 # endif
3171 if (sfname != NULL)
3172 fname_case(sfname, 0); /* set correct case for sfname */
3173 #endif
3175 #ifdef FEAT_LISTCMDS
3176 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3177 goto theend;
3178 #endif
3180 if (ffname == NULL)
3181 other_file = TRUE;
3182 /* there is no file name */
3183 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3184 other_file = FALSE;
3185 else
3187 if (*ffname == NUL) /* re-edit with same file name */
3189 ffname = curbuf->b_ffname;
3190 sfname = curbuf->b_fname;
3192 free_fname = fix_fname(ffname); /* may expand to full path name */
3193 if (free_fname != NULL)
3194 ffname = free_fname;
3195 other_file = otherfile(ffname);
3196 #ifdef FEAT_SUN_WORKSHOP
3197 if (usingSunWorkShop && p_acd
3198 && (cp = vim_strrchr(sfname, '/')) != NULL)
3199 sfname = ++cp;
3200 #endif
3205 * if the file was changed we may not be allowed to abandon it
3206 * - if we are going to re-edit the same file
3207 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3209 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3210 || (curbuf->b_nwindows == 1
3211 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3212 && check_changed(curbuf, p_awa, !other_file,
3213 (flags & ECMD_FORCEIT), FALSE))
3215 if (fnum == 0 && other_file && ffname != NULL)
3216 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3217 goto theend;
3220 #ifdef FEAT_VISUAL
3222 * End Visual mode before switching to another buffer, so the text can be
3223 * copied into the GUI selection buffer.
3225 reset_VIsual();
3226 #endif
3228 #ifdef FEAT_AUTOCMD
3229 if ((command != NULL || newlnum > (linenr_T)0)
3230 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3232 int len;
3233 char_u *p;
3235 /* Set v:swapcommand for the SwapExists autocommands. */
3236 if (command != NULL)
3237 len = (int)STRLEN(command) + 3;
3238 else
3239 len = 30;
3240 p = alloc((unsigned)len);
3241 if (p != NULL)
3243 if (command != NULL)
3244 vim_snprintf((char *)p, len, ":%s\r", command);
3245 else
3246 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3247 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3248 did_set_swapcommand = TRUE;
3249 vim_free(p);
3252 #endif
3255 * If we are starting to edit another file, open a (new) buffer.
3256 * Otherwise we re-use the current buffer.
3258 if (other_file)
3260 #ifdef FEAT_LISTCMDS
3261 if (!(flags & ECMD_ADDBUF))
3262 #endif
3264 if (!cmdmod.keepalt)
3265 curwin->w_alt_fnum = curbuf->b_fnum;
3266 buflist_altfpos();
3269 if (fnum)
3270 buf = buflist_findnr(fnum);
3271 else
3273 #ifdef FEAT_LISTCMDS
3274 if (flags & ECMD_ADDBUF)
3276 linenr_T tlnum = 1L;
3278 if (command != NULL)
3280 tlnum = atol((char *)command);
3281 if (tlnum <= 0)
3282 tlnum = 1L;
3284 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3285 goto theend;
3287 #endif
3288 buf = buflist_new(ffname, sfname, 0L,
3289 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3291 if (buf == NULL)
3292 goto theend;
3293 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3295 oldbuf = FALSE;
3296 buf->b_nwindows = 0;
3298 else /* existing memfile */
3300 oldbuf = TRUE;
3301 (void)buf_check_timestamp(buf, FALSE);
3302 /* Check if autocommands made buffer invalid or changed the current
3303 * buffer. */
3304 if (!buf_valid(buf)
3305 #ifdef FEAT_AUTOCMD
3306 || curbuf != old_curbuf
3307 #endif
3309 goto theend;
3310 #ifdef FEAT_EVAL
3311 if (aborting()) /* autocmds may abort script processing */
3312 goto theend;
3313 #endif
3316 /* May jump to last used line number for a loaded buffer or when asked
3317 * for explicitly */
3318 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3320 pos = buflist_findfpos(buf);
3321 newlnum = pos->lnum;
3322 solcol = pos->col;
3326 * Make the (new) buffer the one used by the current window.
3327 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3328 * If the current buffer was empty and has no file name, curbuf
3329 * is returned by buflist_new().
3331 if (buf != curbuf)
3333 #ifdef FEAT_AUTOCMD
3335 * Be careful: The autocommands may delete any buffer and change
3336 * the current buffer.
3337 * - If the buffer we are going to edit is deleted, give up.
3338 * - If the current buffer is deleted, prefer to load the new
3339 * buffer when loading a buffer is required. This avoids
3340 * loading another buffer which then must be closed again.
3341 * - If we ended up in the new buffer already, need to skip a few
3342 * things, set auto_buf.
3344 if (buf->b_fname != NULL)
3345 new_name = vim_strsave(buf->b_fname);
3346 au_new_curbuf = buf;
3347 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3348 if (!buf_valid(buf)) /* new buffer has been deleted */
3350 delbuf_msg(new_name); /* frees new_name */
3351 goto theend;
3353 # ifdef FEAT_EVAL
3354 if (aborting()) /* autocmds may abort script processing */
3356 vim_free(new_name);
3357 goto theend;
3359 # endif
3360 if (buf == curbuf) /* already in new buffer */
3361 auto_buf = TRUE;
3362 else
3364 if (curbuf == old_curbuf)
3365 #endif
3366 buf_copy_options(buf, BCO_ENTER);
3368 /* close the link to the current buffer */
3369 u_sync(FALSE);
3370 close_buffer(curwin, curbuf,
3371 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3373 #ifdef FEAT_AUTOCMD
3374 # ifdef FEAT_EVAL
3375 if (aborting()) /* autocmds may abort script processing */
3377 vim_free(new_name);
3378 goto theend;
3380 # endif
3381 /* Be careful again, like above. */
3382 if (!buf_valid(buf)) /* new buffer has been deleted */
3384 delbuf_msg(new_name); /* frees new_name */
3385 goto theend;
3387 if (buf == curbuf) /* already in new buffer */
3388 auto_buf = TRUE;
3389 else
3390 #endif
3392 curwin->w_buffer = buf;
3393 curbuf = buf;
3394 ++curbuf->b_nwindows;
3395 /* set 'fileformat' */
3396 if (*p_ffs && !oldbuf)
3397 set_fileformat(default_fileformat(), OPT_LOCAL);
3400 /* May get the window options from the last time this buffer
3401 * was in this window (or another window). If not used
3402 * before, reset the local window options to the global
3403 * values. Also restores old folding stuff. */
3404 get_winopts(curbuf);
3405 #ifdef FEAT_SPELL
3406 did_get_winopts = TRUE;
3407 #endif
3409 #ifdef FEAT_AUTOCMD
3411 vim_free(new_name);
3412 au_new_curbuf = NULL;
3413 #endif
3415 else
3416 ++curbuf->b_nwindows;
3418 curwin->w_pcmark.lnum = 1;
3419 curwin->w_pcmark.col = 0;
3421 else /* !other_file */
3423 if (
3424 #ifdef FEAT_LISTCMDS
3425 (flags & ECMD_ADDBUF) ||
3426 #endif
3427 check_fname() == FAIL)
3428 goto theend;
3429 oldbuf = (flags & ECMD_OLDBUF);
3432 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3434 char_u *p;
3436 curbuf->b_help = TRUE;
3437 #ifdef FEAT_QUICKFIX
3438 set_string_option_direct((char_u *)"buftype", -1,
3439 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3440 #endif
3443 * Always set these options after jumping to a help tag, because the
3444 * user may have an autocommand that gets in the way.
3445 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3446 * latin1 word characters (for translated help files).
3447 * Only set it when needed, buf_init_chartab() is some work.
3450 #ifdef EBCDIC
3451 (char_u *)"65-255,^*,^|,^\"";
3452 #else
3453 (char_u *)"!-~,^*,^|,^\",192-255";
3454 #endif
3455 if (STRCMP(curbuf->b_p_isk, p) != 0)
3457 set_string_option_direct((char_u *)"isk", -1, p,
3458 OPT_FREE|OPT_LOCAL, 0);
3459 check_buf_options(curbuf);
3460 (void)buf_init_chartab(curbuf, FALSE);
3463 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3464 curwin->w_p_list = FALSE; /* no list mode */
3466 curbuf->b_p_ma = FALSE; /* not modifiable */
3467 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3468 curwin->w_p_nu = 0; /* no line numbers */
3469 #ifdef FEAT_SCROLLBIND
3470 curwin->w_p_scb = FALSE; /* no scroll binding */
3471 #endif
3472 #ifdef FEAT_ARABIC
3473 curwin->w_p_arab = FALSE; /* no arabic mode */
3474 #endif
3475 #ifdef FEAT_RIGHTLEFT
3476 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3477 #endif
3478 #ifdef FEAT_FOLDING
3479 curwin->w_p_fen = FALSE; /* No folding in the help window */
3480 #endif
3481 #ifdef FEAT_DIFF
3482 curwin->w_p_diff = FALSE; /* No 'diff' */
3483 #endif
3484 #ifdef FEAT_SPELL
3485 curwin->w_p_spell = FALSE; /* No spell checking */
3486 #endif
3488 #ifdef FEAT_AUTOCMD
3489 buf = curbuf;
3490 #endif
3491 set_buflisted(FALSE);
3493 else
3495 #ifdef FEAT_AUTOCMD
3496 buf = curbuf;
3497 #endif
3498 /* Don't make a buffer listed if it's a help buffer. Useful when
3499 * using CTRL-O to go back to a help file. */
3500 if (!curbuf->b_help)
3501 set_buflisted(TRUE);
3504 #ifdef FEAT_AUTOCMD
3505 /* If autocommands change buffers under our fingers, forget about
3506 * editing the file. */
3507 if (buf != curbuf)
3508 goto theend;
3509 # ifdef FEAT_EVAL
3510 if (aborting()) /* autocmds may abort script processing */
3511 goto theend;
3512 # endif
3514 /* Since we are starting to edit a file, consider the filetype to be
3515 * unset. Helps for when an autocommand changes files and expects syntax
3516 * highlighting to work in the other file. */
3517 did_filetype = FALSE;
3518 #endif
3521 * other_file oldbuf
3522 * FALSE FALSE re-edit same file, buffer is re-used
3523 * FALSE TRUE re-edit same file, nothing changes
3524 * TRUE FALSE start editing new file, new buffer
3525 * TRUE TRUE start editing in existing buffer (nothing to do)
3527 if (!other_file && !oldbuf) /* re-use the buffer */
3529 set_last_cursor(curwin); /* may set b_last_cursor */
3530 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3532 newlnum = curwin->w_cursor.lnum;
3533 solcol = curwin->w_cursor.col;
3535 #ifdef FEAT_AUTOCMD
3536 buf = curbuf;
3537 if (buf->b_fname != NULL)
3538 new_name = vim_strsave(buf->b_fname);
3539 else
3540 new_name = NULL;
3541 #endif
3542 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3543 #ifdef FEAT_AUTOCMD
3544 /* If autocommands deleted the buffer we were going to re-edit, give
3545 * up and jump to the end. */
3546 if (!buf_valid(buf))
3548 delbuf_msg(new_name); /* frees new_name */
3549 goto theend;
3551 vim_free(new_name);
3553 /* If autocommands change buffers under our fingers, forget about
3554 * re-editing the file. Should do the buf_clear_file(), but perhaps
3555 * the autocommands changed the buffer... */
3556 if (buf != curbuf)
3557 goto theend;
3558 # ifdef FEAT_EVAL
3559 if (aborting()) /* autocmds may abort script processing */
3560 goto theend;
3561 # endif
3562 #endif
3563 buf_clear_file(curbuf);
3564 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3565 curbuf->b_op_end.lnum = 0;
3569 * If we get here we are sure to start editing
3571 /* don't redraw until the cursor is in the right line */
3572 ++RedrawingDisabled;
3574 /* Assume success now */
3575 retval = OK;
3578 * Reset cursor position, could be used by autocommands.
3580 check_cursor();
3583 * Check if we are editing the w_arg_idx file in the argument list.
3585 check_arg_idx(curwin);
3587 #ifdef FEAT_AUTOCMD
3588 if (!auto_buf)
3589 #endif
3592 * Set cursor and init window before reading the file and executing
3593 * autocommands. This allows for the autocommands to position the
3594 * cursor.
3596 curwin_init();
3598 #ifdef FEAT_FOLDING
3599 /* It's possible that all lines in the buffer changed. Need to update
3600 * automatic folding for all windows where it's used. */
3601 # ifdef FEAT_WINDOWS
3603 win_T *win;
3604 tabpage_T *tp;
3606 FOR_ALL_TAB_WINDOWS(tp, win)
3607 if (win->w_buffer == curbuf)
3608 foldUpdateAll(win);
3610 # else
3611 foldUpdateAll(curwin);
3612 # endif
3613 #endif
3615 /* Change directories when the 'acd' option is set. */
3616 DO_AUTOCHDIR
3619 * Careful: open_buffer() and apply_autocmds() may change the current
3620 * buffer and window.
3622 lnum = curwin->w_cursor.lnum;
3623 topline = curwin->w_topline;
3624 if (!oldbuf) /* need to read the file */
3626 #if defined(HAS_SWAP_EXISTS_ACTION)
3627 swap_exists_action = SEA_DIALOG;
3628 #endif
3629 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3632 * Open the buffer and read the file.
3634 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3635 if (should_abort(open_buffer(FALSE, eap)))
3636 retval = FAIL;
3637 #else
3638 (void)open_buffer(FALSE, eap);
3639 #endif
3641 #if defined(HAS_SWAP_EXISTS_ACTION)
3642 if (swap_exists_action == SEA_QUIT)
3643 retval = FAIL;
3644 handle_swap_exists(old_curbuf);
3645 #endif
3647 #ifdef FEAT_AUTOCMD
3648 else
3650 /* Read the modelines, but only to set window-local options. Any
3651 * buffer-local options have already been set and may have been
3652 * changed by the user. */
3653 do_modelines(OPT_WINONLY);
3655 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3656 &retval);
3657 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3658 &retval);
3660 check_arg_idx(curwin);
3661 #endif
3664 * If autocommands change the cursor position or topline, we should
3665 * keep it.
3667 if (curwin->w_cursor.lnum != lnum)
3669 newlnum = curwin->w_cursor.lnum;
3670 newcol = curwin->w_cursor.col;
3672 if (curwin->w_topline == topline)
3673 topline = 0;
3675 /* Even when cursor didn't move we need to recompute topline. */
3676 changed_line_abv_curs();
3678 #ifdef FEAT_TITLE
3679 maketitle();
3680 #endif
3683 #ifdef FEAT_DIFF
3684 /* Tell the diff stuff that this buffer is new and/or needs updating.
3685 * Also needed when re-editing the same buffer, because unloading will
3686 * have removed it as a diff buffer. */
3687 if (curwin->w_p_diff)
3689 diff_buf_add(curbuf);
3690 diff_invalidate(curbuf);
3692 #endif
3694 #ifdef FEAT_SPELL
3695 /* If the window options were changed may need to set the spell language.
3696 * Can only do this after the buffer has been properly setup. */
3697 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3698 did_set_spelllang(curbuf);
3699 #endif
3701 if (command == NULL)
3703 if (newcol >= 0) /* position set by autocommands */
3705 curwin->w_cursor.lnum = newlnum;
3706 curwin->w_cursor.col = newcol;
3707 check_cursor();
3709 else if (newlnum > 0) /* line number from caller or old position */
3711 curwin->w_cursor.lnum = newlnum;
3712 check_cursor_lnum();
3713 if (solcol >= 0 && !p_sol)
3715 /* 'sol' is off: Use last known column. */
3716 curwin->w_cursor.col = solcol;
3717 check_cursor_col();
3718 #ifdef FEAT_VIRTUALEDIT
3719 curwin->w_cursor.coladd = 0;
3720 #endif
3721 curwin->w_set_curswant = TRUE;
3723 else
3724 beginline(BL_SOL | BL_FIX);
3726 else /* no line number, go to last line in Ex mode */
3728 if (exmode_active)
3729 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3730 beginline(BL_WHITE | BL_FIX);
3734 #ifdef FEAT_WINDOWS
3735 /* Check if cursors in other windows on the same buffer are still valid */
3736 check_lnums(FALSE);
3737 #endif
3740 * Did not read the file, need to show some info about the file.
3741 * Do this after setting the cursor.
3743 if (oldbuf
3744 #ifdef FEAT_AUTOCMD
3745 && !auto_buf
3746 #endif
3749 int msg_scroll_save = msg_scroll;
3751 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3752 * message. */
3753 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3754 msg_scroll = FALSE;
3755 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3756 check_for_delay(FALSE);
3757 msg_start();
3758 msg_scroll = msg_scroll_save;
3759 msg_scrolled_ign = TRUE;
3761 fileinfo(FALSE, TRUE, FALSE);
3763 msg_scrolled_ign = FALSE;
3766 if (command != NULL)
3767 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3769 #ifdef FEAT_KEYMAP
3770 if (curbuf->b_kmap_state & KEYMAP_INIT)
3771 keymap_init();
3772 #endif
3774 --RedrawingDisabled;
3775 if (!skip_redraw)
3777 n = p_so;
3778 if (topline == 0 && command == NULL)
3779 p_so = 999; /* force cursor halfway the window */
3780 update_topline();
3781 #ifdef FEAT_SCROLLBIND
3782 curwin->w_scbind_pos = curwin->w_topline;
3783 #endif
3784 p_so = n;
3785 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3788 if (p_im)
3789 need_start_insertmode = TRUE;
3791 /* Change directories when the 'acd' option is set. */
3792 DO_AUTOCHDIR
3794 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3795 if (gui.in_use && curbuf->b_ffname != NULL)
3797 # ifdef FEAT_SUN_WORKSHOP
3798 if (usingSunWorkShop)
3799 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3800 # endif
3801 # ifdef FEAT_NETBEANS_INTG
3802 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3803 netbeans_file_opened(curbuf);
3804 # endif
3806 #endif
3808 theend:
3809 #ifdef FEAT_AUTOCMD
3810 if (did_set_swapcommand)
3811 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3812 #endif
3813 #ifdef FEAT_BROWSE
3814 vim_free(browse_file);
3815 #endif
3816 vim_free(free_fname);
3817 return retval;
3820 #ifdef FEAT_AUTOCMD
3821 static void
3822 delbuf_msg(name)
3823 char_u *name;
3825 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3826 name == NULL ? (char_u *)"" : name);
3827 vim_free(name);
3828 au_new_curbuf = NULL;
3830 #endif
3832 static int append_indent = 0; /* autoindent for first line */
3835 * ":insert" and ":append", also used by ":change"
3837 void
3838 ex_append(eap)
3839 exarg_T *eap;
3841 char_u *theline;
3842 int did_undo = FALSE;
3843 linenr_T lnum = eap->line2;
3844 int indent = 0;
3845 char_u *p;
3846 int vcol;
3847 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3849 /* the ! flag toggles autoindent */
3850 if (eap->forceit)
3851 curbuf->b_p_ai = !curbuf->b_p_ai;
3853 /* First autoindent comes from the line we start on */
3854 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3855 append_indent = get_indent_lnum(lnum);
3857 if (eap->cmdidx != CMD_append)
3858 --lnum;
3860 /* when the buffer is empty append to line 0 and delete the dummy line */
3861 if (empty && lnum == 1)
3862 lnum = 0;
3864 State = INSERT; /* behave like in Insert mode */
3865 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3866 State |= LANGMAP;
3868 for (;;)
3870 msg_scroll = TRUE;
3871 need_wait_return = FALSE;
3872 if (curbuf->b_p_ai)
3874 if (append_indent >= 0)
3876 indent = append_indent;
3877 append_indent = -1;
3879 else if (lnum > 0)
3880 indent = get_indent_lnum(lnum);
3882 ex_keep_indent = FALSE;
3883 if (eap->getline == NULL)
3885 /* No getline() function, use the lines that follow. This ends
3886 * when there is no more. */
3887 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3888 break;
3889 p = vim_strchr(eap->nextcmd, NL);
3890 if (p == NULL)
3891 p = eap->nextcmd + STRLEN(eap->nextcmd);
3892 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3893 if (*p != NUL)
3894 ++p;
3895 eap->nextcmd = p;
3897 else
3898 theline = eap->getline(
3899 #ifdef FEAT_EVAL
3900 eap->cstack->cs_looplevel > 0 ? -1 :
3901 #endif
3902 NUL, eap->cookie, indent);
3903 lines_left = Rows - 1;
3904 if (theline == NULL)
3905 break;
3907 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3908 if (ex_keep_indent)
3909 append_indent = indent;
3911 /* Look for the "." after automatic indent. */
3912 vcol = 0;
3913 for (p = theline; indent > vcol; ++p)
3915 if (*p == ' ')
3916 ++vcol;
3917 else if (*p == TAB)
3918 vcol += 8 - vcol % 8;
3919 else
3920 break;
3922 if ((p[0] == '.' && p[1] == NUL)
3923 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3924 == FAIL))
3926 vim_free(theline);
3927 break;
3930 /* don't use autoindent if nothing was typed. */
3931 if (p[0] == NUL)
3932 theline[0] = NUL;
3934 did_undo = TRUE;
3935 ml_append(lnum, theline, (colnr_T)0, FALSE);
3936 appended_lines_mark(lnum, 1L);
3938 vim_free(theline);
3939 ++lnum;
3941 if (empty)
3943 ml_delete(2L, FALSE);
3944 empty = FALSE;
3947 State = NORMAL;
3949 if (eap->forceit)
3950 curbuf->b_p_ai = !curbuf->b_p_ai;
3952 /* "start" is set to eap->line2+1 unless that position is invalid (when
3953 * eap->line2 pointed to the end of the buffer and nothing was appended)
3954 * "end" is set to lnum when something has been appended, otherwise
3955 * it is the same than "start" -- Acevedo */
3956 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3957 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3958 if (eap->cmdidx != CMD_append)
3959 --curbuf->b_op_start.lnum;
3960 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3961 ? lnum : curbuf->b_op_start.lnum;
3962 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3963 curwin->w_cursor.lnum = lnum;
3964 check_cursor_lnum();
3965 beginline(BL_SOL | BL_FIX);
3967 need_wait_return = FALSE; /* don't use wait_return() now */
3968 ex_no_reprint = TRUE;
3972 * ":change"
3974 void
3975 ex_change(eap)
3976 exarg_T *eap;
3978 linenr_T lnum;
3980 if (eap->line2 >= eap->line1
3981 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3982 return;
3984 /* the ! flag toggles autoindent */
3985 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3986 append_indent = get_indent_lnum(eap->line1);
3988 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3990 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3991 break;
3992 ml_delete(eap->line1, FALSE);
3994 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3996 /* ":append" on the line above the deleted lines. */
3997 eap->line2 = eap->line1;
3998 ex_append(eap);
4001 void
4002 ex_z(eap)
4003 exarg_T *eap;
4005 char_u *x;
4006 int bigness;
4007 char_u *kind;
4008 int minus = 0;
4009 linenr_T start, end, curs, i;
4010 int j;
4011 linenr_T lnum = eap->line2;
4013 /* Vi compatible: ":z!" uses display height, without a count uses
4014 * 'scroll' */
4015 if (eap->forceit)
4016 bigness = curwin->w_height;
4017 else if (firstwin == lastwin)
4018 bigness = curwin->w_p_scr * 2;
4019 else
4020 bigness = curwin->w_height - 3;
4021 if (bigness < 1)
4022 bigness = 1;
4024 x = eap->arg;
4025 kind = x;
4026 if (*kind == '-' || *kind == '+' || *kind == '='
4027 || *kind == '^' || *kind == '.')
4028 ++x;
4029 while (*x == '-' || *x == '+')
4030 ++x;
4032 if (*x != 0)
4034 if (!VIM_ISDIGIT(*x))
4036 EMSG(_("E144: non-numeric argument to :z"));
4037 return;
4039 else
4041 bigness = atoi((char *)x);
4042 p_window = bigness;
4043 if (*kind == '=')
4044 bigness += 2;
4048 /* the number of '-' and '+' multiplies the distance */
4049 if (*kind == '-' || *kind == '+')
4050 for (x = kind + 1; *x == *kind; ++x)
4053 switch (*kind)
4055 case '-':
4056 start = lnum - bigness * (linenr_T)(x - kind);
4057 end = start + bigness;
4058 curs = end;
4059 break;
4061 case '=':
4062 start = lnum - (bigness + 1) / 2 + 1;
4063 end = lnum + (bigness + 1) / 2 - 1;
4064 curs = lnum;
4065 minus = 1;
4066 break;
4068 case '^':
4069 start = lnum - bigness * 2;
4070 end = lnum - bigness;
4071 curs = lnum - bigness;
4072 break;
4074 case '.':
4075 start = lnum - (bigness + 1) / 2 + 1;
4076 end = lnum + (bigness + 1) / 2 - 1;
4077 curs = end;
4078 break;
4080 default: /* '+' */
4081 start = lnum;
4082 if (*kind == '+')
4083 start += bigness * (linenr_T)(x - kind - 1) + 1;
4084 else if (eap->addr_count == 0)
4085 ++start;
4086 end = start + bigness - 1;
4087 curs = end;
4088 break;
4091 if (start < 1)
4092 start = 1;
4094 if (end > curbuf->b_ml.ml_line_count)
4095 end = curbuf->b_ml.ml_line_count;
4097 if (curs > curbuf->b_ml.ml_line_count)
4098 curs = curbuf->b_ml.ml_line_count;
4100 for (i = start; i <= end; i++)
4102 if (minus && i == lnum)
4104 msg_putchar('\n');
4106 for (j = 1; j < Columns; j++)
4107 msg_putchar('-');
4110 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4112 if (minus && i == lnum)
4114 msg_putchar('\n');
4116 for (j = 1; j < Columns; j++)
4117 msg_putchar('-');
4121 curwin->w_cursor.lnum = curs;
4122 ex_no_reprint = TRUE;
4126 * Check if the restricted flag is set.
4127 * If so, give an error message and return TRUE.
4128 * Otherwise, return FALSE.
4131 check_restricted()
4133 if (restricted)
4135 EMSG(_("E145: Shell commands not allowed in rvim"));
4136 return TRUE;
4138 return FALSE;
4142 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4143 * If so, give an error message and return TRUE.
4144 * Otherwise, return FALSE.
4147 check_secure()
4149 if (secure)
4151 secure = 2;
4152 EMSG(_(e_curdir));
4153 return TRUE;
4155 #ifdef HAVE_SANDBOX
4157 * In the sandbox more things are not allowed, including the things
4158 * disallowed in secure mode.
4160 if (sandbox != 0)
4162 EMSG(_(e_sandbox));
4163 return TRUE;
4165 #endif
4166 return FALSE;
4169 static char_u *old_sub = NULL; /* previous substitute pattern */
4170 static int global_need_beginline; /* call beginline() after ":g" */
4172 /* do_sub()
4174 * Perform a substitution from line eap->line1 to line eap->line2 using the
4175 * command pointed to by eap->arg which should be of the form:
4177 * /pattern/substitution/{flags}
4179 * The usual escapes are supported as described in the regexp docs.
4181 void
4182 do_sub(eap)
4183 exarg_T *eap;
4185 linenr_T lnum;
4186 long i = 0;
4187 regmmatch_T regmatch;
4188 static int do_all = FALSE; /* do multiple substitutions per line */
4189 static int do_ask = FALSE; /* ask for confirmation */
4190 static int do_count = FALSE; /* count only */
4191 static int do_error = TRUE; /* if false, ignore errors */
4192 static int do_print = FALSE; /* print last line with subs. */
4193 static int do_list = FALSE; /* list last line with subs. */
4194 static int do_number = FALSE; /* list last line with line nr*/
4195 static int do_ic = 0; /* ignore case flag */
4196 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4197 int delimiter;
4198 int sublen;
4199 int got_quit = FALSE;
4200 int got_match = FALSE;
4201 int temp;
4202 int which_pat;
4203 char_u *cmd;
4204 int save_State;
4205 linenr_T first_line = 0; /* first changed line */
4206 linenr_T last_line= 0; /* below last changed line AFTER the
4207 * change */
4208 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4209 linenr_T line2;
4210 long nmatch; /* number of lines in match */
4211 char_u *sub_firstline; /* allocated copy of first sub line */
4212 int endcolumn = FALSE; /* cursor in last column when done */
4213 pos_T old_cursor = curwin->w_cursor;
4215 cmd = eap->arg;
4216 if (!global_busy)
4218 sub_nsubs = 0;
4219 sub_nlines = 0;
4222 if (eap->cmdidx == CMD_tilde)
4223 which_pat = RE_LAST; /* use last used regexp */
4224 else
4225 which_pat = RE_SUBST; /* use last substitute regexp */
4227 /* new pattern and substitution */
4228 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4229 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4231 /* don't accept alphanumeric for separator */
4232 if (isalpha(*cmd))
4234 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4235 return;
4238 * undocumented vi feature:
4239 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4240 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4242 if (*cmd == '\\')
4244 ++cmd;
4245 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4247 EMSG(_(e_backslash));
4248 return;
4250 if (*cmd != '&')
4251 which_pat = RE_SEARCH; /* use last '/' pattern */
4252 pat = (char_u *)""; /* empty search pattern */
4253 delimiter = *cmd++; /* remember delimiter character */
4255 else /* find the end of the regexp */
4257 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4258 if (p_altkeymap && curwin->w_p_rl)
4259 lrF_sub(cmd);
4260 #endif
4261 which_pat = RE_LAST; /* use last used regexp */
4262 delimiter = *cmd++; /* remember delimiter character */
4263 pat = cmd; /* remember start of search pat */
4264 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4265 if (cmd[0] == delimiter) /* end delimiter found */
4266 *cmd++ = NUL; /* replace it with a NUL */
4270 * Small incompatibility: vi sees '\n' as end of the command, but in
4271 * Vim we want to use '\n' to find/substitute a NUL.
4273 sub = cmd; /* remember the start of the substitution */
4275 while (cmd[0])
4277 if (cmd[0] == delimiter) /* end delimiter found */
4279 *cmd++ = NUL; /* replace it with a NUL */
4280 break;
4282 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4283 ++cmd;
4284 mb_ptr_adv(cmd);
4287 if (!eap->skip)
4289 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4290 if (STRCMP(sub, "%") == 0
4291 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4293 if (old_sub == NULL) /* there is no previous command */
4295 EMSG(_(e_nopresub));
4296 return;
4298 sub = old_sub;
4300 else
4302 vim_free(old_sub);
4303 old_sub = vim_strsave(sub);
4307 else if (!eap->skip) /* use previous pattern and substitution */
4309 if (old_sub == NULL) /* there is no previous command */
4311 EMSG(_(e_nopresub));
4312 return;
4314 pat = NULL; /* search_regcomp() will use previous pattern */
4315 sub = old_sub;
4317 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4318 * last column after using "$". */
4319 endcolumn = (curwin->w_curswant == MAXCOL);
4323 * Find trailing options. When '&' is used, keep old options.
4325 if (*cmd == '&')
4326 ++cmd;
4327 else
4329 if (!p_ed)
4331 if (p_gd) /* default is global on */
4332 do_all = TRUE;
4333 else
4334 do_all = FALSE;
4335 do_ask = FALSE;
4337 do_error = TRUE;
4338 do_print = FALSE;
4339 do_count = FALSE;
4340 do_number = FALSE;
4341 do_ic = 0;
4343 while (*cmd)
4346 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4347 * 'r' is never inverted.
4349 if (*cmd == 'g')
4350 do_all = !do_all;
4351 else if (*cmd == 'c')
4352 do_ask = !do_ask;
4353 else if (*cmd == 'n')
4354 do_count = TRUE;
4355 else if (*cmd == 'e')
4356 do_error = !do_error;
4357 else if (*cmd == 'r') /* use last used regexp */
4358 which_pat = RE_LAST;
4359 else if (*cmd == 'p')
4360 do_print = TRUE;
4361 else if (*cmd == '#')
4363 do_print = TRUE;
4364 do_number = TRUE;
4366 else if (*cmd == 'l')
4368 do_print = TRUE;
4369 do_list = TRUE;
4371 else if (*cmd == 'i') /* ignore case */
4372 do_ic = 'i';
4373 else if (*cmd == 'I') /* don't ignore case */
4374 do_ic = 'I';
4375 else
4376 break;
4377 ++cmd;
4379 if (do_count)
4380 do_ask = FALSE;
4383 * check for a trailing count
4385 cmd = skipwhite(cmd);
4386 if (VIM_ISDIGIT(*cmd))
4388 i = getdigits(&cmd);
4389 if (i <= 0 && !eap->skip && do_error)
4391 EMSG(_(e_zerocount));
4392 return;
4394 eap->line1 = eap->line2;
4395 eap->line2 += i - 1;
4396 if (eap->line2 > curbuf->b_ml.ml_line_count)
4397 eap->line2 = curbuf->b_ml.ml_line_count;
4401 * check for trailing command or garbage
4403 cmd = skipwhite(cmd);
4404 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4406 eap->nextcmd = check_nextcmd(cmd);
4407 if (eap->nextcmd == NULL)
4409 EMSG(_(e_trailing));
4410 return;
4414 if (eap->skip) /* not executing commands, only parsing */
4415 return;
4417 if (!do_count && !curbuf->b_p_ma)
4419 /* Substitution is not allowed in non-'modifiable' buffer */
4420 EMSG(_(e_modifiable));
4421 return;
4424 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4426 if (do_error)
4427 EMSG(_(e_invcmd));
4428 return;
4431 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4432 if (do_ic == 'i')
4433 regmatch.rmm_ic = TRUE;
4434 else if (do_ic == 'I')
4435 regmatch.rmm_ic = FALSE;
4437 sub_firstline = NULL;
4440 * ~ in the substitute pattern is replaced with the old pattern.
4441 * We do it here once to avoid it to be replaced over and over again.
4442 * But don't do it when it starts with "\=", then it's an expression.
4444 if (!(sub[0] == '\\' && sub[1] == '='))
4445 sub = regtilde(sub, p_magic);
4448 * Check for a match on each line.
4450 line2 = eap->line2;
4451 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4452 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4453 || aborting()
4454 #endif
4455 ); ++lnum)
4457 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4458 (colnr_T)0, NULL);
4459 if (nmatch)
4461 colnr_T copycol;
4462 colnr_T matchcol;
4463 colnr_T prev_matchcol = MAXCOL;
4464 char_u *new_end, *new_start = NULL;
4465 unsigned new_start_len = 0;
4466 char_u *p1;
4467 int did_sub = FALSE;
4468 int lastone;
4469 unsigned len, needed_len;
4470 long nmatch_tl = 0; /* nr of lines matched below lnum */
4471 int do_again; /* do it again after joining lines */
4472 int skip_match = FALSE;
4473 linenr_T sub_firstlnum; /* nr of first sub line */
4476 * The new text is build up step by step, to avoid too much
4477 * copying. There are these pieces:
4478 * sub_firstline The old text, unmodified.
4479 * copycol Column in the old text where we started
4480 * looking for a match; from here old text still
4481 * needs to be copied to the new text.
4482 * matchcol Column number of the old text where to look
4483 * for the next match. It's just after the
4484 * previous match or one further.
4485 * prev_matchcol Column just after the previous match (if any).
4486 * Mostly equal to matchcol, except for the first
4487 * match and after skipping an empty match.
4488 * regmatch.*pos Where the pattern matched in the old text.
4489 * new_start The new text, all that has been produced so
4490 * far.
4491 * new_end The new text, where to append new text.
4493 * lnum The line number where we found the start of
4494 * the match. Can be below the line we searched
4495 * when there is a \n before a \zs in the
4496 * pattern.
4497 * sub_firstlnum The line number in the buffer where to look
4498 * for a match. Can be different from "lnum"
4499 * when the pattern or substitute string contains
4500 * line breaks.
4502 * Special situations:
4503 * - When the substitute string contains a line break, the part up
4504 * to the line break is inserted in the text, but the copy of
4505 * the original line is kept. "sub_firstlnum" is adjusted for
4506 * the inserted lines.
4507 * - When the matched pattern contains a line break, the old line
4508 * is taken from the line at the end of the pattern. The lines
4509 * in the match are deleted later, "sub_firstlnum" is adjusted
4510 * accordingly.
4512 * The new text is built up in new_start[]. It has some extra
4513 * room to avoid using alloc()/free() too often. new_start_len is
4514 * the length of the allocated memory at new_start.
4516 * Make a copy of the old line, so it won't be taken away when
4517 * updating the screen or handling a multi-line match. The "old_"
4518 * pointers point into this copy.
4520 sub_firstlnum = lnum;
4521 copycol = 0;
4522 matchcol = 0;
4524 /* At first match, remember current cursor position. */
4525 if (!got_match)
4527 setpcmark();
4528 got_match = TRUE;
4532 * Loop until nothing more to replace in this line.
4533 * 1. Handle match with empty string.
4534 * 2. If do_ask is set, ask for confirmation.
4535 * 3. substitute the string.
4536 * 4. if do_all is set, find next match
4537 * 5. break if there isn't another match in this line
4539 for (;;)
4541 /* Advance "lnum" to the line where the match starts. The
4542 * match does not start in the first line when there is a line
4543 * break before \zs. */
4544 if (regmatch.startpos[0].lnum > 0)
4546 lnum += regmatch.startpos[0].lnum;
4547 sub_firstlnum += regmatch.startpos[0].lnum;
4548 nmatch -= regmatch.startpos[0].lnum;
4549 vim_free(sub_firstline);
4550 sub_firstline = NULL;
4553 if (sub_firstline == NULL)
4555 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4556 if (sub_firstline == NULL)
4558 vim_free(new_start);
4559 goto outofmem;
4563 /* Save the line number of the last change for the final
4564 * cursor position (just like Vi). */
4565 curwin->w_cursor.lnum = lnum;
4566 do_again = FALSE;
4569 * 1. Match empty string does not count, except for first
4570 * match. This reproduces the strange vi behaviour.
4571 * This also catches endless loops.
4573 if (matchcol == prev_matchcol
4574 && regmatch.endpos[0].lnum == 0
4575 && matchcol == regmatch.endpos[0].col)
4577 if (sub_firstline[matchcol] == NUL)
4578 /* We already were at the end of the line. Don't look
4579 * for a match in this line again. */
4580 skip_match = TRUE;
4581 else
4582 ++matchcol; /* search for a match at next column */
4583 goto skip;
4586 /* Normally we continue searching for a match just after the
4587 * previous match. */
4588 matchcol = regmatch.endpos[0].col;
4589 prev_matchcol = matchcol;
4592 * 2. If do_count is set only increase the counter.
4593 * If do_ask is set, ask for confirmation.
4595 if (do_count)
4597 /* For a multi-line match, put matchcol at the NUL at
4598 * the end of the line and set nmatch to one, so that
4599 * we continue looking for a match on the next line.
4600 * Avoids that ":s/\nB\@=//gc" get stuck. */
4601 if (nmatch > 1)
4603 matchcol = (colnr_T)STRLEN(sub_firstline);
4604 nmatch = 1;
4605 skip_match = TRUE;
4607 sub_nsubs++;
4608 did_sub = TRUE;
4609 goto skip;
4612 if (do_ask)
4614 /* change State to CONFIRM, so that the mouse works
4615 * properly */
4616 save_State = State;
4617 State = CONFIRM;
4618 #ifdef FEAT_MOUSE
4619 setmouse(); /* disable mouse in xterm */
4620 #endif
4621 curwin->w_cursor.col = regmatch.startpos[0].col;
4623 /* When 'cpoptions' contains "u" don't sync undo when
4624 * asking for confirmation. */
4625 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4626 ++no_u_sync;
4629 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4631 while (do_ask)
4633 if (exmode_active)
4635 char_u *resp;
4636 colnr_T sc, ec;
4638 print_line_no_prefix(lnum, FALSE, FALSE);
4640 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4641 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4642 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4643 msg_start();
4644 for (i = 0; i < (long)sc; ++i)
4645 msg_putchar(' ');
4646 for ( ; i <= (long)ec; ++i)
4647 msg_putchar('^');
4649 resp = getexmodeline('?', NULL, 0);
4650 if (resp != NULL)
4652 i = *resp;
4653 vim_free(resp);
4656 else
4658 #ifdef FEAT_FOLDING
4659 int save_p_fen = curwin->w_p_fen;
4661 curwin->w_p_fen = FALSE;
4662 #endif
4663 /* Invert the matched string.
4664 * Remove the inversion afterwards. */
4665 temp = RedrawingDisabled;
4666 RedrawingDisabled = 0;
4668 search_match_lines = regmatch.endpos[0].lnum
4669 - regmatch.startpos[0].lnum;
4670 search_match_endcol = regmatch.endpos[0].col;
4671 highlight_match = TRUE;
4673 update_topline();
4674 validate_cursor();
4675 update_screen(SOME_VALID);
4676 highlight_match = FALSE;
4677 redraw_later(SOME_VALID);
4679 #ifdef FEAT_FOLDING
4680 curwin->w_p_fen = save_p_fen;
4681 #endif
4682 if (msg_row == Rows - 1)
4683 msg_didout = FALSE; /* avoid a scroll-up */
4684 msg_starthere();
4685 i = msg_scroll;
4686 msg_scroll = 0; /* truncate msg when
4687 needed */
4688 msg_no_more = TRUE;
4689 /* write message same highlighting as for
4690 * wait_return */
4691 smsg_attr(hl_attr(HLF_R),
4692 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4693 msg_no_more = FALSE;
4694 msg_scroll = i;
4695 showruler(TRUE);
4696 windgoto(msg_row, msg_col);
4697 RedrawingDisabled = temp;
4699 #ifdef USE_ON_FLY_SCROLL
4700 dont_scroll = FALSE; /* allow scrolling here */
4701 #endif
4702 ++no_mapping; /* don't map this key */
4703 ++allow_keys; /* allow special keys */
4704 i = plain_vgetc();
4705 --allow_keys;
4706 --no_mapping;
4708 /* clear the question */
4709 msg_didout = FALSE; /* don't scroll up */
4710 msg_col = 0;
4711 gotocmdline(TRUE);
4714 need_wait_return = FALSE; /* no hit-return prompt */
4715 if (i == 'q' || i == ESC || i == Ctrl_C
4716 #ifdef UNIX
4717 || i == intr_char
4718 #endif
4721 got_quit = TRUE;
4722 break;
4724 if (i == 'n')
4725 break;
4726 if (i == 'y')
4727 break;
4728 if (i == 'l')
4730 /* last: replace and then stop */
4731 do_all = FALSE;
4732 line2 = lnum;
4733 break;
4735 if (i == 'a')
4737 do_ask = FALSE;
4738 break;
4740 #ifdef FEAT_INS_EXPAND
4741 if (i == Ctrl_E)
4742 scrollup_clamp();
4743 else if (i == Ctrl_Y)
4744 scrolldown_clamp();
4745 #endif
4747 State = save_State;
4748 #ifdef FEAT_MOUSE
4749 setmouse();
4750 #endif
4751 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4752 --no_u_sync;
4754 if (i == 'n')
4756 /* For a multi-line match, put matchcol at the NUL at
4757 * the end of the line and set nmatch to one, so that
4758 * we continue looking for a match on the next line.
4759 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4760 * get stuck when pressing 'n'. */
4761 if (nmatch > 1)
4763 matchcol = (colnr_T)STRLEN(sub_firstline);
4764 skip_match = TRUE;
4766 goto skip;
4768 if (got_quit)
4769 break;
4772 /* Move the cursor to the start of the match, so that we can
4773 * use "\=col("."). */
4774 curwin->w_cursor.col = regmatch.startpos[0].col;
4777 * 3. substitute the string.
4779 /* get length of substitution part */
4780 sublen = vim_regsub_multi(&regmatch,
4781 sub_firstlnum - regmatch.startpos[0].lnum,
4782 sub, sub_firstline, FALSE, p_magic, TRUE);
4784 /* When the match included the "$" of the last line it may
4785 * go beyond the last line of the buffer. */
4786 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4788 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4789 skip_match = TRUE;
4792 /* Need room for:
4793 * - result so far in new_start (not for first sub in line)
4794 * - original text up to match
4795 * - length of substituted part
4796 * - original text after match
4798 if (nmatch == 1)
4799 p1 = sub_firstline;
4800 else
4802 p1 = ml_get(sub_firstlnum + nmatch - 1);
4803 nmatch_tl += nmatch - 1;
4805 i = regmatch.startpos[0].col - copycol;
4806 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4807 + sublen + 1;
4808 if (new_start == NULL)
4811 * Get some space for a temporary buffer to do the
4812 * substitution into (and some extra space to avoid
4813 * too many calls to alloc()/free()).
4815 new_start_len = needed_len + 50;
4816 if ((new_start = alloc_check(new_start_len)) == NULL)
4817 goto outofmem;
4818 *new_start = NUL;
4819 new_end = new_start;
4821 else
4824 * Check if the temporary buffer is long enough to do the
4825 * substitution into. If not, make it larger (with a bit
4826 * extra to avoid too many calls to alloc()/free()).
4828 len = (unsigned)STRLEN(new_start);
4829 needed_len += len;
4830 if (needed_len > new_start_len)
4832 new_start_len = needed_len + 50;
4833 if ((p1 = alloc_check(new_start_len)) == NULL)
4835 vim_free(new_start);
4836 goto outofmem;
4838 mch_memmove(p1, new_start, (size_t)(len + 1));
4839 vim_free(new_start);
4840 new_start = p1;
4842 new_end = new_start + len;
4846 * copy the text up to the part that matched
4848 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4849 new_end += i;
4851 (void)vim_regsub_multi(&regmatch,
4852 sub_firstlnum - regmatch.startpos[0].lnum,
4853 sub, new_end, TRUE, p_magic, TRUE);
4854 sub_nsubs++;
4855 did_sub = TRUE;
4857 /* Move the cursor to the start of the line, to avoid that it
4858 * is beyond the end of the line after the substitution. */
4859 curwin->w_cursor.col = 0;
4861 /* For a multi-line match, make a copy of the last matched
4862 * line and continue in that one. */
4863 if (nmatch > 1)
4865 sub_firstlnum += nmatch - 1;
4866 vim_free(sub_firstline);
4867 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4868 /* When going beyond the last line, stop substituting. */
4869 if (sub_firstlnum <= line2)
4870 do_again = TRUE;
4871 else
4872 do_all = FALSE;
4875 /* Remember next character to be copied. */
4876 copycol = regmatch.endpos[0].col;
4878 if (skip_match)
4880 /* Already hit end of the buffer, sub_firstlnum is one
4881 * less than what it ought to be. */
4882 vim_free(sub_firstline);
4883 sub_firstline = vim_strsave((char_u *)"");
4884 copycol = 0;
4888 * Now the trick is to replace CTRL-M chars with a real line
4889 * break. This would make it impossible to insert a CTRL-M in
4890 * the text. The line break can be avoided by preceding the
4891 * CTRL-M with a backslash. To be able to insert a backslash,
4892 * they must be doubled in the string and are halved here.
4893 * That is Vi compatible.
4895 for (p1 = new_end; *p1; ++p1)
4897 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4898 mch_memmove(p1, p1 + 1, STRLEN(p1));
4899 else if (*p1 == CAR)
4901 if (u_inssub(lnum) == OK) /* prepare for undo */
4903 *p1 = NUL; /* truncate up to the CR */
4904 ml_append(lnum - 1, new_start,
4905 (colnr_T)(p1 - new_start + 1), FALSE);
4906 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4907 if (do_ask)
4908 appended_lines(lnum - 1, 1L);
4909 else
4911 if (first_line == 0)
4912 first_line = lnum;
4913 last_line = lnum + 1;
4915 /* All line numbers increase. */
4916 ++sub_firstlnum;
4917 ++lnum;
4918 ++line2;
4919 /* move the cursor to the new line, like Vi */
4920 ++curwin->w_cursor.lnum;
4921 /* copy the rest */
4922 mch_memmove(new_start, p1 + 1, STRLEN(p1 + 1) + 1);
4923 p1 = new_start - 1;
4926 #ifdef FEAT_MBYTE
4927 else if (has_mbyte)
4928 p1 += (*mb_ptr2len)(p1) - 1;
4929 #endif
4933 * 4. If do_all is set, find next match.
4934 * Prevent endless loop with patterns that match empty
4935 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4936 * But ":s/\n/#/" is OK.
4938 skip:
4939 /* We already know that we did the last subst when we are at
4940 * the end of the line, except that a pattern like
4941 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4942 * "line2" when there is a \zs in the pattern after a line
4943 * break. */
4944 lastone = (skip_match
4945 || got_int
4946 || got_quit
4947 || lnum > line2
4948 || !(do_all || do_again)
4949 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4950 && !re_multiline(regmatch.regprog)));
4951 nmatch = -1;
4954 * Replace the line in the buffer when needed. This is
4955 * skipped when there are more matches.
4956 * The check for nmatch_tl is needed for when multi-line
4957 * matching must replace the lines before trying to do another
4958 * match, otherwise "\@<=" won't work.
4959 * When asking the user we like to show the already replaced
4960 * text, but don't do it when "\<@=" or "\<@!" is used, it
4961 * changes what matches.
4962 * When the match starts below where we start searching also
4963 * need to replace the line first (using \zs after \n).
4965 if (lastone
4966 || (do_ask && !re_lookbehind(regmatch.regprog))
4967 || nmatch_tl > 0
4968 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4969 curbuf, sub_firstlnum,
4970 matchcol, NULL)) == 0
4971 || regmatch.startpos[0].lnum > 0)
4973 if (new_start != NULL)
4976 * Copy the rest of the line, that didn't match.
4977 * "matchcol" has to be adjusted, we use the end of
4978 * the line as reference, because the substitute may
4979 * have changed the number of characters. Same for
4980 * "prev_matchcol".
4982 STRCAT(new_start, sub_firstline + copycol);
4983 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4984 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4985 - prev_matchcol;
4987 if (u_savesub(lnum) != OK)
4988 break;
4989 ml_replace(lnum, new_start, TRUE);
4991 if (nmatch_tl > 0)
4994 * Matched lines have now been substituted and are
4995 * useless, delete them. The part after the match
4996 * has been appended to new_start, we don't need
4997 * it in the buffer.
4999 ++lnum;
5000 if (u_savedel(lnum, nmatch_tl) != OK)
5001 break;
5002 for (i = 0; i < nmatch_tl; ++i)
5003 ml_delete(lnum, (int)FALSE);
5004 mark_adjust(lnum, lnum + nmatch_tl - 1,
5005 (long)MAXLNUM, -nmatch_tl);
5006 if (do_ask)
5007 deleted_lines(lnum, nmatch_tl);
5008 --lnum;
5009 line2 -= nmatch_tl; /* nr of lines decreases */
5010 nmatch_tl = 0;
5013 /* When asking, undo is saved each time, must also set
5014 * changed flag each time. */
5015 if (do_ask)
5016 changed_bytes(lnum, 0);
5017 else
5019 if (first_line == 0)
5020 first_line = lnum;
5021 last_line = lnum + 1;
5024 sub_firstlnum = lnum;
5025 vim_free(sub_firstline); /* free the temp buffer */
5026 sub_firstline = new_start;
5027 new_start = NULL;
5028 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5029 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5030 - prev_matchcol;
5031 copycol = 0;
5033 if (nmatch == -1 && !lastone)
5034 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
5035 sub_firstlnum, matchcol, NULL);
5038 * 5. break if there isn't another match in this line
5040 if (nmatch <= 0)
5042 /* If the match found didn't start where we were
5043 * searching, do the next search in the line where we
5044 * found the match. */
5045 if (nmatch == -1)
5046 lnum -= regmatch.startpos[0].lnum;
5047 break;
5051 line_breakcheck();
5054 if (did_sub)
5055 ++sub_nlines;
5056 vim_free(sub_firstline); /* free the copy of the original line */
5057 sub_firstline = NULL;
5060 line_breakcheck();
5063 if (first_line != 0)
5065 /* Need to subtract the number of added lines from "last_line" to get
5066 * the line number before the change (same as adding the number of
5067 * deleted lines). */
5068 i = curbuf->b_ml.ml_line_count - old_line_count;
5069 changed_lines(first_line, 0, last_line - i, i);
5072 outofmem:
5073 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5075 /* ":s/pat//n" doesn't move the cursor */
5076 if (do_count)
5077 curwin->w_cursor = old_cursor;
5079 if (sub_nsubs)
5081 /* Set the '[ and '] marks. */
5082 curbuf->b_op_start.lnum = eap->line1;
5083 curbuf->b_op_end.lnum = line2;
5084 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5086 if (!global_busy)
5088 if (endcolumn)
5089 coladvance((colnr_T)MAXCOL);
5090 else
5091 beginline(BL_WHITE | BL_FIX);
5092 if (!do_sub_msg(do_count) && do_ask)
5093 MSG("");
5095 else
5096 global_need_beginline = TRUE;
5097 if (do_print)
5098 print_line(curwin->w_cursor.lnum, do_number, do_list);
5100 else if (!global_busy)
5102 if (got_int) /* interrupted */
5103 EMSG(_(e_interr));
5104 else if (got_match) /* did find something but nothing substituted */
5105 MSG("");
5106 else if (do_error) /* nothing found */
5107 EMSG2(_(e_patnotf2), get_search_pat());
5110 vim_free(regmatch.regprog);
5114 * Give message for number of substitutions.
5115 * Can also be used after a ":global" command.
5116 * Return TRUE if a message was given.
5119 do_sub_msg(count_only)
5120 int count_only; /* used 'n' flag for ":s" */
5122 int len = 0;
5125 * Only report substitutions when:
5126 * - more than 'report' substitutions
5127 * - command was typed by user, or number of changed lines > 'report'
5128 * - giving messages is not disabled by 'lazyredraw'
5130 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5131 || count_only)
5132 && messaging())
5134 if (got_int)
5136 STRCPY(msg_buf, _("(Interrupted) "));
5137 len = (int)STRLEN(msg_buf);
5139 if (sub_nsubs == 1)
5140 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5141 "%s", count_only ? _("1 match") : _("1 substitution"));
5142 else
5143 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5144 count_only ? _("%ld matches") : _("%ld substitutions"),
5145 sub_nsubs);
5146 len = (int)STRLEN(msg_buf);
5147 if (sub_nlines == 1)
5148 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5149 "%s", _(" on 1 line"));
5150 else
5151 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5152 _(" on %ld lines"), (long)sub_nlines);
5153 if (msg(msg_buf))
5154 /* save message to display it after redraw */
5155 set_keep_msg(msg_buf, 0);
5156 return TRUE;
5158 if (got_int)
5160 EMSG(_(e_interr));
5161 return TRUE;
5163 return FALSE;
5167 * Execute a global command of the form:
5169 * g/pattern/X : execute X on all lines where pattern matches
5170 * v/pattern/X : execute X on all lines where pattern does not match
5172 * where 'X' is an EX command
5174 * The command character (as well as the trailing slash) is optional, and
5175 * is assumed to be 'p' if missing.
5177 * This is implemented in two passes: first we scan the file for the pattern and
5178 * set a mark for each line that (not) matches. secondly we execute the command
5179 * for each line that has a mark. This is required because after deleting
5180 * lines we do not know where to search for the next match.
5182 void
5183 ex_global(eap)
5184 exarg_T *eap;
5186 linenr_T lnum; /* line number according to old situation */
5187 int ndone = 0;
5188 int type; /* first char of cmd: 'v' or 'g' */
5189 char_u *cmd; /* command argument */
5191 char_u delim; /* delimiter, normally '/' */
5192 char_u *pat;
5193 regmmatch_T regmatch;
5194 int match;
5195 int which_pat;
5197 if (global_busy)
5199 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5200 return;
5203 if (eap->forceit) /* ":global!" is like ":vglobal" */
5204 type = 'v';
5205 else
5206 type = *eap->cmd;
5207 cmd = eap->arg;
5208 which_pat = RE_LAST; /* default: use last used regexp */
5209 sub_nsubs = 0;
5210 sub_nlines = 0;
5213 * undocumented vi feature:
5214 * "\/" and "\?": use previous search pattern.
5215 * "\&": use previous substitute pattern.
5217 if (*cmd == '\\')
5219 ++cmd;
5220 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5222 EMSG(_(e_backslash));
5223 return;
5225 if (*cmd == '&')
5226 which_pat = RE_SUBST; /* use previous substitute pattern */
5227 else
5228 which_pat = RE_SEARCH; /* use previous search pattern */
5229 ++cmd;
5230 pat = (char_u *)"";
5232 else if (*cmd == NUL)
5234 EMSG(_("E148: Regular expression missing from global"));
5235 return;
5237 else
5239 delim = *cmd; /* get the delimiter */
5240 if (delim)
5241 ++cmd; /* skip delimiter if there is one */
5242 pat = cmd; /* remember start of pattern */
5243 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5244 if (cmd[0] == delim) /* end delimiter found */
5245 *cmd++ = NUL; /* replace it with a NUL */
5248 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5249 if (p_altkeymap && curwin->w_p_rl)
5250 lrFswap(pat,0);
5251 #endif
5253 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5255 EMSG(_(e_invcmd));
5256 return;
5260 * pass 1: set marks for each (not) matching line
5262 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5264 /* a match on this line? */
5265 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5266 (colnr_T)0, NULL);
5267 if ((type == 'g' && match) || (type == 'v' && !match))
5269 ml_setmarked(lnum);
5270 ndone++;
5272 line_breakcheck();
5276 * pass 2: execute the command for each line that has been marked
5278 if (got_int)
5279 MSG(_(e_interr));
5280 else if (ndone == 0)
5282 if (type == 'v')
5283 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5284 else
5285 smsg((char_u *)_(e_patnotf2), pat);
5287 else
5288 global_exe(cmd);
5290 ml_clearmarked(); /* clear rest of the marks */
5291 vim_free(regmatch.regprog);
5295 * Execute "cmd" on lines marked with ml_setmarked().
5297 void
5298 global_exe(cmd)
5299 char_u *cmd;
5301 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5302 linenr_T lnum; /* line number according to old situation */
5305 * Set current position only once for a global command.
5306 * If global_busy is set, setpcmark() will not do anything.
5307 * If there is an error, global_busy will be incremented.
5309 setpcmark();
5311 /* When the command writes a message, don't overwrite the command. */
5312 msg_didout = TRUE;
5314 global_need_beginline = FALSE;
5315 global_busy = 1;
5316 old_lcount = curbuf->b_ml.ml_line_count;
5317 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5319 curwin->w_cursor.lnum = lnum;
5320 curwin->w_cursor.col = 0;
5321 if (*cmd == NUL || *cmd == '\n')
5322 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5323 else
5324 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5325 ui_breakcheck();
5328 global_busy = 0;
5329 if (global_need_beginline)
5330 beginline(BL_WHITE | BL_FIX);
5331 else
5332 check_cursor(); /* cursor may be beyond the end of the line */
5334 /* the cursor may not have moved in the text but a change in a previous
5335 * line may move it on the screen */
5336 changed_line_abv_curs();
5338 /* If it looks like no message was written, allow overwriting the
5339 * command with the report for number of changes. */
5340 if (msg_col == 0 && msg_scrolled == 0)
5341 msg_didout = FALSE;
5343 /* If substitutes done, report number of substitutes, otherwise report
5344 * number of extra or deleted lines. */
5345 if (!do_sub_msg(FALSE))
5346 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5349 #ifdef FEAT_VIMINFO
5351 read_viminfo_sub_string(virp, force)
5352 vir_T *virp;
5353 int force;
5355 if (old_sub != NULL && force)
5356 vim_free(old_sub);
5357 if (force || old_sub == NULL)
5358 old_sub = viminfo_readstring(virp, 1, TRUE);
5359 return viminfo_readline(virp);
5362 void
5363 write_viminfo_sub_string(fp)
5364 FILE *fp;
5366 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5368 fprintf(fp, _("\n# Last Substitute String:\n$"));
5369 viminfo_writestring(fp, old_sub);
5372 #endif /* FEAT_VIMINFO */
5374 #if defined(EXITFREE) || defined(PROTO)
5375 void
5376 free_old_sub()
5378 vim_free(old_sub);
5380 #endif
5382 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5384 * Set up for a tagpreview.
5385 * Return TRUE when it was created.
5388 prepare_tagpreview(undo_sync)
5389 int undo_sync; /* sync undo when leaving the window */
5391 win_T *wp;
5393 # ifdef FEAT_GUI
5394 need_mouse_correct = TRUE;
5395 # endif
5398 * If there is already a preview window open, use that one.
5400 if (!curwin->w_p_pvw)
5402 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5403 if (wp->w_p_pvw)
5404 break;
5405 if (wp != NULL)
5406 win_enter(wp, undo_sync);
5407 else
5410 * There is no preview window open yet. Create one.
5412 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5413 == FAIL)
5414 return FALSE;
5415 curwin->w_p_pvw = TRUE;
5416 curwin->w_p_wfh = TRUE;
5417 # ifdef FEAT_SCROLLBIND
5418 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5419 # endif
5420 # ifdef FEAT_DIFF
5421 curwin->w_p_diff = FALSE; /* no 'diff' */
5422 # endif
5423 # ifdef FEAT_FOLDING
5424 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5425 # endif
5426 return TRUE;
5429 return FALSE;
5432 #endif
5436 * ":help": open a read-only window on a help file
5438 void
5439 ex_help(eap)
5440 exarg_T *eap;
5442 char_u *arg;
5443 char_u *tag;
5444 FILE *helpfd; /* file descriptor of help file */
5445 int n;
5446 int i;
5447 #ifdef FEAT_WINDOWS
5448 win_T *wp;
5449 #endif
5450 int num_matches;
5451 char_u **matches;
5452 char_u *p;
5453 int empty_fnum = 0;
5454 int alt_fnum = 0;
5455 buf_T *buf;
5456 #ifdef FEAT_MULTI_LANG
5457 int len;
5458 char_u *lang;
5459 #endif
5461 if (eap != NULL)
5464 * A ":help" command ends at the first LF, or at a '|' that is
5465 * followed by some text. Set nextcmd to the following command.
5467 for (arg = eap->arg; *arg; ++arg)
5469 if (*arg == '\n' || *arg == '\r'
5470 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5472 *arg++ = NUL;
5473 eap->nextcmd = arg;
5474 break;
5477 arg = eap->arg;
5479 if (eap->forceit && *arg == NUL)
5481 EMSG(_("E478: Don't panic!"));
5482 return;
5485 if (eap->skip) /* not executing commands */
5486 return;
5488 else
5489 arg = (char_u *)"";
5491 /* remove trailing blanks */
5492 p = arg + STRLEN(arg) - 1;
5493 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5494 *p-- = NUL;
5496 #ifdef FEAT_MULTI_LANG
5497 /* Check for a specified language */
5498 lang = check_help_lang(arg);
5499 #endif
5501 /* When no argument given go to the index. */
5502 if (*arg == NUL)
5503 arg = (char_u *)"help.txt";
5506 * Check if there is a match for the argument.
5508 n = find_help_tags(arg, &num_matches, &matches,
5509 eap != NULL && eap->forceit);
5511 i = 0;
5512 #ifdef FEAT_MULTI_LANG
5513 if (n != FAIL && lang != NULL)
5514 /* Find first item with the requested language. */
5515 for (i = 0; i < num_matches; ++i)
5517 len = (int)STRLEN(matches[i]);
5518 if (len > 3 && matches[i][len - 3] == '@'
5519 && STRICMP(matches[i] + len - 2, lang) == 0)
5520 break;
5522 #endif
5523 if (i >= num_matches || n == FAIL)
5525 #ifdef FEAT_MULTI_LANG
5526 if (lang != NULL)
5527 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5528 else
5529 #endif
5530 EMSG2(_("E149: Sorry, no help for %s"), arg);
5531 if (n != FAIL)
5532 FreeWild(num_matches, matches);
5533 return;
5536 /* The first match (in the requested language) is the best match. */
5537 tag = vim_strsave(matches[i]);
5538 FreeWild(num_matches, matches);
5540 #ifdef FEAT_GUI
5541 need_mouse_correct = TRUE;
5542 #endif
5545 * Re-use an existing help window or open a new one.
5546 * Always open a new one for ":tab help".
5548 if (!curwin->w_buffer->b_help
5549 #ifdef FEAT_WINDOWS
5550 || cmdmod.tab != 0
5551 #endif
5554 #ifdef FEAT_WINDOWS
5555 if (cmdmod.tab != 0)
5556 wp = NULL;
5557 else
5558 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5559 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5560 break;
5561 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5562 win_enter(wp, TRUE);
5563 else
5564 #endif
5567 * There is no help window yet.
5568 * Try to open the file specified by the "helpfile" option.
5570 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5572 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5573 goto erret;
5575 fclose(helpfd);
5577 #ifdef FEAT_WINDOWS
5578 /* Split off help window; put it at far top if no position
5579 * specified, the current window is vertically split and
5580 * narrow. */
5581 n = WSP_HELP;
5582 # ifdef FEAT_VERTSPLIT
5583 if (cmdmod.split == 0 && curwin->w_width != Columns
5584 && curwin->w_width < 80)
5585 n |= WSP_TOP;
5586 # endif
5587 if (win_split(0, n) == FAIL)
5588 goto erret;
5589 #else
5590 /* use current window */
5591 if (!can_abandon(curbuf, FALSE))
5592 goto erret;
5593 #endif
5595 #ifdef FEAT_WINDOWS
5596 if (curwin->w_height < p_hh)
5597 win_setheight((int)p_hh);
5598 #endif
5601 * Open help file (do_ecmd() will set b_help flag, readfile() will
5602 * set b_p_ro flag).
5603 * Set the alternate file to the previously edited file.
5605 alt_fnum = curbuf->b_fnum;
5606 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5607 ECMD_HIDE + ECMD_SET_HELP);
5608 if (!cmdmod.keepalt)
5609 curwin->w_alt_fnum = alt_fnum;
5610 empty_fnum = curbuf->b_fnum;
5614 if (!p_im)
5615 restart_edit = 0; /* don't want insert mode in help file */
5617 if (tag != NULL)
5618 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5620 /* Delete the empty buffer if we're not using it. Careful: autocommands
5621 * may have jumped to another window, check that the buffer is not in a
5622 * window. */
5623 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5625 buf = buflist_findnr(empty_fnum);
5626 if (buf != NULL && buf->b_nwindows == 0)
5627 wipe_buffer(buf, TRUE);
5630 /* keep the previous alternate file */
5631 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5632 curwin->w_alt_fnum = alt_fnum;
5634 erret:
5635 vim_free(tag);
5639 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5641 * In an argument search for a language specifiers in the form "@xx".
5642 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5643 * Returns NULL if not found.
5645 char_u *
5646 check_help_lang(arg)
5647 char_u *arg;
5649 int len = (int)STRLEN(arg);
5651 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5652 && ASCII_ISALPHA(arg[len - 1]))
5654 arg[len - 3] = NUL; /* remove the '@' */
5655 return arg + len - 2;
5657 return NULL;
5659 #endif
5662 * Return a heuristic indicating how well the given string matches. The
5663 * smaller the number, the better the match. This is the order of priorities,
5664 * from best match to worst match:
5665 * - Match with least alpha-numeric characters is better.
5666 * - Match with least total characters is better.
5667 * - Match towards the start is better.
5668 * - Match starting with "+" is worse (feature instead of command)
5669 * Assumption is made that the matched_string passed has already been found to
5670 * match some string for which help is requested. webb.
5673 help_heuristic(matched_string, offset, wrong_case)
5674 char_u *matched_string;
5675 int offset; /* offset for match */
5676 int wrong_case; /* no matching case */
5678 int num_letters;
5679 char_u *p;
5681 num_letters = 0;
5682 for (p = matched_string; *p; p++)
5683 if (ASCII_ISALNUM(*p))
5684 num_letters++;
5687 * Multiply the number of letters by 100 to give it a much bigger
5688 * weighting than the number of characters.
5689 * If there only is a match while ignoring case, add 5000.
5690 * If the match starts in the middle of a word, add 10000 to put it
5691 * somewhere in the last half.
5692 * If the match is more than 2 chars from the start, multiply by 200 to
5693 * put it after matches at the start.
5695 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5696 && ASCII_ISALNUM(matched_string[offset - 1]))
5697 offset += 10000;
5698 else if (offset > 2)
5699 offset *= 200;
5700 if (wrong_case)
5701 offset += 5000;
5702 /* Features are less interesting than the subjects themselves, but "+"
5703 * alone is not a feature. */
5704 if (matched_string[0] == '+' && matched_string[1] != NUL)
5705 offset += 100;
5706 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5710 * Compare functions for qsort() below, that checks the help heuristics number
5711 * that has been put after the tagname by find_tags().
5713 static int
5714 #ifdef __BORLANDC__
5715 _RTLENTRYF
5716 #endif
5717 help_compare(s1, s2)
5718 const void *s1;
5719 const void *s2;
5721 char *p1;
5722 char *p2;
5724 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5725 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5726 return strcmp(p1, p2);
5730 * Find all help tags matching "arg", sort them and return in matches[], with
5731 * the number of matches in num_matches.
5732 * The matches will be sorted with a "best" match algorithm.
5733 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5736 find_help_tags(arg, num_matches, matches, keep_lang)
5737 char_u *arg;
5738 int *num_matches;
5739 char_u ***matches;
5740 int keep_lang;
5742 char_u *s, *d;
5743 int i;
5744 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5745 "/*", "/\\*", "\"*", "**",
5746 "/\\(\\)",
5747 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5748 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5749 "[count]", "[quotex]", "[range]",
5750 "[pattern]", "\\|", "\\%$"};
5751 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5752 "/star", "/\\\\star", "quotestar", "starstar",
5753 "/\\\\(\\\\)",
5754 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5755 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5756 "\\[count]", "\\[quotex]", "\\[range]",
5757 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5758 int flags;
5760 d = IObuff; /* assume IObuff is long enough! */
5763 * Recognize a few exceptions to the rule. Some strings that contain '*'
5764 * with "star". Otherwise '*' is recognized as a wildcard.
5766 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5767 if (STRCMP(arg, mtable[i]) == 0)
5769 STRCPY(d, rtable[i]);
5770 break;
5773 if (i < 0) /* no match in table */
5775 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5776 * Also replace "\%^" and "\%(", they match every tag too.
5777 * Also "\zs", "\z1", etc.
5778 * Also "\@<", "\@=", "\@<=", etc.
5779 * And also "\_$" and "\_^". */
5780 if (arg[0] == '\\'
5781 && ((arg[1] != NUL && arg[2] == NUL)
5782 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5783 && arg[2] != NUL)))
5785 STRCPY(d, "/\\\\");
5786 STRCPY(d + 3, arg + 1);
5787 /* Check for "/\\_$", should be "/\\_\$" */
5788 if (d[3] == '_' && d[4] == '$')
5789 STRCPY(d + 4, "\\$");
5791 else
5793 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5794 if (arg[0] == '[' && (arg[1] == ':'
5795 || (arg[1] == '+' && arg[2] == '+')))
5796 *d++ = '\\';
5798 for (s = arg; *s; ++s)
5801 * Replace "|" with "bar" and '"' with "quote" to match the name of
5802 * the tags for these commands.
5803 * Replace "*" with ".*" and "?" with "." to match command line
5804 * completion.
5805 * Insert a backslash before '~', '$' and '.' to avoid their
5806 * special meaning.
5808 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5809 break;
5810 switch (*s)
5812 case '|': STRCPY(d, "bar");
5813 d += 3;
5814 continue;
5815 case '"': STRCPY(d, "quote");
5816 d += 5;
5817 continue;
5818 case '*': *d++ = '.';
5819 break;
5820 case '?': *d++ = '.';
5821 continue;
5822 case '$':
5823 case '.':
5824 case '~': *d++ = '\\';
5825 break;
5829 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5830 * ":help i_^_CTRL-D" work.
5831 * Insert '-' before and after "CTRL-X" when applicable.
5833 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5834 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5836 if (d > IObuff && d[-1] != '_')
5837 *d++ = '_'; /* prepend a '_' */
5838 STRCPY(d, "CTRL-");
5839 d += 5;
5840 if (*s < ' ')
5842 #ifdef EBCDIC
5843 *d++ = CtrlChar(*s);
5844 #else
5845 *d++ = *s + '@';
5846 #endif
5847 if (d[-1] == '\\')
5848 *d++ = '\\'; /* double a backslash */
5850 else
5851 *d++ = *++s;
5852 if (s[1] != NUL && s[1] != '_')
5853 *d++ = '_'; /* append a '_' */
5854 continue;
5856 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5857 *d++ = '\\';
5860 * Insert a backslash before a backslash after a slash, for search
5861 * pattern tags: "/\|" --> "/\\|".
5863 else if (s[0] == '\\' && s[1] != '\\'
5864 && *arg == '/' && s == arg + 1)
5865 *d++ = '\\';
5867 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5868 * "CTRL-\_CTRL-N" */
5869 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5871 STRCPY(d, "CTRL-\\\\");
5872 d += 7;
5873 s += 6;
5876 *d++ = *s;
5879 * If tag starts with ', toss everything after a second '. Fixes
5880 * CTRL-] on 'option'. (would include the trailing '.').
5882 if (*s == '\'' && s > arg && *arg == '\'')
5883 break;
5885 *d = NUL;
5889 *matches = (char_u **)"";
5890 *num_matches = 0;
5891 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5892 if (keep_lang)
5893 flags |= TAG_KEEP_LANG;
5894 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5895 && *num_matches > 0)
5896 /* Sort the matches found on the heuristic number that is after the
5897 * tag name. */
5898 qsort((void *)*matches, (size_t)*num_matches,
5899 sizeof(char_u *), help_compare);
5900 return OK;
5904 * After reading a help file: May cleanup a help buffer when syntax
5905 * highlighting is not used.
5907 void
5908 fix_help_buffer()
5910 linenr_T lnum;
5911 char_u *line;
5912 int in_example = FALSE;
5913 int len;
5914 char_u *p;
5915 char_u *rt;
5916 int mustfree;
5918 /* set filetype to "help". */
5919 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5921 #ifdef FEAT_SYN_HL
5922 if (!syntax_present(curbuf))
5923 #endif
5925 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5927 line = ml_get_buf(curbuf, lnum, FALSE);
5928 len = (int)STRLEN(line);
5929 if (in_example && len > 0 && !vim_iswhite(line[0]))
5931 /* End of example: non-white or '<' in first column. */
5932 if (line[0] == '<')
5934 /* blank-out a '<' in the first column */
5935 line = ml_get_buf(curbuf, lnum, TRUE);
5936 line[0] = ' ';
5938 in_example = FALSE;
5940 if (!in_example && len > 0)
5942 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5944 /* blank-out a '>' in the last column (start of example) */
5945 line = ml_get_buf(curbuf, lnum, TRUE);
5946 line[len - 1] = ' ';
5947 in_example = TRUE;
5949 else if (line[len - 1] == '~')
5951 /* blank-out a '~' at the end of line (header marker) */
5952 line = ml_get_buf(curbuf, lnum, TRUE);
5953 line[len - 1] = ' ';
5960 * In the "help.txt" file, add the locally added help files.
5961 * This uses the very first line in the help file.
5963 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5965 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5967 line = ml_get_buf(curbuf, lnum, FALSE);
5968 if (strstr((char *)line, "*local-additions*") != NULL)
5970 /* Go through all directories in 'runtimepath', skipping
5971 * $VIMRUNTIME. */
5972 p = p_rtp;
5973 while (*p != NUL)
5975 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5976 mustfree = FALSE;
5977 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5978 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5980 int fcount;
5981 char_u **fnames;
5982 FILE *fd;
5983 char_u *s;
5984 int fi;
5985 #ifdef FEAT_MBYTE
5986 vimconv_T vc;
5987 char_u *cp;
5988 #endif
5990 /* Find all "doc/ *.txt" files in this directory. */
5991 add_pathsep(NameBuff);
5992 STRCAT(NameBuff, "doc/*.txt");
5993 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5994 &fnames, EW_FILE|EW_SILENT) == OK
5995 && fcount > 0)
5997 for (fi = 0; fi < fcount; ++fi)
5999 fd = mch_fopen((char *)fnames[fi], "r");
6000 if (fd != NULL)
6002 vim_fgets(IObuff, IOSIZE, fd);
6003 if (IObuff[0] == '*'
6004 && (s = vim_strchr(IObuff + 1, '*'))
6005 != NULL)
6007 #ifdef FEAT_MBYTE
6008 int this_utf = MAYBE;
6009 #endif
6010 /* Change tag definition to a
6011 * reference and remove <CR>/<NL>. */
6012 IObuff[0] = '|';
6013 *s = '|';
6014 while (*s != NUL)
6016 if (*s == '\r' || *s == '\n')
6017 *s = NUL;
6018 #ifdef FEAT_MBYTE
6019 /* The text is utf-8 when a byte
6020 * above 127 is found and no
6021 * illegal byte sequence is found.
6023 if (*s >= 0x80 && this_utf != FALSE)
6025 int l;
6027 this_utf = TRUE;
6028 l = utf_ptr2len(s);
6029 if (l == 1)
6030 this_utf = FALSE;
6031 s += l - 1;
6033 #endif
6034 ++s;
6036 #ifdef FEAT_MBYTE
6037 /* The help file is latin1 or utf-8;
6038 * conversion to the current
6039 * 'encoding' may be required. */
6040 vc.vc_type = CONV_NONE;
6041 convert_setup(&vc, (char_u *)(
6042 this_utf == TRUE ? "utf-8"
6043 : "latin1"), p_enc);
6044 if (vc.vc_type == CONV_NONE)
6045 /* No conversion needed. */
6046 cp = IObuff;
6047 else
6049 /* Do the conversion. If it fails
6050 * use the unconverted text. */
6051 cp = string_convert(&vc, IObuff,
6052 NULL);
6053 if (cp == NULL)
6054 cp = IObuff;
6056 convert_setup(&vc, NULL, NULL);
6058 ml_append(lnum, cp, (colnr_T)0, FALSE);
6059 if (cp != IObuff)
6060 vim_free(cp);
6061 #else
6062 ml_append(lnum, IObuff, (colnr_T)0,
6063 FALSE);
6064 #endif
6065 ++lnum;
6067 fclose(fd);
6070 FreeWild(fcount, fnames);
6073 if (mustfree)
6074 vim_free(rt);
6076 break;
6083 * ":exusage"
6085 /*ARGSUSED*/
6086 void
6087 ex_exusage(eap)
6088 exarg_T *eap;
6090 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6094 * ":viusage"
6096 /*ARGSUSED*/
6097 void
6098 ex_viusage(eap)
6099 exarg_T *eap;
6101 do_cmdline_cmd((char_u *)"help normal-index");
6104 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6105 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
6108 * ":helptags"
6110 void
6111 ex_helptags(eap)
6112 exarg_T *eap;
6114 garray_T ga;
6115 int i, j;
6116 int len;
6117 #ifdef FEAT_MULTI_LANG
6118 char_u lang[2];
6119 #endif
6120 expand_T xpc;
6121 char_u *dirname;
6122 char_u ext[5];
6123 char_u fname[8];
6124 int filecount;
6125 char_u **files;
6126 int add_help_tags = FALSE;
6128 /* Check for ":helptags ++t {dir}". */
6129 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6131 add_help_tags = TRUE;
6132 eap->arg = skipwhite(eap->arg + 3);
6135 ExpandInit(&xpc);
6136 xpc.xp_context = EXPAND_DIRECTORIES;
6137 dirname = ExpandOne(&xpc, eap->arg, NULL,
6138 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6139 if (dirname == NULL || !mch_isdir(dirname))
6141 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6142 return;
6145 #ifdef FEAT_MULTI_LANG
6146 /* Get a list of all files in the directory. */
6147 STRCPY(NameBuff, dirname);
6148 add_pathsep(NameBuff);
6149 STRCAT(NameBuff, "*");
6150 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6151 EW_FILE|EW_SILENT) == FAIL
6152 || filecount == 0)
6154 EMSG2("E151: No match: %s", NameBuff);
6155 vim_free(dirname);
6156 return;
6159 /* Go over all files in the directory to find out what languages are
6160 * present. */
6161 ga_init2(&ga, 1, 10);
6162 for (i = 0; i < filecount; ++i)
6164 len = (int)STRLEN(files[i]);
6165 if (len > 4)
6167 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6169 /* ".txt" -> language "en" */
6170 lang[0] = 'e';
6171 lang[1] = 'n';
6173 else if (files[i][len - 4] == '.'
6174 && ASCII_ISALPHA(files[i][len - 3])
6175 && ASCII_ISALPHA(files[i][len - 2])
6176 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6178 /* ".abx" -> language "ab" */
6179 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6180 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6182 else
6183 continue;
6185 /* Did we find this language already? */
6186 for (j = 0; j < ga.ga_len; j += 2)
6187 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6188 break;
6189 if (j == ga.ga_len)
6191 /* New language, add it. */
6192 if (ga_grow(&ga, 2) == FAIL)
6193 break;
6194 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6195 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6201 * Loop over the found languages to generate a tags file for each one.
6203 for (j = 0; j < ga.ga_len; j += 2)
6205 STRCPY(fname, "tags-xx");
6206 fname[5] = ((char_u *)ga.ga_data)[j];
6207 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6208 if (fname[5] == 'e' && fname[6] == 'n')
6210 /* English is an exception: use ".txt" and "tags". */
6211 fname[4] = NUL;
6212 STRCPY(ext, ".txt");
6214 else
6216 /* Language "ab" uses ".abx" and "tags-ab". */
6217 STRCPY(ext, ".xxx");
6218 ext[1] = fname[5];
6219 ext[2] = fname[6];
6221 helptags_one(dirname, ext, fname, add_help_tags);
6224 ga_clear(&ga);
6225 FreeWild(filecount, files);
6227 #else
6228 /* No language support, just use "*.txt" and "tags". */
6229 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6230 #endif
6231 vim_free(dirname);
6234 static void
6235 helptags_one(dir, ext, tagfname, add_help_tags)
6236 char_u *dir; /* doc directory */
6237 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6238 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6239 int add_help_tags; /* add "help-tags" tag */
6241 FILE *fd_tags;
6242 FILE *fd;
6243 garray_T ga;
6244 int filecount;
6245 char_u **files;
6246 char_u *p1, *p2;
6247 int fi;
6248 char_u *s;
6249 int i;
6250 char_u *fname;
6251 # ifdef FEAT_MBYTE
6252 int utf8 = MAYBE;
6253 int this_utf8;
6254 int firstline;
6255 int mix = FALSE; /* detected mixed encodings */
6256 # endif
6259 * Find all *.txt files.
6261 STRCPY(NameBuff, dir);
6262 add_pathsep(NameBuff);
6263 STRCAT(NameBuff, "*");
6264 STRCAT(NameBuff, ext);
6265 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6266 EW_FILE|EW_SILENT) == FAIL
6267 || filecount == 0)
6269 if (!got_int)
6270 EMSG2("E151: No match: %s", NameBuff);
6271 return;
6275 * Open the tags file for writing.
6276 * Do this before scanning through all the files.
6278 STRCPY(NameBuff, dir);
6279 add_pathsep(NameBuff);
6280 STRCAT(NameBuff, tagfname);
6281 fd_tags = mch_fopen((char *)NameBuff, "w");
6282 if (fd_tags == NULL)
6284 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6285 FreeWild(filecount, files);
6286 return;
6290 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6291 * add the "help-tags" tag.
6293 ga_init2(&ga, (int)sizeof(char_u *), 100);
6294 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6295 dir, FALSE) == FPC_SAME)
6297 if (ga_grow(&ga, 1) == FAIL)
6298 got_int = TRUE;
6299 else
6301 s = alloc(18 + (unsigned)STRLEN(tagfname));
6302 if (s == NULL)
6303 got_int = TRUE;
6304 else
6306 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6307 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6308 ++ga.ga_len;
6314 * Go over all the files and extract the tags.
6316 for (fi = 0; fi < filecount && !got_int; ++fi)
6318 fd = mch_fopen((char *)files[fi], "r");
6319 if (fd == NULL)
6321 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6322 continue;
6324 fname = gettail(files[fi]);
6326 # ifdef FEAT_MBYTE
6327 firstline = TRUE;
6328 # endif
6329 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6331 # ifdef FEAT_MBYTE
6332 if (firstline)
6334 /* Detect utf-8 file by a non-ASCII char in the first line. */
6335 this_utf8 = MAYBE;
6336 for (s = IObuff; *s != NUL; ++s)
6337 if (*s >= 0x80)
6339 int l;
6341 this_utf8 = TRUE;
6342 l = utf_ptr2len(s);
6343 if (l == 1)
6345 /* Illegal UTF-8 byte sequence. */
6346 this_utf8 = FALSE;
6347 break;
6349 s += l - 1;
6351 if (this_utf8 == MAYBE) /* only ASCII characters found */
6352 this_utf8 = FALSE;
6353 if (utf8 == MAYBE) /* first file */
6354 utf8 = this_utf8;
6355 else if (utf8 != this_utf8)
6357 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6358 mix = !got_int;
6359 got_int = TRUE;
6361 firstline = FALSE;
6363 # endif
6364 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6365 while (p1 != NULL)
6367 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6368 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6370 for (s = p1 + 1; s < p2; ++s)
6371 if (*s == ' ' || *s == '\t' || *s == '|')
6372 break;
6375 * Only accept a *tag* when it consists of valid
6376 * characters, there is white space before it and is
6377 * followed by a white character or end-of-line.
6379 if (s == p2
6380 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6381 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6382 || s[1] == '\0'))
6384 *p2 = '\0';
6385 ++p1;
6386 if (ga_grow(&ga, 1) == FAIL)
6388 got_int = TRUE;
6389 break;
6391 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6392 if (s == NULL)
6394 got_int = TRUE;
6395 break;
6397 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6398 ++ga.ga_len;
6399 sprintf((char *)s, "%s\t%s", p1, fname);
6401 /* find next '*' */
6402 p2 = vim_strchr(p2 + 1, '*');
6405 p1 = p2;
6407 line_breakcheck();
6410 fclose(fd);
6413 FreeWild(filecount, files);
6415 if (!got_int)
6418 * Sort the tags.
6420 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6423 * Check for duplicates.
6425 for (i = 1; i < ga.ga_len; ++i)
6427 p1 = ((char_u **)ga.ga_data)[i - 1];
6428 p2 = ((char_u **)ga.ga_data)[i];
6429 while (*p1 == *p2)
6431 if (*p2 == '\t')
6433 *p2 = NUL;
6434 vim_snprintf((char *)NameBuff, MAXPATHL,
6435 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6436 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6437 EMSG(NameBuff);
6438 *p2 = '\t';
6439 break;
6441 ++p1;
6442 ++p2;
6446 # ifdef FEAT_MBYTE
6447 if (utf8 == TRUE)
6448 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6449 # endif
6452 * Write the tags into the file.
6454 for (i = 0; i < ga.ga_len; ++i)
6456 s = ((char_u **)ga.ga_data)[i];
6457 if (STRNCMP(s, "help-tags\t", 10) == 0)
6458 /* help-tags entry was added in formatted form */
6459 fputs((char *)s, fd_tags);
6460 else
6462 fprintf(fd_tags, "%s\t/*", s);
6463 for (p1 = s; *p1 != '\t'; ++p1)
6465 /* insert backslash before '\\' and '/' */
6466 if (*p1 == '\\' || *p1 == '/')
6467 putc('\\', fd_tags);
6468 putc(*p1, fd_tags);
6470 fprintf(fd_tags, "*\n");
6474 #ifdef FEAT_MBYTE
6475 if (mix)
6476 got_int = FALSE; /* continue with other languages */
6477 #endif
6479 for (i = 0; i < ga.ga_len; ++i)
6480 vim_free(((char_u **)ga.ga_data)[i]);
6481 ga_clear(&ga);
6482 fclose(fd_tags); /* there is no check for an error... */
6484 #endif
6486 #if defined(FEAT_SIGNS) || defined(PROTO)
6489 * Struct to hold the sign properties.
6491 typedef struct sign sign_T;
6493 struct sign
6495 sign_T *sn_next; /* next sign in list */
6496 int sn_typenr; /* type number of sign (negative if not equal
6497 to name) */
6498 char_u *sn_name; /* name of sign */
6499 char_u *sn_icon; /* name of pixmap */
6500 #ifdef FEAT_SIGN_ICONS
6501 void *sn_image; /* icon image */
6502 #endif
6503 char_u *sn_text; /* text used instead of pixmap */
6504 int sn_line_hl; /* highlight ID for line */
6505 int sn_text_hl; /* highlight ID for text */
6508 static sign_T *first_sign = NULL;
6509 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6511 static void sign_list_defined __ARGS((sign_T *sp));
6514 * ":sign" command
6516 void
6517 ex_sign(eap)
6518 exarg_T *eap;
6520 char_u *arg = eap->arg;
6521 char_u *p;
6522 int idx;
6523 sign_T *sp;
6524 sign_T *sp_prev;
6525 buf_T *buf;
6526 static char *cmds[] = {
6527 "define",
6528 #define SIGNCMD_DEFINE 0
6529 "undefine",
6530 #define SIGNCMD_UNDEFINE 1
6531 "list",
6532 #define SIGNCMD_LIST 2
6533 "place",
6534 #define SIGNCMD_PLACE 3
6535 "unplace",
6536 #define SIGNCMD_UNPLACE 4
6537 "jump",
6538 #define SIGNCMD_JUMP 5
6539 #define SIGNCMD_LAST 6
6542 /* Parse the subcommand. */
6543 p = skiptowhite(arg);
6544 if (*p != NUL)
6545 *p++ = NUL;
6546 for (idx = 0; ; ++idx)
6548 if (idx == SIGNCMD_LAST)
6550 EMSG2(_("E160: Unknown sign command: %s"), arg);
6551 return;
6553 if (STRCMP(arg, cmds[idx]) == 0)
6554 break;
6556 arg = skipwhite(p);
6558 if (idx <= SIGNCMD_LIST)
6561 * Define, undefine or list signs.
6563 if (idx == SIGNCMD_LIST && *arg == NUL)
6565 /* ":sign list": list all defined signs */
6566 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6567 sign_list_defined(sp);
6569 else if (*arg == NUL)
6570 EMSG(_("E156: Missing sign name"));
6571 else
6573 p = skiptowhite(arg);
6574 if (*p != NUL)
6575 *p++ = NUL;
6576 sp_prev = NULL;
6577 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6579 if (STRCMP(sp->sn_name, arg) == 0)
6580 break;
6581 sp_prev = sp;
6583 if (idx == SIGNCMD_DEFINE)
6585 /* ":sign define {name} ...": define a sign */
6586 if (sp == NULL)
6588 /* Allocate a new sign. */
6589 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6590 if (sp == NULL)
6591 return;
6592 if (sp_prev == NULL)
6593 first_sign = sp;
6594 else
6595 sp_prev->sn_next = sp;
6596 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6598 /* If the name is a number use that for the typenr,
6599 * otherwise use a negative number. */
6600 if (VIM_ISDIGIT(*arg))
6601 sp->sn_typenr = atoi((char *)arg);
6602 else
6604 sign_T *lp;
6605 int start = last_sign_typenr;
6607 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6609 if (lp->sn_typenr == last_sign_typenr)
6611 --last_sign_typenr;
6612 if (last_sign_typenr == 0)
6613 last_sign_typenr = MAX_TYPENR;
6614 if (last_sign_typenr == start)
6616 EMSG(_("E612: Too many signs defined"));
6617 return;
6619 lp = first_sign;
6620 continue;
6624 sp->sn_typenr = last_sign_typenr--;
6625 if (last_sign_typenr == 0)
6626 last_sign_typenr = MAX_TYPENR; /* wrap around */
6630 /* set values for a defined sign. */
6631 for (;;)
6633 arg = skipwhite(p);
6634 if (*arg == NUL)
6635 break;
6636 p = skiptowhite_esc(arg);
6637 if (STRNCMP(arg, "icon=", 5) == 0)
6639 arg += 5;
6640 vim_free(sp->sn_icon);
6641 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6642 backslash_halve(sp->sn_icon);
6643 #ifdef FEAT_SIGN_ICONS
6644 if (gui.in_use)
6646 out_flush();
6647 if (sp->sn_image != NULL)
6648 gui_mch_destroy_sign(sp->sn_image);
6649 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6651 #endif
6653 else if (STRNCMP(arg, "text=", 5) == 0)
6655 char_u *s;
6656 int cells;
6657 int len;
6659 arg += 5;
6660 #ifdef FEAT_MBYTE
6661 /* Count cells and check for non-printable chars */
6662 if (has_mbyte)
6664 cells = 0;
6665 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6667 if (!vim_isprintc((*mb_ptr2char)(s)))
6668 break;
6669 cells += (*mb_ptr2cells)(s);
6672 else
6673 #endif
6675 for (s = arg; s < p; ++s)
6676 if (!vim_isprintc(*s))
6677 break;
6678 cells = (int)(s - arg);
6680 /* Currently must be one or two display cells */
6681 if (s != p || cells < 1 || cells > 2)
6683 *p = NUL;
6684 EMSG2(_("E239: Invalid sign text: %s"), arg);
6685 return;
6688 vim_free(sp->sn_text);
6689 /* Allocate one byte more if we need to pad up
6690 * with a space. */
6691 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6692 sp->sn_text = vim_strnsave(arg, len);
6694 if (sp->sn_text != NULL && cells == 1)
6695 STRCPY(sp->sn_text + len - 1, " ");
6697 else if (STRNCMP(arg, "linehl=", 7) == 0)
6699 arg += 7;
6700 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6702 else if (STRNCMP(arg, "texthl=", 7) == 0)
6704 arg += 7;
6705 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6707 else
6709 EMSG2(_(e_invarg2), arg);
6710 return;
6714 else if (sp == NULL)
6715 EMSG2(_("E155: Unknown sign: %s"), arg);
6716 else if (idx == SIGNCMD_LIST)
6717 /* ":sign list {name}" */
6718 sign_list_defined(sp);
6719 else
6721 /* ":sign undefine {name}" */
6722 vim_free(sp->sn_name);
6723 vim_free(sp->sn_icon);
6724 #ifdef FEAT_SIGN_ICONS
6725 if (sp->sn_image != NULL)
6727 out_flush();
6728 gui_mch_destroy_sign(sp->sn_image);
6730 #endif
6731 vim_free(sp->sn_text);
6732 if (sp_prev == NULL)
6733 first_sign = sp->sn_next;
6734 else
6735 sp_prev->sn_next = sp->sn_next;
6736 vim_free(sp);
6740 else
6742 int id = -1;
6743 linenr_T lnum = -1;
6744 char_u *sign_name = NULL;
6745 char_u *arg1;
6747 if (*arg == NUL)
6749 if (idx == SIGNCMD_PLACE)
6751 /* ":sign place": list placed signs in all buffers */
6752 sign_list_placed(NULL);
6754 else if (idx == SIGNCMD_UNPLACE)
6756 /* ":sign unplace": remove placed sign at cursor */
6757 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6758 if (id > 0)
6760 buf_delsign(curwin->w_buffer, id);
6761 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6763 else
6764 EMSG(_("E159: Missing sign number"));
6766 else
6767 EMSG(_(e_argreq));
6768 return;
6771 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6773 /* ":sign unplace *": remove all placed signs */
6774 buf_delete_all_signs();
6775 return;
6778 /* first arg could be placed sign id */
6779 arg1 = arg;
6780 if (VIM_ISDIGIT(*arg))
6782 id = getdigits(&arg);
6783 if (!vim_iswhite(*arg) && *arg != NUL)
6785 id = -1;
6786 arg = arg1;
6788 else
6790 arg = skipwhite(arg);
6791 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6793 /* ":sign unplace {id}": remove placed sign by number */
6794 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6795 if ((lnum = buf_delsign(buf, id)) != 0)
6796 update_debug_sign(buf, lnum);
6797 return;
6803 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6804 * Leave "arg" pointing to {fname}.
6806 for (;;)
6808 if (STRNCMP(arg, "line=", 5) == 0)
6810 arg += 5;
6811 lnum = atoi((char *)arg);
6812 arg = skiptowhite(arg);
6814 else if (STRNCMP(arg, "name=", 5) == 0)
6816 arg += 5;
6817 sign_name = arg;
6818 arg = skiptowhite(arg);
6819 if (*arg != NUL)
6820 *arg++ = NUL;
6822 else if (STRNCMP(arg, "file=", 5) == 0)
6824 arg += 5;
6825 buf = buflist_findname(arg);
6826 break;
6828 else if (STRNCMP(arg, "buffer=", 7) == 0)
6830 arg += 7;
6831 buf = buflist_findnr((int)getdigits(&arg));
6832 if (*skipwhite(arg) != NUL)
6833 EMSG(_(e_trailing));
6834 break;
6836 else
6838 EMSG(_(e_invarg));
6839 return;
6841 arg = skipwhite(arg);
6844 if (buf == NULL)
6846 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6848 else if (id <= 0)
6850 if (lnum >= 0 || sign_name != NULL)
6851 EMSG(_(e_invarg));
6852 else
6853 /* ":sign place file={fname}": list placed signs in one file */
6854 sign_list_placed(buf);
6856 else if (idx == SIGNCMD_JUMP)
6858 /* ":sign jump {id} file={fname}" */
6859 if (lnum >= 0 || sign_name != NULL)
6860 EMSG(_(e_invarg));
6861 else if ((lnum = buf_findsign(buf, id)) > 0)
6862 { /* goto a sign ... */
6863 if (buf_jump_open_win(buf) != NULL)
6864 { /* ... in a current window */
6865 curwin->w_cursor.lnum = lnum;
6866 check_cursor_lnum();
6867 beginline(BL_WHITE);
6869 else
6870 { /* ... not currently in a window */
6871 char_u *cmd;
6873 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6874 if (cmd == NULL)
6875 return;
6876 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6877 do_cmdline_cmd(cmd);
6878 vim_free(cmd);
6880 #ifdef FEAT_FOLDING
6881 foldOpenCursor();
6882 #endif
6884 else
6885 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6887 else if (idx == SIGNCMD_UNPLACE)
6889 /* ":sign unplace {id} file={fname}" */
6890 if (lnum >= 0 || sign_name != NULL)
6891 EMSG(_(e_invarg));
6892 else
6894 lnum = buf_delsign(buf, id);
6895 update_debug_sign(buf, lnum);
6898 /* idx == SIGNCMD_PLACE */
6899 else if (sign_name != NULL)
6901 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6902 if (STRCMP(sp->sn_name, sign_name) == 0)
6903 break;
6904 if (sp == NULL)
6906 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6907 return;
6909 if (lnum > 0)
6910 /* ":sign place {id} line={lnum} name={name} file={fname}":
6911 * place a sign */
6912 buf_addsign(buf, id, lnum, sp->sn_typenr);
6913 else
6914 /* ":sign place {id} file={fname}": change sign type */
6915 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6916 update_debug_sign(buf, lnum);
6918 else
6919 EMSG(_(e_invarg));
6923 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6925 * Allocate the icons. Called when the GUI has started. Allows defining
6926 * signs before it starts.
6928 void
6929 sign_gui_started()
6931 sign_T *sp;
6933 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6934 if (sp->sn_icon != NULL)
6935 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6937 #endif
6940 * List one sign.
6942 static void
6943 sign_list_defined(sp)
6944 sign_T *sp;
6946 char_u *p;
6948 smsg((char_u *)"sign %s", sp->sn_name);
6949 if (sp->sn_icon != NULL)
6951 MSG_PUTS(" icon=");
6952 msg_outtrans(sp->sn_icon);
6953 #ifdef FEAT_SIGN_ICONS
6954 if (sp->sn_image == NULL)
6955 MSG_PUTS(_(" (NOT FOUND)"));
6956 #else
6957 MSG_PUTS(_(" (not supported)"));
6958 #endif
6960 if (sp->sn_text != NULL)
6962 MSG_PUTS(" text=");
6963 msg_outtrans(sp->sn_text);
6965 if (sp->sn_line_hl > 0)
6967 MSG_PUTS(" linehl=");
6968 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6969 if (p == NULL)
6970 MSG_PUTS("NONE");
6971 else
6972 msg_puts(p);
6974 if (sp->sn_text_hl > 0)
6976 MSG_PUTS(" texthl=");
6977 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6978 if (p == NULL)
6979 MSG_PUTS("NONE");
6980 else
6981 msg_puts(p);
6986 * Get highlighting attribute for sign "typenr".
6987 * If "line" is TRUE: line highl, if FALSE: text highl.
6990 sign_get_attr(typenr, line)
6991 int typenr;
6992 int line;
6994 sign_T *sp;
6996 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6997 if (sp->sn_typenr == typenr)
6999 if (line)
7001 if (sp->sn_line_hl > 0)
7002 return syn_id2attr(sp->sn_line_hl);
7004 else
7006 if (sp->sn_text_hl > 0)
7007 return syn_id2attr(sp->sn_text_hl);
7009 break;
7011 return 0;
7015 * Get text mark for sign "typenr".
7016 * Returns NULL if there isn't one.
7018 char_u *
7019 sign_get_text(typenr)
7020 int typenr;
7022 sign_T *sp;
7024 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7025 if (sp->sn_typenr == typenr)
7026 return sp->sn_text;
7027 return NULL;
7030 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7031 void *
7032 sign_get_image(typenr)
7033 int typenr; /* the attribute which may have a sign */
7035 sign_T *sp;
7037 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7038 if (sp->sn_typenr == typenr)
7039 return sp->sn_image;
7040 return NULL;
7042 #endif
7045 * Get the name of a sign by its typenr.
7047 char_u *
7048 sign_typenr2name(typenr)
7049 int typenr;
7051 sign_T *sp;
7053 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7054 if (sp->sn_typenr == typenr)
7055 return sp->sn_name;
7056 return (char_u *)_("[Deleted]");
7059 #endif
7061 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7063 * ":drop"
7064 * Opens the first argument in a window. When there are two or more arguments
7065 * the argument list is redefined.
7067 void
7068 ex_drop(eap)
7069 exarg_T *eap;
7071 int split = FALSE;
7072 win_T *wp;
7073 buf_T *buf;
7074 # ifdef FEAT_WINDOWS
7075 tabpage_T *tp;
7076 # endif
7079 * Check if the first argument is already being edited in a window. If
7080 * so, jump to that window.
7081 * We would actually need to check all arguments, but that's complicated
7082 * and mostly only one file is dropped.
7083 * This also ignores wildcards, since it is very unlikely the user is
7084 * editing a file name with a wildcard character.
7086 set_arglist(eap->arg);
7089 * Expanding wildcards may result in an empty argument list. E.g. when
7090 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7091 * already did an error message for this.
7093 if (ARGCOUNT == 0)
7094 return;
7096 # ifdef FEAT_WINDOWS
7097 if (cmdmod.tab)
7099 /* ":tab drop file ...": open a tab for each argument that isn't
7100 * edited in a window yet. It's like ":tab all" but without closing
7101 * windows or tabs. */
7102 ex_all(eap);
7104 else
7105 # endif
7107 /* ":drop file ...": Edit the first argument. Jump to an existing
7108 * window if possible, edit in current window if the current buffer
7109 * can be abandoned, otherwise open a new window. */
7110 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7112 FOR_ALL_TAB_WINDOWS(tp, wp)
7114 if (wp->w_buffer == buf)
7116 # ifdef FEAT_WINDOWS
7117 goto_tabpage_win(tp, wp);
7118 # endif
7119 curwin->w_arg_idx = 0;
7120 return;
7125 * Check whether the current buffer is changed. If so, we will need
7126 * to split the current window or data could be lost.
7127 * Skip the check if the 'hidden' option is set, as in this case the
7128 * buffer won't be lost.
7130 if (!P_HID(curbuf))
7132 # ifdef FEAT_WINDOWS
7133 ++emsg_off;
7134 # endif
7135 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7136 # ifdef FEAT_WINDOWS
7137 --emsg_off;
7138 # else
7139 if (split)
7140 return;
7141 # endif
7144 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7145 if (split)
7147 eap->cmdidx = CMD_sfirst;
7148 eap->cmd[0] = 's';
7150 else
7151 eap->cmdidx = CMD_first;
7152 ex_rewind(eap);
7155 #endif