Merged from the latest developing branch.
[MacVim/KaoriYa.git] / src / ex_cmds.c
blob5d382d18efbb64493e8f965a1e410b55781409ae
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 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for mch_open(), must be before vim.h */
16 #endif
18 #include "vim.h"
19 #include "version.h"
21 #ifdef FEAT_EX_EXTRA
22 static int linelen __ARGS((int *has_tab));
23 #endif
24 static void do_filter __ARGS((linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out));
25 #ifdef FEAT_VIMINFO
26 static char_u *viminfo_filename __ARGS((char_u *));
27 static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int flags));
28 static int viminfo_encoding __ARGS((vir_T *virp));
29 static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
30 #endif
32 static int check_overwrite __ARGS((exarg_T *eap, buf_T *buf, char_u *fname, char_u *ffname, int other));
33 static int check_readonly __ARGS((int *forceit, buf_T *buf));
34 #ifdef FEAT_AUTOCMD
35 static void delbuf_msg __ARGS((char_u *name));
36 #endif
37 static int
38 #ifdef __BORLANDC__
39 _RTLENTRYF
40 #endif
41 help_compare __ARGS((const void *s1, const void *s2));
44 * ":ascii" and "ga".
46 /*ARGSUSED*/
47 void
48 do_ascii(eap)
49 exarg_T *eap;
51 int c;
52 char buf1[20];
53 char buf2[20];
54 char_u buf3[7];
55 #ifdef FEAT_MBYTE
56 int cc[MAX_MCO];
57 int ci = 0;
58 int len;
60 if (enc_utf8)
61 c = utfc_ptr2char(ml_get_cursor(), cc);
62 else
63 #endif
64 c = gchar_cursor();
65 if (c == NUL)
67 MSG("NUL");
68 return;
71 #ifdef FEAT_MBYTE
72 IObuff[0] = NUL;
73 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
74 #endif
76 if (c == NL) /* NUL is stored as NL */
77 c = NUL;
78 if (vim_isprintc_strict(c) && (c < ' '
79 #ifndef EBCDIC
80 || c > '~'
81 #endif
84 transchar_nonprint(buf3, c);
85 sprintf(buf1, " <%s>", (char *)buf3);
87 else
88 buf1[0] = NUL;
89 #ifndef EBCDIC
90 if (c >= 0x80)
91 sprintf(buf2, " <M-%s>", transchar(c & 0x7f));
92 else
93 #endif
94 buf2[0] = NUL;
95 vim_snprintf((char *)IObuff, IOSIZE,
96 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
97 transchar(c), buf1, buf2, c, c, c);
98 #ifdef FEAT_MBYTE
99 if (enc_utf8)
100 c = cc[ci++];
101 else
102 c = 0;
103 #endif
106 #ifdef FEAT_MBYTE
107 /* Repeat for combining characters. */
108 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
110 len = (int)STRLEN(IObuff);
111 /* This assumes every multi-byte char is printable... */
112 if (len > 0)
113 IObuff[len++] = ' ';
114 IObuff[len++] = '<';
115 if (enc_utf8 && utf_iscomposing(c)
116 # ifdef USE_GUI
117 && !gui.in_use
118 # endif
120 IObuff[len++] = ' '; /* draw composing char on top of a space */
121 len += (*mb_char2bytes)(c, IObuff + len);
122 vim_snprintf((char *)IObuff + len, IOSIZE - len,
123 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
124 : _("> %d, Hex %08x, Octal %o"), c, c, c);
125 if (ci == MAX_MCO)
126 break;
127 if (enc_utf8)
128 c = cc[ci++];
129 else
130 c = 0;
132 #endif
134 msg(IObuff);
137 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
139 * ":left", ":center" and ":right": align text.
141 void
142 ex_align(eap)
143 exarg_T *eap;
145 pos_T save_curpos;
146 int len;
147 int indent = 0;
148 int new_indent;
149 int has_tab;
150 int width;
152 #ifdef FEAT_RIGHTLEFT
153 if (curwin->w_p_rl)
155 /* switch left and right aligning */
156 if (eap->cmdidx == CMD_right)
157 eap->cmdidx = CMD_left;
158 else if (eap->cmdidx == CMD_left)
159 eap->cmdidx = CMD_right;
161 #endif
163 width = atoi((char *)eap->arg);
164 save_curpos = curwin->w_cursor;
165 if (eap->cmdidx == CMD_left) /* width is used for new indent */
167 if (width >= 0)
168 indent = width;
170 else
173 * if 'textwidth' set, use it
174 * else if 'wrapmargin' set, use it
175 * if invalid value, use 80
177 if (width <= 0)
178 width = curbuf->b_p_tw;
179 if (width == 0 && curbuf->b_p_wm > 0)
180 width = W_WIDTH(curwin) - curbuf->b_p_wm;
181 if (width <= 0)
182 width = 80;
185 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
186 return;
188 for (curwin->w_cursor.lnum = eap->line1;
189 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
191 if (eap->cmdidx == CMD_left) /* left align */
192 new_indent = indent;
193 else
195 has_tab = FALSE; /* avoid uninit warnings */
196 len = linelen(eap->cmdidx == CMD_right ? &has_tab
197 : NULL) - get_indent();
199 if (len <= 0) /* skip blank lines */
200 continue;
202 if (eap->cmdidx == CMD_center)
203 new_indent = (width - len) / 2;
204 else
206 new_indent = width - len; /* right align */
209 * Make sure that embedded TABs don't make the text go too far
210 * to the right.
212 if (has_tab)
213 while (new_indent > 0)
215 (void)set_indent(new_indent, 0);
216 if (linelen(NULL) <= width)
219 * Now try to move the line as much as possible to
220 * the right. Stop when it moves too far.
223 (void)set_indent(++new_indent, 0);
224 while (linelen(NULL) <= width);
225 --new_indent;
226 break;
228 --new_indent;
232 if (new_indent < 0)
233 new_indent = 0;
234 (void)set_indent(new_indent, 0); /* set indent */
236 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
237 curwin->w_cursor = save_curpos;
238 beginline(BL_WHITE | BL_FIX);
242 * Get the length of the current line, excluding trailing white space.
244 static int
245 linelen(has_tab)
246 int *has_tab;
248 char_u *line;
249 char_u *first;
250 char_u *last;
251 int save;
252 int len;
254 /* find the first non-blank character */
255 line = ml_get_curline();
256 first = skipwhite(line);
258 /* find the character after the last non-blank character */
259 for (last = first + STRLEN(first);
260 last > first && vim_iswhite(last[-1]); --last)
262 save = *last;
263 *last = NUL;
264 len = linetabsize(line); /* get line length */
265 if (has_tab != NULL) /* check for embedded TAB */
266 *has_tab = (vim_strrchr(first, TAB) != NULL);
267 *last = save;
269 return len;
272 /* Buffer for two lines used during sorting. They are allocated to
273 * contain the longest line being sorted. */
274 static char_u *sortbuf1;
275 static char_u *sortbuf2;
277 static int sort_ic; /* ignore case */
278 static int sort_nr; /* sort on number */
279 static int sort_rx; /* sort on regex instead of skipping it */
281 static int sort_abort; /* flag to indicate if sorting has been interrupted */
283 /* Struct to store info to be sorted. */
284 typedef struct
286 linenr_T lnum; /* line number */
287 long start_col_nr; /* starting column number or number */
288 long end_col_nr; /* ending column number */
289 } sorti_T;
291 static int
292 #ifdef __BORLANDC__
293 _RTLENTRYF
294 #endif
295 sort_compare __ARGS((const void *s1, const void *s2));
297 static int
298 #ifdef __BORLANDC__
299 _RTLENTRYF
300 #endif
301 sort_compare(s1, s2)
302 const void *s1;
303 const void *s2;
305 sorti_T l1 = *(sorti_T *)s1;
306 sorti_T l2 = *(sorti_T *)s2;
307 int result = 0;
309 /* If the user interrupts, there's no way to stop qsort() immediately, but
310 * if we return 0 every time, qsort will assume it's done sorting and
311 * exit. */
312 if (sort_abort)
313 return 0;
314 fast_breakcheck();
315 if (got_int)
316 sort_abort = TRUE;
318 /* When sorting numbers "start_col_nr" is the number, not the column
319 * number. */
320 if (sort_nr)
321 result = l1.start_col_nr - l2.start_col_nr;
322 else
324 /* We need to copy one line into "sortbuf1", because there is no
325 * guarantee that the first pointer becomes invalid when obtaining the
326 * second one. */
327 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
328 l1.end_col_nr - l1.start_col_nr + 1);
329 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
330 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
331 l2.end_col_nr - l2.start_col_nr + 1);
332 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
334 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
335 : STRCMP(sortbuf1, sortbuf2);
338 /* If two lines have the same value, preserve the original line order. */
339 if (result == 0)
340 return (int)(l1.lnum - l2.lnum);
341 return result;
345 * ":sort".
347 void
348 ex_sort(eap)
349 exarg_T *eap;
351 regmatch_T regmatch;
352 int len;
353 linenr_T lnum;
354 long maxlen = 0;
355 sorti_T *nrs;
356 size_t count = eap->line2 - eap->line1 + 1;
357 size_t i;
358 char_u *p;
359 char_u *s;
360 char_u *s2;
361 char_u c; /* temporary character storage */
362 int unique = FALSE;
363 long deleted;
364 colnr_T start_col;
365 colnr_T end_col;
366 int sort_oct; /* sort on octal number */
367 int sort_hex; /* sort on hex number */
369 /* Sorting one line is really quick! */
370 if (count <= 1)
371 return;
373 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
374 return;
375 sortbuf1 = NULL;
376 sortbuf2 = NULL;
377 regmatch.regprog = NULL;
378 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
379 if (nrs == NULL)
380 goto sortend;
382 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
384 for (p = eap->arg; *p != NUL; ++p)
386 if (vim_iswhite(*p))
388 else if (*p == 'i')
389 sort_ic = TRUE;
390 else if (*p == 'r')
391 sort_rx = TRUE;
392 else if (*p == 'n')
393 sort_nr = 2;
394 else if (*p == 'o')
395 sort_oct = 2;
396 else if (*p == 'x')
397 sort_hex = 2;
398 else if (*p == 'u')
399 unique = TRUE;
400 else if (*p == '"') /* comment start */
401 break;
402 else if (check_nextcmd(p) != NULL)
404 eap->nextcmd = check_nextcmd(p);
405 break;
407 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
409 s = skip_regexp(p + 1, *p, TRUE, NULL);
410 if (*s != *p)
412 EMSG(_(e_invalpat));
413 goto sortend;
415 *s = NUL;
416 /* Use last search pattern if sort pattern is empty. */
417 if (s == p + 1 && last_search_pat() != NULL)
418 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
419 else
420 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
421 if (regmatch.regprog == NULL)
422 goto sortend;
423 p = s; /* continue after the regexp */
424 regmatch.rm_ic = p_ic;
426 else
428 EMSG2(_(e_invarg2), p);
429 goto sortend;
433 /* Can only have one of 'n', 'o' and 'x'. */
434 if (sort_nr + sort_oct + sort_hex > 2)
436 EMSG(_(e_invarg));
437 goto sortend;
440 /* From here on "sort_nr" is used as a flag for any number sorting. */
441 sort_nr += sort_oct + sort_hex;
444 * Make an array with all line numbers. This avoids having to copy all
445 * the lines into allocated memory.
446 * When sorting on strings "start_col_nr" is the offset in the line, for
447 * numbers sorting it's the number to sort on. This means the pattern
448 * matching and number conversion only has to be done once per line.
449 * Also get the longest line length for allocating "sortbuf".
451 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
453 s = ml_get(lnum);
454 len = (int)STRLEN(s);
455 if (maxlen < len)
456 maxlen = len;
458 start_col = 0;
459 end_col = len;
460 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
462 if (sort_rx)
464 start_col = (colnr_T)(regmatch.startp[0] - s);
465 end_col = (colnr_T)(regmatch.endp[0] - s);
467 else
468 start_col = (colnr_T)(regmatch.endp[0] - s);
470 else
471 if (regmatch.regprog != NULL)
472 end_col = 0;
474 if (sort_nr)
476 /* Make sure vim_str2nr doesn't read any digits past the end
477 * of the match, by temporarily terminating the string there */
478 s2 = s + end_col;
479 c = *s2;
480 (*s2) = 0;
481 /* Sorting on number: Store the number itself. */
482 p = s + start_col;
483 if (sort_hex)
484 s = skiptohex(p);
485 else
486 s = skiptodigit(p);
487 if (s > p && s[-1] == '-')
488 --s; /* include preceding negative sign */
489 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
490 &nrs[lnum - eap->line1].start_col_nr, NULL);
491 (*s2) = c;
493 else
495 /* Store the column to sort at. */
496 nrs[lnum - eap->line1].start_col_nr = start_col;
497 nrs[lnum - eap->line1].end_col_nr = end_col;
500 nrs[lnum - eap->line1].lnum = lnum;
502 if (regmatch.regprog != NULL)
503 fast_breakcheck();
504 if (got_int)
505 goto sortend;
508 /* Allocate a buffer that can hold the longest line. */
509 sortbuf1 = alloc((unsigned)maxlen + 1);
510 if (sortbuf1 == NULL)
511 goto sortend;
512 sortbuf2 = alloc((unsigned)maxlen + 1);
513 if (sortbuf2 == NULL)
514 goto sortend;
516 /* Sort the array of line numbers. Note: can't be interrupted! */
517 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
519 if (sort_abort)
520 goto sortend;
522 /* Insert the lines in the sorted order below the last one. */
523 lnum = eap->line2;
524 for (i = 0; i < count; ++i)
526 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
527 if (!unique || i == 0
528 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
530 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
531 break;
532 if (unique)
533 STRCPY(sortbuf1, s);
535 fast_breakcheck();
536 if (got_int)
537 goto sortend;
540 /* delete the original lines if appending worked */
541 if (i == count)
542 for (i = 0; i < count; ++i)
543 ml_delete(eap->line1, FALSE);
544 else
545 count = 0;
547 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
548 deleted = (long)(count - (lnum - eap->line2));
549 if (deleted > 0)
550 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
551 else if (deleted < 0)
552 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
553 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
555 curwin->w_cursor.lnum = eap->line1;
556 beginline(BL_WHITE | BL_FIX);
558 sortend:
559 vim_free(nrs);
560 vim_free(sortbuf1);
561 vim_free(sortbuf2);
562 vim_free(regmatch.regprog);
563 if (got_int)
564 EMSG(_(e_interr));
568 * ":retab".
570 void
571 ex_retab(eap)
572 exarg_T *eap;
574 linenr_T lnum;
575 int got_tab = FALSE;
576 long num_spaces = 0;
577 long num_tabs;
578 long len;
579 long col;
580 long vcol;
581 long start_col = 0; /* For start of white-space string */
582 long start_vcol = 0; /* For start of white-space string */
583 int temp;
584 long old_len;
585 char_u *ptr;
586 char_u *new_line = (char_u *)1; /* init to non-NULL */
587 int did_undo; /* called u_save for current line */
588 int new_ts;
589 int save_list;
590 linenr_T first_line = 0; /* first changed line */
591 linenr_T last_line = 0; /* last changed line */
593 save_list = curwin->w_p_list;
594 curwin->w_p_list = 0; /* don't want list mode here */
596 new_ts = getdigits(&(eap->arg));
597 if (new_ts < 0)
599 EMSG(_(e_positive));
600 return;
602 if (new_ts == 0)
603 new_ts = curbuf->b_p_ts;
604 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
606 ptr = ml_get(lnum);
607 col = 0;
608 vcol = 0;
609 did_undo = FALSE;
610 for (;;)
612 if (vim_iswhite(ptr[col]))
614 if (!got_tab && num_spaces == 0)
616 /* First consecutive white-space */
617 start_vcol = vcol;
618 start_col = col;
620 if (ptr[col] == ' ')
621 num_spaces++;
622 else
623 got_tab = TRUE;
625 else
627 if (got_tab || (eap->forceit && num_spaces > 1))
629 /* Retabulate this string of white-space */
631 /* len is virtual length of white string */
632 len = num_spaces = vcol - start_vcol;
633 num_tabs = 0;
634 if (!curbuf->b_p_et)
636 temp = new_ts - (start_vcol % new_ts);
637 if (num_spaces >= temp)
639 num_spaces -= temp;
640 num_tabs++;
642 num_tabs += num_spaces / new_ts;
643 num_spaces -= (num_spaces / new_ts) * new_ts;
645 if (curbuf->b_p_et || got_tab ||
646 (num_spaces + num_tabs < len))
648 if (did_undo == FALSE)
650 did_undo = TRUE;
651 if (u_save((linenr_T)(lnum - 1),
652 (linenr_T)(lnum + 1)) == FAIL)
654 new_line = NULL; /* flag out-of-memory */
655 break;
659 /* len is actual number of white characters used */
660 len = num_spaces + num_tabs;
661 old_len = (long)STRLEN(ptr);
662 new_line = lalloc(old_len - col + start_col + len + 1,
663 TRUE);
664 if (new_line == NULL)
665 break;
666 if (start_col > 0)
667 mch_memmove(new_line, ptr, (size_t)start_col);
668 mch_memmove(new_line + start_col + len,
669 ptr + col, (size_t)(old_len - col + 1));
670 ptr = new_line + start_col;
671 for (col = 0; col < len; col++)
672 ptr[col] = (col < num_tabs) ? '\t' : ' ';
673 ml_replace(lnum, new_line, FALSE);
674 if (first_line == 0)
675 first_line = lnum;
676 last_line = lnum;
677 ptr = new_line;
678 col = start_col + len;
681 got_tab = FALSE;
682 num_spaces = 0;
684 if (ptr[col] == NUL)
685 break;
686 vcol += chartabsize(ptr + col, (colnr_T)vcol);
687 #ifdef FEAT_MBYTE
688 if (has_mbyte)
689 col += (*mb_ptr2len)(ptr + col);
690 else
691 #endif
692 ++col;
694 if (new_line == NULL) /* out of memory */
695 break;
696 line_breakcheck();
698 if (got_int)
699 EMSG(_(e_interr));
701 if (curbuf->b_p_ts != new_ts)
702 redraw_curbuf_later(NOT_VALID);
703 if (first_line != 0)
704 changed_lines(first_line, 0, last_line + 1, 0L);
706 curwin->w_p_list = save_list; /* restore 'list' */
708 curbuf->b_p_ts = new_ts;
709 coladvance(curwin->w_curswant);
711 u_clearline();
713 #endif
716 * :move command - move lines line1-line2 to line dest
718 * return FAIL for failure, OK otherwise
721 do_move(line1, line2, dest)
722 linenr_T line1;
723 linenr_T line2;
724 linenr_T dest;
726 char_u *str;
727 linenr_T l;
728 linenr_T extra; /* Num lines added before line1 */
729 linenr_T num_lines; /* Num lines moved */
730 linenr_T last_line; /* Last line in file after adding new text */
732 if (dest >= line1 && dest < line2)
734 EMSG(_("E134: Move lines into themselves"));
735 return FAIL;
738 num_lines = line2 - line1 + 1;
741 * First we copy the old text to its new location -- webb
742 * Also copy the flag that ":global" command uses.
744 if (u_save(dest, dest + 1) == FAIL)
745 return FAIL;
746 for (extra = 0, l = line1; l <= line2; l++)
748 str = vim_strsave(ml_get(l + extra));
749 if (str != NULL)
751 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
752 vim_free(str);
753 if (dest < line1)
754 extra++;
759 * Now we must be careful adjusting our marks so that we don't overlap our
760 * mark_adjust() calls.
762 * We adjust the marks within the old text so that they refer to the
763 * last lines of the file (temporarily), because we know no other marks
764 * will be set there since these line numbers did not exist until we added
765 * our new lines.
767 * Then we adjust the marks on lines between the old and new text positions
768 * (either forwards or backwards).
770 * And Finally we adjust the marks we put at the end of the file back to
771 * their final destination at the new text position -- webb
773 last_line = curbuf->b_ml.ml_line_count;
774 mark_adjust(line1, line2, last_line - line2, 0L);
775 if (dest >= line2)
777 mark_adjust(line2 + 1, dest, -num_lines, 0L);
778 curbuf->b_op_start.lnum = dest - num_lines + 1;
779 curbuf->b_op_end.lnum = dest;
781 else
783 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
784 curbuf->b_op_start.lnum = dest + 1;
785 curbuf->b_op_end.lnum = dest + num_lines;
787 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
788 mark_adjust(last_line - num_lines + 1, last_line,
789 -(last_line - dest - extra), 0L);
792 * Now we delete the original text -- webb
794 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
795 return FAIL;
797 for (l = line1; l <= line2; l++)
798 ml_delete(line1 + extra, TRUE);
800 if (!global_busy && num_lines > p_report)
802 if (num_lines == 1)
803 MSG(_("1 line moved"));
804 else
805 smsg((char_u *)_("%ld lines moved"), num_lines);
809 * Leave the cursor on the last of the moved lines.
811 if (dest >= line1)
812 curwin->w_cursor.lnum = dest;
813 else
814 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
816 if (line1 < dest)
817 changed_lines(line1, 0, dest + num_lines + 1, 0L);
818 else
819 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
821 return OK;
825 * ":copy"
827 void
828 ex_copy(line1, line2, n)
829 linenr_T line1;
830 linenr_T line2;
831 linenr_T n;
833 linenr_T count;
834 char_u *p;
836 count = line2 - line1 + 1;
837 curbuf->b_op_start.lnum = n + 1;
838 curbuf->b_op_end.lnum = n + count;
839 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
842 * there are three situations:
843 * 1. destination is above line1
844 * 2. destination is between line1 and line2
845 * 3. destination is below line2
847 * n = destination (when starting)
848 * curwin->w_cursor.lnum = destination (while copying)
849 * line1 = start of source (while copying)
850 * line2 = end of source (while copying)
852 if (u_save(n, n + 1) == FAIL)
853 return;
855 curwin->w_cursor.lnum = n;
856 while (line1 <= line2)
858 /* need to use vim_strsave() because the line will be unlocked within
859 * ml_append() */
860 p = vim_strsave(ml_get(line1));
861 if (p != NULL)
863 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
864 vim_free(p);
866 /* situation 2: skip already copied lines */
867 if (line1 == n)
868 line1 = curwin->w_cursor.lnum;
869 ++line1;
870 if (curwin->w_cursor.lnum < line1)
871 ++line1;
872 if (curwin->w_cursor.lnum < line2)
873 ++line2;
874 ++curwin->w_cursor.lnum;
877 appended_lines_mark(n, count);
879 msgmore((long)count);
882 static char_u *prevcmd = NULL; /* the previous command */
884 #if defined(EXITFREE) || defined(PROTO)
885 void
886 free_prev_shellcmd()
888 vim_free(prevcmd);
890 #endif
893 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
894 * Bangs in the argument are replaced with the previously entered command.
895 * Remember the argument.
897 * RISCOS: Bangs only replaced when followed by a space, since many
898 * pathnames contain one.
900 void
901 do_bang(addr_count, eap, forceit, do_in, do_out)
902 int addr_count;
903 exarg_T *eap;
904 int forceit;
905 int do_in, do_out;
907 char_u *arg = eap->arg; /* command */
908 linenr_T line1 = eap->line1; /* start of range */
909 linenr_T line2 = eap->line2; /* end of range */
910 char_u *newcmd = NULL; /* the new command */
911 int free_newcmd = FALSE; /* need to free() newcmd */
912 int ins_prevcmd;
913 char_u *t;
914 char_u *p;
915 char_u *trailarg;
916 int len;
917 int scroll_save = msg_scroll;
920 * Disallow shell commands for "rvim".
921 * Disallow shell commands from .exrc and .vimrc in current directory for
922 * security reasons.
924 if (check_restricted() || check_secure())
925 return;
927 if (addr_count == 0) /* :! */
929 msg_scroll = FALSE; /* don't scroll here */
930 autowrite_all();
931 msg_scroll = scroll_save;
935 * Try to find an embedded bang, like in :!<cmd> ! [args]
936 * (:!! is indicated by the 'forceit' variable)
938 ins_prevcmd = forceit;
939 trailarg = arg;
942 len = (int)STRLEN(trailarg) + 1;
943 if (newcmd != NULL)
944 len += (int)STRLEN(newcmd);
945 if (ins_prevcmd)
947 if (prevcmd == NULL)
949 EMSG(_(e_noprev));
950 vim_free(newcmd);
951 return;
953 len += (int)STRLEN(prevcmd);
955 if ((t = alloc(len)) == NULL)
957 vim_free(newcmd);
958 return;
960 *t = NUL;
961 if (newcmd != NULL)
962 STRCAT(t, newcmd);
963 if (ins_prevcmd)
964 STRCAT(t, prevcmd);
965 p = t + STRLEN(t);
966 STRCAT(t, trailarg);
967 vim_free(newcmd);
968 newcmd = t;
971 * Scan the rest of the argument for '!', which is replaced by the
972 * previous command. "\!" is replaced by "!" (this is vi compatible).
974 trailarg = NULL;
975 while (*p)
977 if (*p == '!'
978 #ifdef RISCOS
979 && (p[1] == ' ' || p[1] == NUL)
980 #endif
983 if (p > newcmd && p[-1] == '\\')
984 STRMOVE(p - 1, p);
985 else
987 trailarg = p;
988 *trailarg++ = NUL;
989 ins_prevcmd = TRUE;
990 break;
993 ++p;
995 } while (trailarg != NULL);
997 vim_free(prevcmd);
998 prevcmd = newcmd;
1000 if (bangredo) /* put cmd in redo buffer for ! command */
1002 AppendToRedobuffLit(prevcmd, -1);
1003 AppendToRedobuff((char_u *)"\n");
1004 bangredo = FALSE;
1007 * Add quotes around the command, for shells that need them.
1009 if (*p_shq != NUL)
1011 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1012 if (newcmd == NULL)
1013 return;
1014 STRCPY(newcmd, p_shq);
1015 STRCAT(newcmd, prevcmd);
1016 STRCAT(newcmd, p_shq);
1017 free_newcmd = TRUE;
1019 if (addr_count == 0) /* :! */
1021 /* echo the command */
1022 msg_start();
1023 msg_putchar(':');
1024 msg_putchar('!');
1025 msg_outtrans(newcmd);
1026 msg_clr_eos();
1027 windgoto(msg_row, msg_col);
1029 do_shell(newcmd, 0);
1031 else /* :range! */
1033 /* Careful: This may recursively call do_bang() again! (because of
1034 * autocommands) */
1035 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1036 #ifdef FEAT_AUTOCMD
1037 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1038 #endif
1040 if (free_newcmd)
1041 vim_free(newcmd);
1045 * do_filter: filter lines through a command given by the user
1047 * We mostly use temp files and the call_shell() routine here. This would
1048 * normally be done using pipes on a UNIX machine, but this is more portable
1049 * to non-unix machines. The call_shell() routine needs to be able
1050 * to deal with redirection somehow, and should handle things like looking
1051 * at the PATH env. variable, and adding reasonable extensions to the
1052 * command name given by the user. All reasonable versions of call_shell()
1053 * do this.
1054 * Alternatively, if on Unix and redirecting input or output, but not both,
1055 * and the 'shelltemp' option isn't set, use pipes.
1056 * We use input redirection if do_in is TRUE.
1057 * We use output redirection if do_out is TRUE.
1059 static void
1060 do_filter(line1, line2, eap, cmd, do_in, do_out)
1061 linenr_T line1, line2;
1062 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1063 char_u *cmd;
1064 int do_in, do_out;
1066 char_u *itmp = NULL;
1067 char_u *otmp = NULL;
1068 linenr_T linecount;
1069 linenr_T read_linecount;
1070 pos_T cursor_save;
1071 char_u *cmd_buf;
1072 #ifdef FEAT_AUTOCMD
1073 buf_T *old_curbuf = curbuf;
1074 #endif
1075 int shell_flags = 0;
1077 if (*cmd == NUL) /* no filter command */
1078 return;
1080 #ifdef WIN3264
1082 * Check if external commands are allowed now.
1084 if (can_end_termcap_mode(TRUE) == FALSE)
1085 return;
1086 #endif
1088 cursor_save = curwin->w_cursor;
1089 linecount = line2 - line1 + 1;
1090 curwin->w_cursor.lnum = line1;
1091 curwin->w_cursor.col = 0;
1092 changed_line_abv_curs();
1093 invalidate_botline();
1096 * When using temp files:
1097 * 1. * Form temp file names
1098 * 2. * Write the lines to a temp file
1099 * 3. Run the filter command on the temp file
1100 * 4. * Read the output of the command into the buffer
1101 * 5. * Delete the original lines to be filtered
1102 * 6. * Remove the temp files
1104 * When writing the input with a pipe or when catching the output with a
1105 * pipe only need to do 3.
1108 if (do_out)
1109 shell_flags |= SHELL_DOOUT;
1111 #if !defined(USE_SYSTEM) && defined(UNIX)
1112 if (!do_in && do_out && !p_stmp)
1114 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1115 shell_flags |= SHELL_READ;
1116 curwin->w_cursor.lnum = line2;
1118 else if (do_in && !do_out && !p_stmp)
1120 /* Use a pipe to write stdin of the command, do not use a temp file. */
1121 shell_flags |= SHELL_WRITE;
1122 curbuf->b_op_start.lnum = line1;
1123 curbuf->b_op_end.lnum = line2;
1125 else if (do_in && do_out && !p_stmp)
1127 /* Use a pipe to write stdin and fetch stdout of the command, do not
1128 * use a temp file. */
1129 shell_flags |= SHELL_READ|SHELL_WRITE;
1130 curbuf->b_op_start.lnum = line1;
1131 curbuf->b_op_end.lnum = line2;
1132 curwin->w_cursor.lnum = line2;
1134 else
1135 #endif
1136 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1137 || (do_out && (otmp = vim_tempname('o')) == NULL))
1139 EMSG(_(e_notmp));
1140 goto filterend;
1144 * The writing and reading of temp files will not be shown.
1145 * Vi also doesn't do this and the messages are not very informative.
1147 ++no_wait_return; /* don't call wait_return() while busy */
1148 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1149 FALSE, FALSE, FALSE, TRUE) == FAIL)
1151 msg_putchar('\n'); /* keep message from buf_write() */
1152 --no_wait_return;
1153 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1154 if (!aborting())
1155 #endif
1156 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1157 goto filterend;
1159 #ifdef FEAT_AUTOCMD
1160 if (curbuf != old_curbuf)
1161 goto filterend;
1162 #endif
1164 if (!do_out)
1165 msg_putchar('\n');
1167 /* Create the shell command in allocated memory. */
1168 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1169 if (cmd_buf == NULL)
1170 goto filterend;
1172 windgoto((int)Rows - 1, 0);
1173 cursor_on();
1176 * When not redirecting the output the command can write anything to the
1177 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1178 * stderr output of external command. Clear the screen later.
1179 * If do_in is FALSE, this could be something like ":r !cat", which may
1180 * also mess up the screen, clear it later.
1182 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1183 redraw_later_clear();
1185 if (do_out)
1187 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1189 vim_free(cmd_buf);
1190 goto error;
1192 redraw_curbuf_later(VALID);
1194 read_linecount = curbuf->b_ml.ml_line_count;
1197 * When call_shell() fails wait_return() is called to give the user a
1198 * chance to read the error messages. Otherwise errors are ignored, so you
1199 * can see the error messages from the command that appear on stdout; use
1200 * 'u' to fix the text
1201 * Switch to cooked mode when not redirecting stdin, avoids that something
1202 * like ":r !cat" hangs.
1203 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1205 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1207 redraw_later_clear();
1208 wait_return(FALSE);
1210 vim_free(cmd_buf);
1212 did_check_timestamps = FALSE;
1213 need_check_timestamps = TRUE;
1215 /* When interrupting the shell command, it may still have produced some
1216 * useful output. Reset got_int here, so that readfile() won't cancel
1217 * reading. */
1218 ui_breakcheck();
1219 got_int = FALSE;
1221 if (do_out)
1223 if (otmp != NULL)
1225 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1226 eap, READ_FILTER) == FAIL)
1228 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1229 if (!aborting())
1230 #endif
1232 msg_putchar('\n');
1233 EMSG2(_(e_notread), otmp);
1235 goto error;
1237 #ifdef FEAT_AUTOCMD
1238 if (curbuf != old_curbuf)
1239 goto filterend;
1240 #endif
1243 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1245 if (shell_flags & SHELL_READ)
1247 curbuf->b_op_start.lnum = line2 + 1;
1248 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1249 appended_lines_mark(line2, read_linecount);
1252 if (do_in)
1254 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1256 if (read_linecount >= linecount)
1257 /* move all marks from old lines to new lines */
1258 mark_adjust(line1, line2, linecount, 0L);
1259 else
1261 /* move marks from old lines to new lines, delete marks
1262 * that are in deleted lines */
1263 mark_adjust(line1, line1 + read_linecount - 1,
1264 linecount, 0L);
1265 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1270 * Put cursor on first filtered line for ":range!cmd".
1271 * Adjust '[ and '] (set by buf_write()).
1273 curwin->w_cursor.lnum = line1;
1274 del_lines(linecount, TRUE);
1275 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1276 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1277 write_lnum_adjust(-linecount); /* adjust last line
1278 for next write */
1279 #ifdef FEAT_FOLDING
1280 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1281 #endif
1283 else
1286 * Put cursor on last new line for ":r !cmd".
1288 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1289 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1292 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1293 --no_wait_return;
1295 if (linecount > p_report)
1297 if (do_in)
1299 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1300 _("%ld lines filtered"), (long)linecount);
1301 if (msg(msg_buf) && !msg_scroll)
1302 /* save message to display it after redraw */
1303 set_keep_msg(msg_buf, 0);
1305 else
1306 msgmore((long)linecount);
1309 else
1311 error:
1312 /* put cursor back in same position for ":w !cmd" */
1313 curwin->w_cursor = cursor_save;
1314 --no_wait_return;
1315 wait_return(FALSE);
1318 filterend:
1320 #ifdef FEAT_AUTOCMD
1321 if (curbuf != old_curbuf)
1323 --no_wait_return;
1324 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1326 #endif
1327 if (itmp != NULL)
1328 mch_remove(itmp);
1329 if (otmp != NULL)
1330 mch_remove(otmp);
1331 vim_free(itmp);
1332 vim_free(otmp);
1336 * Call a shell to execute a command.
1337 * When "cmd" is NULL start an interactive shell.
1339 void
1340 do_shell(cmd, flags)
1341 char_u *cmd;
1342 int flags; /* may be SHELL_DOOUT when output is redirected */
1344 buf_T *buf;
1345 #ifndef FEAT_GUI_MSWIN
1346 int save_nwr;
1347 #endif
1348 #ifdef MSWIN
1349 int winstart = FALSE;
1350 #endif
1353 * Disallow shell commands for "rvim".
1354 * Disallow shell commands from .exrc and .vimrc in current directory for
1355 * security reasons.
1357 if (check_restricted() || check_secure())
1359 msg_end();
1360 return;
1363 #ifdef MSWIN
1365 * Check if external commands are allowed now.
1367 if (can_end_termcap_mode(TRUE) == FALSE)
1368 return;
1371 * Check if ":!start" is used.
1373 if (cmd != NULL)
1374 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1375 #endif
1378 * For autocommands we want to get the output on the current screen, to
1379 * avoid having to type return below.
1381 msg_putchar('\r'); /* put cursor at start of line */
1382 #ifdef FEAT_AUTOCMD
1383 if (!autocmd_busy)
1384 #endif
1386 #ifdef MSWIN
1387 if (!winstart)
1388 #endif
1389 stoptermcap();
1391 #ifdef MSWIN
1392 if (!winstart)
1393 #endif
1394 msg_putchar('\n'); /* may shift screen one line up */
1396 /* warning message before calling the shell */
1397 if (p_warn
1398 #ifdef FEAT_AUTOCMD
1399 && !autocmd_busy
1400 #endif
1401 && msg_silent == 0)
1402 for (buf = firstbuf; buf; buf = buf->b_next)
1403 if (bufIsChanged(buf))
1405 #ifdef FEAT_GUI_MSWIN
1406 if (!winstart)
1407 starttermcap(); /* don't want a message box here */
1408 #endif
1409 MSG_PUTS(_("[No write since last change]\n"));
1410 #ifdef FEAT_GUI_MSWIN
1411 if (!winstart)
1412 stoptermcap();
1413 #endif
1414 break;
1417 /* This windgoto is required for when the '\n' resulted in a "delete line
1418 * 1" command to the terminal. */
1419 if (!swapping_screen())
1420 windgoto(msg_row, msg_col);
1421 cursor_on();
1422 (void)call_shell(cmd, SHELL_COOKED | flags);
1423 did_check_timestamps = FALSE;
1424 need_check_timestamps = TRUE;
1427 * put the message cursor at the end of the screen, avoids wait_return()
1428 * to overwrite the text that the external command showed
1430 if (!swapping_screen())
1432 msg_row = Rows - 1;
1433 msg_col = 0;
1436 #ifdef FEAT_AUTOCMD
1437 if (autocmd_busy)
1439 if (msg_silent == 0)
1440 redraw_later_clear();
1442 else
1443 #endif
1446 * For ":sh" there is no need to call wait_return(), just redraw.
1447 * Also for the Win32 GUI (the output is in a console window).
1448 * Otherwise there is probably text on the screen that the user wants
1449 * to read before redrawing, so call wait_return().
1451 #ifndef FEAT_GUI_MSWIN
1452 if (cmd == NULL
1453 # ifdef WIN3264
1454 || (winstart && !need_wait_return)
1455 # endif
1458 if (msg_silent == 0)
1459 redraw_later_clear();
1460 need_wait_return = FALSE;
1462 else
1465 * If we switch screens when starttermcap() is called, we really
1466 * want to wait for "hit return to continue".
1468 save_nwr = no_wait_return;
1469 if (swapping_screen())
1470 no_wait_return = FALSE;
1471 # ifdef AMIGA
1472 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1473 # else
1474 wait_return(msg_silent == 0);
1475 # endif
1476 no_wait_return = save_nwr;
1478 #endif /* FEAT_GUI_W32 */
1480 #ifdef MSWIN
1481 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1482 #endif
1483 starttermcap(); /* start termcap if not done by wait_return() */
1486 * In an Amiga window redrawing is caused by asking the window size.
1487 * If we got an interrupt this will not work. The chance that the
1488 * window size is wrong is very small, but we need to redraw the
1489 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1490 * but it saves an extra redraw.
1492 #ifdef AMIGA
1493 if (skip_redraw) /* ':' hit in wait_return() */
1495 if (msg_silent == 0)
1496 redraw_later_clear();
1498 else if (term_console)
1500 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1501 if (got_int && msg_silent == 0)
1502 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1503 else
1504 must_redraw = 0; /* no extra redraw needed */
1506 #endif
1509 /* display any error messages now */
1510 display_errors();
1512 #ifdef FEAT_AUTOCMD
1513 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1514 #endif
1518 * Create a shell command from a command string, input redirection file and
1519 * output redirection file.
1520 * Returns an allocated string with the shell command, or NULL for failure.
1522 char_u *
1523 make_filter_cmd(cmd, itmp, otmp)
1524 char_u *cmd; /* command */
1525 char_u *itmp; /* NULL or name of input file */
1526 char_u *otmp; /* NULL or name of output file */
1528 char_u *buf;
1529 long_u len;
1531 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1532 if (itmp != NULL)
1533 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1534 if (otmp != NULL)
1535 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1536 buf = lalloc(len, TRUE);
1537 if (buf == NULL)
1538 return NULL;
1540 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1542 * Put braces around the command (for concatenated commands) when
1543 * redirecting input and/or output.
1545 if (itmp != NULL || otmp != NULL)
1546 sprintf((char *)buf, "(%s)", (char *)cmd);
1547 else
1548 STRCPY(buf, cmd);
1549 if (itmp != NULL)
1551 STRCAT(buf, " < ");
1552 STRCAT(buf, itmp);
1554 #else
1556 * for shells that don't understand braces around commands, at least allow
1557 * the use of commands in a pipe.
1559 STRCPY(buf, cmd);
1560 if (itmp != NULL)
1562 char_u *p;
1565 * If there is a pipe, we have to put the '<' in front of it.
1566 * Don't do this when 'shellquote' is not empty, otherwise the
1567 * redirection would be inside the quotes.
1569 if (*p_shq == NUL)
1571 p = vim_strchr(buf, '|');
1572 if (p != NULL)
1573 *p = NUL;
1575 # ifdef RISCOS
1576 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1577 STRCAT(buf, itmp);
1578 STRCAT(buf, " } ");
1579 # else
1580 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1581 STRCAT(buf, itmp);
1582 # endif
1583 if (*p_shq == NUL)
1585 p = vim_strchr(cmd, '|');
1586 if (p != NULL)
1588 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1589 STRCAT(buf, p);
1593 #endif
1594 if (otmp != NULL)
1595 append_redir(buf, p_srr, otmp);
1597 return buf;
1601 * Append output redirection for file "fname" to the end of string buffer "buf"
1602 * Works with the 'shellredir' and 'shellpipe' options.
1603 * The caller should make sure that there is enough room:
1604 * STRLEN(opt) + STRLEN(fname) + 3
1606 void
1607 append_redir(buf, opt, fname)
1608 char_u *buf;
1609 char_u *opt;
1610 char_u *fname;
1612 char_u *p;
1614 buf += STRLEN(buf);
1615 /* find "%s", skipping "%%" */
1616 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1617 if (p[1] == 's')
1618 break;
1619 if (p != NULL)
1621 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1622 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1624 else
1625 sprintf((char *)buf,
1626 #ifdef FEAT_QUICKFIX
1627 # ifndef RISCOS
1628 opt != p_sp ? " %s%s" :
1629 # endif
1630 " %s %s",
1631 #else
1632 # ifndef RISCOS
1633 " %s%s", /* " > %s" causes problems on Amiga */
1634 # else
1635 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1636 # endif
1637 #endif
1638 (char *)opt, (char *)fname);
1641 #ifdef FEAT_VIMINFO
1643 static int no_viminfo __ARGS((void));
1644 static int viminfo_errcnt;
1646 static int
1647 no_viminfo()
1649 /* "vim -i NONE" does not read or write a viminfo file */
1650 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1654 * Report an error for reading a viminfo file.
1655 * Count the number of errors. When there are more than 10, return TRUE.
1658 viminfo_error(errnum, message, line)
1659 char *errnum;
1660 char *message;
1661 char_u *line;
1663 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1664 errnum, message);
1665 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1666 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1667 IObuff[STRLEN(IObuff) - 1] = NUL;
1668 emsg(IObuff);
1669 if (++viminfo_errcnt >= 10)
1671 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1672 return TRUE;
1674 return FALSE;
1678 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1679 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
1682 read_viminfo(file, flags)
1683 char_u *file; /* file name or NULL to use default name */
1684 int flags; /* VIF_WANT_INFO et al. */
1686 FILE *fp;
1687 char_u *fname;
1689 if (no_viminfo())
1690 return FAIL;
1692 fname = viminfo_filename(file); /* get file name in allocated buffer */
1693 if (fname == NULL)
1694 return FAIL;
1695 fp = mch_fopen((char *)fname, READBIN);
1697 if (p_verbose > 0)
1699 verbose_enter();
1700 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1701 fname,
1702 (flags & VIF_WANT_INFO) ? _(" info") : "",
1703 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1704 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
1705 fp == NULL ? _(" FAILED") : "");
1706 verbose_leave();
1709 vim_free(fname);
1710 if (fp == NULL)
1711 return FAIL;
1713 viminfo_errcnt = 0;
1714 do_viminfo(fp, NULL, flags);
1716 fclose(fp);
1717 return OK;
1721 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1722 * that effectively a merge of current info and old info is done. This allows
1723 * multiple vims to run simultaneously, without losing any marks etc. If
1724 * forceit is TRUE, then the old file is not read in, and only internal info is
1725 * written to the file. -- webb
1727 void
1728 write_viminfo(file, forceit)
1729 char_u *file;
1730 int forceit;
1732 char_u *fname;
1733 FILE *fp_in = NULL; /* input viminfo file, if any */
1734 FILE *fp_out = NULL; /* output viminfo file */
1735 char_u *tempname = NULL; /* name of temp viminfo file */
1736 struct stat st_new; /* mch_stat() of potential new file */
1737 char_u *wp;
1738 #if defined(UNIX) || defined(VMS)
1739 mode_t umask_save;
1740 #endif
1741 #ifdef UNIX
1742 int shortname = FALSE; /* use 8.3 file name */
1743 struct stat st_old; /* mch_stat() of existing viminfo file */
1744 #endif
1745 #ifdef WIN3264
1746 long perm = -1;
1747 #endif
1749 if (no_viminfo())
1750 return;
1752 fname = viminfo_filename(file); /* may set to default if NULL */
1753 if (fname == NULL)
1754 return;
1756 fp_in = mch_fopen((char *)fname, READBIN);
1757 if (fp_in == NULL)
1759 /* if it does exist, but we can't read it, don't try writing */
1760 if (mch_stat((char *)fname, &st_new) == 0)
1761 goto end;
1762 #if defined(UNIX) || defined(VMS)
1764 * For Unix we create the .viminfo non-accessible for others,
1765 * because it may contain text from non-accessible documents.
1767 umask_save = umask(077);
1768 #endif
1769 fp_out = mch_fopen((char *)fname, WRITEBIN);
1770 #if defined(UNIX) || defined(VMS)
1771 (void)umask(umask_save);
1772 #endif
1774 else
1777 * There is an existing viminfo file. Create a temporary file to
1778 * write the new viminfo into, in the same directory as the
1779 * existing viminfo file, which will be renamed later.
1781 #ifdef UNIX
1783 * For Unix we check the owner of the file. It's not very nice to
1784 * overwrite a user's viminfo file after a "su root", with a
1785 * viminfo file that the user can't read.
1787 st_old.st_dev = 0;
1788 st_old.st_ino = 0;
1789 st_old.st_mode = 0600;
1790 if (mch_stat((char *)fname, &st_old) == 0
1791 && getuid() != ROOT_UID
1792 && !(st_old.st_uid == getuid()
1793 ? (st_old.st_mode & 0200)
1794 : (st_old.st_gid == getgid()
1795 ? (st_old.st_mode & 0020)
1796 : (st_old.st_mode & 0002))))
1798 int tt = msg_didany;
1800 /* avoid a wait_return for this message, it's annoying */
1801 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1802 msg_didany = tt;
1803 fclose(fp_in);
1804 goto end;
1806 #endif
1807 #ifdef WIN3264
1808 /* Get the file attributes of the existing viminfo file. */
1809 perm = mch_getperm(fname);
1810 #endif
1813 * Make tempname.
1814 * May try twice: Once normal and once with shortname set, just in
1815 * case somebody puts his viminfo file in an 8.3 filesystem.
1817 for (;;)
1819 tempname = buf_modname(
1820 #ifdef UNIX
1821 shortname,
1822 #else
1823 # ifdef SHORT_FNAME
1824 TRUE,
1825 # else
1826 # ifdef FEAT_GUI_W32
1827 gui_is_win32s(),
1828 # else
1829 FALSE,
1830 # endif
1831 # endif
1832 #endif
1833 fname,
1834 #ifdef VMS
1835 (char_u *)"-tmp",
1836 #else
1837 # ifdef RISCOS
1838 (char_u *)"/tmp",
1839 # else
1840 (char_u *)".tmp",
1841 # endif
1842 #endif
1843 FALSE);
1844 if (tempname == NULL) /* out of memory */
1845 break;
1848 * Check if tempfile already exists. Never overwrite an
1849 * existing file!
1851 if (mch_stat((char *)tempname, &st_new) == 0)
1853 #ifdef UNIX
1855 * Check if tempfile is same as original file. May happen
1856 * when modname() gave the same file back. E.g. silly
1857 * link, or file name-length reached. Try again with
1858 * shortname set.
1860 if (!shortname && st_new.st_dev == st_old.st_dev
1861 && st_new.st_ino == st_old.st_ino)
1863 vim_free(tempname);
1864 tempname = NULL;
1865 shortname = TRUE;
1866 continue;
1868 #endif
1870 * Try another name. Change one character, just before
1871 * the extension. This should also work for an 8.3
1872 * file name, when after adding the extension it still is
1873 * the same file as the original.
1875 wp = tempname + STRLEN(tempname) - 5;
1876 if (wp < gettail(tempname)) /* empty file name? */
1877 wp = gettail(tempname);
1878 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1879 --*wp)
1882 * They all exist? Must be something wrong! Don't
1883 * write the viminfo file then.
1885 if (*wp == 'a')
1887 vim_free(tempname);
1888 tempname = NULL;
1889 break;
1893 break;
1896 if (tempname != NULL)
1898 #ifdef VMS
1899 /* fdopen() fails for some reason */
1900 umask_save = umask(077);
1901 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1902 (void)umask(umask_save);
1903 #else
1904 int fd;
1906 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1907 * protection:
1908 * Unix: same as original file, but strip s-bit. Reset umask to
1909 * avoid it getting in the way.
1910 * Others: r&w for user only. */
1911 # ifdef UNIX
1912 umask_save = umask(0);
1913 fd = mch_open((char *)tempname,
1914 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1915 (int)((st_old.st_mode & 0777) | 0600));
1916 (void)umask(umask_save);
1917 # else
1918 fd = mch_open((char *)tempname,
1919 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1920 # endif
1921 if (fd < 0)
1922 fp_out = NULL;
1923 else
1924 fp_out = fdopen(fd, WRITEBIN);
1925 #endif /* VMS */
1928 * If we can't create in the same directory, try creating a
1929 * "normal" temp file.
1931 if (fp_out == NULL)
1933 vim_free(tempname);
1934 if ((tempname = vim_tempname('o')) != NULL)
1935 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1938 #if defined(UNIX) && defined(HAVE_FCHOWN)
1940 * Make sure the owner can read/write it. This only works for
1941 * root.
1943 if (fp_out != NULL)
1944 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1945 #endif
1950 * Check if the new viminfo file can be written to.
1952 if (fp_out == NULL)
1954 EMSG2(_("E138: Can't write viminfo file %s!"),
1955 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1956 if (fp_in != NULL)
1957 fclose(fp_in);
1958 goto end;
1961 if (p_verbose > 0)
1963 verbose_enter();
1964 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1965 verbose_leave();
1968 viminfo_errcnt = 0;
1969 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
1971 fclose(fp_out); /* errors are ignored !? */
1972 if (fp_in != NULL)
1974 fclose(fp_in);
1977 * In case of an error keep the original viminfo file.
1978 * Otherwise rename the newly written file.
1980 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1981 mch_remove(tempname);
1983 #ifdef WIN3264
1984 /* If the viminfo file was hidden then also hide the new file. */
1985 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1986 mch_hide(fname);
1987 #endif
1990 end:
1991 vim_free(fname);
1992 vim_free(tempname);
1996 * Get the viminfo file name to use.
1997 * If "file" is given and not empty, use it (has already been expanded by
1998 * cmdline functions).
1999 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2000 * expand environment variables.
2001 * Returns an allocated string. NULL when out of memory.
2003 static char_u *
2004 viminfo_filename(file)
2005 char_u *file;
2007 if (file == NULL || *file == NUL)
2009 if (use_viminfo != NULL)
2010 file = use_viminfo;
2011 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2013 #ifdef VIMINFO_FILE2
2014 /* don't use $HOME when not defined (turned into "c:/"!). */
2015 # ifdef VMS
2016 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2017 # else
2018 if (mch_getenv((char_u *)"HOME") == NULL)
2019 # endif
2021 /* don't use $VIM when not available. */
2022 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2023 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2024 file = (char_u *)VIMINFO_FILE2;
2025 else
2026 file = (char_u *)VIMINFO_FILE;
2028 else
2029 #endif
2030 file = (char_u *)VIMINFO_FILE;
2032 expand_env(file, NameBuff, MAXPATHL);
2033 file = NameBuff;
2035 return vim_strsave(file);
2039 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2041 static void
2042 do_viminfo(fp_in, fp_out, flags)
2043 FILE *fp_in;
2044 FILE *fp_out;
2045 int flags;
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 (flags & VIF_WANT_INFO)
2061 eof = read_viminfo_up_to_marks(&vir,
2062 flags & VIF_FORCEIT, fp_out != NULL);
2063 else
2064 /* Skip info, find start of marks */
2065 while (!(eof = viminfo_readline(&vir))
2066 && vir.vir_line[0] != '>')
2069 if (fp_out != NULL)
2071 /* Write the info: */
2072 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2073 VIM_VERSION_MEDIUM);
2074 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2075 #ifdef FEAT_MBYTE
2076 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2077 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2078 #endif
2079 write_viminfo_search_pattern(fp_out);
2080 write_viminfo_sub_string(fp_out);
2081 #ifdef FEAT_CMDHIST
2082 write_viminfo_history(fp_out);
2083 #endif
2084 write_viminfo_registers(fp_out);
2085 #ifdef FEAT_EVAL
2086 write_viminfo_varlist(fp_out);
2087 #endif
2088 write_viminfo_filemarks(fp_out);
2089 write_viminfo_bufferlist(fp_out);
2090 count = write_viminfo_marks(fp_out);
2092 if (fp_in != NULL
2093 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2094 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
2096 vim_free(vir.vir_line);
2097 #ifdef FEAT_MBYTE
2098 if (vir.vir_conv.vc_type != CONV_NONE)
2099 convert_setup(&vir.vir_conv, NULL, NULL);
2100 #endif
2104 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2105 * first part of the viminfo file which contains everything but the marks that
2106 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2108 static int
2109 read_viminfo_up_to_marks(virp, forceit, writing)
2110 vir_T *virp;
2111 int forceit;
2112 int writing;
2114 int eof;
2115 buf_T *buf;
2117 #ifdef FEAT_CMDHIST
2118 prepare_viminfo_history(forceit ? 9999 : 0);
2119 #endif
2120 eof = viminfo_readline(virp);
2121 while (!eof && virp->vir_line[0] != '>')
2123 switch (virp->vir_line[0])
2125 /* Characters reserved for future expansion, ignored now */
2126 case '+': /* "+40 /path/dir file", for running vim without args */
2127 case '|': /* to be defined */
2128 case '^': /* to be defined */
2129 case '<': /* long line - ignored */
2130 /* A comment or empty line. */
2131 case NUL:
2132 case '\r':
2133 case '\n':
2134 case '#':
2135 eof = viminfo_readline(virp);
2136 break;
2137 case '*': /* "*encoding=value" */
2138 eof = viminfo_encoding(virp);
2139 break;
2140 case '!': /* global variable */
2141 #ifdef FEAT_EVAL
2142 eof = read_viminfo_varlist(virp, writing);
2143 #else
2144 eof = viminfo_readline(virp);
2145 #endif
2146 break;
2147 case '%': /* entry for buffer list */
2148 eof = read_viminfo_bufferlist(virp, writing);
2149 break;
2150 case '"':
2151 eof = read_viminfo_register(virp, forceit);
2152 break;
2153 case '/': /* Search string */
2154 case '&': /* Substitute search string */
2155 case '~': /* Last search string, followed by '/' or '&' */
2156 eof = read_viminfo_search_pattern(virp, forceit);
2157 break;
2158 case '$':
2159 eof = read_viminfo_sub_string(virp, forceit);
2160 break;
2161 case ':':
2162 case '?':
2163 case '=':
2164 case '@':
2165 #ifdef FEAT_CMDHIST
2166 eof = read_viminfo_history(virp);
2167 #else
2168 eof = viminfo_readline(virp);
2169 #endif
2170 break;
2171 case '-':
2172 case '\'':
2173 eof = read_viminfo_filemark(virp, forceit);
2174 break;
2175 default:
2176 if (viminfo_error("E575: ", _("Illegal starting char"),
2177 virp->vir_line))
2178 eof = TRUE;
2179 else
2180 eof = viminfo_readline(virp);
2181 break;
2185 #ifdef FEAT_CMDHIST
2186 /* Finish reading history items. */
2187 finish_viminfo_history();
2188 #endif
2190 /* Change file names to buffer numbers for fmarks. */
2191 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2192 fmarks_check_names(buf);
2194 return eof;
2198 * Compare the 'encoding' value in the viminfo file with the current value of
2199 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2200 * conversion of text with iconv() in viminfo_readstring().
2202 static int
2203 viminfo_encoding(virp)
2204 vir_T *virp;
2206 #ifdef FEAT_MBYTE
2207 char_u *p;
2208 int i;
2210 if (get_viminfo_parameter('c') != 0)
2212 p = vim_strchr(virp->vir_line, '=');
2213 if (p != NULL)
2215 /* remove trailing newline */
2216 ++p;
2217 for (i = 0; vim_isprintc(p[i]); ++i)
2219 p[i] = NUL;
2221 convert_setup(&virp->vir_conv, p, p_enc);
2224 #endif
2225 return viminfo_readline(virp);
2229 * Read a line from the viminfo file.
2230 * Returns TRUE for end-of-file;
2233 viminfo_readline(virp)
2234 vir_T *virp;
2236 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2240 * check string read from viminfo file
2241 * remove '\n' at the end of the line
2242 * - replace CTRL-V CTRL-V with CTRL-V
2243 * - replace CTRL-V 'n' with '\n'
2245 * Check for a long line as written by viminfo_writestring().
2247 * Return the string in allocated memory (NULL when out of memory).
2249 /*ARGSUSED*/
2250 char_u *
2251 viminfo_readstring(virp, off, convert)
2252 vir_T *virp;
2253 int off; /* offset for virp->vir_line */
2254 int convert; /* convert the string */
2256 char_u *retval;
2257 char_u *s, *d;
2258 long len;
2260 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2262 len = atol((char *)virp->vir_line + off + 1);
2263 retval = lalloc(len, TRUE);
2264 if (retval == NULL)
2266 /* Line too long? File messed up? Skip next line. */
2267 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2268 return NULL;
2270 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2271 s = retval + 1; /* Skip the leading '<' */
2273 else
2275 retval = vim_strsave(virp->vir_line + off);
2276 if (retval == NULL)
2277 return NULL;
2278 s = retval;
2281 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2282 d = retval;
2283 while (*s != NUL && *s != '\n')
2285 if (s[0] == Ctrl_V && s[1] != NUL)
2287 if (s[1] == 'n')
2288 *d++ = '\n';
2289 else
2290 *d++ = Ctrl_V;
2291 s += 2;
2293 else
2294 *d++ = *s++;
2296 *d = NUL;
2298 #ifdef FEAT_MBYTE
2299 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2301 d = string_convert(&virp->vir_conv, retval, NULL);
2302 if (d != NULL)
2304 vim_free(retval);
2305 retval = d;
2308 #endif
2310 return retval;
2314 * write string to viminfo file
2315 * - replace CTRL-V with CTRL-V CTRL-V
2316 * - replace '\n' with CTRL-V 'n'
2317 * - add a '\n' at the end
2319 * For a long line:
2320 * - write " CTRL-V <length> \n " in first line
2321 * - write " < <string> \n " in second line
2323 void
2324 viminfo_writestring(fd, p)
2325 FILE *fd;
2326 char_u *p;
2328 int c;
2329 char_u *s;
2330 int len = 0;
2332 for (s = p; *s != NUL; ++s)
2334 if (*s == Ctrl_V || *s == '\n')
2335 ++len;
2336 ++len;
2339 /* If the string will be too long, write its length and put it in the next
2340 * line. Take into account that some room is needed for what comes before
2341 * the string (e.g., variable name). Add something to the length for the
2342 * '<', NL and trailing NUL. */
2343 if (len > LSIZE / 2)
2344 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2346 while ((c = *p++) != NUL)
2348 if (c == Ctrl_V || c == '\n')
2350 putc(Ctrl_V, fd);
2351 if (c == '\n')
2352 c = 'n';
2354 putc(c, fd);
2356 putc('\n', fd);
2358 #endif /* FEAT_VIMINFO */
2361 * Implementation of ":fixdel", also used by get_stty().
2362 * <BS> resulting <Del>
2363 * ^? ^H
2364 * not ^? ^?
2366 /*ARGSUSED*/
2367 void
2368 do_fixdel(eap)
2369 exarg_T *eap;
2371 char_u *p;
2373 p = find_termcode((char_u *)"kb");
2374 add_termcode((char_u *)"kD", p != NULL
2375 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2378 void
2379 print_line_no_prefix(lnum, use_number, list)
2380 linenr_T lnum;
2381 int use_number;
2382 int list;
2384 char_u numbuf[30];
2386 if (curwin->w_p_nu || use_number)
2388 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2389 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2391 msg_prt_line(ml_get(lnum), list);
2395 * Print a text line. Also in silent mode ("ex -s").
2397 void
2398 print_line(lnum, use_number, list)
2399 linenr_T lnum;
2400 int use_number;
2401 int list;
2403 int save_silent = silent_mode;
2405 msg_start();
2406 silent_mode = FALSE;
2407 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2408 print_line_no_prefix(lnum, use_number, list);
2409 if (save_silent)
2411 msg_putchar('\n');
2412 cursor_on(); /* msg_start() switches it off */
2413 out_flush();
2414 silent_mode = save_silent;
2415 info_message = FALSE;
2420 * ":file[!] [fname]".
2422 void
2423 ex_file(eap)
2424 exarg_T *eap;
2426 char_u *fname, *sfname, *xfname;
2427 buf_T *buf;
2429 /* ":0file" removes the file name. Check for illegal uses ":3file",
2430 * "0file name", etc. */
2431 if (eap->addr_count > 0
2432 && (*eap->arg != NUL
2433 || eap->line2 > 0
2434 || eap->addr_count > 1))
2436 EMSG(_(e_invarg));
2437 return;
2440 if (*eap->arg != NUL || eap->addr_count == 1)
2442 #ifdef FEAT_AUTOCMD
2443 buf = curbuf;
2444 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2445 /* buffer changed, don't change name now */
2446 if (buf != curbuf)
2447 return;
2448 # ifdef FEAT_EVAL
2449 if (aborting()) /* autocmds may abort script processing */
2450 return;
2451 # endif
2452 #endif
2454 * The name of the current buffer will be changed.
2455 * A new (unlisted) buffer entry needs to be made to hold the old file
2456 * name, which will become the alternate file name.
2457 * But don't set the alternate file name if the buffer didn't have a
2458 * name.
2460 fname = curbuf->b_ffname;
2461 sfname = curbuf->b_sfname;
2462 xfname = curbuf->b_fname;
2463 curbuf->b_ffname = NULL;
2464 curbuf->b_sfname = NULL;
2465 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2467 curbuf->b_ffname = fname;
2468 curbuf->b_sfname = sfname;
2469 return;
2471 curbuf->b_flags |= BF_NOTEDITED;
2472 if (xfname != NULL && *xfname != NUL)
2474 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2475 if (buf != NULL && !cmdmod.keepalt)
2476 curwin->w_alt_fnum = buf->b_fnum;
2478 vim_free(fname);
2479 vim_free(sfname);
2480 #ifdef FEAT_AUTOCMD
2481 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2482 #endif
2483 /* Change directories when the 'acd' option is set. */
2484 DO_AUTOCHDIR
2486 /* print full file name if :cd used */
2487 fileinfo(FALSE, FALSE, eap->forceit);
2491 * ":update".
2493 void
2494 ex_update(eap)
2495 exarg_T *eap;
2497 if (curbufIsChanged())
2498 (void)do_write(eap);
2502 * ":write" and ":saveas".
2504 void
2505 ex_write(eap)
2506 exarg_T *eap;
2508 if (eap->usefilter) /* input lines to shell command */
2509 do_bang(1, eap, FALSE, TRUE, FALSE);
2510 else
2511 (void)do_write(eap);
2515 * write current buffer to file 'eap->arg'
2516 * if 'eap->append' is TRUE, append to the file
2518 * if *eap->arg == NUL write to current file
2520 * return FAIL for failure, OK otherwise
2523 do_write(eap)
2524 exarg_T *eap;
2526 int other;
2527 char_u *fname = NULL; /* init to shut up gcc */
2528 char_u *ffname;
2529 int retval = FAIL;
2530 char_u *free_fname = NULL;
2531 #ifdef FEAT_BROWSE
2532 char_u *browse_file = NULL;
2533 #endif
2534 buf_T *alt_buf = NULL;
2536 if (not_writing()) /* check 'write' option */
2537 return FAIL;
2539 ffname = eap->arg;
2540 #ifdef FEAT_BROWSE
2541 if (cmdmod.browse)
2543 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2544 NULL, NULL, NULL, curbuf);
2545 if (browse_file == NULL)
2546 goto theend;
2547 ffname = browse_file;
2549 #endif
2550 if (*ffname == NUL)
2552 if (eap->cmdidx == CMD_saveas)
2554 EMSG(_(e_argreq));
2555 goto theend;
2557 other = FALSE;
2559 else
2561 fname = ffname;
2562 free_fname = fix_fname(ffname);
2564 * When out-of-memory, keep unexpanded file name, because we MUST be
2565 * able to write the file in this situation.
2567 if (free_fname != NULL)
2568 ffname = free_fname;
2569 other = otherfile(ffname);
2573 * If we have a new file, put its name in the list of alternate file names.
2575 if (other)
2577 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2578 || eap->cmdidx == CMD_saveas)
2579 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2580 else
2581 alt_buf = buflist_findname(ffname);
2582 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2584 /* Overwriting a file that is loaded in another buffer is not a
2585 * good idea. */
2586 EMSG(_(e_bufloaded));
2587 goto theend;
2592 * Writing to the current file is not allowed in readonly mode
2593 * and a file name is required.
2594 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2596 if (!other && (
2597 #ifdef FEAT_QUICKFIX
2598 bt_dontwrite_msg(curbuf) ||
2599 #endif
2600 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2601 goto theend;
2603 if (!other)
2605 ffname = curbuf->b_ffname;
2606 fname = curbuf->b_fname;
2608 * Not writing the whole file is only allowed with '!'.
2610 if ( (eap->line1 != 1
2611 || eap->line2 != curbuf->b_ml.ml_line_count)
2612 && !eap->forceit
2613 && !eap->append
2614 && !p_wa)
2616 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2617 if (p_confirm || cmdmod.confirm)
2619 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2620 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2621 goto theend;
2622 eap->forceit = TRUE;
2624 else
2625 #endif
2627 EMSG(_("E140: Use ! to write partial buffer"));
2628 goto theend;
2633 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2635 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2637 #ifdef FEAT_AUTOCMD
2638 buf_T *was_curbuf = curbuf;
2640 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2641 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2642 # ifdef FEAT_EVAL
2643 if (curbuf != was_curbuf || aborting())
2644 # else
2645 if (curbuf != was_curbuf)
2646 # endif
2648 /* buffer changed, don't change name now */
2649 retval = FAIL;
2650 goto theend;
2652 #endif
2653 /* Exchange the file names for the current and the alternate
2654 * buffer. This makes it look like we are now editing the buffer
2655 * under the new name. Must be done before buf_write(), because
2656 * if there is no file name and 'cpo' contains 'F', it will set
2657 * the file name. */
2658 fname = alt_buf->b_fname;
2659 alt_buf->b_fname = curbuf->b_fname;
2660 curbuf->b_fname = fname;
2661 fname = alt_buf->b_ffname;
2662 alt_buf->b_ffname = curbuf->b_ffname;
2663 curbuf->b_ffname = fname;
2664 fname = alt_buf->b_sfname;
2665 alt_buf->b_sfname = curbuf->b_sfname;
2666 curbuf->b_sfname = fname;
2667 buf_name_changed(curbuf);
2668 #ifdef FEAT_AUTOCMD
2669 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2670 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2671 if (!alt_buf->b_p_bl)
2673 alt_buf->b_p_bl = TRUE;
2674 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2676 # ifdef FEAT_EVAL
2677 if (curbuf != was_curbuf || aborting())
2678 # else
2679 if (curbuf != was_curbuf)
2680 # endif
2682 /* buffer changed, don't write the file */
2683 retval = FAIL;
2684 goto theend;
2687 /* If 'filetype' was empty try detecting it now. */
2688 if (*curbuf->b_p_ft == NUL)
2690 if (au_has_group((char_u *)"filetypedetect"))
2691 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2692 TRUE);
2693 do_modelines(0);
2695 #endif
2698 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2699 eap, eap->append, eap->forceit, TRUE, FALSE);
2701 /* After ":saveas fname" reset 'readonly'. */
2702 if (eap->cmdidx == CMD_saveas)
2704 if (retval == OK)
2705 curbuf->b_p_ro = FALSE;
2706 /* Change directories when the 'acd' option is set. */
2707 DO_AUTOCHDIR
2711 theend:
2712 #ifdef FEAT_BROWSE
2713 vim_free(browse_file);
2714 #endif
2715 vim_free(free_fname);
2716 return retval;
2720 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2721 * BF_NEW or BF_READERR, check for overwriting current file.
2722 * May set eap->forceit if a dialog says it's OK to overwrite.
2723 * Return OK if it's OK, FAIL if it is not.
2725 /*ARGSUSED*/
2726 static int
2727 check_overwrite(eap, buf, fname, ffname, other)
2728 exarg_T *eap;
2729 buf_T *buf;
2730 char_u *fname; /* file name to be used (can differ from
2731 buf->ffname) */
2732 char_u *ffname; /* full path version of fname */
2733 int other; /* writing under other name */
2736 * write to other file or b_flags set or not writing the whole file:
2737 * overwriting only allowed with '!'
2739 if ( (other
2740 || (buf->b_flags & BF_NOTEDITED)
2741 || ((buf->b_flags & BF_NEW)
2742 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2743 || (buf->b_flags & BF_READERR))
2744 && !p_wa
2745 #ifdef FEAT_QUICKFIX
2746 && !bt_nofile(buf)
2747 #endif
2748 && vim_fexists(ffname))
2750 if (!eap->forceit && !eap->append)
2752 #ifdef UNIX
2753 /* with UNIX it is possible to open a directory */
2754 if (mch_isdir(ffname))
2756 EMSG2(_(e_isadir2), ffname);
2757 return FAIL;
2759 #endif
2760 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2761 if (p_confirm || cmdmod.confirm)
2763 char_u buff[IOSIZE];
2765 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2766 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2767 return FAIL;
2768 eap->forceit = TRUE;
2770 else
2771 #endif
2773 EMSG(_(e_exists));
2774 return FAIL;
2778 /* For ":w! filename" check that no swap file exists for "filename". */
2779 if (other && !emsg_silent)
2781 char_u dir[MAXPATHL];
2782 char_u *p;
2783 int r;
2784 char_u *swapname;
2786 /* We only try the first entry in 'directory', without checking if
2787 * it's writable. If the "." directory is not writable the write
2788 * will probably fail anyway.
2789 * Use 'shortname' of the current buffer, since there is no buffer
2790 * for the written file. */
2791 if (*p_dir == NUL)
2792 STRCPY(dir, ".");
2793 else
2795 p = p_dir;
2796 copy_option_part(&p, dir, MAXPATHL, ",");
2798 swapname = makeswapname(fname, ffname, curbuf, dir);
2799 r = vim_fexists(swapname);
2800 if (r)
2802 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2803 if (p_confirm || cmdmod.confirm)
2805 char_u buff[IOSIZE];
2807 dialog_msg(buff,
2808 _("Swap file \"%s\" exists, overwrite anyway?"),
2809 swapname);
2810 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2811 != VIM_YES)
2813 vim_free(swapname);
2814 return FAIL;
2816 eap->forceit = TRUE;
2818 else
2819 #endif
2821 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2822 swapname);
2823 vim_free(swapname);
2824 return FAIL;
2827 vim_free(swapname);
2830 return OK;
2834 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2836 void
2837 ex_wnext(eap)
2838 exarg_T *eap;
2840 int i;
2842 if (eap->cmd[1] == 'n')
2843 i = curwin->w_arg_idx + (int)eap->line2;
2844 else
2845 i = curwin->w_arg_idx - (int)eap->line2;
2846 eap->line1 = 1;
2847 eap->line2 = curbuf->b_ml.ml_line_count;
2848 if (do_write(eap) != FAIL)
2849 do_argfile(eap, i);
2853 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2855 void
2856 do_wqall(eap)
2857 exarg_T *eap;
2859 buf_T *buf;
2860 int error = 0;
2861 int save_forceit = eap->forceit;
2863 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2864 exiting = TRUE;
2866 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2868 if (bufIsChanged(buf))
2871 * Check if there is a reason the buffer cannot be written:
2872 * 1. if the 'write' option is set
2873 * 2. if there is no file name (even after browsing)
2874 * 3. if the 'readonly' is set (even after a dialog)
2875 * 4. if overwriting is allowed (even after a dialog)
2877 if (not_writing())
2879 ++error;
2880 break;
2882 #ifdef FEAT_BROWSE
2883 /* ":browse wall": ask for file name if there isn't one */
2884 if (buf->b_ffname == NULL && cmdmod.browse)
2885 browse_save_fname(buf);
2886 #endif
2887 if (buf->b_ffname == NULL)
2889 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2890 ++error;
2892 else if (check_readonly(&eap->forceit, buf)
2893 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2894 FALSE) == FAIL)
2896 ++error;
2898 else
2900 if (buf_write_all(buf, eap->forceit) == FAIL)
2901 ++error;
2902 #ifdef FEAT_AUTOCMD
2903 /* an autocommand may have deleted the buffer */
2904 if (!buf_valid(buf))
2905 buf = firstbuf;
2906 #endif
2908 eap->forceit = save_forceit; /* check_overwrite() may set it */
2911 if (exiting)
2913 if (!error)
2914 getout(0); /* exit Vim */
2915 not_exiting();
2920 * Check the 'write' option.
2921 * Return TRUE and give a message when it's not st.
2924 not_writing()
2926 if (p_write)
2927 return FALSE;
2928 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2929 return TRUE;
2933 * Check if a buffer is read-only (either 'readonly' option is set or file is
2934 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2935 * message when the buffer is readonly.
2937 static int
2938 check_readonly(forceit, buf)
2939 int *forceit;
2940 buf_T *buf;
2942 struct stat st;
2944 /* Handle a file being readonly when the 'readonly' option is set or when
2945 * the file exists and permissions are read-only.
2946 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2947 * important for device checks but not here. */
2948 if (!*forceit && (buf->b_p_ro
2949 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2950 && check_file_readonly(buf->b_ffname, 0777))))
2952 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2953 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2955 char_u buff[IOSIZE];
2957 if (buf->b_p_ro)
2958 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2959 buf->b_fname);
2960 else
2961 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2962 buf->b_fname);
2964 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2966 /* Set forceit, to force the writing of a readonly file */
2967 *forceit = TRUE;
2968 return FALSE;
2970 else
2971 return TRUE;
2973 else
2974 #endif
2975 if (buf->b_p_ro)
2976 EMSG(_(e_readonly));
2977 else
2978 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2979 buf->b_fname);
2980 return TRUE;
2983 return FALSE;
2987 * Try to abandon current file and edit a new or existing file.
2988 * 'fnum' is the number of the file, if zero use ffname/sfname.
2990 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2991 * -1 for successfully opening another file.
2992 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2995 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2996 int fnum;
2997 char_u *ffname;
2998 char_u *sfname;
2999 int setpm;
3000 linenr_T lnum;
3001 int forceit;
3003 int other;
3004 int retval;
3005 char_u *free_me = NULL;
3007 if (text_locked())
3008 return 1;
3009 #ifdef FEAT_AUTOCMD
3010 if (curbuf_locked())
3011 return 1;
3012 #endif
3014 if (fnum == 0)
3016 /* make ffname full path, set sfname */
3017 fname_expand(curbuf, &ffname, &sfname);
3018 other = otherfile(ffname);
3019 free_me = ffname; /* has been allocated, free() later */
3021 else
3022 other = (fnum != curbuf->b_fnum);
3024 if (other)
3025 ++no_wait_return; /* don't wait for autowrite message */
3026 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3027 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3029 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3030 if (p_confirm && p_write)
3031 dialog_changed(curbuf, FALSE);
3032 if (curbufIsChanged())
3033 #endif
3035 if (other)
3036 --no_wait_return;
3037 EMSG(_(e_nowrtmsg));
3038 retval = 2; /* file has been changed */
3039 goto theend;
3042 if (other)
3043 --no_wait_return;
3044 if (setpm)
3045 setpcmark();
3046 if (!other)
3048 if (lnum != 0)
3049 curwin->w_cursor.lnum = lnum;
3050 check_cursor_lnum();
3051 beginline(BL_SOL | BL_FIX);
3052 retval = 0; /* it's in the same file */
3054 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3055 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3056 retval = -1; /* opened another file */
3057 else
3058 retval = 1; /* error encountered */
3060 theend:
3061 vim_free(free_me);
3062 return retval;
3066 * start editing a new file
3068 * fnum: file number; if zero use ffname/sfname
3069 * ffname: the file name
3070 * - full path if sfname used,
3071 * - any file name if sfname is NULL
3072 * - empty string to re-edit with the same file name (but may be
3073 * in a different directory)
3074 * - NULL to start an empty buffer
3075 * sfname: the short file name (or NULL)
3076 * eap: contains the command to be executed after loading the file and
3077 * forced 'ff' and 'fenc'
3078 * newlnum: if > 0: put cursor on this line number (if possible)
3079 * if ECMD_LASTL: use last position in loaded file
3080 * if ECMD_LAST: use last position in all files
3081 * if ECMD_ONE: use first line
3082 * flags:
3083 * ECMD_HIDE: if TRUE don't free the current buffer
3084 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3085 * ECMD_OLDBUF: use existing buffer if it exists
3086 * ECMD_FORCEIT: ! used for Ex command
3087 * ECMD_ADDBUF: don't edit, just add to buffer list
3089 * return FAIL for failure, OK otherwise
3092 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3093 int fnum;
3094 char_u *ffname;
3095 char_u *sfname;
3096 exarg_T *eap; /* can be NULL! */
3097 linenr_T newlnum;
3098 int flags;
3100 int other_file; /* TRUE if editing another file */
3101 int oldbuf; /* TRUE if using existing buffer */
3102 #ifdef FEAT_AUTOCMD
3103 int auto_buf = FALSE; /* TRUE if autocommands brought us
3104 into the buffer unexpectedly */
3105 char_u *new_name = NULL;
3106 int did_set_swapcommand = FALSE;
3107 #endif
3108 buf_T *buf;
3109 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3110 buf_T *old_curbuf = curbuf;
3111 #endif
3112 char_u *free_fname = NULL;
3113 #ifdef FEAT_BROWSE
3114 char_u *browse_file = NULL;
3115 #endif
3116 int retval = FAIL;
3117 long n;
3118 linenr_T lnum;
3119 linenr_T topline = 0;
3120 int newcol = -1;
3121 int solcol = -1;
3122 pos_T *pos;
3123 #ifdef FEAT_SUN_WORKSHOP
3124 char_u *cp;
3125 #endif
3126 char_u *command = NULL;
3127 #ifdef FEAT_SPELL
3128 int did_get_winopts = FALSE;
3129 #endif
3131 if (eap != NULL)
3132 command = eap->do_ecmd_cmd;
3134 if (fnum != 0)
3136 if (fnum == curbuf->b_fnum) /* file is already being edited */
3137 return OK; /* nothing to do */
3138 other_file = TRUE;
3140 else
3142 #ifdef FEAT_BROWSE
3143 if (cmdmod.browse)
3145 # ifdef FEAT_AUTOCMD
3146 if (
3147 # ifdef FEAT_GUI
3148 !gui.in_use &&
3149 # endif
3150 au_has_group((char_u *)"FileExplorer"))
3152 /* No browsing supported but we do have the file explorer:
3153 * Edit the directory. */
3154 if (ffname == NULL || !mch_isdir(ffname))
3155 ffname = (char_u *)".";
3157 else
3158 # endif
3160 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3161 NULL, NULL, NULL, curbuf);
3162 if (browse_file == NULL)
3163 goto theend;
3164 ffname = browse_file;
3167 #endif
3168 /* if no short name given, use ffname for short name */
3169 if (sfname == NULL)
3170 sfname = ffname;
3171 #ifdef USE_FNAME_CASE
3172 # ifdef USE_LONG_FNAME
3173 if (USE_LONG_FNAME)
3174 # endif
3175 if (sfname != NULL)
3176 fname_case(sfname, 0); /* set correct case for sfname */
3177 #endif
3179 #ifdef FEAT_LISTCMDS
3180 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3181 goto theend;
3182 #endif
3184 if (ffname == NULL)
3185 other_file = TRUE;
3186 /* there is no file name */
3187 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3188 other_file = FALSE;
3189 else
3191 if (*ffname == NUL) /* re-edit with same file name */
3193 ffname = curbuf->b_ffname;
3194 sfname = curbuf->b_fname;
3196 free_fname = fix_fname(ffname); /* may expand to full path name */
3197 if (free_fname != NULL)
3198 ffname = free_fname;
3199 other_file = otherfile(ffname);
3200 #ifdef FEAT_SUN_WORKSHOP
3201 if (usingSunWorkShop && p_acd
3202 && (cp = vim_strrchr(sfname, '/')) != NULL)
3203 sfname = ++cp;
3204 #endif
3209 * if the file was changed we may not be allowed to abandon it
3210 * - if we are going to re-edit the same file
3211 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3213 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3214 || (curbuf->b_nwindows == 1
3215 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3216 && check_changed(curbuf, p_awa, !other_file,
3217 (flags & ECMD_FORCEIT), FALSE))
3219 if (fnum == 0 && other_file && ffname != NULL)
3220 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3221 goto theend;
3224 #ifdef FEAT_VISUAL
3226 * End Visual mode before switching to another buffer, so the text can be
3227 * copied into the GUI selection buffer.
3229 reset_VIsual();
3230 #endif
3232 #ifdef FEAT_AUTOCMD
3233 if ((command != NULL || newlnum > (linenr_T)0)
3234 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3236 int len;
3237 char_u *p;
3239 /* Set v:swapcommand for the SwapExists autocommands. */
3240 if (command != NULL)
3241 len = (int)STRLEN(command) + 3;
3242 else
3243 len = 30;
3244 p = alloc((unsigned)len);
3245 if (p != NULL)
3247 if (command != NULL)
3248 vim_snprintf((char *)p, len, ":%s\r", command);
3249 else
3250 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3251 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3252 did_set_swapcommand = TRUE;
3253 vim_free(p);
3256 #endif
3259 * If we are starting to edit another file, open a (new) buffer.
3260 * Otherwise we re-use the current buffer.
3262 if (other_file)
3264 #ifdef FEAT_LISTCMDS
3265 if (!(flags & ECMD_ADDBUF))
3266 #endif
3268 if (!cmdmod.keepalt)
3269 curwin->w_alt_fnum = curbuf->b_fnum;
3270 buflist_altfpos();
3273 if (fnum)
3274 buf = buflist_findnr(fnum);
3275 else
3277 #ifdef FEAT_LISTCMDS
3278 if (flags & ECMD_ADDBUF)
3280 linenr_T tlnum = 1L;
3282 if (command != NULL)
3284 tlnum = atol((char *)command);
3285 if (tlnum <= 0)
3286 tlnum = 1L;
3288 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3289 goto theend;
3291 #endif
3292 buf = buflist_new(ffname, sfname, 0L,
3293 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3295 if (buf == NULL)
3296 goto theend;
3297 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3299 oldbuf = FALSE;
3300 buf->b_nwindows = 0;
3302 else /* existing memfile */
3304 oldbuf = TRUE;
3305 (void)buf_check_timestamp(buf, FALSE);
3306 /* Check if autocommands made buffer invalid or changed the current
3307 * buffer. */
3308 if (!buf_valid(buf)
3309 #ifdef FEAT_AUTOCMD
3310 || curbuf != old_curbuf
3311 #endif
3313 goto theend;
3314 #ifdef FEAT_EVAL
3315 if (aborting()) /* autocmds may abort script processing */
3316 goto theend;
3317 #endif
3320 /* May jump to last used line number for a loaded buffer or when asked
3321 * for explicitly */
3322 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3324 pos = buflist_findfpos(buf);
3325 newlnum = pos->lnum;
3326 solcol = pos->col;
3330 * Make the (new) buffer the one used by the current window.
3331 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3332 * If the current buffer was empty and has no file name, curbuf
3333 * is returned by buflist_new().
3335 if (buf != curbuf)
3337 #ifdef FEAT_AUTOCMD
3339 * Be careful: The autocommands may delete any buffer and change
3340 * the current buffer.
3341 * - If the buffer we are going to edit is deleted, give up.
3342 * - If the current buffer is deleted, prefer to load the new
3343 * buffer when loading a buffer is required. This avoids
3344 * loading another buffer which then must be closed again.
3345 * - If we ended up in the new buffer already, need to skip a few
3346 * things, set auto_buf.
3348 if (buf->b_fname != NULL)
3349 new_name = vim_strsave(buf->b_fname);
3350 au_new_curbuf = buf;
3351 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3352 if (!buf_valid(buf)) /* new buffer has been deleted */
3354 delbuf_msg(new_name); /* frees new_name */
3355 goto theend;
3357 # ifdef FEAT_EVAL
3358 if (aborting()) /* autocmds may abort script processing */
3360 vim_free(new_name);
3361 goto theend;
3363 # endif
3364 if (buf == curbuf) /* already in new buffer */
3365 auto_buf = TRUE;
3366 else
3368 if (curbuf == old_curbuf)
3369 #endif
3370 buf_copy_options(buf, BCO_ENTER);
3372 /* close the link to the current buffer */
3373 u_sync(FALSE);
3374 close_buffer(curwin, curbuf,
3375 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3377 #ifdef FEAT_AUTOCMD
3378 # ifdef FEAT_EVAL
3379 if (aborting()) /* autocmds may abort script processing */
3381 vim_free(new_name);
3382 goto theend;
3384 # endif
3385 /* Be careful again, like above. */
3386 if (!buf_valid(buf)) /* new buffer has been deleted */
3388 delbuf_msg(new_name); /* frees new_name */
3389 goto theend;
3391 if (buf == curbuf) /* already in new buffer */
3392 auto_buf = TRUE;
3393 else
3394 #endif
3396 curwin->w_buffer = buf;
3397 curbuf = buf;
3398 ++curbuf->b_nwindows;
3399 /* set 'fileformat' */
3400 if (*p_ffs && !oldbuf)
3401 set_fileformat(default_fileformat(), OPT_LOCAL);
3404 /* May get the window options from the last time this buffer
3405 * was in this window (or another window). If not used
3406 * before, reset the local window options to the global
3407 * values. Also restores old folding stuff. */
3408 get_winopts(curbuf);
3409 #ifdef FEAT_SPELL
3410 did_get_winopts = TRUE;
3411 #endif
3413 #ifdef FEAT_AUTOCMD
3415 vim_free(new_name);
3416 au_new_curbuf = NULL;
3417 #endif
3419 else
3420 ++curbuf->b_nwindows;
3422 curwin->w_pcmark.lnum = 1;
3423 curwin->w_pcmark.col = 0;
3425 else /* !other_file */
3427 if (
3428 #ifdef FEAT_LISTCMDS
3429 (flags & ECMD_ADDBUF) ||
3430 #endif
3431 check_fname() == FAIL)
3432 goto theend;
3433 oldbuf = (flags & ECMD_OLDBUF);
3436 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3438 char_u *p;
3440 curbuf->b_help = TRUE;
3441 #ifdef FEAT_QUICKFIX
3442 set_string_option_direct((char_u *)"buftype", -1,
3443 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3444 #endif
3447 * Always set these options after jumping to a help tag, because the
3448 * user may have an autocommand that gets in the way.
3449 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3450 * latin1 word characters (for translated help files).
3451 * Only set it when needed, buf_init_chartab() is some work.
3454 #ifdef EBCDIC
3455 (char_u *)"65-255,^*,^|,^\"";
3456 #else
3457 (char_u *)"!-~,^*,^|,^\",192-255";
3458 #endif
3459 if (STRCMP(curbuf->b_p_isk, p) != 0)
3461 set_string_option_direct((char_u *)"isk", -1, p,
3462 OPT_FREE|OPT_LOCAL, 0);
3463 check_buf_options(curbuf);
3464 (void)buf_init_chartab(curbuf, FALSE);
3467 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3468 curwin->w_p_list = FALSE; /* no list mode */
3470 curbuf->b_p_ma = FALSE; /* not modifiable */
3471 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3472 curwin->w_p_nu = 0; /* no line numbers */
3473 #ifdef FEAT_SCROLLBIND
3474 curwin->w_p_scb = FALSE; /* no scroll binding */
3475 #endif
3476 #ifdef FEAT_ARABIC
3477 curwin->w_p_arab = FALSE; /* no arabic mode */
3478 #endif
3479 #ifdef FEAT_RIGHTLEFT
3480 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3481 #endif
3482 #ifdef FEAT_FOLDING
3483 curwin->w_p_fen = FALSE; /* No folding in the help window */
3484 #endif
3485 #ifdef FEAT_DIFF
3486 curwin->w_p_diff = FALSE; /* No 'diff' */
3487 #endif
3488 #ifdef FEAT_SPELL
3489 curwin->w_p_spell = FALSE; /* No spell checking */
3490 #endif
3492 #ifdef FEAT_AUTOCMD
3493 buf = curbuf;
3494 #endif
3495 set_buflisted(FALSE);
3497 else
3499 #ifdef FEAT_AUTOCMD
3500 buf = curbuf;
3501 #endif
3502 /* Don't make a buffer listed if it's a help buffer. Useful when
3503 * using CTRL-O to go back to a help file. */
3504 if (!curbuf->b_help)
3505 set_buflisted(TRUE);
3508 #ifdef FEAT_AUTOCMD
3509 /* If autocommands change buffers under our fingers, forget about
3510 * editing the file. */
3511 if (buf != curbuf)
3512 goto theend;
3513 # ifdef FEAT_EVAL
3514 if (aborting()) /* autocmds may abort script processing */
3515 goto theend;
3516 # endif
3518 /* Since we are starting to edit a file, consider the filetype to be
3519 * unset. Helps for when an autocommand changes files and expects syntax
3520 * highlighting to work in the other file. */
3521 did_filetype = FALSE;
3522 #endif
3525 * other_file oldbuf
3526 * FALSE FALSE re-edit same file, buffer is re-used
3527 * FALSE TRUE re-edit same file, nothing changes
3528 * TRUE FALSE start editing new file, new buffer
3529 * TRUE TRUE start editing in existing buffer (nothing to do)
3531 if (!other_file && !oldbuf) /* re-use the buffer */
3533 set_last_cursor(curwin); /* may set b_last_cursor */
3534 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3536 newlnum = curwin->w_cursor.lnum;
3537 solcol = curwin->w_cursor.col;
3539 #ifdef FEAT_AUTOCMD
3540 buf = curbuf;
3541 if (buf->b_fname != NULL)
3542 new_name = vim_strsave(buf->b_fname);
3543 else
3544 new_name = NULL;
3545 #endif
3546 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3547 #ifdef FEAT_AUTOCMD
3548 /* If autocommands deleted the buffer we were going to re-edit, give
3549 * up and jump to the end. */
3550 if (!buf_valid(buf))
3552 delbuf_msg(new_name); /* frees new_name */
3553 goto theend;
3555 vim_free(new_name);
3557 /* If autocommands change buffers under our fingers, forget about
3558 * re-editing the file. Should do the buf_clear_file(), but perhaps
3559 * the autocommands changed the buffer... */
3560 if (buf != curbuf)
3561 goto theend;
3562 # ifdef FEAT_EVAL
3563 if (aborting()) /* autocmds may abort script processing */
3564 goto theend;
3565 # endif
3566 #endif
3567 buf_clear_file(curbuf);
3568 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3569 curbuf->b_op_end.lnum = 0;
3573 * If we get here we are sure to start editing
3575 /* don't redraw until the cursor is in the right line */
3576 ++RedrawingDisabled;
3578 /* Assume success now */
3579 retval = OK;
3582 * Reset cursor position, could be used by autocommands.
3584 check_cursor();
3587 * Check if we are editing the w_arg_idx file in the argument list.
3589 check_arg_idx(curwin);
3591 #ifdef FEAT_AUTOCMD
3592 if (!auto_buf)
3593 #endif
3596 * Set cursor and init window before reading the file and executing
3597 * autocommands. This allows for the autocommands to position the
3598 * cursor.
3600 curwin_init();
3602 #ifdef FEAT_FOLDING
3603 /* It's possible that all lines in the buffer changed. Need to update
3604 * automatic folding for all windows where it's used. */
3605 # ifdef FEAT_WINDOWS
3607 win_T *win;
3608 tabpage_T *tp;
3610 FOR_ALL_TAB_WINDOWS(tp, win)
3611 if (win->w_buffer == curbuf)
3612 foldUpdateAll(win);
3614 # else
3615 foldUpdateAll(curwin);
3616 # endif
3617 #endif
3619 /* Change directories when the 'acd' option is set. */
3620 DO_AUTOCHDIR
3623 * Careful: open_buffer() and apply_autocmds() may change the current
3624 * buffer and window.
3626 lnum = curwin->w_cursor.lnum;
3627 topline = curwin->w_topline;
3628 if (!oldbuf) /* need to read the file */
3630 #if defined(HAS_SWAP_EXISTS_ACTION)
3631 swap_exists_action = SEA_DIALOG;
3632 #endif
3633 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3636 * Open the buffer and read the file.
3638 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3639 if (should_abort(open_buffer(FALSE, eap)))
3640 retval = FAIL;
3641 #else
3642 (void)open_buffer(FALSE, eap);
3643 #endif
3645 #if defined(HAS_SWAP_EXISTS_ACTION)
3646 if (swap_exists_action == SEA_QUIT)
3647 retval = FAIL;
3648 handle_swap_exists(old_curbuf);
3649 #endif
3651 #ifdef FEAT_AUTOCMD
3652 else
3654 /* Read the modelines, but only to set window-local options. Any
3655 * buffer-local options have already been set and may have been
3656 * changed by the user. */
3657 do_modelines(OPT_WINONLY);
3659 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3660 &retval);
3661 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3662 &retval);
3664 check_arg_idx(curwin);
3665 #endif
3668 * If autocommands change the cursor position or topline, we should
3669 * keep it.
3671 if (curwin->w_cursor.lnum != lnum)
3673 newlnum = curwin->w_cursor.lnum;
3674 newcol = curwin->w_cursor.col;
3676 if (curwin->w_topline == topline)
3677 topline = 0;
3679 /* Even when cursor didn't move we need to recompute topline. */
3680 changed_line_abv_curs();
3682 #ifdef FEAT_TITLE
3683 maketitle();
3684 #endif
3687 #ifdef FEAT_DIFF
3688 /* Tell the diff stuff that this buffer is new and/or needs updating.
3689 * Also needed when re-editing the same buffer, because unloading will
3690 * have removed it as a diff buffer. */
3691 if (curwin->w_p_diff)
3693 diff_buf_add(curbuf);
3694 diff_invalidate(curbuf);
3696 #endif
3698 #ifdef FEAT_SPELL
3699 /* If the window options were changed may need to set the spell language.
3700 * Can only do this after the buffer has been properly setup. */
3701 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3702 did_set_spelllang(curbuf);
3703 #endif
3705 if (command == NULL)
3707 if (newcol >= 0) /* position set by autocommands */
3709 curwin->w_cursor.lnum = newlnum;
3710 curwin->w_cursor.col = newcol;
3711 check_cursor();
3713 else if (newlnum > 0) /* line number from caller or old position */
3715 curwin->w_cursor.lnum = newlnum;
3716 check_cursor_lnum();
3717 if (solcol >= 0 && !p_sol)
3719 /* 'sol' is off: Use last known column. */
3720 curwin->w_cursor.col = solcol;
3721 check_cursor_col();
3722 #ifdef FEAT_VIRTUALEDIT
3723 curwin->w_cursor.coladd = 0;
3724 #endif
3725 curwin->w_set_curswant = TRUE;
3727 else
3728 beginline(BL_SOL | BL_FIX);
3730 else /* no line number, go to last line in Ex mode */
3732 if (exmode_active)
3733 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3734 beginline(BL_WHITE | BL_FIX);
3738 #ifdef FEAT_WINDOWS
3739 /* Check if cursors in other windows on the same buffer are still valid */
3740 check_lnums(FALSE);
3741 #endif
3744 * Did not read the file, need to show some info about the file.
3745 * Do this after setting the cursor.
3747 if (oldbuf
3748 #ifdef FEAT_AUTOCMD
3749 && !auto_buf
3750 #endif
3753 int msg_scroll_save = msg_scroll;
3755 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3756 * message. */
3757 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3758 msg_scroll = FALSE;
3759 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3760 check_for_delay(FALSE);
3761 msg_start();
3762 msg_scroll = msg_scroll_save;
3763 msg_scrolled_ign = TRUE;
3765 fileinfo(FALSE, TRUE, FALSE);
3767 msg_scrolled_ign = FALSE;
3770 if (command != NULL)
3771 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3773 #ifdef FEAT_KEYMAP
3774 if (curbuf->b_kmap_state & KEYMAP_INIT)
3775 keymap_init();
3776 #endif
3778 --RedrawingDisabled;
3779 if (!skip_redraw)
3781 n = p_so;
3782 if (topline == 0 && command == NULL)
3783 p_so = 999; /* force cursor halfway the window */
3784 update_topline();
3785 #ifdef FEAT_SCROLLBIND
3786 curwin->w_scbind_pos = curwin->w_topline;
3787 #endif
3788 p_so = n;
3789 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3792 if (p_im)
3793 need_start_insertmode = TRUE;
3795 /* Change directories when the 'acd' option is set. */
3796 DO_AUTOCHDIR
3798 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3799 if (gui.in_use && curbuf->b_ffname != NULL)
3801 # ifdef FEAT_SUN_WORKSHOP
3802 if (usingSunWorkShop)
3803 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3804 # endif
3805 # ifdef FEAT_NETBEANS_INTG
3806 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3807 netbeans_file_opened(curbuf);
3808 # endif
3810 #endif
3812 theend:
3813 #ifdef FEAT_AUTOCMD
3814 if (did_set_swapcommand)
3815 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3816 #endif
3817 #ifdef FEAT_BROWSE
3818 vim_free(browse_file);
3819 #endif
3820 vim_free(free_fname);
3821 return retval;
3824 #ifdef FEAT_AUTOCMD
3825 static void
3826 delbuf_msg(name)
3827 char_u *name;
3829 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3830 name == NULL ? (char_u *)"" : name);
3831 vim_free(name);
3832 au_new_curbuf = NULL;
3834 #endif
3836 static int append_indent = 0; /* autoindent for first line */
3839 * ":insert" and ":append", also used by ":change"
3841 void
3842 ex_append(eap)
3843 exarg_T *eap;
3845 char_u *theline;
3846 int did_undo = FALSE;
3847 linenr_T lnum = eap->line2;
3848 int indent = 0;
3849 char_u *p;
3850 int vcol;
3851 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3853 /* the ! flag toggles autoindent */
3854 if (eap->forceit)
3855 curbuf->b_p_ai = !curbuf->b_p_ai;
3857 /* First autoindent comes from the line we start on */
3858 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3859 append_indent = get_indent_lnum(lnum);
3861 if (eap->cmdidx != CMD_append)
3862 --lnum;
3864 /* when the buffer is empty append to line 0 and delete the dummy line */
3865 if (empty && lnum == 1)
3866 lnum = 0;
3868 State = INSERT; /* behave like in Insert mode */
3869 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3870 State |= LANGMAP;
3872 for (;;)
3874 msg_scroll = TRUE;
3875 need_wait_return = FALSE;
3876 if (curbuf->b_p_ai)
3878 if (append_indent >= 0)
3880 indent = append_indent;
3881 append_indent = -1;
3883 else if (lnum > 0)
3884 indent = get_indent_lnum(lnum);
3886 ex_keep_indent = FALSE;
3887 if (eap->getline == NULL)
3889 /* No getline() function, use the lines that follow. This ends
3890 * when there is no more. */
3891 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3892 break;
3893 p = vim_strchr(eap->nextcmd, NL);
3894 if (p == NULL)
3895 p = eap->nextcmd + STRLEN(eap->nextcmd);
3896 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3897 if (*p != NUL)
3898 ++p;
3899 eap->nextcmd = p;
3901 else
3902 theline = eap->getline(
3903 #ifdef FEAT_EVAL
3904 eap->cstack->cs_looplevel > 0 ? -1 :
3905 #endif
3906 NUL, eap->cookie, indent);
3907 lines_left = Rows - 1;
3908 if (theline == NULL)
3909 break;
3911 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3912 if (ex_keep_indent)
3913 append_indent = indent;
3915 /* Look for the "." after automatic indent. */
3916 vcol = 0;
3917 for (p = theline; indent > vcol; ++p)
3919 if (*p == ' ')
3920 ++vcol;
3921 else if (*p == TAB)
3922 vcol += 8 - vcol % 8;
3923 else
3924 break;
3926 if ((p[0] == '.' && p[1] == NUL)
3927 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3928 == FAIL))
3930 vim_free(theline);
3931 break;
3934 /* don't use autoindent if nothing was typed. */
3935 if (p[0] == NUL)
3936 theline[0] = NUL;
3938 did_undo = TRUE;
3939 ml_append(lnum, theline, (colnr_T)0, FALSE);
3940 appended_lines_mark(lnum, 1L);
3942 vim_free(theline);
3943 ++lnum;
3945 if (empty)
3947 ml_delete(2L, FALSE);
3948 empty = FALSE;
3951 State = NORMAL;
3953 if (eap->forceit)
3954 curbuf->b_p_ai = !curbuf->b_p_ai;
3956 /* "start" is set to eap->line2+1 unless that position is invalid (when
3957 * eap->line2 pointed to the end of the buffer and nothing was appended)
3958 * "end" is set to lnum when something has been appended, otherwise
3959 * it is the same than "start" -- Acevedo */
3960 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3961 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3962 if (eap->cmdidx != CMD_append)
3963 --curbuf->b_op_start.lnum;
3964 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3965 ? lnum : curbuf->b_op_start.lnum;
3966 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3967 curwin->w_cursor.lnum = lnum;
3968 check_cursor_lnum();
3969 beginline(BL_SOL | BL_FIX);
3971 need_wait_return = FALSE; /* don't use wait_return() now */
3972 ex_no_reprint = TRUE;
3976 * ":change"
3978 void
3979 ex_change(eap)
3980 exarg_T *eap;
3982 linenr_T lnum;
3984 if (eap->line2 >= eap->line1
3985 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3986 return;
3988 /* the ! flag toggles autoindent */
3989 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3990 append_indent = get_indent_lnum(eap->line1);
3992 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3994 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3995 break;
3996 ml_delete(eap->line1, FALSE);
3998 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4000 /* ":append" on the line above the deleted lines. */
4001 eap->line2 = eap->line1;
4002 ex_append(eap);
4005 void
4006 ex_z(eap)
4007 exarg_T *eap;
4009 char_u *x;
4010 int bigness;
4011 char_u *kind;
4012 int minus = 0;
4013 linenr_T start, end, curs, i;
4014 int j;
4015 linenr_T lnum = eap->line2;
4017 /* Vi compatible: ":z!" uses display height, without a count uses
4018 * 'scroll' */
4019 if (eap->forceit)
4020 bigness = curwin->w_height;
4021 else if (firstwin == lastwin)
4022 bigness = curwin->w_p_scr * 2;
4023 else
4024 bigness = curwin->w_height - 3;
4025 if (bigness < 1)
4026 bigness = 1;
4028 x = eap->arg;
4029 kind = x;
4030 if (*kind == '-' || *kind == '+' || *kind == '='
4031 || *kind == '^' || *kind == '.')
4032 ++x;
4033 while (*x == '-' || *x == '+')
4034 ++x;
4036 if (*x != 0)
4038 if (!VIM_ISDIGIT(*x))
4040 EMSG(_("E144: non-numeric argument to :z"));
4041 return;
4043 else
4045 bigness = atoi((char *)x);
4046 p_window = bigness;
4047 if (*kind == '=')
4048 bigness += 2;
4052 /* the number of '-' and '+' multiplies the distance */
4053 if (*kind == '-' || *kind == '+')
4054 for (x = kind + 1; *x == *kind; ++x)
4057 switch (*kind)
4059 case '-':
4060 start = lnum - bigness * (linenr_T)(x - kind);
4061 end = start + bigness;
4062 curs = end;
4063 break;
4065 case '=':
4066 start = lnum - (bigness + 1) / 2 + 1;
4067 end = lnum + (bigness + 1) / 2 - 1;
4068 curs = lnum;
4069 minus = 1;
4070 break;
4072 case '^':
4073 start = lnum - bigness * 2;
4074 end = lnum - bigness;
4075 curs = lnum - bigness;
4076 break;
4078 case '.':
4079 start = lnum - (bigness + 1) / 2 + 1;
4080 end = lnum + (bigness + 1) / 2 - 1;
4081 curs = end;
4082 break;
4084 default: /* '+' */
4085 start = lnum;
4086 if (*kind == '+')
4087 start += bigness * (linenr_T)(x - kind - 1) + 1;
4088 else if (eap->addr_count == 0)
4089 ++start;
4090 end = start + bigness - 1;
4091 curs = end;
4092 break;
4095 if (start < 1)
4096 start = 1;
4098 if (end > curbuf->b_ml.ml_line_count)
4099 end = curbuf->b_ml.ml_line_count;
4101 if (curs > curbuf->b_ml.ml_line_count)
4102 curs = curbuf->b_ml.ml_line_count;
4104 for (i = start; i <= end; i++)
4106 if (minus && i == lnum)
4108 msg_putchar('\n');
4110 for (j = 1; j < Columns; j++)
4111 msg_putchar('-');
4114 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4116 if (minus && i == lnum)
4118 msg_putchar('\n');
4120 for (j = 1; j < Columns; j++)
4121 msg_putchar('-');
4125 curwin->w_cursor.lnum = curs;
4126 ex_no_reprint = TRUE;
4130 * Check if the restricted flag is set.
4131 * If so, give an error message and return TRUE.
4132 * Otherwise, return FALSE.
4135 check_restricted()
4137 if (restricted)
4139 EMSG(_("E145: Shell commands not allowed in rvim"));
4140 return TRUE;
4142 return FALSE;
4146 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4147 * If so, give an error message and return TRUE.
4148 * Otherwise, return FALSE.
4151 check_secure()
4153 if (secure)
4155 secure = 2;
4156 EMSG(_(e_curdir));
4157 return TRUE;
4159 #ifdef HAVE_SANDBOX
4161 * In the sandbox more things are not allowed, including the things
4162 * disallowed in secure mode.
4164 if (sandbox != 0)
4166 EMSG(_(e_sandbox));
4167 return TRUE;
4169 #endif
4170 return FALSE;
4173 static char_u *old_sub = NULL; /* previous substitute pattern */
4174 static int global_need_beginline; /* call beginline() after ":g" */
4176 /* do_sub()
4178 * Perform a substitution from line eap->line1 to line eap->line2 using the
4179 * command pointed to by eap->arg which should be of the form:
4181 * /pattern/substitution/{flags}
4183 * The usual escapes are supported as described in the regexp docs.
4185 void
4186 do_sub(eap)
4187 exarg_T *eap;
4189 linenr_T lnum;
4190 long i = 0;
4191 regmmatch_T regmatch;
4192 static int do_all = FALSE; /* do multiple substitutions per line */
4193 static int do_ask = FALSE; /* ask for confirmation */
4194 static int do_count = FALSE; /* count only */
4195 static int do_error = TRUE; /* if false, ignore errors */
4196 static int do_print = FALSE; /* print last line with subs. */
4197 static int do_list = FALSE; /* list last line with subs. */
4198 static int do_number = FALSE; /* list last line with line nr*/
4199 static int do_ic = 0; /* ignore case flag */
4200 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4201 int delimiter;
4202 int sublen;
4203 int got_quit = FALSE;
4204 int got_match = FALSE;
4205 int temp;
4206 int which_pat;
4207 char_u *cmd;
4208 int save_State;
4209 linenr_T first_line = 0; /* first changed line */
4210 linenr_T last_line= 0; /* below last changed line AFTER the
4211 * change */
4212 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4213 linenr_T line2;
4214 long nmatch; /* number of lines in match */
4215 char_u *sub_firstline; /* allocated copy of first sub line */
4216 int endcolumn = FALSE; /* cursor in last column when done */
4217 pos_T old_cursor = curwin->w_cursor;
4219 cmd = eap->arg;
4220 if (!global_busy)
4222 sub_nsubs = 0;
4223 sub_nlines = 0;
4226 if (eap->cmdidx == CMD_tilde)
4227 which_pat = RE_LAST; /* use last used regexp */
4228 else
4229 which_pat = RE_SUBST; /* use last substitute regexp */
4231 /* new pattern and substitution */
4232 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4233 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4235 /* don't accept alphanumeric for separator */
4236 if (isalpha(*cmd))
4238 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4239 return;
4242 * undocumented vi feature:
4243 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4244 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4246 if (*cmd == '\\')
4248 ++cmd;
4249 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4251 EMSG(_(e_backslash));
4252 return;
4254 if (*cmd != '&')
4255 which_pat = RE_SEARCH; /* use last '/' pattern */
4256 pat = (char_u *)""; /* empty search pattern */
4257 delimiter = *cmd++; /* remember delimiter character */
4259 else /* find the end of the regexp */
4261 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4262 if (p_altkeymap && curwin->w_p_rl)
4263 lrF_sub(cmd);
4264 #endif
4265 which_pat = RE_LAST; /* use last used regexp */
4266 delimiter = *cmd++; /* remember delimiter character */
4267 pat = cmd; /* remember start of search pat */
4268 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4269 if (cmd[0] == delimiter) /* end delimiter found */
4270 *cmd++ = NUL; /* replace it with a NUL */
4274 * Small incompatibility: vi sees '\n' as end of the command, but in
4275 * Vim we want to use '\n' to find/substitute a NUL.
4277 sub = cmd; /* remember the start of the substitution */
4279 while (cmd[0])
4281 if (cmd[0] == delimiter) /* end delimiter found */
4283 *cmd++ = NUL; /* replace it with a NUL */
4284 break;
4286 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4287 ++cmd;
4288 mb_ptr_adv(cmd);
4291 if (!eap->skip)
4293 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4294 if (STRCMP(sub, "%") == 0
4295 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4297 if (old_sub == NULL) /* there is no previous command */
4299 EMSG(_(e_nopresub));
4300 return;
4302 sub = old_sub;
4304 else
4306 vim_free(old_sub);
4307 old_sub = vim_strsave(sub);
4311 else if (!eap->skip) /* use previous pattern and substitution */
4313 if (old_sub == NULL) /* there is no previous command */
4315 EMSG(_(e_nopresub));
4316 return;
4318 pat = NULL; /* search_regcomp() will use previous pattern */
4319 sub = old_sub;
4321 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4322 * last column after using "$". */
4323 endcolumn = (curwin->w_curswant == MAXCOL);
4327 * Find trailing options. When '&' is used, keep old options.
4329 if (*cmd == '&')
4330 ++cmd;
4331 else
4333 if (!p_ed)
4335 if (p_gd) /* default is global on */
4336 do_all = TRUE;
4337 else
4338 do_all = FALSE;
4339 do_ask = FALSE;
4341 do_error = TRUE;
4342 do_print = FALSE;
4343 do_count = FALSE;
4344 do_number = FALSE;
4345 do_ic = 0;
4347 while (*cmd)
4350 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4351 * 'r' is never inverted.
4353 if (*cmd == 'g')
4354 do_all = !do_all;
4355 else if (*cmd == 'c')
4356 do_ask = !do_ask;
4357 else if (*cmd == 'n')
4358 do_count = TRUE;
4359 else if (*cmd == 'e')
4360 do_error = !do_error;
4361 else if (*cmd == 'r') /* use last used regexp */
4362 which_pat = RE_LAST;
4363 else if (*cmd == 'p')
4364 do_print = TRUE;
4365 else if (*cmd == '#')
4367 do_print = TRUE;
4368 do_number = TRUE;
4370 else if (*cmd == 'l')
4372 do_print = TRUE;
4373 do_list = TRUE;
4375 else if (*cmd == 'i') /* ignore case */
4376 do_ic = 'i';
4377 else if (*cmd == 'I') /* don't ignore case */
4378 do_ic = 'I';
4379 else
4380 break;
4381 ++cmd;
4383 if (do_count)
4384 do_ask = FALSE;
4387 * check for a trailing count
4389 cmd = skipwhite(cmd);
4390 if (VIM_ISDIGIT(*cmd))
4392 i = getdigits(&cmd);
4393 if (i <= 0 && !eap->skip && do_error)
4395 EMSG(_(e_zerocount));
4396 return;
4398 eap->line1 = eap->line2;
4399 eap->line2 += i - 1;
4400 if (eap->line2 > curbuf->b_ml.ml_line_count)
4401 eap->line2 = curbuf->b_ml.ml_line_count;
4405 * check for trailing command or garbage
4407 cmd = skipwhite(cmd);
4408 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4410 eap->nextcmd = check_nextcmd(cmd);
4411 if (eap->nextcmd == NULL)
4413 EMSG(_(e_trailing));
4414 return;
4418 if (eap->skip) /* not executing commands, only parsing */
4419 return;
4421 if (!do_count && !curbuf->b_p_ma)
4423 /* Substitution is not allowed in non-'modifiable' buffer */
4424 EMSG(_(e_modifiable));
4425 return;
4428 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4430 if (do_error)
4431 EMSG(_(e_invcmd));
4432 return;
4435 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4436 if (do_ic == 'i')
4437 regmatch.rmm_ic = TRUE;
4438 else if (do_ic == 'I')
4439 regmatch.rmm_ic = FALSE;
4441 sub_firstline = NULL;
4444 * ~ in the substitute pattern is replaced with the old pattern.
4445 * We do it here once to avoid it to be replaced over and over again.
4446 * But don't do it when it starts with "\=", then it's an expression.
4448 if (!(sub[0] == '\\' && sub[1] == '='))
4449 sub = regtilde(sub, p_magic);
4452 * Check for a match on each line.
4454 line2 = eap->line2;
4455 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4456 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4457 || aborting()
4458 #endif
4459 ); ++lnum)
4461 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4462 (colnr_T)0, NULL);
4463 if (nmatch)
4465 colnr_T copycol;
4466 colnr_T matchcol;
4467 colnr_T prev_matchcol = MAXCOL;
4468 char_u *new_end, *new_start = NULL;
4469 unsigned new_start_len = 0;
4470 char_u *p1;
4471 int did_sub = FALSE;
4472 int lastone;
4473 unsigned len, needed_len;
4474 long nmatch_tl = 0; /* nr of lines matched below lnum */
4475 int do_again; /* do it again after joining lines */
4476 int skip_match = FALSE;
4477 linenr_T sub_firstlnum; /* nr of first sub line */
4480 * The new text is build up step by step, to avoid too much
4481 * copying. There are these pieces:
4482 * sub_firstline The old text, unmodified.
4483 * copycol Column in the old text where we started
4484 * looking for a match; from here old text still
4485 * needs to be copied to the new text.
4486 * matchcol Column number of the old text where to look
4487 * for the next match. It's just after the
4488 * previous match or one further.
4489 * prev_matchcol Column just after the previous match (if any).
4490 * Mostly equal to matchcol, except for the first
4491 * match and after skipping an empty match.
4492 * regmatch.*pos Where the pattern matched in the old text.
4493 * new_start The new text, all that has been produced so
4494 * far.
4495 * new_end The new text, where to append new text.
4497 * lnum The line number where we found the start of
4498 * the match. Can be below the line we searched
4499 * when there is a \n before a \zs in the
4500 * pattern.
4501 * sub_firstlnum The line number in the buffer where to look
4502 * for a match. Can be different from "lnum"
4503 * when the pattern or substitute string contains
4504 * line breaks.
4506 * Special situations:
4507 * - When the substitute string contains a line break, the part up
4508 * to the line break is inserted in the text, but the copy of
4509 * the original line is kept. "sub_firstlnum" is adjusted for
4510 * the inserted lines.
4511 * - When the matched pattern contains a line break, the old line
4512 * is taken from the line at the end of the pattern. The lines
4513 * in the match are deleted later, "sub_firstlnum" is adjusted
4514 * accordingly.
4516 * The new text is built up in new_start[]. It has some extra
4517 * room to avoid using alloc()/free() too often. new_start_len is
4518 * the length of the allocated memory at new_start.
4520 * Make a copy of the old line, so it won't be taken away when
4521 * updating the screen or handling a multi-line match. The "old_"
4522 * pointers point into this copy.
4524 sub_firstlnum = lnum;
4525 copycol = 0;
4526 matchcol = 0;
4528 /* At first match, remember current cursor position. */
4529 if (!got_match)
4531 setpcmark();
4532 got_match = TRUE;
4536 * Loop until nothing more to replace in this line.
4537 * 1. Handle match with empty string.
4538 * 2. If do_ask is set, ask for confirmation.
4539 * 3. substitute the string.
4540 * 4. if do_all is set, find next match
4541 * 5. break if there isn't another match in this line
4543 for (;;)
4545 /* Advance "lnum" to the line where the match starts. The
4546 * match does not start in the first line when there is a line
4547 * break before \zs. */
4548 if (regmatch.startpos[0].lnum > 0)
4550 lnum += regmatch.startpos[0].lnum;
4551 sub_firstlnum += regmatch.startpos[0].lnum;
4552 nmatch -= regmatch.startpos[0].lnum;
4553 vim_free(sub_firstline);
4554 sub_firstline = NULL;
4557 if (sub_firstline == NULL)
4559 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4560 if (sub_firstline == NULL)
4562 vim_free(new_start);
4563 goto outofmem;
4567 /* Save the line number of the last change for the final
4568 * cursor position (just like Vi). */
4569 curwin->w_cursor.lnum = lnum;
4570 do_again = FALSE;
4573 * 1. Match empty string does not count, except for first
4574 * match. This reproduces the strange vi behaviour.
4575 * This also catches endless loops.
4577 if (matchcol == prev_matchcol
4578 && regmatch.endpos[0].lnum == 0
4579 && matchcol == regmatch.endpos[0].col)
4581 if (sub_firstline[matchcol] == NUL)
4582 /* We already were at the end of the line. Don't look
4583 * for a match in this line again. */
4584 skip_match = TRUE;
4585 else
4586 ++matchcol; /* search for a match at next column */
4587 goto skip;
4590 /* Normally we continue searching for a match just after the
4591 * previous match. */
4592 matchcol = regmatch.endpos[0].col;
4593 prev_matchcol = matchcol;
4596 * 2. If do_count is set only increase the counter.
4597 * If do_ask is set, ask for confirmation.
4599 if (do_count)
4601 /* For a multi-line match, put matchcol at the NUL at
4602 * the end of the line and set nmatch to one, so that
4603 * we continue looking for a match on the next line.
4604 * Avoids that ":s/\nB\@=//gc" get stuck. */
4605 if (nmatch > 1)
4607 matchcol = (colnr_T)STRLEN(sub_firstline);
4608 nmatch = 1;
4609 skip_match = TRUE;
4611 sub_nsubs++;
4612 did_sub = TRUE;
4613 goto skip;
4616 if (do_ask)
4618 /* change State to CONFIRM, so that the mouse works
4619 * properly */
4620 save_State = State;
4621 State = CONFIRM;
4622 #ifdef FEAT_MOUSE
4623 setmouse(); /* disable mouse in xterm */
4624 #endif
4625 curwin->w_cursor.col = regmatch.startpos[0].col;
4627 /* When 'cpoptions' contains "u" don't sync undo when
4628 * asking for confirmation. */
4629 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4630 ++no_u_sync;
4633 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4635 while (do_ask)
4637 if (exmode_active)
4639 char_u *resp;
4640 colnr_T sc, ec;
4642 print_line_no_prefix(lnum, FALSE, FALSE);
4644 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4645 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4646 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4647 msg_start();
4648 for (i = 0; i < (long)sc; ++i)
4649 msg_putchar(' ');
4650 for ( ; i <= (long)ec; ++i)
4651 msg_putchar('^');
4653 resp = getexmodeline('?', NULL, 0);
4654 if (resp != NULL)
4656 i = *resp;
4657 vim_free(resp);
4660 else
4662 #ifdef FEAT_FOLDING
4663 int save_p_fen = curwin->w_p_fen;
4665 curwin->w_p_fen = FALSE;
4666 #endif
4667 /* Invert the matched string.
4668 * Remove the inversion afterwards. */
4669 temp = RedrawingDisabled;
4670 RedrawingDisabled = 0;
4672 search_match_lines = regmatch.endpos[0].lnum
4673 - regmatch.startpos[0].lnum;
4674 search_match_endcol = regmatch.endpos[0].col;
4675 highlight_match = TRUE;
4677 update_topline();
4678 validate_cursor();
4679 update_screen(SOME_VALID);
4680 highlight_match = FALSE;
4681 redraw_later(SOME_VALID);
4683 #ifdef FEAT_FOLDING
4684 curwin->w_p_fen = save_p_fen;
4685 #endif
4686 if (msg_row == Rows - 1)
4687 msg_didout = FALSE; /* avoid a scroll-up */
4688 msg_starthere();
4689 i = msg_scroll;
4690 msg_scroll = 0; /* truncate msg when
4691 needed */
4692 msg_no_more = TRUE;
4693 /* write message same highlighting as for
4694 * wait_return */
4695 smsg_attr(hl_attr(HLF_R),
4696 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4697 msg_no_more = FALSE;
4698 msg_scroll = i;
4699 showruler(TRUE);
4700 windgoto(msg_row, msg_col);
4701 RedrawingDisabled = temp;
4703 #ifdef USE_ON_FLY_SCROLL
4704 dont_scroll = FALSE; /* allow scrolling here */
4705 #endif
4706 ++no_mapping; /* don't map this key */
4707 ++allow_keys; /* allow special keys */
4708 i = plain_vgetc();
4709 --allow_keys;
4710 --no_mapping;
4712 /* clear the question */
4713 msg_didout = FALSE; /* don't scroll up */
4714 msg_col = 0;
4715 gotocmdline(TRUE);
4718 need_wait_return = FALSE; /* no hit-return prompt */
4719 if (i == 'q' || i == ESC || i == Ctrl_C
4720 #ifdef UNIX
4721 || i == intr_char
4722 #endif
4725 got_quit = TRUE;
4726 break;
4728 if (i == 'n')
4729 break;
4730 if (i == 'y')
4731 break;
4732 if (i == 'l')
4734 /* last: replace and then stop */
4735 do_all = FALSE;
4736 line2 = lnum;
4737 break;
4739 if (i == 'a')
4741 do_ask = FALSE;
4742 break;
4744 #ifdef FEAT_INS_EXPAND
4745 if (i == Ctrl_E)
4746 scrollup_clamp();
4747 else if (i == Ctrl_Y)
4748 scrolldown_clamp();
4749 #endif
4751 State = save_State;
4752 #ifdef FEAT_MOUSE
4753 setmouse();
4754 #endif
4755 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4756 --no_u_sync;
4758 if (i == 'n')
4760 /* For a multi-line match, put matchcol at the NUL at
4761 * the end of the line and set nmatch to one, so that
4762 * we continue looking for a match on the next line.
4763 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4764 * get stuck when pressing 'n'. */
4765 if (nmatch > 1)
4767 matchcol = (colnr_T)STRLEN(sub_firstline);
4768 skip_match = TRUE;
4770 goto skip;
4772 if (got_quit)
4773 break;
4776 /* Move the cursor to the start of the match, so that we can
4777 * use "\=col("."). */
4778 curwin->w_cursor.col = regmatch.startpos[0].col;
4781 * 3. substitute the string.
4783 /* get length of substitution part */
4784 sublen = vim_regsub_multi(&regmatch,
4785 sub_firstlnum - regmatch.startpos[0].lnum,
4786 sub, sub_firstline, FALSE, p_magic, TRUE);
4788 /* When the match included the "$" of the last line it may
4789 * go beyond the last line of the buffer. */
4790 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4792 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4793 skip_match = TRUE;
4796 /* Need room for:
4797 * - result so far in new_start (not for first sub in line)
4798 * - original text up to match
4799 * - length of substituted part
4800 * - original text after match
4802 if (nmatch == 1)
4803 p1 = sub_firstline;
4804 else
4806 p1 = ml_get(sub_firstlnum + nmatch - 1);
4807 nmatch_tl += nmatch - 1;
4809 i = regmatch.startpos[0].col - copycol;
4810 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4811 + sublen + 1;
4812 if (new_start == NULL)
4815 * Get some space for a temporary buffer to do the
4816 * substitution into (and some extra space to avoid
4817 * too many calls to alloc()/free()).
4819 new_start_len = needed_len + 50;
4820 if ((new_start = alloc_check(new_start_len)) == NULL)
4821 goto outofmem;
4822 *new_start = NUL;
4823 new_end = new_start;
4825 else
4828 * Check if the temporary buffer is long enough to do the
4829 * substitution into. If not, make it larger (with a bit
4830 * extra to avoid too many calls to alloc()/free()).
4832 len = (unsigned)STRLEN(new_start);
4833 needed_len += len;
4834 if (needed_len > new_start_len)
4836 new_start_len = needed_len + 50;
4837 if ((p1 = alloc_check(new_start_len)) == NULL)
4839 vim_free(new_start);
4840 goto outofmem;
4842 mch_memmove(p1, new_start, (size_t)(len + 1));
4843 vim_free(new_start);
4844 new_start = p1;
4846 new_end = new_start + len;
4850 * copy the text up to the part that matched
4852 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4853 new_end += i;
4855 (void)vim_regsub_multi(&regmatch,
4856 sub_firstlnum - regmatch.startpos[0].lnum,
4857 sub, new_end, TRUE, p_magic, TRUE);
4858 sub_nsubs++;
4859 did_sub = TRUE;
4861 /* Move the cursor to the start of the line, to avoid that it
4862 * is beyond the end of the line after the substitution. */
4863 curwin->w_cursor.col = 0;
4865 /* For a multi-line match, make a copy of the last matched
4866 * line and continue in that one. */
4867 if (nmatch > 1)
4869 sub_firstlnum += nmatch - 1;
4870 vim_free(sub_firstline);
4871 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4872 /* When going beyond the last line, stop substituting. */
4873 if (sub_firstlnum <= line2)
4874 do_again = TRUE;
4875 else
4876 do_all = FALSE;
4879 /* Remember next character to be copied. */
4880 copycol = regmatch.endpos[0].col;
4882 if (skip_match)
4884 /* Already hit end of the buffer, sub_firstlnum is one
4885 * less than what it ought to be. */
4886 vim_free(sub_firstline);
4887 sub_firstline = vim_strsave((char_u *)"");
4888 copycol = 0;
4892 * Now the trick is to replace CTRL-M chars with a real line
4893 * break. This would make it impossible to insert a CTRL-M in
4894 * the text. The line break can be avoided by preceding the
4895 * CTRL-M with a backslash. To be able to insert a backslash,
4896 * they must be doubled in the string and are halved here.
4897 * That is Vi compatible.
4899 for (p1 = new_end; *p1; ++p1)
4901 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4902 STRMOVE(p1, p1 + 1);
4903 else if (*p1 == CAR)
4905 if (u_inssub(lnum) == OK) /* prepare for undo */
4907 *p1 = NUL; /* truncate up to the CR */
4908 ml_append(lnum - 1, new_start,
4909 (colnr_T)(p1 - new_start + 1), FALSE);
4910 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4911 if (do_ask)
4912 appended_lines(lnum - 1, 1L);
4913 else
4915 if (first_line == 0)
4916 first_line = lnum;
4917 last_line = lnum + 1;
4919 /* All line numbers increase. */
4920 ++sub_firstlnum;
4921 ++lnum;
4922 ++line2;
4923 /* move the cursor to the new line, like Vi */
4924 ++curwin->w_cursor.lnum;
4925 /* copy the rest */
4926 STRMOVE(new_start, p1 + 1);
4927 p1 = new_start - 1;
4930 #ifdef FEAT_MBYTE
4931 else if (has_mbyte)
4932 p1 += (*mb_ptr2len)(p1) - 1;
4933 #endif
4937 * 4. If do_all is set, find next match.
4938 * Prevent endless loop with patterns that match empty
4939 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4940 * But ":s/\n/#/" is OK.
4942 skip:
4943 /* We already know that we did the last subst when we are at
4944 * the end of the line, except that a pattern like
4945 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4946 * "line2" when there is a \zs in the pattern after a line
4947 * break. */
4948 lastone = (skip_match
4949 || got_int
4950 || got_quit
4951 || lnum > line2
4952 || !(do_all || do_again)
4953 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4954 && !re_multiline(regmatch.regprog)));
4955 nmatch = -1;
4958 * Replace the line in the buffer when needed. This is
4959 * skipped when there are more matches.
4960 * The check for nmatch_tl is needed for when multi-line
4961 * matching must replace the lines before trying to do another
4962 * match, otherwise "\@<=" won't work.
4963 * When asking the user we like to show the already replaced
4964 * text, but don't do it when "\<@=" or "\<@!" is used, it
4965 * changes what matches.
4966 * When the match starts below where we start searching also
4967 * need to replace the line first (using \zs after \n).
4969 if (lastone
4970 || (do_ask && !re_lookbehind(regmatch.regprog))
4971 || nmatch_tl > 0
4972 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4973 curbuf, sub_firstlnum,
4974 matchcol, NULL)) == 0
4975 || regmatch.startpos[0].lnum > 0)
4977 if (new_start != NULL)
4980 * Copy the rest of the line, that didn't match.
4981 * "matchcol" has to be adjusted, we use the end of
4982 * the line as reference, because the substitute may
4983 * have changed the number of characters. Same for
4984 * "prev_matchcol".
4986 STRCAT(new_start, sub_firstline + copycol);
4987 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4988 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4989 - prev_matchcol;
4991 if (u_savesub(lnum) != OK)
4992 break;
4993 ml_replace(lnum, new_start, TRUE);
4995 if (nmatch_tl > 0)
4998 * Matched lines have now been substituted and are
4999 * useless, delete them. The part after the match
5000 * has been appended to new_start, we don't need
5001 * it in the buffer.
5003 ++lnum;
5004 if (u_savedel(lnum, nmatch_tl) != OK)
5005 break;
5006 for (i = 0; i < nmatch_tl; ++i)
5007 ml_delete(lnum, (int)FALSE);
5008 mark_adjust(lnum, lnum + nmatch_tl - 1,
5009 (long)MAXLNUM, -nmatch_tl);
5010 if (do_ask)
5011 deleted_lines(lnum, nmatch_tl);
5012 --lnum;
5013 line2 -= nmatch_tl; /* nr of lines decreases */
5014 nmatch_tl = 0;
5017 /* When asking, undo is saved each time, must also set
5018 * changed flag each time. */
5019 if (do_ask)
5020 changed_bytes(lnum, 0);
5021 else
5023 if (first_line == 0)
5024 first_line = lnum;
5025 last_line = lnum + 1;
5028 sub_firstlnum = lnum;
5029 vim_free(sub_firstline); /* free the temp buffer */
5030 sub_firstline = new_start;
5031 new_start = NULL;
5032 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5033 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5034 - prev_matchcol;
5035 copycol = 0;
5037 if (nmatch == -1 && !lastone)
5038 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
5039 sub_firstlnum, matchcol, NULL);
5042 * 5. break if there isn't another match in this line
5044 if (nmatch <= 0)
5046 /* If the match found didn't start where we were
5047 * searching, do the next search in the line where we
5048 * found the match. */
5049 if (nmatch == -1)
5050 lnum -= regmatch.startpos[0].lnum;
5051 break;
5055 line_breakcheck();
5058 if (did_sub)
5059 ++sub_nlines;
5060 vim_free(new_start); /* for when substitute was cancelled */
5061 vim_free(sub_firstline); /* free the copy of the original line */
5062 sub_firstline = NULL;
5065 line_breakcheck();
5068 if (first_line != 0)
5070 /* Need to subtract the number of added lines from "last_line" to get
5071 * the line number before the change (same as adding the number of
5072 * deleted lines). */
5073 i = curbuf->b_ml.ml_line_count - old_line_count;
5074 changed_lines(first_line, 0, last_line - i, i);
5077 outofmem:
5078 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5080 /* ":s/pat//n" doesn't move the cursor */
5081 if (do_count)
5082 curwin->w_cursor = old_cursor;
5084 if (sub_nsubs)
5086 /* Set the '[ and '] marks. */
5087 curbuf->b_op_start.lnum = eap->line1;
5088 curbuf->b_op_end.lnum = line2;
5089 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5091 if (!global_busy)
5093 if (endcolumn)
5094 coladvance((colnr_T)MAXCOL);
5095 else
5096 beginline(BL_WHITE | BL_FIX);
5097 if (!do_sub_msg(do_count) && do_ask)
5098 MSG("");
5100 else
5101 global_need_beginline = TRUE;
5102 if (do_print)
5103 print_line(curwin->w_cursor.lnum, do_number, do_list);
5105 else if (!global_busy)
5107 if (got_int) /* interrupted */
5108 EMSG(_(e_interr));
5109 else if (got_match) /* did find something but nothing substituted */
5110 MSG("");
5111 else if (do_error) /* nothing found */
5112 EMSG2(_(e_patnotf2), get_search_pat());
5115 vim_free(regmatch.regprog);
5119 * Give message for number of substitutions.
5120 * Can also be used after a ":global" command.
5121 * Return TRUE if a message was given.
5124 do_sub_msg(count_only)
5125 int count_only; /* used 'n' flag for ":s" */
5127 int len = 0;
5130 * Only report substitutions when:
5131 * - more than 'report' substitutions
5132 * - command was typed by user, or number of changed lines > 'report'
5133 * - giving messages is not disabled by 'lazyredraw'
5135 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5136 || count_only)
5137 && messaging())
5139 if (got_int)
5141 STRCPY(msg_buf, _("(Interrupted) "));
5142 len = (int)STRLEN(msg_buf);
5144 if (sub_nsubs == 1)
5145 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5146 "%s", count_only ? _("1 match") : _("1 substitution"));
5147 else
5148 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5149 count_only ? _("%ld matches") : _("%ld substitutions"),
5150 sub_nsubs);
5151 len = (int)STRLEN(msg_buf);
5152 if (sub_nlines == 1)
5153 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5154 "%s", _(" on 1 line"));
5155 else
5156 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5157 _(" on %ld lines"), (long)sub_nlines);
5158 if (msg(msg_buf))
5159 /* save message to display it after redraw */
5160 set_keep_msg(msg_buf, 0);
5161 return TRUE;
5163 if (got_int)
5165 EMSG(_(e_interr));
5166 return TRUE;
5168 return FALSE;
5172 * Execute a global command of the form:
5174 * g/pattern/X : execute X on all lines where pattern matches
5175 * v/pattern/X : execute X on all lines where pattern does not match
5177 * where 'X' is an EX command
5179 * The command character (as well as the trailing slash) is optional, and
5180 * is assumed to be 'p' if missing.
5182 * This is implemented in two passes: first we scan the file for the pattern and
5183 * set a mark for each line that (not) matches. secondly we execute the command
5184 * for each line that has a mark. This is required because after deleting
5185 * lines we do not know where to search for the next match.
5187 void
5188 ex_global(eap)
5189 exarg_T *eap;
5191 linenr_T lnum; /* line number according to old situation */
5192 int ndone = 0;
5193 int type; /* first char of cmd: 'v' or 'g' */
5194 char_u *cmd; /* command argument */
5196 char_u delim; /* delimiter, normally '/' */
5197 char_u *pat;
5198 regmmatch_T regmatch;
5199 int match;
5200 int which_pat;
5202 if (global_busy)
5204 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5205 return;
5208 if (eap->forceit) /* ":global!" is like ":vglobal" */
5209 type = 'v';
5210 else
5211 type = *eap->cmd;
5212 cmd = eap->arg;
5213 which_pat = RE_LAST; /* default: use last used regexp */
5214 sub_nsubs = 0;
5215 sub_nlines = 0;
5218 * undocumented vi feature:
5219 * "\/" and "\?": use previous search pattern.
5220 * "\&": use previous substitute pattern.
5222 if (*cmd == '\\')
5224 ++cmd;
5225 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5227 EMSG(_(e_backslash));
5228 return;
5230 if (*cmd == '&')
5231 which_pat = RE_SUBST; /* use previous substitute pattern */
5232 else
5233 which_pat = RE_SEARCH; /* use previous search pattern */
5234 ++cmd;
5235 pat = (char_u *)"";
5237 else if (*cmd == NUL)
5239 EMSG(_("E148: Regular expression missing from global"));
5240 return;
5242 else
5244 delim = *cmd; /* get the delimiter */
5245 if (delim)
5246 ++cmd; /* skip delimiter if there is one */
5247 pat = cmd; /* remember start of pattern */
5248 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5249 if (cmd[0] == delim) /* end delimiter found */
5250 *cmd++ = NUL; /* replace it with a NUL */
5253 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5254 if (p_altkeymap && curwin->w_p_rl)
5255 lrFswap(pat,0);
5256 #endif
5258 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5260 EMSG(_(e_invcmd));
5261 return;
5265 * pass 1: set marks for each (not) matching line
5267 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5269 /* a match on this line? */
5270 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5271 (colnr_T)0, NULL);
5272 if ((type == 'g' && match) || (type == 'v' && !match))
5274 ml_setmarked(lnum);
5275 ndone++;
5277 line_breakcheck();
5281 * pass 2: execute the command for each line that has been marked
5283 if (got_int)
5284 MSG(_(e_interr));
5285 else if (ndone == 0)
5287 if (type == 'v')
5288 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5289 else
5290 smsg((char_u *)_(e_patnotf2), pat);
5292 else
5293 global_exe(cmd);
5295 ml_clearmarked(); /* clear rest of the marks */
5296 vim_free(regmatch.regprog);
5300 * Execute "cmd" on lines marked with ml_setmarked().
5302 void
5303 global_exe(cmd)
5304 char_u *cmd;
5306 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5307 linenr_T lnum; /* line number according to old situation */
5310 * Set current position only once for a global command.
5311 * If global_busy is set, setpcmark() will not do anything.
5312 * If there is an error, global_busy will be incremented.
5314 setpcmark();
5316 /* When the command writes a message, don't overwrite the command. */
5317 msg_didout = TRUE;
5319 global_need_beginline = FALSE;
5320 global_busy = 1;
5321 old_lcount = curbuf->b_ml.ml_line_count;
5322 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5324 curwin->w_cursor.lnum = lnum;
5325 curwin->w_cursor.col = 0;
5326 if (*cmd == NUL || *cmd == '\n')
5327 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5328 else
5329 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5330 ui_breakcheck();
5333 global_busy = 0;
5334 if (global_need_beginline)
5335 beginline(BL_WHITE | BL_FIX);
5336 else
5337 check_cursor(); /* cursor may be beyond the end of the line */
5339 /* the cursor may not have moved in the text but a change in a previous
5340 * line may move it on the screen */
5341 changed_line_abv_curs();
5343 /* If it looks like no message was written, allow overwriting the
5344 * command with the report for number of changes. */
5345 if (msg_col == 0 && msg_scrolled == 0)
5346 msg_didout = FALSE;
5348 /* If substitutes done, report number of substitutes, otherwise report
5349 * number of extra or deleted lines. */
5350 if (!do_sub_msg(FALSE))
5351 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5354 #ifdef FEAT_VIMINFO
5356 read_viminfo_sub_string(virp, force)
5357 vir_T *virp;
5358 int force;
5360 if (old_sub != NULL && force)
5361 vim_free(old_sub);
5362 if (force || old_sub == NULL)
5363 old_sub = viminfo_readstring(virp, 1, TRUE);
5364 return viminfo_readline(virp);
5367 void
5368 write_viminfo_sub_string(fp)
5369 FILE *fp;
5371 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5373 fprintf(fp, _("\n# Last Substitute String:\n$"));
5374 viminfo_writestring(fp, old_sub);
5377 #endif /* FEAT_VIMINFO */
5379 #if defined(EXITFREE) || defined(PROTO)
5380 void
5381 free_old_sub()
5383 vim_free(old_sub);
5385 #endif
5387 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5389 * Set up for a tagpreview.
5390 * Return TRUE when it was created.
5393 prepare_tagpreview(undo_sync)
5394 int undo_sync; /* sync undo when leaving the window */
5396 win_T *wp;
5398 # ifdef FEAT_GUI
5399 need_mouse_correct = TRUE;
5400 # endif
5403 * If there is already a preview window open, use that one.
5405 if (!curwin->w_p_pvw)
5407 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5408 if (wp->w_p_pvw)
5409 break;
5410 if (wp != NULL)
5411 win_enter(wp, undo_sync);
5412 else
5415 * There is no preview window open yet. Create one.
5417 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5418 == FAIL)
5419 return FALSE;
5420 curwin->w_p_pvw = TRUE;
5421 curwin->w_p_wfh = TRUE;
5422 # ifdef FEAT_SCROLLBIND
5423 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5424 # endif
5425 # ifdef FEAT_DIFF
5426 curwin->w_p_diff = FALSE; /* no 'diff' */
5427 # endif
5428 # ifdef FEAT_FOLDING
5429 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5430 # endif
5431 return TRUE;
5434 return FALSE;
5437 #endif
5441 * ":help": open a read-only window on a help file
5443 void
5444 ex_help(eap)
5445 exarg_T *eap;
5447 char_u *arg;
5448 char_u *tag;
5449 FILE *helpfd; /* file descriptor of help file */
5450 int n;
5451 int i;
5452 #ifdef FEAT_WINDOWS
5453 win_T *wp;
5454 #endif
5455 int num_matches;
5456 char_u **matches;
5457 char_u *p;
5458 int empty_fnum = 0;
5459 int alt_fnum = 0;
5460 buf_T *buf;
5461 #ifdef FEAT_MULTI_LANG
5462 int len;
5463 char_u *lang;
5464 #endif
5466 if (eap != NULL)
5469 * A ":help" command ends at the first LF, or at a '|' that is
5470 * followed by some text. Set nextcmd to the following command.
5472 for (arg = eap->arg; *arg; ++arg)
5474 if (*arg == '\n' || *arg == '\r'
5475 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5477 *arg++ = NUL;
5478 eap->nextcmd = arg;
5479 break;
5482 arg = eap->arg;
5484 if (eap->forceit && *arg == NUL)
5486 EMSG(_("E478: Don't panic!"));
5487 return;
5490 if (eap->skip) /* not executing commands */
5491 return;
5493 else
5494 arg = (char_u *)"";
5496 /* remove trailing blanks */
5497 p = arg + STRLEN(arg) - 1;
5498 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5499 *p-- = NUL;
5501 #ifdef FEAT_MULTI_LANG
5502 /* Check for a specified language */
5503 lang = check_help_lang(arg);
5504 #endif
5506 /* When no argument given go to the index. */
5507 if (*arg == NUL)
5508 arg = (char_u *)"help.txt";
5511 * Check if there is a match for the argument.
5513 n = find_help_tags(arg, &num_matches, &matches,
5514 eap != NULL && eap->forceit);
5516 i = 0;
5517 #ifdef FEAT_MULTI_LANG
5518 if (n != FAIL && lang != NULL)
5519 /* Find first item with the requested language. */
5520 for (i = 0; i < num_matches; ++i)
5522 len = (int)STRLEN(matches[i]);
5523 if (len > 3 && matches[i][len - 3] == '@'
5524 && STRICMP(matches[i] + len - 2, lang) == 0)
5525 break;
5527 #endif
5528 if (i >= num_matches || n == FAIL)
5530 #ifdef FEAT_MULTI_LANG
5531 if (lang != NULL)
5532 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5533 else
5534 #endif
5535 EMSG2(_("E149: Sorry, no help for %s"), arg);
5536 if (n != FAIL)
5537 FreeWild(num_matches, matches);
5538 return;
5541 /* The first match (in the requested language) is the best match. */
5542 tag = vim_strsave(matches[i]);
5543 FreeWild(num_matches, matches);
5545 #ifdef FEAT_GUI
5546 need_mouse_correct = TRUE;
5547 #endif
5550 * Re-use an existing help window or open a new one.
5551 * Always open a new one for ":tab help".
5553 if (!curwin->w_buffer->b_help
5554 #ifdef FEAT_WINDOWS
5555 || cmdmod.tab != 0
5556 #endif
5559 #ifdef FEAT_WINDOWS
5560 if (cmdmod.tab != 0)
5561 wp = NULL;
5562 else
5563 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5564 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5565 break;
5566 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5567 win_enter(wp, TRUE);
5568 else
5569 #endif
5572 * There is no help window yet.
5573 * Try to open the file specified by the "helpfile" option.
5575 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5577 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5578 goto erret;
5580 fclose(helpfd);
5582 #ifdef FEAT_WINDOWS
5583 /* Split off help window; put it at far top if no position
5584 * specified, the current window is vertically split and
5585 * narrow. */
5586 n = WSP_HELP;
5587 # ifdef FEAT_VERTSPLIT
5588 if (cmdmod.split == 0 && curwin->w_width != Columns
5589 && curwin->w_width < 80)
5590 n |= WSP_TOP;
5591 # endif
5592 if (win_split(0, n) == FAIL)
5593 goto erret;
5594 #else
5595 /* use current window */
5596 if (!can_abandon(curbuf, FALSE))
5597 goto erret;
5598 #endif
5600 #ifdef FEAT_WINDOWS
5601 if (curwin->w_height < p_hh)
5602 win_setheight((int)p_hh);
5603 #endif
5606 * Open help file (do_ecmd() will set b_help flag, readfile() will
5607 * set b_p_ro flag).
5608 * Set the alternate file to the previously edited file.
5610 alt_fnum = curbuf->b_fnum;
5611 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5612 ECMD_HIDE + ECMD_SET_HELP);
5613 if (!cmdmod.keepalt)
5614 curwin->w_alt_fnum = alt_fnum;
5615 empty_fnum = curbuf->b_fnum;
5619 if (!p_im)
5620 restart_edit = 0; /* don't want insert mode in help file */
5622 if (tag != NULL)
5623 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5625 /* Delete the empty buffer if we're not using it. Careful: autocommands
5626 * may have jumped to another window, check that the buffer is not in a
5627 * window. */
5628 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5630 buf = buflist_findnr(empty_fnum);
5631 if (buf != NULL && buf->b_nwindows == 0)
5632 wipe_buffer(buf, TRUE);
5635 /* keep the previous alternate file */
5636 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5637 curwin->w_alt_fnum = alt_fnum;
5639 erret:
5640 vim_free(tag);
5644 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5646 * In an argument search for a language specifiers in the form "@xx".
5647 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5648 * Returns NULL if not found.
5650 char_u *
5651 check_help_lang(arg)
5652 char_u *arg;
5654 int len = (int)STRLEN(arg);
5656 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5657 && ASCII_ISALPHA(arg[len - 1]))
5659 arg[len - 3] = NUL; /* remove the '@' */
5660 return arg + len - 2;
5662 return NULL;
5664 #endif
5667 * Return a heuristic indicating how well the given string matches. The
5668 * smaller the number, the better the match. This is the order of priorities,
5669 * from best match to worst match:
5670 * - Match with least alpha-numeric characters is better.
5671 * - Match with least total characters is better.
5672 * - Match towards the start is better.
5673 * - Match starting with "+" is worse (feature instead of command)
5674 * Assumption is made that the matched_string passed has already been found to
5675 * match some string for which help is requested. webb.
5678 help_heuristic(matched_string, offset, wrong_case)
5679 char_u *matched_string;
5680 int offset; /* offset for match */
5681 int wrong_case; /* no matching case */
5683 int num_letters;
5684 char_u *p;
5686 num_letters = 0;
5687 for (p = matched_string; *p; p++)
5688 if (ASCII_ISALNUM(*p))
5689 num_letters++;
5692 * Multiply the number of letters by 100 to give it a much bigger
5693 * weighting than the number of characters.
5694 * If there only is a match while ignoring case, add 5000.
5695 * If the match starts in the middle of a word, add 10000 to put it
5696 * somewhere in the last half.
5697 * If the match is more than 2 chars from the start, multiply by 200 to
5698 * put it after matches at the start.
5700 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5701 && ASCII_ISALNUM(matched_string[offset - 1]))
5702 offset += 10000;
5703 else if (offset > 2)
5704 offset *= 200;
5705 if (wrong_case)
5706 offset += 5000;
5707 /* Features are less interesting than the subjects themselves, but "+"
5708 * alone is not a feature. */
5709 if (matched_string[0] == '+' && matched_string[1] != NUL)
5710 offset += 100;
5711 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5715 * Compare functions for qsort() below, that checks the help heuristics number
5716 * that has been put after the tagname by find_tags().
5718 static int
5719 #ifdef __BORLANDC__
5720 _RTLENTRYF
5721 #endif
5722 help_compare(s1, s2)
5723 const void *s1;
5724 const void *s2;
5726 char *p1;
5727 char *p2;
5729 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5730 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5731 return strcmp(p1, p2);
5735 * Find all help tags matching "arg", sort them and return in matches[], with
5736 * the number of matches in num_matches.
5737 * The matches will be sorted with a "best" match algorithm.
5738 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5741 find_help_tags(arg, num_matches, matches, keep_lang)
5742 char_u *arg;
5743 int *num_matches;
5744 char_u ***matches;
5745 int keep_lang;
5747 char_u *s, *d;
5748 int i;
5749 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5750 "/*", "/\\*", "\"*", "**",
5751 "/\\(\\)",
5752 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5753 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5754 "[count]", "[quotex]", "[range]",
5755 "[pattern]", "\\|", "\\%$"};
5756 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5757 "/star", "/\\\\star", "quotestar", "starstar",
5758 "/\\\\(\\\\)",
5759 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5760 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5761 "\\[count]", "\\[quotex]", "\\[range]",
5762 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5763 int flags;
5765 d = IObuff; /* assume IObuff is long enough! */
5768 * Recognize a few exceptions to the rule. Some strings that contain '*'
5769 * with "star". Otherwise '*' is recognized as a wildcard.
5771 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5772 if (STRCMP(arg, mtable[i]) == 0)
5774 STRCPY(d, rtable[i]);
5775 break;
5778 if (i < 0) /* no match in table */
5780 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5781 * Also replace "\%^" and "\%(", they match every tag too.
5782 * Also "\zs", "\z1", etc.
5783 * Also "\@<", "\@=", "\@<=", etc.
5784 * And also "\_$" and "\_^". */
5785 if (arg[0] == '\\'
5786 && ((arg[1] != NUL && arg[2] == NUL)
5787 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5788 && arg[2] != NUL)))
5790 STRCPY(d, "/\\\\");
5791 STRCPY(d + 3, arg + 1);
5792 /* Check for "/\\_$", should be "/\\_\$" */
5793 if (d[3] == '_' && d[4] == '$')
5794 STRCPY(d + 4, "\\$");
5796 else
5798 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5799 if (arg[0] == '[' && (arg[1] == ':'
5800 || (arg[1] == '+' && arg[2] == '+')))
5801 *d++ = '\\';
5803 for (s = arg; *s; ++s)
5806 * Replace "|" with "bar" and '"' with "quote" to match the name of
5807 * the tags for these commands.
5808 * Replace "*" with ".*" and "?" with "." to match command line
5809 * completion.
5810 * Insert a backslash before '~', '$' and '.' to avoid their
5811 * special meaning.
5813 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5814 break;
5815 switch (*s)
5817 case '|': STRCPY(d, "bar");
5818 d += 3;
5819 continue;
5820 case '"': STRCPY(d, "quote");
5821 d += 5;
5822 continue;
5823 case '*': *d++ = '.';
5824 break;
5825 case '?': *d++ = '.';
5826 continue;
5827 case '$':
5828 case '.':
5829 case '~': *d++ = '\\';
5830 break;
5834 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5835 * ":help i_^_CTRL-D" work.
5836 * Insert '-' before and after "CTRL-X" when applicable.
5838 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5839 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5841 if (d > IObuff && d[-1] != '_')
5842 *d++ = '_'; /* prepend a '_' */
5843 STRCPY(d, "CTRL-");
5844 d += 5;
5845 if (*s < ' ')
5847 #ifdef EBCDIC
5848 *d++ = CtrlChar(*s);
5849 #else
5850 *d++ = *s + '@';
5851 #endif
5852 if (d[-1] == '\\')
5853 *d++ = '\\'; /* double a backslash */
5855 else
5856 *d++ = *++s;
5857 if (s[1] != NUL && s[1] != '_')
5858 *d++ = '_'; /* append a '_' */
5859 continue;
5861 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5862 *d++ = '\\';
5865 * Insert a backslash before a backslash after a slash, for search
5866 * pattern tags: "/\|" --> "/\\|".
5868 else if (s[0] == '\\' && s[1] != '\\'
5869 && *arg == '/' && s == arg + 1)
5870 *d++ = '\\';
5872 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5873 * "CTRL-\_CTRL-N" */
5874 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5876 STRCPY(d, "CTRL-\\\\");
5877 d += 7;
5878 s += 6;
5881 *d++ = *s;
5884 * If tag starts with ', toss everything after a second '. Fixes
5885 * CTRL-] on 'option'. (would include the trailing '.').
5887 if (*s == '\'' && s > arg && *arg == '\'')
5888 break;
5890 *d = NUL;
5894 *matches = (char_u **)"";
5895 *num_matches = 0;
5896 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5897 if (keep_lang)
5898 flags |= TAG_KEEP_LANG;
5899 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5900 && *num_matches > 0)
5902 /* Sort the matches found on the heuristic number that is after the
5903 * tag name. */
5904 qsort((void *)*matches, (size_t)*num_matches,
5905 sizeof(char_u *), help_compare);
5906 /* Delete more than TAG_MANY to reduce the size of the listing. */
5907 while (*num_matches > TAG_MANY)
5908 vim_free((*matches)[--*num_matches]);
5910 return OK;
5914 * After reading a help file: May cleanup a help buffer when syntax
5915 * highlighting is not used.
5917 void
5918 fix_help_buffer()
5920 linenr_T lnum;
5921 char_u *line;
5922 int in_example = FALSE;
5923 int len;
5924 char_u *p;
5925 char_u *rt;
5926 int mustfree;
5928 /* set filetype to "help". */
5929 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5931 #ifdef FEAT_SYN_HL
5932 if (!syntax_present(curbuf))
5933 #endif
5935 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5937 line = ml_get_buf(curbuf, lnum, FALSE);
5938 len = (int)STRLEN(line);
5939 if (in_example && len > 0 && !vim_iswhite(line[0]))
5941 /* End of example: non-white or '<' in first column. */
5942 if (line[0] == '<')
5944 /* blank-out a '<' in the first column */
5945 line = ml_get_buf(curbuf, lnum, TRUE);
5946 line[0] = ' ';
5948 in_example = FALSE;
5950 if (!in_example && len > 0)
5952 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5954 /* blank-out a '>' in the last column (start of example) */
5955 line = ml_get_buf(curbuf, lnum, TRUE);
5956 line[len - 1] = ' ';
5957 in_example = TRUE;
5959 else if (line[len - 1] == '~')
5961 /* blank-out a '~' at the end of line (header marker) */
5962 line = ml_get_buf(curbuf, lnum, TRUE);
5963 line[len - 1] = ' ';
5970 * In the "help.txt" file, add the locally added help files.
5971 * This uses the very first line in the help file.
5973 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5975 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5977 line = ml_get_buf(curbuf, lnum, FALSE);
5978 if (strstr((char *)line, "*local-additions*") != NULL)
5980 /* Go through all directories in 'runtimepath', skipping
5981 * $VIMRUNTIME. */
5982 p = p_rtp;
5983 while (*p != NUL)
5985 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5986 mustfree = FALSE;
5987 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5988 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5990 int fcount;
5991 char_u **fnames;
5992 FILE *fd;
5993 char_u *s;
5994 int fi;
5995 #ifdef FEAT_MBYTE
5996 vimconv_T vc;
5997 char_u *cp;
5998 #endif
6000 /* Find all "doc/ *.txt" files in this directory. */
6001 add_pathsep(NameBuff);
6002 STRCAT(NameBuff, "doc/*.txt");
6003 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6004 &fnames, EW_FILE|EW_SILENT) == OK
6005 && fcount > 0)
6007 for (fi = 0; fi < fcount; ++fi)
6009 fd = mch_fopen((char *)fnames[fi], "r");
6010 if (fd != NULL)
6012 vim_fgets(IObuff, IOSIZE, fd);
6013 if (IObuff[0] == '*'
6014 && (s = vim_strchr(IObuff + 1, '*'))
6015 != NULL)
6017 #ifdef FEAT_MBYTE
6018 int this_utf = MAYBE;
6019 #endif
6020 /* Change tag definition to a
6021 * reference and remove <CR>/<NL>. */
6022 IObuff[0] = '|';
6023 *s = '|';
6024 while (*s != NUL)
6026 if (*s == '\r' || *s == '\n')
6027 *s = NUL;
6028 #ifdef FEAT_MBYTE
6029 /* The text is utf-8 when a byte
6030 * above 127 is found and no
6031 * illegal byte sequence is found.
6033 if (*s >= 0x80 && this_utf != FALSE)
6035 int l;
6037 this_utf = TRUE;
6038 l = utf_ptr2len(s);
6039 if (l == 1)
6040 this_utf = FALSE;
6041 s += l - 1;
6043 #endif
6044 ++s;
6046 #ifdef FEAT_MBYTE
6047 /* The help file is latin1 or utf-8;
6048 * conversion to the current
6049 * 'encoding' may be required. */
6050 vc.vc_type = CONV_NONE;
6051 convert_setup(&vc, (char_u *)(
6052 this_utf == TRUE ? "utf-8"
6053 : "latin1"), p_enc);
6054 if (vc.vc_type == CONV_NONE)
6055 /* No conversion needed. */
6056 cp = IObuff;
6057 else
6059 /* Do the conversion. If it fails
6060 * use the unconverted text. */
6061 cp = string_convert(&vc, IObuff,
6062 NULL);
6063 if (cp == NULL)
6064 cp = IObuff;
6066 convert_setup(&vc, NULL, NULL);
6068 ml_append(lnum, cp, (colnr_T)0, FALSE);
6069 if (cp != IObuff)
6070 vim_free(cp);
6071 #else
6072 ml_append(lnum, IObuff, (colnr_T)0,
6073 FALSE);
6074 #endif
6075 ++lnum;
6077 fclose(fd);
6080 FreeWild(fcount, fnames);
6083 if (mustfree)
6084 vim_free(rt);
6086 break;
6093 * ":exusage"
6095 /*ARGSUSED*/
6096 void
6097 ex_exusage(eap)
6098 exarg_T *eap;
6100 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6104 * ":viusage"
6106 /*ARGSUSED*/
6107 void
6108 ex_viusage(eap)
6109 exarg_T *eap;
6111 do_cmdline_cmd((char_u *)"help normal-index");
6114 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6115 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
6118 * ":helptags"
6120 void
6121 ex_helptags(eap)
6122 exarg_T *eap;
6124 garray_T ga;
6125 int i, j;
6126 int len;
6127 #ifdef FEAT_MULTI_LANG
6128 char_u lang[2];
6129 #endif
6130 expand_T xpc;
6131 char_u *dirname;
6132 char_u ext[5];
6133 char_u fname[8];
6134 int filecount;
6135 char_u **files;
6136 int add_help_tags = FALSE;
6138 /* Check for ":helptags ++t {dir}". */
6139 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6141 add_help_tags = TRUE;
6142 eap->arg = skipwhite(eap->arg + 3);
6145 ExpandInit(&xpc);
6146 xpc.xp_context = EXPAND_DIRECTORIES;
6147 dirname = ExpandOne(&xpc, eap->arg, NULL,
6148 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6149 if (dirname == NULL || !mch_isdir(dirname))
6151 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6152 return;
6155 #ifdef FEAT_MULTI_LANG
6156 /* Get a list of all files in the directory. */
6157 STRCPY(NameBuff, dirname);
6158 add_pathsep(NameBuff);
6159 STRCAT(NameBuff, "*");
6160 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6161 EW_FILE|EW_SILENT) == FAIL
6162 || filecount == 0)
6164 EMSG2("E151: No match: %s", NameBuff);
6165 vim_free(dirname);
6166 return;
6169 /* Go over all files in the directory to find out what languages are
6170 * present. */
6171 ga_init2(&ga, 1, 10);
6172 for (i = 0; i < filecount; ++i)
6174 len = (int)STRLEN(files[i]);
6175 if (len > 4)
6177 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6179 /* ".txt" -> language "en" */
6180 lang[0] = 'e';
6181 lang[1] = 'n';
6183 else if (files[i][len - 4] == '.'
6184 && ASCII_ISALPHA(files[i][len - 3])
6185 && ASCII_ISALPHA(files[i][len - 2])
6186 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6188 /* ".abx" -> language "ab" */
6189 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6190 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6192 else
6193 continue;
6195 /* Did we find this language already? */
6196 for (j = 0; j < ga.ga_len; j += 2)
6197 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6198 break;
6199 if (j == ga.ga_len)
6201 /* New language, add it. */
6202 if (ga_grow(&ga, 2) == FAIL)
6203 break;
6204 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6205 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6211 * Loop over the found languages to generate a tags file for each one.
6213 for (j = 0; j < ga.ga_len; j += 2)
6215 STRCPY(fname, "tags-xx");
6216 fname[5] = ((char_u *)ga.ga_data)[j];
6217 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6218 if (fname[5] == 'e' && fname[6] == 'n')
6220 /* English is an exception: use ".txt" and "tags". */
6221 fname[4] = NUL;
6222 STRCPY(ext, ".txt");
6224 else
6226 /* Language "ab" uses ".abx" and "tags-ab". */
6227 STRCPY(ext, ".xxx");
6228 ext[1] = fname[5];
6229 ext[2] = fname[6];
6231 helptags_one(dirname, ext, fname, add_help_tags);
6234 ga_clear(&ga);
6235 FreeWild(filecount, files);
6237 #else
6238 /* No language support, just use "*.txt" and "tags". */
6239 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6240 #endif
6241 vim_free(dirname);
6244 static void
6245 helptags_one(dir, ext, tagfname, add_help_tags)
6246 char_u *dir; /* doc directory */
6247 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6248 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6249 int add_help_tags; /* add "help-tags" tag */
6251 FILE *fd_tags;
6252 FILE *fd;
6253 garray_T ga;
6254 int filecount;
6255 char_u **files;
6256 char_u *p1, *p2;
6257 int fi;
6258 char_u *s;
6259 int i;
6260 char_u *fname;
6261 # ifdef FEAT_MBYTE
6262 int utf8 = MAYBE;
6263 int this_utf8;
6264 int firstline;
6265 int mix = FALSE; /* detected mixed encodings */
6266 # endif
6269 * Find all *.txt files.
6271 STRCPY(NameBuff, dir);
6272 add_pathsep(NameBuff);
6273 STRCAT(NameBuff, "*");
6274 STRCAT(NameBuff, ext);
6275 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6276 EW_FILE|EW_SILENT) == FAIL
6277 || filecount == 0)
6279 if (!got_int)
6280 EMSG2("E151: No match: %s", NameBuff);
6281 return;
6285 * Open the tags file for writing.
6286 * Do this before scanning through all the files.
6288 STRCPY(NameBuff, dir);
6289 add_pathsep(NameBuff);
6290 STRCAT(NameBuff, tagfname);
6291 fd_tags = mch_fopen((char *)NameBuff, "w");
6292 if (fd_tags == NULL)
6294 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6295 FreeWild(filecount, files);
6296 return;
6300 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6301 * add the "help-tags" tag.
6303 ga_init2(&ga, (int)sizeof(char_u *), 100);
6304 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6305 dir, FALSE) == FPC_SAME)
6307 if (ga_grow(&ga, 1) == FAIL)
6308 got_int = TRUE;
6309 else
6311 s = alloc(18 + (unsigned)STRLEN(tagfname));
6312 if (s == NULL)
6313 got_int = TRUE;
6314 else
6316 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6317 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6318 ++ga.ga_len;
6324 * Go over all the files and extract the tags.
6326 for (fi = 0; fi < filecount && !got_int; ++fi)
6328 fd = mch_fopen((char *)files[fi], "r");
6329 if (fd == NULL)
6331 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6332 continue;
6334 fname = gettail(files[fi]);
6336 # ifdef FEAT_MBYTE
6337 firstline = TRUE;
6338 # endif
6339 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6341 # ifdef FEAT_MBYTE
6342 if (firstline)
6344 /* Detect utf-8 file by a non-ASCII char in the first line. */
6345 this_utf8 = MAYBE;
6346 for (s = IObuff; *s != NUL; ++s)
6347 if (*s >= 0x80)
6349 int l;
6351 this_utf8 = TRUE;
6352 l = utf_ptr2len(s);
6353 if (l == 1)
6355 /* Illegal UTF-8 byte sequence. */
6356 this_utf8 = FALSE;
6357 break;
6359 s += l - 1;
6361 if (this_utf8 == MAYBE) /* only ASCII characters found */
6362 this_utf8 = FALSE;
6363 if (utf8 == MAYBE) /* first file */
6364 utf8 = this_utf8;
6365 else if (utf8 != this_utf8)
6367 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6368 mix = !got_int;
6369 got_int = TRUE;
6371 firstline = FALSE;
6373 # endif
6374 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6375 while (p1 != NULL)
6377 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6378 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6380 for (s = p1 + 1; s < p2; ++s)
6381 if (*s == ' ' || *s == '\t' || *s == '|')
6382 break;
6385 * Only accept a *tag* when it consists of valid
6386 * characters, there is white space before it and is
6387 * followed by a white character or end-of-line.
6389 if (s == p2
6390 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6391 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6392 || s[1] == '\0'))
6394 *p2 = '\0';
6395 ++p1;
6396 if (ga_grow(&ga, 1) == FAIL)
6398 got_int = TRUE;
6399 break;
6401 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6402 if (s == NULL)
6404 got_int = TRUE;
6405 break;
6407 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6408 ++ga.ga_len;
6409 sprintf((char *)s, "%s\t%s", p1, fname);
6411 /* find next '*' */
6412 p2 = vim_strchr(p2 + 1, '*');
6415 p1 = p2;
6417 line_breakcheck();
6420 fclose(fd);
6423 FreeWild(filecount, files);
6425 if (!got_int)
6428 * Sort the tags.
6430 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6433 * Check for duplicates.
6435 for (i = 1; i < ga.ga_len; ++i)
6437 p1 = ((char_u **)ga.ga_data)[i - 1];
6438 p2 = ((char_u **)ga.ga_data)[i];
6439 while (*p1 == *p2)
6441 if (*p2 == '\t')
6443 *p2 = NUL;
6444 vim_snprintf((char *)NameBuff, MAXPATHL,
6445 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6446 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6447 EMSG(NameBuff);
6448 *p2 = '\t';
6449 break;
6451 ++p1;
6452 ++p2;
6456 # ifdef FEAT_MBYTE
6457 if (utf8 == TRUE)
6458 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6459 # endif
6462 * Write the tags into the file.
6464 for (i = 0; i < ga.ga_len; ++i)
6466 s = ((char_u **)ga.ga_data)[i];
6467 if (STRNCMP(s, "help-tags\t", 10) == 0)
6468 /* help-tags entry was added in formatted form */
6469 fputs((char *)s, fd_tags);
6470 else
6472 fprintf(fd_tags, "%s\t/*", s);
6473 for (p1 = s; *p1 != '\t'; ++p1)
6475 /* insert backslash before '\\' and '/' */
6476 if (*p1 == '\\' || *p1 == '/')
6477 putc('\\', fd_tags);
6478 putc(*p1, fd_tags);
6480 fprintf(fd_tags, "*\n");
6484 #ifdef FEAT_MBYTE
6485 if (mix)
6486 got_int = FALSE; /* continue with other languages */
6487 #endif
6489 for (i = 0; i < ga.ga_len; ++i)
6490 vim_free(((char_u **)ga.ga_data)[i]);
6491 ga_clear(&ga);
6492 fclose(fd_tags); /* there is no check for an error... */
6494 #endif
6496 #if defined(FEAT_SIGNS) || defined(PROTO)
6499 * Struct to hold the sign properties.
6501 typedef struct sign sign_T;
6503 struct sign
6505 sign_T *sn_next; /* next sign in list */
6506 int sn_typenr; /* type number of sign (negative if not equal
6507 to name) */
6508 char_u *sn_name; /* name of sign */
6509 char_u *sn_icon; /* name of pixmap */
6510 #ifdef FEAT_SIGN_ICONS
6511 void *sn_image; /* icon image */
6512 #endif
6513 char_u *sn_text; /* text used instead of pixmap */
6514 int sn_line_hl; /* highlight ID for line */
6515 int sn_text_hl; /* highlight ID for text */
6518 static sign_T *first_sign = NULL;
6519 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6521 static void sign_list_defined __ARGS((sign_T *sp));
6524 * ":sign" command
6526 void
6527 ex_sign(eap)
6528 exarg_T *eap;
6530 char_u *arg = eap->arg;
6531 char_u *p;
6532 int idx;
6533 sign_T *sp;
6534 sign_T *sp_prev;
6535 buf_T *buf;
6536 static char *cmds[] = {
6537 "define",
6538 #define SIGNCMD_DEFINE 0
6539 "undefine",
6540 #define SIGNCMD_UNDEFINE 1
6541 "list",
6542 #define SIGNCMD_LIST 2
6543 "place",
6544 #define SIGNCMD_PLACE 3
6545 "unplace",
6546 #define SIGNCMD_UNPLACE 4
6547 "jump",
6548 #define SIGNCMD_JUMP 5
6549 #define SIGNCMD_LAST 6
6552 /* Parse the subcommand. */
6553 p = skiptowhite(arg);
6554 if (*p != NUL)
6555 *p++ = NUL;
6556 for (idx = 0; ; ++idx)
6558 if (idx == SIGNCMD_LAST)
6560 EMSG2(_("E160: Unknown sign command: %s"), arg);
6561 return;
6563 if (STRCMP(arg, cmds[idx]) == 0)
6564 break;
6566 arg = skipwhite(p);
6568 if (idx <= SIGNCMD_LIST)
6571 * Define, undefine or list signs.
6573 if (idx == SIGNCMD_LIST && *arg == NUL)
6575 /* ":sign list": list all defined signs */
6576 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6577 sign_list_defined(sp);
6579 else if (*arg == NUL)
6580 EMSG(_("E156: Missing sign name"));
6581 else
6583 p = skiptowhite(arg);
6584 if (*p != NUL)
6585 *p++ = NUL;
6586 sp_prev = NULL;
6587 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6589 if (STRCMP(sp->sn_name, arg) == 0)
6590 break;
6591 sp_prev = sp;
6593 if (idx == SIGNCMD_DEFINE)
6595 /* ":sign define {name} ...": define a sign */
6596 if (sp == NULL)
6598 /* Allocate a new sign. */
6599 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6600 if (sp == NULL)
6601 return;
6602 if (sp_prev == NULL)
6603 first_sign = sp;
6604 else
6605 sp_prev->sn_next = sp;
6606 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6608 /* If the name is a number use that for the typenr,
6609 * otherwise use a negative number. */
6610 if (VIM_ISDIGIT(*arg))
6611 sp->sn_typenr = atoi((char *)arg);
6612 else
6614 sign_T *lp;
6615 int start = last_sign_typenr;
6617 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6619 if (lp->sn_typenr == last_sign_typenr)
6621 --last_sign_typenr;
6622 if (last_sign_typenr == 0)
6623 last_sign_typenr = MAX_TYPENR;
6624 if (last_sign_typenr == start)
6626 EMSG(_("E612: Too many signs defined"));
6627 return;
6629 lp = first_sign;
6630 continue;
6634 sp->sn_typenr = last_sign_typenr--;
6635 if (last_sign_typenr == 0)
6636 last_sign_typenr = MAX_TYPENR; /* wrap around */
6640 /* set values for a defined sign. */
6641 for (;;)
6643 arg = skipwhite(p);
6644 if (*arg == NUL)
6645 break;
6646 p = skiptowhite_esc(arg);
6647 if (STRNCMP(arg, "icon=", 5) == 0)
6649 arg += 5;
6650 vim_free(sp->sn_icon);
6651 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6652 backslash_halve(sp->sn_icon);
6653 #ifdef FEAT_SIGN_ICONS
6654 if (gui.in_use)
6656 out_flush();
6657 if (sp->sn_image != NULL)
6658 gui_mch_destroy_sign(sp->sn_image);
6659 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6661 #endif
6663 else if (STRNCMP(arg, "text=", 5) == 0)
6665 char_u *s;
6666 int cells;
6667 int len;
6669 arg += 5;
6670 #ifdef FEAT_MBYTE
6671 /* Count cells and check for non-printable chars */
6672 if (has_mbyte)
6674 cells = 0;
6675 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6677 if (!vim_isprintc((*mb_ptr2char)(s)))
6678 break;
6679 cells += (*mb_ptr2cells)(s);
6682 else
6683 #endif
6685 for (s = arg; s < p; ++s)
6686 if (!vim_isprintc(*s))
6687 break;
6688 cells = (int)(s - arg);
6690 /* Currently must be one or two display cells */
6691 if (s != p || cells < 1 || cells > 2)
6693 *p = NUL;
6694 EMSG2(_("E239: Invalid sign text: %s"), arg);
6695 return;
6698 vim_free(sp->sn_text);
6699 /* Allocate one byte more if we need to pad up
6700 * with a space. */
6701 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6702 sp->sn_text = vim_strnsave(arg, len);
6704 if (sp->sn_text != NULL && cells == 1)
6705 STRCPY(sp->sn_text + len - 1, " ");
6707 else if (STRNCMP(arg, "linehl=", 7) == 0)
6709 arg += 7;
6710 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6712 else if (STRNCMP(arg, "texthl=", 7) == 0)
6714 arg += 7;
6715 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6717 else
6719 EMSG2(_(e_invarg2), arg);
6720 return;
6724 else if (sp == NULL)
6725 EMSG2(_("E155: Unknown sign: %s"), arg);
6726 else if (idx == SIGNCMD_LIST)
6727 /* ":sign list {name}" */
6728 sign_list_defined(sp);
6729 else
6731 /* ":sign undefine {name}" */
6732 vim_free(sp->sn_name);
6733 vim_free(sp->sn_icon);
6734 #ifdef FEAT_SIGN_ICONS
6735 if (sp->sn_image != NULL)
6737 out_flush();
6738 gui_mch_destroy_sign(sp->sn_image);
6740 #endif
6741 vim_free(sp->sn_text);
6742 if (sp_prev == NULL)
6743 first_sign = sp->sn_next;
6744 else
6745 sp_prev->sn_next = sp->sn_next;
6746 vim_free(sp);
6750 else
6752 int id = -1;
6753 linenr_T lnum = -1;
6754 char_u *sign_name = NULL;
6755 char_u *arg1;
6757 if (*arg == NUL)
6759 if (idx == SIGNCMD_PLACE)
6761 /* ":sign place": list placed signs in all buffers */
6762 sign_list_placed(NULL);
6764 else if (idx == SIGNCMD_UNPLACE)
6766 /* ":sign unplace": remove placed sign at cursor */
6767 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6768 if (id > 0)
6770 buf_delsign(curwin->w_buffer, id);
6771 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6773 else
6774 EMSG(_("E159: Missing sign number"));
6776 else
6777 EMSG(_(e_argreq));
6778 return;
6781 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6783 /* ":sign unplace *": remove all placed signs */
6784 buf_delete_all_signs();
6785 return;
6788 /* first arg could be placed sign id */
6789 arg1 = arg;
6790 if (VIM_ISDIGIT(*arg))
6792 id = getdigits(&arg);
6793 if (!vim_iswhite(*arg) && *arg != NUL)
6795 id = -1;
6796 arg = arg1;
6798 else
6800 arg = skipwhite(arg);
6801 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6803 /* ":sign unplace {id}": remove placed sign by number */
6804 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6805 if ((lnum = buf_delsign(buf, id)) != 0)
6806 update_debug_sign(buf, lnum);
6807 return;
6813 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6814 * Leave "arg" pointing to {fname}.
6816 for (;;)
6818 if (STRNCMP(arg, "line=", 5) == 0)
6820 arg += 5;
6821 lnum = atoi((char *)arg);
6822 arg = skiptowhite(arg);
6824 else if (STRNCMP(arg, "name=", 5) == 0)
6826 arg += 5;
6827 sign_name = arg;
6828 arg = skiptowhite(arg);
6829 if (*arg != NUL)
6830 *arg++ = NUL;
6832 else if (STRNCMP(arg, "file=", 5) == 0)
6834 arg += 5;
6835 buf = buflist_findname(arg);
6836 break;
6838 else if (STRNCMP(arg, "buffer=", 7) == 0)
6840 arg += 7;
6841 buf = buflist_findnr((int)getdigits(&arg));
6842 if (*skipwhite(arg) != NUL)
6843 EMSG(_(e_trailing));
6844 break;
6846 else
6848 EMSG(_(e_invarg));
6849 return;
6851 arg = skipwhite(arg);
6854 if (buf == NULL)
6856 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6858 else if (id <= 0)
6860 if (lnum >= 0 || sign_name != NULL)
6861 EMSG(_(e_invarg));
6862 else
6863 /* ":sign place file={fname}": list placed signs in one file */
6864 sign_list_placed(buf);
6866 else if (idx == SIGNCMD_JUMP)
6868 /* ":sign jump {id} file={fname}" */
6869 if (lnum >= 0 || sign_name != NULL)
6870 EMSG(_(e_invarg));
6871 else if ((lnum = buf_findsign(buf, id)) > 0)
6872 { /* goto a sign ... */
6873 if (buf_jump_open_win(buf) != NULL)
6874 { /* ... in a current window */
6875 curwin->w_cursor.lnum = lnum;
6876 check_cursor_lnum();
6877 beginline(BL_WHITE);
6879 else
6880 { /* ... not currently in a window */
6881 char_u *cmd;
6883 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6884 if (cmd == NULL)
6885 return;
6886 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6887 do_cmdline_cmd(cmd);
6888 vim_free(cmd);
6890 #ifdef FEAT_FOLDING
6891 foldOpenCursor();
6892 #endif
6894 else
6895 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6897 else if (idx == SIGNCMD_UNPLACE)
6899 /* ":sign unplace {id} file={fname}" */
6900 if (lnum >= 0 || sign_name != NULL)
6901 EMSG(_(e_invarg));
6902 else
6904 lnum = buf_delsign(buf, id);
6905 update_debug_sign(buf, lnum);
6908 /* idx == SIGNCMD_PLACE */
6909 else if (sign_name != NULL)
6911 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6912 if (STRCMP(sp->sn_name, sign_name) == 0)
6913 break;
6914 if (sp == NULL)
6916 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6917 return;
6919 if (lnum > 0)
6920 /* ":sign place {id} line={lnum} name={name} file={fname}":
6921 * place a sign */
6922 buf_addsign(buf, id, lnum, sp->sn_typenr);
6923 else
6924 /* ":sign place {id} file={fname}": change sign type */
6925 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6926 update_debug_sign(buf, lnum);
6928 else
6929 EMSG(_(e_invarg));
6933 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6935 * Allocate the icons. Called when the GUI has started. Allows defining
6936 * signs before it starts.
6938 void
6939 sign_gui_started()
6941 sign_T *sp;
6943 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6944 if (sp->sn_icon != NULL)
6945 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6947 #endif
6950 * List one sign.
6952 static void
6953 sign_list_defined(sp)
6954 sign_T *sp;
6956 char_u *p;
6958 smsg((char_u *)"sign %s", sp->sn_name);
6959 if (sp->sn_icon != NULL)
6961 MSG_PUTS(" icon=");
6962 msg_outtrans(sp->sn_icon);
6963 #ifdef FEAT_SIGN_ICONS
6964 if (sp->sn_image == NULL)
6965 MSG_PUTS(_(" (NOT FOUND)"));
6966 #else
6967 MSG_PUTS(_(" (not supported)"));
6968 #endif
6970 if (sp->sn_text != NULL)
6972 MSG_PUTS(" text=");
6973 msg_outtrans(sp->sn_text);
6975 if (sp->sn_line_hl > 0)
6977 MSG_PUTS(" linehl=");
6978 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6979 if (p == NULL)
6980 MSG_PUTS("NONE");
6981 else
6982 msg_puts(p);
6984 if (sp->sn_text_hl > 0)
6986 MSG_PUTS(" texthl=");
6987 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6988 if (p == NULL)
6989 MSG_PUTS("NONE");
6990 else
6991 msg_puts(p);
6996 * Get highlighting attribute for sign "typenr".
6997 * If "line" is TRUE: line highl, if FALSE: text highl.
7000 sign_get_attr(typenr, line)
7001 int typenr;
7002 int line;
7004 sign_T *sp;
7006 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7007 if (sp->sn_typenr == typenr)
7009 if (line)
7011 if (sp->sn_line_hl > 0)
7012 return syn_id2attr(sp->sn_line_hl);
7014 else
7016 if (sp->sn_text_hl > 0)
7017 return syn_id2attr(sp->sn_text_hl);
7019 break;
7021 return 0;
7025 * Get text mark for sign "typenr".
7026 * Returns NULL if there isn't one.
7028 char_u *
7029 sign_get_text(typenr)
7030 int typenr;
7032 sign_T *sp;
7034 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7035 if (sp->sn_typenr == typenr)
7036 return sp->sn_text;
7037 return NULL;
7040 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7041 void *
7042 sign_get_image(typenr)
7043 int typenr; /* the attribute which may have a sign */
7045 sign_T *sp;
7047 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7048 if (sp->sn_typenr == typenr)
7049 return sp->sn_image;
7050 return NULL;
7052 #endif
7055 * Get the name of a sign by its typenr.
7057 char_u *
7058 sign_typenr2name(typenr)
7059 int typenr;
7061 sign_T *sp;
7063 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7064 if (sp->sn_typenr == typenr)
7065 return sp->sn_name;
7066 return (char_u *)_("[Deleted]");
7069 #endif
7071 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7073 * ":drop"
7074 * Opens the first argument in a window. When there are two or more arguments
7075 * the argument list is redefined.
7077 void
7078 ex_drop(eap)
7079 exarg_T *eap;
7081 int split = FALSE;
7082 win_T *wp;
7083 buf_T *buf;
7084 # ifdef FEAT_WINDOWS
7085 tabpage_T *tp;
7086 # endif
7089 * Check if the first argument is already being edited in a window. If
7090 * so, jump to that window.
7091 * We would actually need to check all arguments, but that's complicated
7092 * and mostly only one file is dropped.
7093 * This also ignores wildcards, since it is very unlikely the user is
7094 * editing a file name with a wildcard character.
7096 set_arglist(eap->arg);
7099 * Expanding wildcards may result in an empty argument list. E.g. when
7100 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7101 * already did an error message for this.
7103 if (ARGCOUNT == 0)
7104 return;
7106 # ifdef FEAT_WINDOWS
7107 if (cmdmod.tab)
7109 /* ":tab drop file ...": open a tab for each argument that isn't
7110 * edited in a window yet. It's like ":tab all" but without closing
7111 * windows or tabs. */
7112 ex_all(eap);
7114 else
7115 # endif
7117 /* ":drop file ...": Edit the first argument. Jump to an existing
7118 * window if possible, edit in current window if the current buffer
7119 * can be abandoned, otherwise open a new window. */
7120 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7122 FOR_ALL_TAB_WINDOWS(tp, wp)
7124 if (wp->w_buffer == buf)
7126 # ifdef FEAT_WINDOWS
7127 goto_tabpage_win(tp, wp);
7128 # endif
7129 curwin->w_arg_idx = 0;
7130 return;
7135 * Check whether the current buffer is changed. If so, we will need
7136 * to split the current window or data could be lost.
7137 * Skip the check if the 'hidden' option is set, as in this case the
7138 * buffer won't be lost.
7140 if (!P_HID(curbuf))
7142 # ifdef FEAT_WINDOWS
7143 ++emsg_off;
7144 # endif
7145 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7146 # ifdef FEAT_WINDOWS
7147 --emsg_off;
7148 # else
7149 if (split)
7150 return;
7151 # endif
7154 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7155 if (split)
7157 eap->cmdidx = CMD_sfirst;
7158 eap->cmd[0] = 's';
7160 else
7161 eap->cmdidx = CMD_first;
7162 ex_rewind(eap);
7165 #endif