Merged from the latest developing branch.
[MacVim.git] / src / ex_cmds.c
blobc9174b2b506950076d7a470ab0a46234745023e3
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 int cval;
53 char buf1[20];
54 char buf2[20];
55 char_u buf3[7];
56 #ifdef FEAT_MBYTE
57 int cc[MAX_MCO];
58 int ci = 0;
59 int len;
61 if (enc_utf8)
62 c = utfc_ptr2char(ml_get_cursor(), cc);
63 else
64 #endif
65 c = gchar_cursor();
66 if (c == NUL)
68 MSG("NUL");
69 return;
72 #ifdef FEAT_MBYTE
73 IObuff[0] = NUL;
74 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
75 #endif
77 if (c == NL) /* NUL is stored as NL */
78 c = NUL;
79 if (c == CAR && get_fileformat(curbuf) == EOL_MAC)
80 cval = NL; /* NL is stored as CR */
81 else
82 cval = c;
83 if (vim_isprintc_strict(c) && (c < ' '
84 #ifndef EBCDIC
85 || c > '~'
86 #endif
89 transchar_nonprint(buf3, c);
90 vim_snprintf(buf1, sizeof(buf1), " <%s>", (char *)buf3);
92 else
93 buf1[0] = NUL;
94 #ifndef EBCDIC
95 if (c >= 0x80)
96 vim_snprintf(buf2, sizeof(buf2), " <M-%s>",
97 (char *)transchar(c & 0x7f));
98 else
99 #endif
100 buf2[0] = NUL;
101 vim_snprintf((char *)IObuff, IOSIZE,
102 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
103 transchar(c), buf1, buf2, cval, cval, cval);
104 #ifdef FEAT_MBYTE
105 if (enc_utf8)
106 c = cc[ci++];
107 else
108 c = 0;
109 #endif
112 #ifdef FEAT_MBYTE
113 /* Repeat for combining characters. */
114 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
116 len = (int)STRLEN(IObuff);
117 /* This assumes every multi-byte char is printable... */
118 if (len > 0)
119 IObuff[len++] = ' ';
120 IObuff[len++] = '<';
121 if (enc_utf8 && utf_iscomposing(c)
122 # ifdef USE_GUI
123 && !gui.in_use
124 # endif
126 IObuff[len++] = ' '; /* draw composing char on top of a space */
127 len += (*mb_char2bytes)(c, IObuff + len);
128 vim_snprintf((char *)IObuff + len, IOSIZE - len,
129 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
130 : _("> %d, Hex %08x, Octal %o"), c, c, c);
131 if (ci == MAX_MCO)
132 break;
133 if (enc_utf8)
134 c = cc[ci++];
135 else
136 c = 0;
138 #endif
140 msg(IObuff);
143 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
145 * ":left", ":center" and ":right": align text.
147 void
148 ex_align(eap)
149 exarg_T *eap;
151 pos_T save_curpos;
152 int len;
153 int indent = 0;
154 int new_indent;
155 int has_tab;
156 int width;
158 #ifdef FEAT_RIGHTLEFT
159 if (curwin->w_p_rl)
161 /* switch left and right aligning */
162 if (eap->cmdidx == CMD_right)
163 eap->cmdidx = CMD_left;
164 else if (eap->cmdidx == CMD_left)
165 eap->cmdidx = CMD_right;
167 #endif
169 width = atoi((char *)eap->arg);
170 save_curpos = curwin->w_cursor;
171 if (eap->cmdidx == CMD_left) /* width is used for new indent */
173 if (width >= 0)
174 indent = width;
176 else
179 * if 'textwidth' set, use it
180 * else if 'wrapmargin' set, use it
181 * if invalid value, use 80
183 if (width <= 0)
184 width = curbuf->b_p_tw;
185 if (width == 0 && curbuf->b_p_wm > 0)
186 width = W_WIDTH(curwin) - curbuf->b_p_wm;
187 if (width <= 0)
188 width = 80;
191 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
192 return;
194 for (curwin->w_cursor.lnum = eap->line1;
195 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
197 if (eap->cmdidx == CMD_left) /* left align */
198 new_indent = indent;
199 else
201 has_tab = FALSE; /* avoid uninit warnings */
202 len = linelen(eap->cmdidx == CMD_right ? &has_tab
203 : NULL) - get_indent();
205 if (len <= 0) /* skip blank lines */
206 continue;
208 if (eap->cmdidx == CMD_center)
209 new_indent = (width - len) / 2;
210 else
212 new_indent = width - len; /* right align */
215 * Make sure that embedded TABs don't make the text go too far
216 * to the right.
218 if (has_tab)
219 while (new_indent > 0)
221 (void)set_indent(new_indent, 0);
222 if (linelen(NULL) <= width)
225 * Now try to move the line as much as possible to
226 * the right. Stop when it moves too far.
229 (void)set_indent(++new_indent, 0);
230 while (linelen(NULL) <= width);
231 --new_indent;
232 break;
234 --new_indent;
238 if (new_indent < 0)
239 new_indent = 0;
240 (void)set_indent(new_indent, 0); /* set indent */
242 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
243 curwin->w_cursor = save_curpos;
244 beginline(BL_WHITE | BL_FIX);
248 * Get the length of the current line, excluding trailing white space.
250 static int
251 linelen(has_tab)
252 int *has_tab;
254 char_u *line;
255 char_u *first;
256 char_u *last;
257 int save;
258 int len;
260 /* find the first non-blank character */
261 line = ml_get_curline();
262 first = skipwhite(line);
264 /* find the character after the last non-blank character */
265 for (last = first + STRLEN(first);
266 last > first && vim_iswhite(last[-1]); --last)
268 save = *last;
269 *last = NUL;
270 len = linetabsize(line); /* get line length */
271 if (has_tab != NULL) /* check for embedded TAB */
272 *has_tab = (vim_strrchr(first, TAB) != NULL);
273 *last = save;
275 return len;
278 /* Buffer for two lines used during sorting. They are allocated to
279 * contain the longest line being sorted. */
280 static char_u *sortbuf1;
281 static char_u *sortbuf2;
283 static int sort_ic; /* ignore case */
284 static int sort_nr; /* sort on number */
285 static int sort_rx; /* sort on regex instead of skipping it */
287 static int sort_abort; /* flag to indicate if sorting has been interrupted */
289 /* Struct to store info to be sorted. */
290 typedef struct
292 linenr_T lnum; /* line number */
293 long start_col_nr; /* starting column number or number */
294 long end_col_nr; /* ending column number */
295 } sorti_T;
297 static int
298 #ifdef __BORLANDC__
299 _RTLENTRYF
300 #endif
301 sort_compare __ARGS((const void *s1, const void *s2));
303 static int
304 #ifdef __BORLANDC__
305 _RTLENTRYF
306 #endif
307 sort_compare(s1, s2)
308 const void *s1;
309 const void *s2;
311 sorti_T l1 = *(sorti_T *)s1;
312 sorti_T l2 = *(sorti_T *)s2;
313 int result = 0;
315 /* If the user interrupts, there's no way to stop qsort() immediately, but
316 * if we return 0 every time, qsort will assume it's done sorting and
317 * exit. */
318 if (sort_abort)
319 return 0;
320 fast_breakcheck();
321 if (got_int)
322 sort_abort = TRUE;
324 /* When sorting numbers "start_col_nr" is the number, not the column
325 * number. */
326 if (sort_nr)
327 result = l1.start_col_nr - l2.start_col_nr;
328 else
330 /* We need to copy one line into "sortbuf1", because there is no
331 * guarantee that the first pointer becomes invalid when obtaining the
332 * second one. */
333 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
334 l1.end_col_nr - l1.start_col_nr + 1);
335 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
336 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
337 l2.end_col_nr - l2.start_col_nr + 1);
338 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
340 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
341 : STRCMP(sortbuf1, sortbuf2);
344 /* If two lines have the same value, preserve the original line order. */
345 if (result == 0)
346 return (int)(l1.lnum - l2.lnum);
347 return result;
351 * ":sort".
353 void
354 ex_sort(eap)
355 exarg_T *eap;
357 regmatch_T regmatch;
358 int len;
359 linenr_T lnum;
360 long maxlen = 0;
361 sorti_T *nrs;
362 size_t count = (size_t)(eap->line2 - eap->line1 + 1);
363 size_t i;
364 char_u *p;
365 char_u *s;
366 char_u *s2;
367 char_u c; /* temporary character storage */
368 int unique = FALSE;
369 long deleted;
370 colnr_T start_col;
371 colnr_T end_col;
372 int sort_oct; /* sort on octal number */
373 int sort_hex; /* sort on hex number */
375 /* Sorting one line is really quick! */
376 if (count <= 1)
377 return;
379 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
380 return;
381 sortbuf1 = NULL;
382 sortbuf2 = NULL;
383 regmatch.regprog = NULL;
384 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
385 if (nrs == NULL)
386 goto sortend;
388 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
390 for (p = eap->arg; *p != NUL; ++p)
392 if (vim_iswhite(*p))
394 else if (*p == 'i')
395 sort_ic = TRUE;
396 else if (*p == 'r')
397 sort_rx = TRUE;
398 else if (*p == 'n')
399 sort_nr = 2;
400 else if (*p == 'o')
401 sort_oct = 2;
402 else if (*p == 'x')
403 sort_hex = 2;
404 else if (*p == 'u')
405 unique = TRUE;
406 else if (*p == '"') /* comment start */
407 break;
408 else if (check_nextcmd(p) != NULL)
410 eap->nextcmd = check_nextcmd(p);
411 break;
413 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
415 s = skip_regexp(p + 1, *p, TRUE, NULL);
416 if (*s != *p)
418 EMSG(_(e_invalpat));
419 goto sortend;
421 *s = NUL;
422 /* Use last search pattern if sort pattern is empty. */
423 if (s == p + 1 && last_search_pat() != NULL)
424 regmatch.regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
425 else
426 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
427 if (regmatch.regprog == NULL)
428 goto sortend;
429 p = s; /* continue after the regexp */
430 regmatch.rm_ic = p_ic;
432 else
434 EMSG2(_(e_invarg2), p);
435 goto sortend;
439 /* Can only have one of 'n', 'o' and 'x'. */
440 if (sort_nr + sort_oct + sort_hex > 2)
442 EMSG(_(e_invarg));
443 goto sortend;
446 /* From here on "sort_nr" is used as a flag for any number sorting. */
447 sort_nr += sort_oct + sort_hex;
450 * Make an array with all line numbers. This avoids having to copy all
451 * the lines into allocated memory.
452 * When sorting on strings "start_col_nr" is the offset in the line, for
453 * numbers sorting it's the number to sort on. This means the pattern
454 * matching and number conversion only has to be done once per line.
455 * Also get the longest line length for allocating "sortbuf".
457 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
459 s = ml_get(lnum);
460 len = (int)STRLEN(s);
461 if (maxlen < len)
462 maxlen = len;
464 start_col = 0;
465 end_col = len;
466 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
468 if (sort_rx)
470 start_col = (colnr_T)(regmatch.startp[0] - s);
471 end_col = (colnr_T)(regmatch.endp[0] - s);
473 else
474 start_col = (colnr_T)(regmatch.endp[0] - s);
476 else
477 if (regmatch.regprog != NULL)
478 end_col = 0;
480 if (sort_nr)
482 /* Make sure vim_str2nr doesn't read any digits past the end
483 * of the match, by temporarily terminating the string there */
484 s2 = s + end_col;
485 c = *s2;
486 (*s2) = 0;
487 /* Sorting on number: Store the number itself. */
488 p = s + start_col;
489 if (sort_hex)
490 s = skiptohex(p);
491 else
492 s = skiptodigit(p);
493 if (s > p && s[-1] == '-')
494 --s; /* include preceding negative sign */
495 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
496 &nrs[lnum - eap->line1].start_col_nr, NULL);
497 (*s2) = c;
499 else
501 /* Store the column to sort at. */
502 nrs[lnum - eap->line1].start_col_nr = start_col;
503 nrs[lnum - eap->line1].end_col_nr = end_col;
506 nrs[lnum - eap->line1].lnum = lnum;
508 if (regmatch.regprog != NULL)
509 fast_breakcheck();
510 if (got_int)
511 goto sortend;
514 /* Allocate a buffer that can hold the longest line. */
515 sortbuf1 = alloc((unsigned)maxlen + 1);
516 if (sortbuf1 == NULL)
517 goto sortend;
518 sortbuf2 = alloc((unsigned)maxlen + 1);
519 if (sortbuf2 == NULL)
520 goto sortend;
522 /* Sort the array of line numbers. Note: can't be interrupted! */
523 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
525 if (sort_abort)
526 goto sortend;
528 /* Insert the lines in the sorted order below the last one. */
529 lnum = eap->line2;
530 for (i = 0; i < count; ++i)
532 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
533 if (!unique || i == 0
534 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
536 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
537 break;
538 if (unique)
539 STRCPY(sortbuf1, s);
541 fast_breakcheck();
542 if (got_int)
543 goto sortend;
546 /* delete the original lines if appending worked */
547 if (i == count)
548 for (i = 0; i < count; ++i)
549 ml_delete(eap->line1, FALSE);
550 else
551 count = 0;
553 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
554 deleted = (long)(count - (lnum - eap->line2));
555 if (deleted > 0)
556 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
557 else if (deleted < 0)
558 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
559 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
561 curwin->w_cursor.lnum = eap->line1;
562 beginline(BL_WHITE | BL_FIX);
564 sortend:
565 vim_free(nrs);
566 vim_free(sortbuf1);
567 vim_free(sortbuf2);
568 vim_free(regmatch.regprog);
569 if (got_int)
570 EMSG(_(e_interr));
574 * ":retab".
576 void
577 ex_retab(eap)
578 exarg_T *eap;
580 linenr_T lnum;
581 int got_tab = FALSE;
582 long num_spaces = 0;
583 long num_tabs;
584 long len;
585 long col;
586 long vcol;
587 long start_col = 0; /* For start of white-space string */
588 long start_vcol = 0; /* For start of white-space string */
589 int temp;
590 long old_len;
591 char_u *ptr;
592 char_u *new_line = (char_u *)1; /* init to non-NULL */
593 int did_undo; /* called u_save for current line */
594 int new_ts;
595 int save_list;
596 linenr_T first_line = 0; /* first changed line */
597 linenr_T last_line = 0; /* last changed line */
599 save_list = curwin->w_p_list;
600 curwin->w_p_list = 0; /* don't want list mode here */
602 new_ts = getdigits(&(eap->arg));
603 if (new_ts < 0)
605 EMSG(_(e_positive));
606 return;
608 if (new_ts == 0)
609 new_ts = curbuf->b_p_ts;
610 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
612 ptr = ml_get(lnum);
613 col = 0;
614 vcol = 0;
615 did_undo = FALSE;
616 for (;;)
618 if (vim_iswhite(ptr[col]))
620 if (!got_tab && num_spaces == 0)
622 /* First consecutive white-space */
623 start_vcol = vcol;
624 start_col = col;
626 if (ptr[col] == ' ')
627 num_spaces++;
628 else
629 got_tab = TRUE;
631 else
633 if (got_tab || (eap->forceit && num_spaces > 1))
635 /* Retabulate this string of white-space */
637 /* len is virtual length of white string */
638 len = num_spaces = vcol - start_vcol;
639 num_tabs = 0;
640 if (!curbuf->b_p_et)
642 temp = new_ts - (start_vcol % new_ts);
643 if (num_spaces >= temp)
645 num_spaces -= temp;
646 num_tabs++;
648 num_tabs += num_spaces / new_ts;
649 num_spaces -= (num_spaces / new_ts) * new_ts;
651 if (curbuf->b_p_et || got_tab ||
652 (num_spaces + num_tabs < len))
654 if (did_undo == FALSE)
656 did_undo = TRUE;
657 if (u_save((linenr_T)(lnum - 1),
658 (linenr_T)(lnum + 1)) == FAIL)
660 new_line = NULL; /* flag out-of-memory */
661 break;
665 /* len is actual number of white characters used */
666 len = num_spaces + num_tabs;
667 old_len = (long)STRLEN(ptr);
668 new_line = lalloc(old_len - col + start_col + len + 1,
669 TRUE);
670 if (new_line == NULL)
671 break;
672 if (start_col > 0)
673 mch_memmove(new_line, ptr, (size_t)start_col);
674 mch_memmove(new_line + start_col + len,
675 ptr + col, (size_t)(old_len - col + 1));
676 ptr = new_line + start_col;
677 for (col = 0; col < len; col++)
678 ptr[col] = (col < num_tabs) ? '\t' : ' ';
679 ml_replace(lnum, new_line, FALSE);
680 if (first_line == 0)
681 first_line = lnum;
682 last_line = lnum;
683 ptr = new_line;
684 col = start_col + len;
687 got_tab = FALSE;
688 num_spaces = 0;
690 if (ptr[col] == NUL)
691 break;
692 vcol += chartabsize(ptr + col, (colnr_T)vcol);
693 #ifdef FEAT_MBYTE
694 if (has_mbyte)
695 col += (*mb_ptr2len)(ptr + col);
696 else
697 #endif
698 ++col;
700 if (new_line == NULL) /* out of memory */
701 break;
702 line_breakcheck();
704 if (got_int)
705 EMSG(_(e_interr));
707 if (curbuf->b_p_ts != new_ts)
708 redraw_curbuf_later(NOT_VALID);
709 if (first_line != 0)
710 changed_lines(first_line, 0, last_line + 1, 0L);
712 curwin->w_p_list = save_list; /* restore 'list' */
714 curbuf->b_p_ts = new_ts;
715 coladvance(curwin->w_curswant);
717 u_clearline();
719 #endif
722 * :move command - move lines line1-line2 to line dest
724 * return FAIL for failure, OK otherwise
727 do_move(line1, line2, dest)
728 linenr_T line1;
729 linenr_T line2;
730 linenr_T dest;
732 char_u *str;
733 linenr_T l;
734 linenr_T extra; /* Num lines added before line1 */
735 linenr_T num_lines; /* Num lines moved */
736 linenr_T last_line; /* Last line in file after adding new text */
738 if (dest >= line1 && dest < line2)
740 EMSG(_("E134: Move lines into themselves"));
741 return FAIL;
744 num_lines = line2 - line1 + 1;
747 * First we copy the old text to its new location -- webb
748 * Also copy the flag that ":global" command uses.
750 if (u_save(dest, dest + 1) == FAIL)
751 return FAIL;
752 for (extra = 0, l = line1; l <= line2; l++)
754 str = vim_strsave(ml_get(l + extra));
755 if (str != NULL)
757 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
758 vim_free(str);
759 if (dest < line1)
760 extra++;
765 * Now we must be careful adjusting our marks so that we don't overlap our
766 * mark_adjust() calls.
768 * We adjust the marks within the old text so that they refer to the
769 * last lines of the file (temporarily), because we know no other marks
770 * will be set there since these line numbers did not exist until we added
771 * our new lines.
773 * Then we adjust the marks on lines between the old and new text positions
774 * (either forwards or backwards).
776 * And Finally we adjust the marks we put at the end of the file back to
777 * their final destination at the new text position -- webb
779 last_line = curbuf->b_ml.ml_line_count;
780 mark_adjust(line1, line2, last_line - line2, 0L);
781 if (dest >= line2)
783 mark_adjust(line2 + 1, dest, -num_lines, 0L);
784 curbuf->b_op_start.lnum = dest - num_lines + 1;
785 curbuf->b_op_end.lnum = dest;
787 else
789 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
790 curbuf->b_op_start.lnum = dest + 1;
791 curbuf->b_op_end.lnum = dest + num_lines;
793 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
794 mark_adjust(last_line - num_lines + 1, last_line,
795 -(last_line - dest - extra), 0L);
798 * Now we delete the original text -- webb
800 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
801 return FAIL;
803 for (l = line1; l <= line2; l++)
804 ml_delete(line1 + extra, TRUE);
806 if (!global_busy && num_lines > p_report)
808 if (num_lines == 1)
809 MSG(_("1 line moved"));
810 else
811 smsg((char_u *)_("%ld lines moved"), num_lines);
815 * Leave the cursor on the last of the moved lines.
817 if (dest >= line1)
818 curwin->w_cursor.lnum = dest;
819 else
820 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
822 if (line1 < dest)
823 changed_lines(line1, 0, dest + num_lines + 1, 0L);
824 else
825 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
827 return OK;
831 * ":copy"
833 void
834 ex_copy(line1, line2, n)
835 linenr_T line1;
836 linenr_T line2;
837 linenr_T n;
839 linenr_T count;
840 char_u *p;
842 count = line2 - line1 + 1;
843 curbuf->b_op_start.lnum = n + 1;
844 curbuf->b_op_end.lnum = n + count;
845 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
848 * there are three situations:
849 * 1. destination is above line1
850 * 2. destination is between line1 and line2
851 * 3. destination is below line2
853 * n = destination (when starting)
854 * curwin->w_cursor.lnum = destination (while copying)
855 * line1 = start of source (while copying)
856 * line2 = end of source (while copying)
858 if (u_save(n, n + 1) == FAIL)
859 return;
861 curwin->w_cursor.lnum = n;
862 while (line1 <= line2)
864 /* need to use vim_strsave() because the line will be unlocked within
865 * ml_append() */
866 p = vim_strsave(ml_get(line1));
867 if (p != NULL)
869 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
870 vim_free(p);
872 /* situation 2: skip already copied lines */
873 if (line1 == n)
874 line1 = curwin->w_cursor.lnum;
875 ++line1;
876 if (curwin->w_cursor.lnum < line1)
877 ++line1;
878 if (curwin->w_cursor.lnum < line2)
879 ++line2;
880 ++curwin->w_cursor.lnum;
883 appended_lines_mark(n, count);
885 msgmore((long)count);
888 static char_u *prevcmd = NULL; /* the previous command */
890 #if defined(EXITFREE) || defined(PROTO)
891 void
892 free_prev_shellcmd()
894 vim_free(prevcmd);
896 #endif
899 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
900 * Bangs in the argument are replaced with the previously entered command.
901 * Remember the argument.
903 * RISCOS: Bangs only replaced when followed by a space, since many
904 * pathnames contain one.
906 void
907 do_bang(addr_count, eap, forceit, do_in, do_out)
908 int addr_count;
909 exarg_T *eap;
910 int forceit;
911 int do_in, do_out;
913 char_u *arg = eap->arg; /* command */
914 linenr_T line1 = eap->line1; /* start of range */
915 linenr_T line2 = eap->line2; /* end of range */
916 char_u *newcmd = NULL; /* the new command */
917 int free_newcmd = FALSE; /* need to free() newcmd */
918 int ins_prevcmd;
919 char_u *t;
920 char_u *p;
921 char_u *trailarg;
922 int len;
923 int scroll_save = msg_scroll;
926 * Disallow shell commands for "rvim".
927 * Disallow shell commands from .exrc and .vimrc in current directory for
928 * security reasons.
930 if (check_restricted() || check_secure())
931 return;
933 if (addr_count == 0) /* :! */
935 msg_scroll = FALSE; /* don't scroll here */
936 autowrite_all();
937 msg_scroll = scroll_save;
941 * Try to find an embedded bang, like in :!<cmd> ! [args]
942 * (:!! is indicated by the 'forceit' variable)
944 ins_prevcmd = forceit;
945 trailarg = arg;
948 len = (int)STRLEN(trailarg) + 1;
949 if (newcmd != NULL)
950 len += (int)STRLEN(newcmd);
951 if (ins_prevcmd)
953 if (prevcmd == NULL)
955 EMSG(_(e_noprev));
956 vim_free(newcmd);
957 return;
959 len += (int)STRLEN(prevcmd);
961 if ((t = alloc((unsigned)len)) == NULL)
963 vim_free(newcmd);
964 return;
966 *t = NUL;
967 if (newcmd != NULL)
968 STRCAT(t, newcmd);
969 if (ins_prevcmd)
970 STRCAT(t, prevcmd);
971 p = t + STRLEN(t);
972 STRCAT(t, trailarg);
973 vim_free(newcmd);
974 newcmd = t;
977 * Scan the rest of the argument for '!', which is replaced by the
978 * previous command. "\!" is replaced by "!" (this is vi compatible).
980 trailarg = NULL;
981 while (*p)
983 if (*p == '!'
984 #ifdef RISCOS
985 && (p[1] == ' ' || p[1] == NUL)
986 #endif
989 if (p > newcmd && p[-1] == '\\')
990 STRMOVE(p - 1, p);
991 else
993 trailarg = p;
994 *trailarg++ = NUL;
995 ins_prevcmd = TRUE;
996 break;
999 ++p;
1001 } while (trailarg != NULL);
1003 vim_free(prevcmd);
1004 prevcmd = newcmd;
1006 if (bangredo) /* put cmd in redo buffer for ! command */
1008 AppendToRedobuffLit(prevcmd, -1);
1009 AppendToRedobuff((char_u *)"\n");
1010 bangredo = FALSE;
1013 * Add quotes around the command, for shells that need them.
1015 if (*p_shq != NUL)
1017 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
1018 if (newcmd == NULL)
1019 return;
1020 STRCPY(newcmd, p_shq);
1021 STRCAT(newcmd, prevcmd);
1022 STRCAT(newcmd, p_shq);
1023 free_newcmd = TRUE;
1025 if (addr_count == 0) /* :! */
1027 /* echo the command */
1028 msg_start();
1029 msg_putchar(':');
1030 msg_putchar('!');
1031 msg_outtrans(newcmd);
1032 msg_clr_eos();
1033 windgoto(msg_row, msg_col);
1035 do_shell(newcmd, 0);
1037 else /* :range! */
1039 /* Careful: This may recursively call do_bang() again! (because of
1040 * autocommands) */
1041 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1042 #ifdef FEAT_AUTOCMD
1043 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1044 #endif
1046 if (free_newcmd)
1047 vim_free(newcmd);
1051 * do_filter: filter lines through a command given by the user
1053 * We mostly use temp files and the call_shell() routine here. This would
1054 * normally be done using pipes on a UNIX machine, but this is more portable
1055 * to non-unix machines. The call_shell() routine needs to be able
1056 * to deal with redirection somehow, and should handle things like looking
1057 * at the PATH env. variable, and adding reasonable extensions to the
1058 * command name given by the user. All reasonable versions of call_shell()
1059 * do this.
1060 * Alternatively, if on Unix and redirecting input or output, but not both,
1061 * and the 'shelltemp' option isn't set, use pipes.
1062 * We use input redirection if do_in is TRUE.
1063 * We use output redirection if do_out is TRUE.
1065 static void
1066 do_filter(line1, line2, eap, cmd, do_in, do_out)
1067 linenr_T line1, line2;
1068 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1069 char_u *cmd;
1070 int do_in, do_out;
1072 char_u *itmp = NULL;
1073 char_u *otmp = NULL;
1074 linenr_T linecount;
1075 linenr_T read_linecount;
1076 pos_T cursor_save;
1077 char_u *cmd_buf;
1078 #ifdef FEAT_AUTOCMD
1079 buf_T *old_curbuf = curbuf;
1080 #endif
1081 int shell_flags = 0;
1083 if (*cmd == NUL) /* no filter command */
1084 return;
1086 #ifdef WIN3264
1088 * Check if external commands are allowed now.
1090 if (can_end_termcap_mode(TRUE) == FALSE)
1091 return;
1092 #endif
1094 cursor_save = curwin->w_cursor;
1095 linecount = line2 - line1 + 1;
1096 curwin->w_cursor.lnum = line1;
1097 curwin->w_cursor.col = 0;
1098 changed_line_abv_curs();
1099 invalidate_botline();
1102 * When using temp files:
1103 * 1. * Form temp file names
1104 * 2. * Write the lines to a temp file
1105 * 3. Run the filter command on the temp file
1106 * 4. * Read the output of the command into the buffer
1107 * 5. * Delete the original lines to be filtered
1108 * 6. * Remove the temp files
1110 * When writing the input with a pipe or when catching the output with a
1111 * pipe only need to do 3.
1114 if (do_out)
1115 shell_flags |= SHELL_DOOUT;
1117 #if !defined(USE_SYSTEM) && defined(UNIX)
1118 if (!do_in && do_out && !p_stmp)
1120 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1121 shell_flags |= SHELL_READ;
1122 curwin->w_cursor.lnum = line2;
1124 else if (do_in && !do_out && !p_stmp)
1126 /* Use a pipe to write stdin of the command, do not use a temp file. */
1127 shell_flags |= SHELL_WRITE;
1128 curbuf->b_op_start.lnum = line1;
1129 curbuf->b_op_end.lnum = line2;
1131 else if (do_in && do_out && !p_stmp)
1133 /* Use a pipe to write stdin and fetch stdout of the command, do not
1134 * use a temp file. */
1135 shell_flags |= SHELL_READ|SHELL_WRITE;
1136 curbuf->b_op_start.lnum = line1;
1137 curbuf->b_op_end.lnum = line2;
1138 curwin->w_cursor.lnum = line2;
1140 else
1141 #endif
1142 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1143 || (do_out && (otmp = vim_tempname('o')) == NULL))
1145 EMSG(_(e_notmp));
1146 goto filterend;
1150 * The writing and reading of temp files will not be shown.
1151 * Vi also doesn't do this and the messages are not very informative.
1153 ++no_wait_return; /* don't call wait_return() while busy */
1154 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1155 FALSE, FALSE, FALSE, TRUE) == FAIL)
1157 msg_putchar('\n'); /* keep message from buf_write() */
1158 --no_wait_return;
1159 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1160 if (!aborting())
1161 #endif
1162 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1163 goto filterend;
1165 #ifdef FEAT_AUTOCMD
1166 if (curbuf != old_curbuf)
1167 goto filterend;
1168 #endif
1170 if (!do_out)
1171 msg_putchar('\n');
1173 /* Create the shell command in allocated memory. */
1174 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1175 if (cmd_buf == NULL)
1176 goto filterend;
1178 windgoto((int)Rows - 1, 0);
1179 cursor_on();
1182 * When not redirecting the output the command can write anything to the
1183 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1184 * stderr output of external command. Clear the screen later.
1185 * If do_in is FALSE, this could be something like ":r !cat", which may
1186 * also mess up the screen, clear it later.
1188 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1189 redraw_later_clear();
1191 if (do_out)
1193 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1195 vim_free(cmd_buf);
1196 goto error;
1198 redraw_curbuf_later(VALID);
1200 read_linecount = curbuf->b_ml.ml_line_count;
1203 * When call_shell() fails wait_return() is called to give the user a
1204 * chance to read the error messages. Otherwise errors are ignored, so you
1205 * can see the error messages from the command that appear on stdout; use
1206 * 'u' to fix the text
1207 * Switch to cooked mode when not redirecting stdin, avoids that something
1208 * like ":r !cat" hangs.
1209 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1211 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1213 redraw_later_clear();
1214 wait_return(FALSE);
1216 vim_free(cmd_buf);
1218 did_check_timestamps = FALSE;
1219 need_check_timestamps = TRUE;
1221 /* When interrupting the shell command, it may still have produced some
1222 * useful output. Reset got_int here, so that readfile() won't cancel
1223 * reading. */
1224 ui_breakcheck();
1225 got_int = FALSE;
1227 if (do_out)
1229 if (otmp != NULL)
1231 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1232 eap, READ_FILTER) == FAIL)
1234 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1235 if (!aborting())
1236 #endif
1238 msg_putchar('\n');
1239 EMSG2(_(e_notread), otmp);
1241 goto error;
1243 #ifdef FEAT_AUTOCMD
1244 if (curbuf != old_curbuf)
1245 goto filterend;
1246 #endif
1249 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1251 if (shell_flags & SHELL_READ)
1253 curbuf->b_op_start.lnum = line2 + 1;
1254 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1255 appended_lines_mark(line2, read_linecount);
1258 if (do_in)
1260 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1262 if (read_linecount >= linecount)
1263 /* move all marks from old lines to new lines */
1264 mark_adjust(line1, line2, linecount, 0L);
1265 else
1267 /* move marks from old lines to new lines, delete marks
1268 * that are in deleted lines */
1269 mark_adjust(line1, line1 + read_linecount - 1,
1270 linecount, 0L);
1271 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1276 * Put cursor on first filtered line for ":range!cmd".
1277 * Adjust '[ and '] (set by buf_write()).
1279 curwin->w_cursor.lnum = line1;
1280 del_lines(linecount, TRUE);
1281 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1282 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1283 write_lnum_adjust(-linecount); /* adjust last line
1284 for next write */
1285 #ifdef FEAT_FOLDING
1286 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1287 #endif
1289 else
1292 * Put cursor on last new line for ":r !cmd".
1294 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1295 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1298 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1299 --no_wait_return;
1301 if (linecount > p_report)
1303 if (do_in)
1305 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1306 _("%ld lines filtered"), (long)linecount);
1307 if (msg(msg_buf) && !msg_scroll)
1308 /* save message to display it after redraw */
1309 set_keep_msg(msg_buf, 0);
1311 else
1312 msgmore((long)linecount);
1315 else
1317 error:
1318 /* put cursor back in same position for ":w !cmd" */
1319 curwin->w_cursor = cursor_save;
1320 --no_wait_return;
1321 wait_return(FALSE);
1324 filterend:
1326 #ifdef FEAT_AUTOCMD
1327 if (curbuf != old_curbuf)
1329 --no_wait_return;
1330 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1332 #endif
1333 if (itmp != NULL)
1334 mch_remove(itmp);
1335 if (otmp != NULL)
1336 mch_remove(otmp);
1337 vim_free(itmp);
1338 vim_free(otmp);
1342 * Call a shell to execute a command.
1343 * When "cmd" is NULL start an interactive shell.
1345 void
1346 do_shell(cmd, flags)
1347 char_u *cmd;
1348 int flags; /* may be SHELL_DOOUT when output is redirected */
1350 buf_T *buf;
1351 #ifndef FEAT_GUI_MSWIN
1352 int save_nwr;
1353 #endif
1354 #ifdef MSWIN
1355 int winstart = FALSE;
1356 #endif
1359 * Disallow shell commands for "rvim".
1360 * Disallow shell commands from .exrc and .vimrc in current directory for
1361 * security reasons.
1363 if (check_restricted() || check_secure())
1365 msg_end();
1366 return;
1369 #ifdef MSWIN
1371 * Check if external commands are allowed now.
1373 if (can_end_termcap_mode(TRUE) == FALSE)
1374 return;
1377 * Check if ":!start" is used.
1379 if (cmd != NULL)
1380 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1381 #endif
1384 * For autocommands we want to get the output on the current screen, to
1385 * avoid having to type return below.
1387 msg_putchar('\r'); /* put cursor at start of line */
1388 #ifdef FEAT_AUTOCMD
1389 if (!autocmd_busy)
1390 #endif
1392 #ifdef MSWIN
1393 if (!winstart)
1394 #endif
1395 stoptermcap();
1397 #ifdef MSWIN
1398 if (!winstart)
1399 #endif
1400 msg_putchar('\n'); /* may shift screen one line up */
1402 /* warning message before calling the shell */
1403 if (p_warn
1404 #ifdef FEAT_AUTOCMD
1405 && !autocmd_busy
1406 #endif
1407 && msg_silent == 0)
1408 for (buf = firstbuf; buf; buf = buf->b_next)
1409 if (bufIsChanged(buf))
1411 #ifdef FEAT_GUI_MSWIN
1412 if (!winstart)
1413 starttermcap(); /* don't want a message box here */
1414 #endif
1415 MSG_PUTS(_("[No write since last change]\n"));
1416 #ifdef FEAT_GUI_MSWIN
1417 if (!winstart)
1418 stoptermcap();
1419 #endif
1420 break;
1423 /* This windgoto is required for when the '\n' resulted in a "delete line
1424 * 1" command to the terminal. */
1425 if (!swapping_screen())
1426 windgoto(msg_row, msg_col);
1427 cursor_on();
1428 (void)call_shell(cmd, SHELL_COOKED | flags);
1429 did_check_timestamps = FALSE;
1430 need_check_timestamps = TRUE;
1433 * put the message cursor at the end of the screen, avoids wait_return()
1434 * to overwrite the text that the external command showed
1436 if (!swapping_screen())
1438 msg_row = Rows - 1;
1439 msg_col = 0;
1442 #ifdef FEAT_AUTOCMD
1443 if (autocmd_busy)
1445 if (msg_silent == 0)
1446 redraw_later_clear();
1448 else
1449 #endif
1452 * For ":sh" there is no need to call wait_return(), just redraw.
1453 * Also for the Win32 GUI (the output is in a console window).
1454 * Otherwise there is probably text on the screen that the user wants
1455 * to read before redrawing, so call wait_return().
1457 #ifndef FEAT_GUI_MSWIN
1458 if (cmd == NULL
1459 # ifdef WIN3264
1460 || (winstart && !need_wait_return)
1461 # endif
1464 if (msg_silent == 0)
1465 redraw_later_clear();
1466 need_wait_return = FALSE;
1468 else
1471 * If we switch screens when starttermcap() is called, we really
1472 * want to wait for "hit return to continue".
1474 save_nwr = no_wait_return;
1475 if (swapping_screen())
1476 no_wait_return = FALSE;
1477 # ifdef AMIGA
1478 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1479 # else
1480 wait_return(msg_silent == 0);
1481 # endif
1482 no_wait_return = save_nwr;
1484 #endif /* FEAT_GUI_W32 */
1486 #ifdef MSWIN
1487 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1488 #endif
1489 starttermcap(); /* start termcap if not done by wait_return() */
1492 * In an Amiga window redrawing is caused by asking the window size.
1493 * If we got an interrupt this will not work. The chance that the
1494 * window size is wrong is very small, but we need to redraw the
1495 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1496 * but it saves an extra redraw.
1498 #ifdef AMIGA
1499 if (skip_redraw) /* ':' hit in wait_return() */
1501 if (msg_silent == 0)
1502 redraw_later_clear();
1504 else if (term_console)
1506 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1507 if (got_int && msg_silent == 0)
1508 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1509 else
1510 must_redraw = 0; /* no extra redraw needed */
1512 #endif
1515 /* display any error messages now */
1516 display_errors();
1518 #ifdef FEAT_AUTOCMD
1519 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1520 #endif
1524 * Create a shell command from a command string, input redirection file and
1525 * output redirection file.
1526 * Returns an allocated string with the shell command, or NULL for failure.
1528 char_u *
1529 make_filter_cmd(cmd, itmp, otmp)
1530 char_u *cmd; /* command */
1531 char_u *itmp; /* NULL or name of input file */
1532 char_u *otmp; /* NULL or name of output file */
1534 char_u *buf;
1535 long_u len;
1537 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1538 if (itmp != NULL)
1539 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1540 if (otmp != NULL)
1541 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1542 buf = lalloc(len, TRUE);
1543 if (buf == NULL)
1544 return NULL;
1546 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1548 * Put braces around the command (for concatenated commands) when
1549 * redirecting input and/or output.
1551 if (itmp != NULL || otmp != NULL)
1552 vim_snprintf((char *)buf, len, "(%s)", (char *)cmd);
1553 else
1554 STRCPY(buf, cmd);
1555 if (itmp != NULL)
1557 STRCAT(buf, " < ");
1558 STRCAT(buf, itmp);
1560 #else
1562 * for shells that don't understand braces around commands, at least allow
1563 * the use of commands in a pipe.
1565 STRCPY(buf, cmd);
1566 if (itmp != NULL)
1568 char_u *p;
1571 * If there is a pipe, we have to put the '<' in front of it.
1572 * Don't do this when 'shellquote' is not empty, otherwise the
1573 * redirection would be inside the quotes.
1575 if (*p_shq == NUL)
1577 p = vim_strchr(buf, '|');
1578 if (p != NULL)
1579 *p = NUL;
1581 # ifdef RISCOS
1582 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1583 STRCAT(buf, itmp);
1584 STRCAT(buf, " } ");
1585 # else
1586 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1587 STRCAT(buf, itmp);
1588 # endif
1589 if (*p_shq == NUL)
1591 p = vim_strchr(cmd, '|');
1592 if (p != NULL)
1594 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1595 STRCAT(buf, p);
1599 #endif
1600 if (otmp != NULL)
1601 append_redir(buf, (int)len, p_srr, otmp);
1603 return buf;
1607 * Append output redirection for file "fname" to the end of string buffer
1608 * "buf[buflen]"
1609 * Works with the 'shellredir' and 'shellpipe' options.
1610 * The caller should make sure that there is enough room:
1611 * STRLEN(opt) + STRLEN(fname) + 3
1613 void
1614 append_redir(buf, buflen, opt, fname)
1615 char_u *buf;
1616 int buflen;
1617 char_u *opt;
1618 char_u *fname;
1620 char_u *p;
1621 char_u *end;
1623 end = buf + STRLEN(buf);
1624 /* find "%s", skipping "%%" */
1625 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1626 if (p[1] == 's')
1627 break;
1628 if (p != NULL)
1630 *end = ' '; /* not really needed? Not with sh, ksh or bash */
1631 vim_snprintf((char *)end + 1, (size_t)(buflen - (end + 1 - buf)),
1632 (char *)opt, (char *)fname);
1634 else
1635 vim_snprintf((char *)end, (size_t)(buflen - (end - buf)),
1636 #ifdef FEAT_QUICKFIX
1637 # ifndef RISCOS
1638 opt != p_sp ? " %s%s" :
1639 # endif
1640 " %s %s",
1641 #else
1642 # ifndef RISCOS
1643 " %s%s", /* " > %s" causes problems on Amiga */
1644 # else
1645 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1646 # endif
1647 #endif
1648 (char *)opt, (char *)fname);
1651 #ifdef FEAT_VIMINFO
1653 static int no_viminfo __ARGS((void));
1654 static int viminfo_errcnt;
1656 static int
1657 no_viminfo()
1659 /* "vim -i NONE" does not read or write a viminfo file */
1660 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1664 * Report an error for reading a viminfo file.
1665 * Count the number of errors. When there are more than 10, return TRUE.
1668 viminfo_error(errnum, message, line)
1669 char *errnum;
1670 char *message;
1671 char_u *line;
1673 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1674 errnum, message);
1675 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff) - 1);
1676 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1677 IObuff[STRLEN(IObuff) - 1] = NUL;
1678 emsg(IObuff);
1679 if (++viminfo_errcnt >= 10)
1681 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1682 return TRUE;
1684 return FALSE;
1688 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1689 * set are not over-written unless "flags" includes VIF_FORCEIT. -- webb
1692 read_viminfo(file, flags)
1693 char_u *file; /* file name or NULL to use default name */
1694 int flags; /* VIF_WANT_INFO et al. */
1696 FILE *fp;
1697 char_u *fname;
1699 if (no_viminfo())
1700 return FAIL;
1702 fname = viminfo_filename(file); /* get file name in allocated buffer */
1703 if (fname == NULL)
1704 return FAIL;
1705 fp = mch_fopen((char *)fname, READBIN);
1707 if (p_verbose > 0)
1709 verbose_enter();
1710 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1711 fname,
1712 (flags & VIF_WANT_INFO) ? _(" info") : "",
1713 (flags & VIF_WANT_MARKS) ? _(" marks") : "",
1714 (flags & VIF_GET_OLDFILES) ? _(" oldfiles") : "",
1715 fp == NULL ? _(" FAILED") : "");
1716 verbose_leave();
1719 vim_free(fname);
1720 if (fp == NULL)
1721 return FAIL;
1723 viminfo_errcnt = 0;
1724 do_viminfo(fp, NULL, flags);
1726 fclose(fp);
1727 return OK;
1731 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1732 * that effectively a merge of current info and old info is done. This allows
1733 * multiple vims to run simultaneously, without losing any marks etc. If
1734 * forceit is TRUE, then the old file is not read in, and only internal info is
1735 * written to the file. -- webb
1737 void
1738 write_viminfo(file, forceit)
1739 char_u *file;
1740 int forceit;
1742 char_u *fname;
1743 FILE *fp_in = NULL; /* input viminfo file, if any */
1744 FILE *fp_out = NULL; /* output viminfo file */
1745 char_u *tempname = NULL; /* name of temp viminfo file */
1746 struct stat st_new; /* mch_stat() of potential new file */
1747 char_u *wp;
1748 #if defined(UNIX) || defined(VMS)
1749 mode_t umask_save;
1750 #endif
1751 #ifdef UNIX
1752 int shortname = FALSE; /* use 8.3 file name */
1753 struct stat st_old; /* mch_stat() of existing viminfo file */
1754 #endif
1755 #ifdef WIN3264
1756 long perm = -1;
1757 #endif
1759 if (no_viminfo())
1760 return;
1762 fname = viminfo_filename(file); /* may set to default if NULL */
1763 if (fname == NULL)
1764 return;
1766 fp_in = mch_fopen((char *)fname, READBIN);
1767 if (fp_in == NULL)
1769 /* if it does exist, but we can't read it, don't try writing */
1770 if (mch_stat((char *)fname, &st_new) == 0)
1771 goto end;
1772 #if defined(UNIX) || defined(VMS)
1774 * For Unix we create the .viminfo non-accessible for others,
1775 * because it may contain text from non-accessible documents.
1777 umask_save = umask(077);
1778 #endif
1779 fp_out = mch_fopen((char *)fname, WRITEBIN);
1780 #if defined(UNIX) || defined(VMS)
1781 (void)umask(umask_save);
1782 #endif
1784 else
1787 * There is an existing viminfo file. Create a temporary file to
1788 * write the new viminfo into, in the same directory as the
1789 * existing viminfo file, which will be renamed later.
1791 #ifdef UNIX
1793 * For Unix we check the owner of the file. It's not very nice to
1794 * overwrite a user's viminfo file after a "su root", with a
1795 * viminfo file that the user can't read.
1797 st_old.st_dev = (dev_t)0;
1798 st_old.st_ino = 0;
1799 st_old.st_mode = 0600;
1800 if (mch_stat((char *)fname, &st_old) == 0
1801 && getuid() != ROOT_UID
1802 && !(st_old.st_uid == getuid()
1803 ? (st_old.st_mode & 0200)
1804 : (st_old.st_gid == getgid()
1805 ? (st_old.st_mode & 0020)
1806 : (st_old.st_mode & 0002))))
1808 int tt = msg_didany;
1810 /* avoid a wait_return for this message, it's annoying */
1811 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1812 msg_didany = tt;
1813 fclose(fp_in);
1814 goto end;
1816 #endif
1817 #ifdef WIN3264
1818 /* Get the file attributes of the existing viminfo file. */
1819 perm = mch_getperm(fname);
1820 #endif
1823 * Make tempname.
1824 * May try twice: Once normal and once with shortname set, just in
1825 * case somebody puts his viminfo file in an 8.3 filesystem.
1827 for (;;)
1829 tempname = buf_modname(
1830 #ifdef UNIX
1831 shortname,
1832 #else
1833 # ifdef SHORT_FNAME
1834 TRUE,
1835 # else
1836 # ifdef FEAT_GUI_W32
1837 gui_is_win32s(),
1838 # else
1839 FALSE,
1840 # endif
1841 # endif
1842 #endif
1843 fname,
1844 #ifdef VMS
1845 (char_u *)"-tmp",
1846 #else
1847 # ifdef RISCOS
1848 (char_u *)"/tmp",
1849 # else
1850 (char_u *)".tmp",
1851 # endif
1852 #endif
1853 FALSE);
1854 if (tempname == NULL) /* out of memory */
1855 break;
1858 * Check if tempfile already exists. Never overwrite an
1859 * existing file!
1861 if (mch_stat((char *)tempname, &st_new) == 0)
1863 #ifdef UNIX
1865 * Check if tempfile is same as original file. May happen
1866 * when modname() gave the same file back. E.g. silly
1867 * link, or file name-length reached. Try again with
1868 * shortname set.
1870 if (!shortname && st_new.st_dev == st_old.st_dev
1871 && st_new.st_ino == st_old.st_ino)
1873 vim_free(tempname);
1874 tempname = NULL;
1875 shortname = TRUE;
1876 continue;
1878 #endif
1880 * Try another name. Change one character, just before
1881 * the extension. This should also work for an 8.3
1882 * file name, when after adding the extension it still is
1883 * the same file as the original.
1885 wp = tempname + STRLEN(tempname) - 5;
1886 if (wp < gettail(tempname)) /* empty file name? */
1887 wp = gettail(tempname);
1888 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1889 --*wp)
1892 * They all exist? Must be something wrong! Don't
1893 * write the viminfo file then.
1895 if (*wp == 'a')
1897 vim_free(tempname);
1898 tempname = NULL;
1899 break;
1903 break;
1906 if (tempname != NULL)
1908 #ifdef VMS
1909 /* fdopen() fails for some reason */
1910 umask_save = umask(077);
1911 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1912 (void)umask(umask_save);
1913 #else
1914 int fd;
1916 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1917 * protection:
1918 * Unix: same as original file, but strip s-bit. Reset umask to
1919 * avoid it getting in the way.
1920 * Others: r&w for user only. */
1921 # ifdef UNIX
1922 umask_save = umask(0);
1923 fd = mch_open((char *)tempname,
1924 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1925 (int)((st_old.st_mode & 0777) | 0600));
1926 (void)umask(umask_save);
1927 # else
1928 fd = mch_open((char *)tempname,
1929 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1930 # endif
1931 if (fd < 0)
1932 fp_out = NULL;
1933 else
1934 fp_out = fdopen(fd, WRITEBIN);
1935 #endif /* VMS */
1938 * If we can't create in the same directory, try creating a
1939 * "normal" temp file.
1941 if (fp_out == NULL)
1943 vim_free(tempname);
1944 if ((tempname = vim_tempname('o')) != NULL)
1945 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1948 #if defined(UNIX) && defined(HAVE_FCHOWN)
1950 * Make sure the owner can read/write it. This only works for
1951 * root.
1953 if (fp_out != NULL)
1954 ignored = fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1955 #endif
1960 * Check if the new viminfo file can be written to.
1962 if (fp_out == NULL)
1964 EMSG2(_("E138: Can't write viminfo file %s!"),
1965 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1966 if (fp_in != NULL)
1967 fclose(fp_in);
1968 goto end;
1971 if (p_verbose > 0)
1973 verbose_enter();
1974 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1975 verbose_leave();
1978 viminfo_errcnt = 0;
1979 do_viminfo(fp_in, fp_out, forceit ? 0 : (VIF_WANT_INFO | VIF_WANT_MARKS));
1981 fclose(fp_out); /* errors are ignored !? */
1982 if (fp_in != NULL)
1984 fclose(fp_in);
1987 * In case of an error keep the original viminfo file.
1988 * Otherwise rename the newly written file.
1990 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1991 mch_remove(tempname);
1993 #ifdef WIN3264
1994 /* If the viminfo file was hidden then also hide the new file. */
1995 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1996 mch_hide(fname);
1997 #endif
2000 end:
2001 vim_free(fname);
2002 vim_free(tempname);
2006 * Get the viminfo file name to use.
2007 * If "file" is given and not empty, use it (has already been expanded by
2008 * cmdline functions).
2009 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
2010 * expand environment variables.
2011 * Returns an allocated string. NULL when out of memory.
2013 static char_u *
2014 viminfo_filename(file)
2015 char_u *file;
2017 if (file == NULL || *file == NUL)
2019 if (use_viminfo != NULL)
2020 file = use_viminfo;
2021 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
2023 #ifdef VIMINFO_FILE2
2024 /* don't use $HOME when not defined (turned into "c:/"!). */
2025 # ifdef VMS
2026 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
2027 # else
2028 if (mch_getenv((char_u *)"HOME") == NULL)
2029 # endif
2031 /* don't use $VIM when not available. */
2032 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2033 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2034 file = (char_u *)VIMINFO_FILE2;
2035 else
2036 file = (char_u *)VIMINFO_FILE;
2038 else
2039 #endif
2040 file = (char_u *)VIMINFO_FILE;
2042 expand_env(file, NameBuff, MAXPATHL);
2043 file = NameBuff;
2045 return vim_strsave(file);
2049 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2051 static void
2052 do_viminfo(fp_in, fp_out, flags)
2053 FILE *fp_in;
2054 FILE *fp_out;
2055 int flags;
2057 int count = 0;
2058 int eof = FALSE;
2059 vir_T vir;
2061 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2062 return;
2063 vir.vir_fd = fp_in;
2064 #ifdef FEAT_MBYTE
2065 vir.vir_conv.vc_type = CONV_NONE;
2066 #endif
2068 if (fp_in != NULL)
2070 if (flags & VIF_WANT_INFO)
2071 eof = read_viminfo_up_to_marks(&vir,
2072 flags & VIF_FORCEIT, fp_out != NULL);
2073 else
2074 /* Skip info, find start of marks */
2075 while (!(eof = viminfo_readline(&vir))
2076 && vir.vir_line[0] != '>')
2079 if (fp_out != NULL)
2081 /* Write the info: */
2082 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2083 VIM_VERSION_MEDIUM);
2084 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2085 #ifdef FEAT_MBYTE
2086 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2087 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2088 #endif
2089 write_viminfo_search_pattern(fp_out);
2090 write_viminfo_sub_string(fp_out);
2091 #ifdef FEAT_CMDHIST
2092 write_viminfo_history(fp_out);
2093 #endif
2094 write_viminfo_registers(fp_out);
2095 #ifdef FEAT_EVAL
2096 write_viminfo_varlist(fp_out);
2097 #endif
2098 write_viminfo_filemarks(fp_out);
2099 write_viminfo_bufferlist(fp_out);
2100 count = write_viminfo_marks(fp_out);
2102 if (fp_in != NULL
2103 && (flags & (VIF_WANT_MARKS | VIF_GET_OLDFILES | VIF_FORCEIT)))
2104 copy_viminfo_marks(&vir, fp_out, count, eof, flags);
2106 vim_free(vir.vir_line);
2107 #ifdef FEAT_MBYTE
2108 if (vir.vir_conv.vc_type != CONV_NONE)
2109 convert_setup(&vir.vir_conv, NULL, NULL);
2110 #endif
2114 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2115 * first part of the viminfo file which contains everything but the marks that
2116 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2118 static int
2119 read_viminfo_up_to_marks(virp, forceit, writing)
2120 vir_T *virp;
2121 int forceit;
2122 int writing;
2124 int eof;
2125 buf_T *buf;
2127 #ifdef FEAT_CMDHIST
2128 prepare_viminfo_history(forceit ? 9999 : 0);
2129 #endif
2130 eof = viminfo_readline(virp);
2131 while (!eof && virp->vir_line[0] != '>')
2133 switch (virp->vir_line[0])
2135 /* Characters reserved for future expansion, ignored now */
2136 case '+': /* "+40 /path/dir file", for running vim without args */
2137 case '|': /* to be defined */
2138 case '^': /* to be defined */
2139 case '<': /* long line - ignored */
2140 /* A comment or empty line. */
2141 case NUL:
2142 case '\r':
2143 case '\n':
2144 case '#':
2145 eof = viminfo_readline(virp);
2146 break;
2147 case '*': /* "*encoding=value" */
2148 eof = viminfo_encoding(virp);
2149 break;
2150 case '!': /* global variable */
2151 #ifdef FEAT_EVAL
2152 eof = read_viminfo_varlist(virp, writing);
2153 #else
2154 eof = viminfo_readline(virp);
2155 #endif
2156 break;
2157 case '%': /* entry for buffer list */
2158 eof = read_viminfo_bufferlist(virp, writing);
2159 break;
2160 case '"':
2161 eof = read_viminfo_register(virp, forceit);
2162 break;
2163 case '/': /* Search string */
2164 case '&': /* Substitute search string */
2165 case '~': /* Last search string, followed by '/' or '&' */
2166 eof = read_viminfo_search_pattern(virp, forceit);
2167 break;
2168 case '$':
2169 eof = read_viminfo_sub_string(virp, forceit);
2170 break;
2171 case ':':
2172 case '?':
2173 case '=':
2174 case '@':
2175 #ifdef FEAT_CMDHIST
2176 eof = read_viminfo_history(virp);
2177 #else
2178 eof = viminfo_readline(virp);
2179 #endif
2180 break;
2181 case '-':
2182 case '\'':
2183 eof = read_viminfo_filemark(virp, forceit);
2184 break;
2185 default:
2186 if (viminfo_error("E575: ", _("Illegal starting char"),
2187 virp->vir_line))
2188 eof = TRUE;
2189 else
2190 eof = viminfo_readline(virp);
2191 break;
2195 #ifdef FEAT_CMDHIST
2196 /* Finish reading history items. */
2197 finish_viminfo_history();
2198 #endif
2200 /* Change file names to buffer numbers for fmarks. */
2201 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2202 fmarks_check_names(buf);
2204 return eof;
2208 * Compare the 'encoding' value in the viminfo file with the current value of
2209 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2210 * conversion of text with iconv() in viminfo_readstring().
2212 static int
2213 viminfo_encoding(virp)
2214 vir_T *virp;
2216 #ifdef FEAT_MBYTE
2217 char_u *p;
2218 int i;
2220 if (get_viminfo_parameter('c') != 0)
2222 p = vim_strchr(virp->vir_line, '=');
2223 if (p != NULL)
2225 /* remove trailing newline */
2226 ++p;
2227 for (i = 0; vim_isprintc(p[i]); ++i)
2229 p[i] = NUL;
2231 convert_setup(&virp->vir_conv, p, p_enc);
2234 #endif
2235 return viminfo_readline(virp);
2239 * Read a line from the viminfo file.
2240 * Returns TRUE for end-of-file;
2243 viminfo_readline(virp)
2244 vir_T *virp;
2246 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2250 * check string read from viminfo file
2251 * remove '\n' at the end of the line
2252 * - replace CTRL-V CTRL-V with CTRL-V
2253 * - replace CTRL-V 'n' with '\n'
2255 * Check for a long line as written by viminfo_writestring().
2257 * Return the string in allocated memory (NULL when out of memory).
2259 /*ARGSUSED*/
2260 char_u *
2261 viminfo_readstring(virp, off, convert)
2262 vir_T *virp;
2263 int off; /* offset for virp->vir_line */
2264 int convert; /* convert the string */
2266 char_u *retval;
2267 char_u *s, *d;
2268 long len;
2270 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2272 len = atol((char *)virp->vir_line + off + 1);
2273 retval = lalloc(len, TRUE);
2274 if (retval == NULL)
2276 /* Line too long? File messed up? Skip next line. */
2277 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2278 return NULL;
2280 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2281 s = retval + 1; /* Skip the leading '<' */
2283 else
2285 retval = vim_strsave(virp->vir_line + off);
2286 if (retval == NULL)
2287 return NULL;
2288 s = retval;
2291 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2292 d = retval;
2293 while (*s != NUL && *s != '\n')
2295 if (s[0] == Ctrl_V && s[1] != NUL)
2297 if (s[1] == 'n')
2298 *d++ = '\n';
2299 else
2300 *d++ = Ctrl_V;
2301 s += 2;
2303 else
2304 *d++ = *s++;
2306 *d = NUL;
2308 #ifdef FEAT_MBYTE
2309 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2311 d = string_convert(&virp->vir_conv, retval, NULL);
2312 if (d != NULL)
2314 vim_free(retval);
2315 retval = d;
2318 #endif
2320 return retval;
2324 * write string to viminfo file
2325 * - replace CTRL-V with CTRL-V CTRL-V
2326 * - replace '\n' with CTRL-V 'n'
2327 * - add a '\n' at the end
2329 * For a long line:
2330 * - write " CTRL-V <length> \n " in first line
2331 * - write " < <string> \n " in second line
2333 void
2334 viminfo_writestring(fd, p)
2335 FILE *fd;
2336 char_u *p;
2338 int c;
2339 char_u *s;
2340 int len = 0;
2342 for (s = p; *s != NUL; ++s)
2344 if (*s == Ctrl_V || *s == '\n')
2345 ++len;
2346 ++len;
2349 /* If the string will be too long, write its length and put it in the next
2350 * line. Take into account that some room is needed for what comes before
2351 * the string (e.g., variable name). Add something to the length for the
2352 * '<', NL and trailing NUL. */
2353 if (len > LSIZE / 2)
2354 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2356 while ((c = *p++) != NUL)
2358 if (c == Ctrl_V || c == '\n')
2360 putc(Ctrl_V, fd);
2361 if (c == '\n')
2362 c = 'n';
2364 putc(c, fd);
2366 putc('\n', fd);
2368 #endif /* FEAT_VIMINFO */
2371 * Implementation of ":fixdel", also used by get_stty().
2372 * <BS> resulting <Del>
2373 * ^? ^H
2374 * not ^? ^?
2376 /*ARGSUSED*/
2377 void
2378 do_fixdel(eap)
2379 exarg_T *eap;
2381 char_u *p;
2383 p = find_termcode((char_u *)"kb");
2384 add_termcode((char_u *)"kD", p != NULL
2385 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2388 void
2389 print_line_no_prefix(lnum, use_number, list)
2390 linenr_T lnum;
2391 int use_number;
2392 int list;
2394 char_u numbuf[30];
2396 if (curwin->w_p_nu || use_number)
2398 vim_snprintf((char *)numbuf, sizeof(numbuf),
2399 "%*ld ", number_width(curwin), (long)lnum);
2400 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2402 msg_prt_line(ml_get(lnum), list);
2406 * Print a text line. Also in silent mode ("ex -s").
2408 void
2409 print_line(lnum, use_number, list)
2410 linenr_T lnum;
2411 int use_number;
2412 int list;
2414 int save_silent = silent_mode;
2416 msg_start();
2417 silent_mode = FALSE;
2418 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2419 print_line_no_prefix(lnum, use_number, list);
2420 if (save_silent)
2422 msg_putchar('\n');
2423 cursor_on(); /* msg_start() switches it off */
2424 out_flush();
2425 silent_mode = save_silent;
2427 info_message = FALSE;
2431 * ":file[!] [fname]".
2433 void
2434 ex_file(eap)
2435 exarg_T *eap;
2437 char_u *fname, *sfname, *xfname;
2438 buf_T *buf;
2440 /* ":0file" removes the file name. Check for illegal uses ":3file",
2441 * "0file name", etc. */
2442 if (eap->addr_count > 0
2443 && (*eap->arg != NUL
2444 || eap->line2 > 0
2445 || eap->addr_count > 1))
2447 EMSG(_(e_invarg));
2448 return;
2451 if (*eap->arg != NUL || eap->addr_count == 1)
2453 #ifdef FEAT_AUTOCMD
2454 buf = curbuf;
2455 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2456 /* buffer changed, don't change name now */
2457 if (buf != curbuf)
2458 return;
2459 # ifdef FEAT_EVAL
2460 if (aborting()) /* autocmds may abort script processing */
2461 return;
2462 # endif
2463 #endif
2465 * The name of the current buffer will be changed.
2466 * A new (unlisted) buffer entry needs to be made to hold the old file
2467 * name, which will become the alternate file name.
2468 * But don't set the alternate file name if the buffer didn't have a
2469 * name.
2471 fname = curbuf->b_ffname;
2472 sfname = curbuf->b_sfname;
2473 xfname = curbuf->b_fname;
2474 curbuf->b_ffname = NULL;
2475 curbuf->b_sfname = NULL;
2476 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2478 curbuf->b_ffname = fname;
2479 curbuf->b_sfname = sfname;
2480 return;
2482 curbuf->b_flags |= BF_NOTEDITED;
2483 if (xfname != NULL && *xfname != NUL)
2485 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2486 if (buf != NULL && !cmdmod.keepalt)
2487 curwin->w_alt_fnum = buf->b_fnum;
2489 vim_free(fname);
2490 vim_free(sfname);
2491 #ifdef FEAT_AUTOCMD
2492 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2493 #endif
2494 /* Change directories when the 'acd' option is set. */
2495 DO_AUTOCHDIR
2497 /* print full file name if :cd used */
2498 fileinfo(FALSE, FALSE, eap->forceit);
2502 * ":update".
2504 void
2505 ex_update(eap)
2506 exarg_T *eap;
2508 if (curbufIsChanged())
2509 (void)do_write(eap);
2513 * ":write" and ":saveas".
2515 void
2516 ex_write(eap)
2517 exarg_T *eap;
2519 if (eap->usefilter) /* input lines to shell command */
2520 do_bang(1, eap, FALSE, TRUE, FALSE);
2521 else
2522 (void)do_write(eap);
2526 * write current buffer to file 'eap->arg'
2527 * if 'eap->append' is TRUE, append to the file
2529 * if *eap->arg == NUL write to current file
2531 * return FAIL for failure, OK otherwise
2534 do_write(eap)
2535 exarg_T *eap;
2537 int other;
2538 char_u *fname = NULL; /* init to shut up gcc */
2539 char_u *ffname;
2540 int retval = FAIL;
2541 char_u *free_fname = NULL;
2542 #ifdef FEAT_BROWSE
2543 char_u *browse_file = NULL;
2544 #endif
2545 buf_T *alt_buf = NULL;
2547 if (not_writing()) /* check 'write' option */
2548 return FAIL;
2550 ffname = eap->arg;
2551 #ifdef FEAT_BROWSE
2552 if (cmdmod.browse)
2554 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2555 NULL, NULL, NULL, curbuf);
2556 if (browse_file == NULL)
2557 goto theend;
2558 ffname = browse_file;
2560 #endif
2561 if (*ffname == NUL)
2563 if (eap->cmdidx == CMD_saveas)
2565 EMSG(_(e_argreq));
2566 goto theend;
2568 other = FALSE;
2570 else
2572 fname = ffname;
2573 free_fname = fix_fname(ffname);
2575 * When out-of-memory, keep unexpanded file name, because we MUST be
2576 * able to write the file in this situation.
2578 if (free_fname != NULL)
2579 ffname = free_fname;
2580 other = otherfile(ffname);
2584 * If we have a new file, put its name in the list of alternate file names.
2586 if (other)
2588 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2589 || eap->cmdidx == CMD_saveas)
2590 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2591 else
2592 alt_buf = buflist_findname(ffname);
2593 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2595 /* Overwriting a file that is loaded in another buffer is not a
2596 * good idea. */
2597 EMSG(_(e_bufloaded));
2598 goto theend;
2603 * Writing to the current file is not allowed in readonly mode
2604 * and a file name is required.
2605 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2607 if (!other && (
2608 #ifdef FEAT_QUICKFIX
2609 bt_dontwrite_msg(curbuf) ||
2610 #endif
2611 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2612 goto theend;
2614 if (!other)
2616 ffname = curbuf->b_ffname;
2617 fname = curbuf->b_fname;
2619 * Not writing the whole file is only allowed with '!'.
2621 if ( (eap->line1 != 1
2622 || eap->line2 != curbuf->b_ml.ml_line_count)
2623 && !eap->forceit
2624 && !eap->append
2625 && !p_wa)
2627 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2628 if (p_confirm || cmdmod.confirm)
2630 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2631 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2632 goto theend;
2633 eap->forceit = TRUE;
2635 else
2636 #endif
2638 EMSG(_("E140: Use ! to write partial buffer"));
2639 goto theend;
2644 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2646 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2648 #ifdef FEAT_AUTOCMD
2649 buf_T *was_curbuf = curbuf;
2651 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2652 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2653 # ifdef FEAT_EVAL
2654 if (curbuf != was_curbuf || aborting())
2655 # else
2656 if (curbuf != was_curbuf)
2657 # endif
2659 /* buffer changed, don't change name now */
2660 retval = FAIL;
2661 goto theend;
2663 #endif
2664 /* Exchange the file names for the current and the alternate
2665 * buffer. This makes it look like we are now editing the buffer
2666 * under the new name. Must be done before buf_write(), because
2667 * if there is no file name and 'cpo' contains 'F', it will set
2668 * the file name. */
2669 fname = alt_buf->b_fname;
2670 alt_buf->b_fname = curbuf->b_fname;
2671 curbuf->b_fname = fname;
2672 fname = alt_buf->b_ffname;
2673 alt_buf->b_ffname = curbuf->b_ffname;
2674 curbuf->b_ffname = fname;
2675 fname = alt_buf->b_sfname;
2676 alt_buf->b_sfname = curbuf->b_sfname;
2677 curbuf->b_sfname = fname;
2678 buf_name_changed(curbuf);
2679 #ifdef FEAT_AUTOCMD
2680 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2681 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2682 if (!alt_buf->b_p_bl)
2684 alt_buf->b_p_bl = TRUE;
2685 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2687 # ifdef FEAT_EVAL
2688 if (curbuf != was_curbuf || aborting())
2689 # else
2690 if (curbuf != was_curbuf)
2691 # endif
2693 /* buffer changed, don't write the file */
2694 retval = FAIL;
2695 goto theend;
2698 /* If 'filetype' was empty try detecting it now. */
2699 if (*curbuf->b_p_ft == NUL)
2701 if (au_has_group((char_u *)"filetypedetect"))
2702 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2703 TRUE);
2704 do_modelines(0);
2706 #endif
2709 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2710 eap, eap->append, eap->forceit, TRUE, FALSE);
2712 /* After ":saveas fname" reset 'readonly'. */
2713 if (eap->cmdidx == CMD_saveas)
2715 if (retval == OK)
2717 curbuf->b_p_ro = FALSE;
2718 #ifdef FEAT_WINDOWS
2719 redraw_tabline = TRUE;
2720 #endif
2722 /* Change directories when the 'acd' option is set. */
2723 DO_AUTOCHDIR
2727 theend:
2728 #ifdef FEAT_BROWSE
2729 vim_free(browse_file);
2730 #endif
2731 vim_free(free_fname);
2732 return retval;
2736 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2737 * BF_NEW or BF_READERR, check for overwriting current file.
2738 * May set eap->forceit if a dialog says it's OK to overwrite.
2739 * Return OK if it's OK, FAIL if it is not.
2741 /*ARGSUSED*/
2742 static int
2743 check_overwrite(eap, buf, fname, ffname, other)
2744 exarg_T *eap;
2745 buf_T *buf;
2746 char_u *fname; /* file name to be used (can differ from
2747 buf->ffname) */
2748 char_u *ffname; /* full path version of fname */
2749 int other; /* writing under other name */
2752 * write to other file or b_flags set or not writing the whole file:
2753 * overwriting only allowed with '!'
2755 if ( (other
2756 || (buf->b_flags & BF_NOTEDITED)
2757 || ((buf->b_flags & BF_NEW)
2758 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2759 || (buf->b_flags & BF_READERR))
2760 && !p_wa
2761 #ifdef FEAT_QUICKFIX
2762 && !bt_nofile(buf)
2763 #endif
2764 && vim_fexists(ffname))
2766 if (!eap->forceit && !eap->append)
2768 #ifdef UNIX
2769 /* with UNIX it is possible to open a directory */
2770 if (mch_isdir(ffname))
2772 EMSG2(_(e_isadir2), ffname);
2773 return FAIL;
2775 #endif
2776 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2777 if (p_confirm || cmdmod.confirm)
2779 char_u buff[IOSIZE];
2781 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2782 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2783 return FAIL;
2784 eap->forceit = TRUE;
2786 else
2787 #endif
2789 EMSG(_(e_exists));
2790 return FAIL;
2794 /* For ":w! filename" check that no swap file exists for "filename". */
2795 if (other && !emsg_silent)
2797 char_u dir[MAXPATHL];
2798 char_u *p;
2799 int r;
2800 char_u *swapname;
2802 /* We only try the first entry in 'directory', without checking if
2803 * it's writable. If the "." directory is not writable the write
2804 * will probably fail anyway.
2805 * Use 'shortname' of the current buffer, since there is no buffer
2806 * for the written file. */
2807 if (*p_dir == NUL)
2808 STRCPY(dir, ".");
2809 else
2811 p = p_dir;
2812 copy_option_part(&p, dir, MAXPATHL, ",");
2814 swapname = makeswapname(fname, ffname, curbuf, dir);
2815 r = vim_fexists(swapname);
2816 if (r)
2818 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2819 if (p_confirm || cmdmod.confirm)
2821 char_u buff[IOSIZE];
2823 dialog_msg(buff,
2824 _("Swap file \"%s\" exists, overwrite anyway?"),
2825 swapname);
2826 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2827 != VIM_YES)
2829 vim_free(swapname);
2830 return FAIL;
2832 eap->forceit = TRUE;
2834 else
2835 #endif
2837 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2838 swapname);
2839 vim_free(swapname);
2840 return FAIL;
2843 vim_free(swapname);
2846 return OK;
2850 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2852 void
2853 ex_wnext(eap)
2854 exarg_T *eap;
2856 int i;
2858 if (eap->cmd[1] == 'n')
2859 i = curwin->w_arg_idx + (int)eap->line2;
2860 else
2861 i = curwin->w_arg_idx - (int)eap->line2;
2862 eap->line1 = 1;
2863 eap->line2 = curbuf->b_ml.ml_line_count;
2864 if (do_write(eap) != FAIL)
2865 do_argfile(eap, i);
2869 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2871 void
2872 do_wqall(eap)
2873 exarg_T *eap;
2875 buf_T *buf;
2876 int error = 0;
2877 int save_forceit = eap->forceit;
2879 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2880 exiting = TRUE;
2882 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2884 if (bufIsChanged(buf))
2887 * Check if there is a reason the buffer cannot be written:
2888 * 1. if the 'write' option is set
2889 * 2. if there is no file name (even after browsing)
2890 * 3. if the 'readonly' is set (even after a dialog)
2891 * 4. if overwriting is allowed (even after a dialog)
2893 if (not_writing())
2895 ++error;
2896 break;
2898 #ifdef FEAT_BROWSE
2899 /* ":browse wall": ask for file name if there isn't one */
2900 if (buf->b_ffname == NULL && cmdmod.browse)
2901 browse_save_fname(buf);
2902 #endif
2903 if (buf->b_ffname == NULL)
2905 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2906 ++error;
2908 else if (check_readonly(&eap->forceit, buf)
2909 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2910 FALSE) == FAIL)
2912 ++error;
2914 else
2916 if (buf_write_all(buf, eap->forceit) == FAIL)
2917 ++error;
2918 #ifdef FEAT_AUTOCMD
2919 /* an autocommand may have deleted the buffer */
2920 if (!buf_valid(buf))
2921 buf = firstbuf;
2922 #endif
2924 eap->forceit = save_forceit; /* check_overwrite() may set it */
2927 if (exiting)
2929 if (!error)
2930 getout(0); /* exit Vim */
2931 not_exiting();
2936 * Check the 'write' option.
2937 * Return TRUE and give a message when it's not st.
2940 not_writing()
2942 if (p_write)
2943 return FALSE;
2944 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2945 return TRUE;
2949 * Check if a buffer is read-only (either 'readonly' option is set or file is
2950 * read-only). Ask for overruling in a dialog. Return TRUE and give an error
2951 * message when the buffer is readonly.
2953 static int
2954 check_readonly(forceit, buf)
2955 int *forceit;
2956 buf_T *buf;
2958 struct stat st;
2960 /* Handle a file being readonly when the 'readonly' option is set or when
2961 * the file exists and permissions are read-only.
2962 * We will send 0777 to check_file_readonly(), as the "perm" variable is
2963 * important for device checks but not here. */
2964 if (!*forceit && (buf->b_p_ro
2965 || (mch_stat((char *)buf->b_ffname, &st) >= 0
2966 && check_file_readonly(buf->b_ffname, 0777))))
2968 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2969 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2971 char_u buff[IOSIZE];
2973 if (buf->b_p_ro)
2974 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2975 buf->b_fname);
2976 else
2977 dialog_msg(buff, _("File permissions of \"%s\" are read-only.\nIt may still be possible to write it.\nDo you wish to try?"),
2978 buf->b_fname);
2980 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2982 /* Set forceit, to force the writing of a readonly file */
2983 *forceit = TRUE;
2984 return FALSE;
2986 else
2987 return TRUE;
2989 else
2990 #endif
2991 if (buf->b_p_ro)
2992 EMSG(_(e_readonly));
2993 else
2994 EMSG2(_("E505: \"%s\" is read-only (add ! to override)"),
2995 buf->b_fname);
2996 return TRUE;
2999 return FALSE;
3003 * Try to abandon current file and edit a new or existing file.
3004 * 'fnum' is the number of the file, if zero use ffname/sfname.
3006 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
3007 * -1 for successfully opening another file.
3008 * 'lnum' is the line number for the cursor in the new file (if non-zero).
3011 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
3012 int fnum;
3013 char_u *ffname;
3014 char_u *sfname;
3015 int setpm;
3016 linenr_T lnum;
3017 int forceit;
3019 int other;
3020 int retval;
3021 char_u *free_me = NULL;
3023 if (text_locked())
3024 return 1;
3025 #ifdef FEAT_AUTOCMD
3026 if (curbuf_locked())
3027 return 1;
3028 #endif
3030 if (fnum == 0)
3032 /* make ffname full path, set sfname */
3033 fname_expand(curbuf, &ffname, &sfname);
3034 other = otherfile(ffname);
3035 free_me = ffname; /* has been allocated, free() later */
3037 else
3038 other = (fnum != curbuf->b_fnum);
3040 if (other)
3041 ++no_wait_return; /* don't wait for autowrite message */
3042 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
3043 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
3045 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3046 if (p_confirm && p_write)
3047 dialog_changed(curbuf, FALSE);
3048 if (curbufIsChanged())
3049 #endif
3051 if (other)
3052 --no_wait_return;
3053 EMSG(_(e_nowrtmsg));
3054 retval = 2; /* file has been changed */
3055 goto theend;
3058 if (other)
3059 --no_wait_return;
3060 if (setpm)
3061 setpcmark();
3062 if (!other)
3064 if (lnum != 0)
3065 curwin->w_cursor.lnum = lnum;
3066 check_cursor_lnum();
3067 beginline(BL_SOL | BL_FIX);
3068 retval = 0; /* it's in the same file */
3070 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3071 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0),
3072 curwin) == OK)
3073 retval = -1; /* opened another file */
3074 else
3075 retval = 1; /* error encountered */
3077 theend:
3078 vim_free(free_me);
3079 return retval;
3083 * start editing a new file
3085 * fnum: file number; if zero use ffname/sfname
3086 * ffname: the file name
3087 * - full path if sfname used,
3088 * - any file name if sfname is NULL
3089 * - empty string to re-edit with the same file name (but may be
3090 * in a different directory)
3091 * - NULL to start an empty buffer
3092 * sfname: the short file name (or NULL)
3093 * eap: contains the command to be executed after loading the file and
3094 * forced 'ff' and 'fenc'
3095 * newlnum: if > 0: put cursor on this line number (if possible)
3096 * if ECMD_LASTL: use last position in loaded file
3097 * if ECMD_LAST: use last position in all files
3098 * if ECMD_ONE: use first line
3099 * flags:
3100 * ECMD_HIDE: if TRUE don't free the current buffer
3101 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3102 * ECMD_OLDBUF: use existing buffer if it exists
3103 * ECMD_FORCEIT: ! used for Ex command
3104 * ECMD_ADDBUF: don't edit, just add to buffer list
3105 * oldwin: Should be "curwin" when editing a new buffer in the current
3106 * window, NULL when splitting the window first. When not NULL info
3107 * of the previous buffer for "oldwin" is stored.
3109 * return FAIL for failure, OK otherwise
3112 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags, oldwin)
3113 int fnum;
3114 char_u *ffname;
3115 char_u *sfname;
3116 exarg_T *eap; /* can be NULL! */
3117 linenr_T newlnum;
3118 int flags;
3119 win_T *oldwin;
3121 int other_file; /* TRUE if editing another file */
3122 int oldbuf; /* TRUE if using existing buffer */
3123 #ifdef FEAT_AUTOCMD
3124 int auto_buf = FALSE; /* TRUE if autocommands brought us
3125 into the buffer unexpectedly */
3126 char_u *new_name = NULL;
3127 int did_set_swapcommand = FALSE;
3128 #endif
3129 buf_T *buf;
3130 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3131 buf_T *old_curbuf = curbuf;
3132 #endif
3133 char_u *free_fname = NULL;
3134 #ifdef FEAT_BROWSE
3135 char_u *browse_file = NULL;
3136 #endif
3137 int retval = FAIL;
3138 long n;
3139 linenr_T lnum;
3140 linenr_T topline = 0;
3141 int newcol = -1;
3142 int solcol = -1;
3143 pos_T *pos;
3144 #ifdef FEAT_SUN_WORKSHOP
3145 char_u *cp;
3146 #endif
3147 char_u *command = NULL;
3148 #ifdef FEAT_SPELL
3149 int did_get_winopts = FALSE;
3150 #endif
3152 if (eap != NULL)
3153 command = eap->do_ecmd_cmd;
3155 if (fnum != 0)
3157 if (fnum == curbuf->b_fnum) /* file is already being edited */
3158 return OK; /* nothing to do */
3159 other_file = TRUE;
3161 else
3163 #ifdef FEAT_BROWSE
3164 if (cmdmod.browse)
3166 # ifdef FEAT_AUTOCMD
3167 if (
3168 # ifdef FEAT_GUI
3169 !gui.in_use &&
3170 # endif
3171 au_has_group((char_u *)"FileExplorer"))
3173 /* No browsing supported but we do have the file explorer:
3174 * Edit the directory. */
3175 if (ffname == NULL || !mch_isdir(ffname))
3176 ffname = (char_u *)".";
3178 else
3179 # endif
3181 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3182 NULL, NULL, NULL, curbuf);
3183 if (browse_file == NULL)
3184 goto theend;
3185 ffname = browse_file;
3188 #endif
3189 /* if no short name given, use ffname for short name */
3190 if (sfname == NULL)
3191 sfname = ffname;
3192 #ifdef USE_FNAME_CASE
3193 # ifdef USE_LONG_FNAME
3194 if (USE_LONG_FNAME)
3195 # endif
3196 if (sfname != NULL)
3197 fname_case(sfname, 0); /* set correct case for sfname */
3198 #endif
3200 #ifdef FEAT_LISTCMDS
3201 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3202 goto theend;
3203 #endif
3205 if (ffname == NULL)
3206 other_file = TRUE;
3207 /* there is no file name */
3208 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3209 other_file = FALSE;
3210 else
3212 if (*ffname == NUL) /* re-edit with same file name */
3214 ffname = curbuf->b_ffname;
3215 sfname = curbuf->b_fname;
3217 free_fname = fix_fname(ffname); /* may expand to full path name */
3218 if (free_fname != NULL)
3219 ffname = free_fname;
3220 other_file = otherfile(ffname);
3221 #ifdef FEAT_SUN_WORKSHOP
3222 if (usingSunWorkShop && p_acd
3223 && (cp = vim_strrchr(sfname, '/')) != NULL)
3224 sfname = ++cp;
3225 #endif
3230 * if the file was changed we may not be allowed to abandon it
3231 * - if we are going to re-edit the same file
3232 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3234 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3235 || (curbuf->b_nwindows == 1
3236 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3237 && check_changed(curbuf, p_awa, !other_file,
3238 (flags & ECMD_FORCEIT), FALSE))
3240 if (fnum == 0 && other_file && ffname != NULL)
3241 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3242 goto theend;
3245 #ifdef FEAT_VISUAL
3247 * End Visual mode before switching to another buffer, so the text can be
3248 * copied into the GUI selection buffer.
3250 reset_VIsual();
3251 #endif
3253 #ifdef FEAT_AUTOCMD
3254 if ((command != NULL || newlnum > (linenr_T)0)
3255 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3257 int len;
3258 char_u *p;
3260 /* Set v:swapcommand for the SwapExists autocommands. */
3261 if (command != NULL)
3262 len = (int)STRLEN(command) + 3;
3263 else
3264 len = 30;
3265 p = alloc((unsigned)len);
3266 if (p != NULL)
3268 if (command != NULL)
3269 vim_snprintf((char *)p, len, ":%s\r", command);
3270 else
3271 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3272 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3273 did_set_swapcommand = TRUE;
3274 vim_free(p);
3277 #endif
3280 * If we are starting to edit another file, open a (new) buffer.
3281 * Otherwise we re-use the current buffer.
3283 if (other_file)
3285 #ifdef FEAT_LISTCMDS
3286 if (!(flags & ECMD_ADDBUF))
3287 #endif
3289 if (!cmdmod.keepalt)
3290 curwin->w_alt_fnum = curbuf->b_fnum;
3291 if (oldwin != NULL)
3292 buflist_altfpos(oldwin);
3295 if (fnum)
3296 buf = buflist_findnr(fnum);
3297 else
3299 #ifdef FEAT_LISTCMDS
3300 if (flags & ECMD_ADDBUF)
3302 linenr_T tlnum = 1L;
3304 if (command != NULL)
3306 tlnum = atol((char *)command);
3307 if (tlnum <= 0)
3308 tlnum = 1L;
3310 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3311 goto theend;
3313 #endif
3314 buf = buflist_new(ffname, sfname, 0L,
3315 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3317 if (buf == NULL)
3318 goto theend;
3319 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3321 oldbuf = FALSE;
3322 buf->b_nwindows = 0;
3324 else /* existing memfile */
3326 oldbuf = TRUE;
3327 (void)buf_check_timestamp(buf, FALSE);
3328 /* Check if autocommands made buffer invalid or changed the current
3329 * buffer. */
3330 if (!buf_valid(buf)
3331 #ifdef FEAT_AUTOCMD
3332 || curbuf != old_curbuf
3333 #endif
3335 goto theend;
3336 #ifdef FEAT_EVAL
3337 if (aborting()) /* autocmds may abort script processing */
3338 goto theend;
3339 #endif
3342 /* May jump to last used line number for a loaded buffer or when asked
3343 * for explicitly */
3344 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3346 pos = buflist_findfpos(buf);
3347 newlnum = pos->lnum;
3348 solcol = pos->col;
3352 * Make the (new) buffer the one used by the current window.
3353 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3354 * If the current buffer was empty and has no file name, curbuf
3355 * is returned by buflist_new().
3357 if (buf != curbuf)
3359 #ifdef FEAT_AUTOCMD
3361 * Be careful: The autocommands may delete any buffer and change
3362 * the current buffer.
3363 * - If the buffer we are going to edit is deleted, give up.
3364 * - If the current buffer is deleted, prefer to load the new
3365 * buffer when loading a buffer is required. This avoids
3366 * loading another buffer which then must be closed again.
3367 * - If we ended up in the new buffer already, need to skip a few
3368 * things, set auto_buf.
3370 if (buf->b_fname != NULL)
3371 new_name = vim_strsave(buf->b_fname);
3372 au_new_curbuf = buf;
3373 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3374 if (!buf_valid(buf)) /* new buffer has been deleted */
3376 delbuf_msg(new_name); /* frees new_name */
3377 goto theend;
3379 # ifdef FEAT_EVAL
3380 if (aborting()) /* autocmds may abort script processing */
3382 vim_free(new_name);
3383 goto theend;
3385 # endif
3386 if (buf == curbuf) /* already in new buffer */
3387 auto_buf = TRUE;
3388 else
3390 if (curbuf == old_curbuf)
3391 #endif
3392 buf_copy_options(buf, BCO_ENTER);
3394 /* close the link to the current buffer */
3395 u_sync(FALSE);
3396 close_buffer(oldwin, curbuf,
3397 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3399 #ifdef FEAT_AUTOCMD
3400 # ifdef FEAT_EVAL
3401 if (aborting()) /* autocmds may abort script processing */
3403 vim_free(new_name);
3404 goto theend;
3406 # endif
3407 /* Be careful again, like above. */
3408 if (!buf_valid(buf)) /* new buffer has been deleted */
3410 delbuf_msg(new_name); /* frees new_name */
3411 goto theend;
3413 if (buf == curbuf) /* already in new buffer */
3414 auto_buf = TRUE;
3415 else
3416 #endif
3418 curwin->w_buffer = buf;
3419 curbuf = buf;
3420 ++curbuf->b_nwindows;
3421 /* set 'fileformat' */
3422 if (*p_ffs && !oldbuf)
3423 set_fileformat(default_fileformat(), OPT_LOCAL);
3426 /* May get the window options from the last time this buffer
3427 * was in this window (or another window). If not used
3428 * before, reset the local window options to the global
3429 * values. Also restores old folding stuff. */
3430 get_winopts(curbuf);
3431 #ifdef FEAT_SPELL
3432 did_get_winopts = TRUE;
3433 #endif
3435 #ifdef FEAT_AUTOCMD
3437 vim_free(new_name);
3438 au_new_curbuf = NULL;
3439 #endif
3441 else
3442 ++curbuf->b_nwindows;
3444 curwin->w_pcmark.lnum = 1;
3445 curwin->w_pcmark.col = 0;
3447 else /* !other_file */
3449 if (
3450 #ifdef FEAT_LISTCMDS
3451 (flags & ECMD_ADDBUF) ||
3452 #endif
3453 check_fname() == FAIL)
3454 goto theend;
3455 oldbuf = (flags & ECMD_OLDBUF);
3458 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3460 char_u *p;
3462 curbuf->b_help = TRUE;
3463 #ifdef FEAT_QUICKFIX
3464 set_string_option_direct((char_u *)"buftype", -1,
3465 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3466 #endif
3469 * Always set these options after jumping to a help tag, because the
3470 * user may have an autocommand that gets in the way.
3471 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3472 * latin1 word characters (for translated help files).
3473 * Only set it when needed, buf_init_chartab() is some work.
3476 #ifdef EBCDIC
3477 (char_u *)"65-255,^*,^|,^\"";
3478 #else
3479 (char_u *)"!-~,^*,^|,^\",192-255";
3480 #endif
3481 if (STRCMP(curbuf->b_p_isk, p) != 0)
3483 set_string_option_direct((char_u *)"isk", -1, p,
3484 OPT_FREE|OPT_LOCAL, 0);
3485 check_buf_options(curbuf);
3486 (void)buf_init_chartab(curbuf, FALSE);
3489 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3490 curwin->w_p_list = FALSE; /* no list mode */
3492 curbuf->b_p_ma = FALSE; /* not modifiable */
3493 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3494 curwin->w_p_nu = 0; /* no line numbers */
3495 #ifdef FEAT_SCROLLBIND
3496 curwin->w_p_scb = FALSE; /* no scroll binding */
3497 #endif
3498 #ifdef FEAT_ARABIC
3499 curwin->w_p_arab = FALSE; /* no arabic mode */
3500 #endif
3501 #ifdef FEAT_RIGHTLEFT
3502 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3503 #endif
3504 #ifdef FEAT_FOLDING
3505 curwin->w_p_fen = FALSE; /* No folding in the help window */
3506 #endif
3507 #ifdef FEAT_DIFF
3508 curwin->w_p_diff = FALSE; /* No 'diff' */
3509 #endif
3510 #ifdef FEAT_SPELL
3511 curwin->w_p_spell = FALSE; /* No spell checking */
3512 #endif
3514 #ifdef FEAT_AUTOCMD
3515 buf = curbuf;
3516 #endif
3517 set_buflisted(FALSE);
3519 else
3521 #ifdef FEAT_AUTOCMD
3522 buf = curbuf;
3523 #endif
3524 /* Don't make a buffer listed if it's a help buffer. Useful when
3525 * using CTRL-O to go back to a help file. */
3526 if (!curbuf->b_help)
3527 set_buflisted(TRUE);
3530 #ifdef FEAT_AUTOCMD
3531 /* If autocommands change buffers under our fingers, forget about
3532 * editing the file. */
3533 if (buf != curbuf)
3534 goto theend;
3535 # ifdef FEAT_EVAL
3536 if (aborting()) /* autocmds may abort script processing */
3537 goto theend;
3538 # endif
3540 /* Since we are starting to edit a file, consider the filetype to be
3541 * unset. Helps for when an autocommand changes files and expects syntax
3542 * highlighting to work in the other file. */
3543 did_filetype = FALSE;
3544 #endif
3547 * other_file oldbuf
3548 * FALSE FALSE re-edit same file, buffer is re-used
3549 * FALSE TRUE re-edit same file, nothing changes
3550 * TRUE FALSE start editing new file, new buffer
3551 * TRUE TRUE start editing in existing buffer (nothing to do)
3553 if (!other_file && !oldbuf) /* re-use the buffer */
3555 set_last_cursor(curwin); /* may set b_last_cursor */
3556 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3558 newlnum = curwin->w_cursor.lnum;
3559 solcol = curwin->w_cursor.col;
3561 #ifdef FEAT_AUTOCMD
3562 buf = curbuf;
3563 if (buf->b_fname != NULL)
3564 new_name = vim_strsave(buf->b_fname);
3565 else
3566 new_name = NULL;
3567 #endif
3568 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3569 #ifdef FEAT_AUTOCMD
3570 /* If autocommands deleted the buffer we were going to re-edit, give
3571 * up and jump to the end. */
3572 if (!buf_valid(buf))
3574 delbuf_msg(new_name); /* frees new_name */
3575 goto theend;
3577 vim_free(new_name);
3579 /* If autocommands change buffers under our fingers, forget about
3580 * re-editing the file. Should do the buf_clear_file(), but perhaps
3581 * the autocommands changed the buffer... */
3582 if (buf != curbuf)
3583 goto theend;
3584 # ifdef FEAT_EVAL
3585 if (aborting()) /* autocmds may abort script processing */
3586 goto theend;
3587 # endif
3588 #endif
3589 buf_clear_file(curbuf);
3590 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3591 curbuf->b_op_end.lnum = 0;
3595 * If we get here we are sure to start editing
3597 /* don't redraw until the cursor is in the right line */
3598 ++RedrawingDisabled;
3600 /* Assume success now */
3601 retval = OK;
3604 * Reset cursor position, could be used by autocommands.
3606 check_cursor();
3609 * Check if we are editing the w_arg_idx file in the argument list.
3611 check_arg_idx(curwin);
3613 #ifdef FEAT_AUTOCMD
3614 if (!auto_buf)
3615 #endif
3618 * Set cursor and init window before reading the file and executing
3619 * autocommands. This allows for the autocommands to position the
3620 * cursor.
3622 curwin_init();
3624 #ifdef FEAT_FOLDING
3625 /* It's possible that all lines in the buffer changed. Need to update
3626 * automatic folding for all windows where it's used. */
3627 # ifdef FEAT_WINDOWS
3629 win_T *win;
3630 tabpage_T *tp;
3632 FOR_ALL_TAB_WINDOWS(tp, win)
3633 if (win->w_buffer == curbuf)
3634 foldUpdateAll(win);
3636 # else
3637 foldUpdateAll(curwin);
3638 # endif
3639 #endif
3641 /* Change directories when the 'acd' option is set. */
3642 DO_AUTOCHDIR
3645 * Careful: open_buffer() and apply_autocmds() may change the current
3646 * buffer and window.
3648 lnum = curwin->w_cursor.lnum;
3649 topline = curwin->w_topline;
3650 if (!oldbuf) /* need to read the file */
3652 #if defined(HAS_SWAP_EXISTS_ACTION)
3653 swap_exists_action = SEA_DIALOG;
3654 #endif
3655 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3658 * Open the buffer and read the file.
3660 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3661 if (should_abort(open_buffer(FALSE, eap)))
3662 retval = FAIL;
3663 #else
3664 (void)open_buffer(FALSE, eap);
3665 #endif
3667 #if defined(HAS_SWAP_EXISTS_ACTION)
3668 if (swap_exists_action == SEA_QUIT)
3669 retval = FAIL;
3670 handle_swap_exists(old_curbuf);
3671 #endif
3673 #ifdef FEAT_AUTOCMD
3674 else
3676 /* Read the modelines, but only to set window-local options. Any
3677 * buffer-local options have already been set and may have been
3678 * changed by the user. */
3679 do_modelines(OPT_WINONLY);
3681 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3682 &retval);
3683 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3684 &retval);
3686 check_arg_idx(curwin);
3687 #endif
3690 * If autocommands change the cursor position or topline, we should
3691 * keep it.
3693 if (curwin->w_cursor.lnum != lnum)
3695 newlnum = curwin->w_cursor.lnum;
3696 newcol = curwin->w_cursor.col;
3698 if (curwin->w_topline == topline)
3699 topline = 0;
3701 /* Even when cursor didn't move we need to recompute topline. */
3702 changed_line_abv_curs();
3704 #ifdef FEAT_TITLE
3705 maketitle();
3706 #endif
3709 #ifdef FEAT_DIFF
3710 /* Tell the diff stuff that this buffer is new and/or needs updating.
3711 * Also needed when re-editing the same buffer, because unloading will
3712 * have removed it as a diff buffer. */
3713 if (curwin->w_p_diff)
3715 diff_buf_add(curbuf);
3716 diff_invalidate(curbuf);
3718 #endif
3720 #ifdef FEAT_SPELL
3721 /* If the window options were changed may need to set the spell language.
3722 * Can only do this after the buffer has been properly setup. */
3723 if (did_get_winopts && curwin->w_p_spell && *curbuf->b_p_spl != NUL)
3724 (void)did_set_spelllang(curbuf);
3725 #endif
3727 if (command == NULL)
3729 if (newcol >= 0) /* position set by autocommands */
3731 curwin->w_cursor.lnum = newlnum;
3732 curwin->w_cursor.col = newcol;
3733 check_cursor();
3735 else if (newlnum > 0) /* line number from caller or old position */
3737 curwin->w_cursor.lnum = newlnum;
3738 check_cursor_lnum();
3739 if (solcol >= 0 && !p_sol)
3741 /* 'sol' is off: Use last known column. */
3742 curwin->w_cursor.col = solcol;
3743 check_cursor_col();
3744 #ifdef FEAT_VIRTUALEDIT
3745 curwin->w_cursor.coladd = 0;
3746 #endif
3747 curwin->w_set_curswant = TRUE;
3749 else
3750 beginline(BL_SOL | BL_FIX);
3752 else /* no line number, go to last line in Ex mode */
3754 if (exmode_active)
3755 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3756 beginline(BL_WHITE | BL_FIX);
3760 #ifdef FEAT_WINDOWS
3761 /* Check if cursors in other windows on the same buffer are still valid */
3762 check_lnums(FALSE);
3763 #endif
3766 * Did not read the file, need to show some info about the file.
3767 * Do this after setting the cursor.
3769 if (oldbuf
3770 #ifdef FEAT_AUTOCMD
3771 && !auto_buf
3772 #endif
3775 int msg_scroll_save = msg_scroll;
3777 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3778 * message. */
3779 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3780 msg_scroll = FALSE;
3781 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3782 check_for_delay(FALSE);
3783 msg_start();
3784 msg_scroll = msg_scroll_save;
3785 msg_scrolled_ign = TRUE;
3787 fileinfo(FALSE, TRUE, FALSE);
3789 msg_scrolled_ign = FALSE;
3792 if (command != NULL)
3793 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3795 #ifdef FEAT_KEYMAP
3796 if (curbuf->b_kmap_state & KEYMAP_INIT)
3797 (void)keymap_init();
3798 #endif
3800 --RedrawingDisabled;
3801 if (!skip_redraw)
3803 n = p_so;
3804 if (topline == 0 && command == NULL)
3805 p_so = 999; /* force cursor halfway the window */
3806 update_topline();
3807 #ifdef FEAT_SCROLLBIND
3808 curwin->w_scbind_pos = curwin->w_topline;
3809 #endif
3810 p_so = n;
3811 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3814 if (p_im)
3815 need_start_insertmode = TRUE;
3817 /* Change directories when the 'acd' option is set. */
3818 DO_AUTOCHDIR
3820 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3821 if (gui.in_use && curbuf->b_ffname != NULL)
3823 # ifdef FEAT_SUN_WORKSHOP
3824 if (usingSunWorkShop)
3825 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3826 # endif
3827 # ifdef FEAT_NETBEANS_INTG
3828 if (usingNetbeans && ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3829 netbeans_file_opened(curbuf);
3830 # endif
3832 #endif
3834 theend:
3835 #ifdef FEAT_AUTOCMD
3836 if (did_set_swapcommand)
3837 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3838 #endif
3839 #ifdef FEAT_BROWSE
3840 vim_free(browse_file);
3841 #endif
3842 vim_free(free_fname);
3843 return retval;
3846 #ifdef FEAT_AUTOCMD
3847 static void
3848 delbuf_msg(name)
3849 char_u *name;
3851 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3852 name == NULL ? (char_u *)"" : name);
3853 vim_free(name);
3854 au_new_curbuf = NULL;
3856 #endif
3858 static int append_indent = 0; /* autoindent for first line */
3861 * ":insert" and ":append", also used by ":change"
3863 void
3864 ex_append(eap)
3865 exarg_T *eap;
3867 char_u *theline;
3868 int did_undo = FALSE;
3869 linenr_T lnum = eap->line2;
3870 int indent = 0;
3871 char_u *p;
3872 int vcol;
3873 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3875 /* the ! flag toggles autoindent */
3876 if (eap->forceit)
3877 curbuf->b_p_ai = !curbuf->b_p_ai;
3879 /* First autoindent comes from the line we start on */
3880 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3881 append_indent = get_indent_lnum(lnum);
3883 if (eap->cmdidx != CMD_append)
3884 --lnum;
3886 /* when the buffer is empty append to line 0 and delete the dummy line */
3887 if (empty && lnum == 1)
3888 lnum = 0;
3890 State = INSERT; /* behave like in Insert mode */
3891 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3892 State |= LANGMAP;
3894 for (;;)
3896 msg_scroll = TRUE;
3897 need_wait_return = FALSE;
3898 if (curbuf->b_p_ai)
3900 if (append_indent >= 0)
3902 indent = append_indent;
3903 append_indent = -1;
3905 else if (lnum > 0)
3906 indent = get_indent_lnum(lnum);
3908 ex_keep_indent = FALSE;
3909 if (eap->getline == NULL)
3911 /* No getline() function, use the lines that follow. This ends
3912 * when there is no more. */
3913 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3914 break;
3915 p = vim_strchr(eap->nextcmd, NL);
3916 if (p == NULL)
3917 p = eap->nextcmd + STRLEN(eap->nextcmd);
3918 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3919 if (*p != NUL)
3920 ++p;
3921 eap->nextcmd = p;
3923 else
3924 theline = eap->getline(
3925 #ifdef FEAT_EVAL
3926 eap->cstack->cs_looplevel > 0 ? -1 :
3927 #endif
3928 NUL, eap->cookie, indent);
3929 lines_left = Rows - 1;
3930 if (theline == NULL)
3931 break;
3933 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3934 if (ex_keep_indent)
3935 append_indent = indent;
3937 /* Look for the "." after automatic indent. */
3938 vcol = 0;
3939 for (p = theline; indent > vcol; ++p)
3941 if (*p == ' ')
3942 ++vcol;
3943 else if (*p == TAB)
3944 vcol += 8 - vcol % 8;
3945 else
3946 break;
3948 if ((p[0] == '.' && p[1] == NUL)
3949 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3950 == FAIL))
3952 vim_free(theline);
3953 break;
3956 /* don't use autoindent if nothing was typed. */
3957 if (p[0] == NUL)
3958 theline[0] = NUL;
3960 did_undo = TRUE;
3961 ml_append(lnum, theline, (colnr_T)0, FALSE);
3962 appended_lines_mark(lnum, 1L);
3964 vim_free(theline);
3965 ++lnum;
3967 if (empty)
3969 ml_delete(2L, FALSE);
3970 empty = FALSE;
3973 State = NORMAL;
3975 if (eap->forceit)
3976 curbuf->b_p_ai = !curbuf->b_p_ai;
3978 /* "start" is set to eap->line2+1 unless that position is invalid (when
3979 * eap->line2 pointed to the end of the buffer and nothing was appended)
3980 * "end" is set to lnum when something has been appended, otherwise
3981 * it is the same than "start" -- Acevedo */
3982 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3983 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3984 if (eap->cmdidx != CMD_append)
3985 --curbuf->b_op_start.lnum;
3986 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3987 ? lnum : curbuf->b_op_start.lnum;
3988 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3989 curwin->w_cursor.lnum = lnum;
3990 check_cursor_lnum();
3991 beginline(BL_SOL | BL_FIX);
3993 need_wait_return = FALSE; /* don't use wait_return() now */
3994 ex_no_reprint = TRUE;
3998 * ":change"
4000 void
4001 ex_change(eap)
4002 exarg_T *eap;
4004 linenr_T lnum;
4006 if (eap->line2 >= eap->line1
4007 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
4008 return;
4010 /* the ! flag toggles autoindent */
4011 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
4012 append_indent = get_indent_lnum(eap->line1);
4014 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
4016 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
4017 break;
4018 ml_delete(eap->line1, FALSE);
4020 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
4022 /* ":append" on the line above the deleted lines. */
4023 eap->line2 = eap->line1;
4024 ex_append(eap);
4027 void
4028 ex_z(eap)
4029 exarg_T *eap;
4031 char_u *x;
4032 int bigness;
4033 char_u *kind;
4034 int minus = 0;
4035 linenr_T start, end, curs, i;
4036 int j;
4037 linenr_T lnum = eap->line2;
4039 /* Vi compatible: ":z!" uses display height, without a count uses
4040 * 'scroll' */
4041 if (eap->forceit)
4042 bigness = curwin->w_height;
4043 else if (firstwin == lastwin)
4044 bigness = curwin->w_p_scr * 2;
4045 else
4046 bigness = curwin->w_height - 3;
4047 if (bigness < 1)
4048 bigness = 1;
4050 x = eap->arg;
4051 kind = x;
4052 if (*kind == '-' || *kind == '+' || *kind == '='
4053 || *kind == '^' || *kind == '.')
4054 ++x;
4055 while (*x == '-' || *x == '+')
4056 ++x;
4058 if (*x != 0)
4060 if (!VIM_ISDIGIT(*x))
4062 EMSG(_("E144: non-numeric argument to :z"));
4063 return;
4065 else
4067 bigness = atoi((char *)x);
4068 p_window = bigness;
4069 if (*kind == '=')
4070 bigness += 2;
4074 /* the number of '-' and '+' multiplies the distance */
4075 if (*kind == '-' || *kind == '+')
4076 for (x = kind + 1; *x == *kind; ++x)
4079 switch (*kind)
4081 case '-':
4082 start = lnum - bigness * (linenr_T)(x - kind);
4083 end = start + bigness;
4084 curs = end;
4085 break;
4087 case '=':
4088 start = lnum - (bigness + 1) / 2 + 1;
4089 end = lnum + (bigness + 1) / 2 - 1;
4090 curs = lnum;
4091 minus = 1;
4092 break;
4094 case '^':
4095 start = lnum - bigness * 2;
4096 end = lnum - bigness;
4097 curs = lnum - bigness;
4098 break;
4100 case '.':
4101 start = lnum - (bigness + 1) / 2 + 1;
4102 end = lnum + (bigness + 1) / 2 - 1;
4103 curs = end;
4104 break;
4106 default: /* '+' */
4107 start = lnum;
4108 if (*kind == '+')
4109 start += bigness * (linenr_T)(x - kind - 1) + 1;
4110 else if (eap->addr_count == 0)
4111 ++start;
4112 end = start + bigness - 1;
4113 curs = end;
4114 break;
4117 if (start < 1)
4118 start = 1;
4120 if (end > curbuf->b_ml.ml_line_count)
4121 end = curbuf->b_ml.ml_line_count;
4123 if (curs > curbuf->b_ml.ml_line_count)
4124 curs = curbuf->b_ml.ml_line_count;
4126 for (i = start; i <= end; i++)
4128 if (minus && i == lnum)
4130 msg_putchar('\n');
4132 for (j = 1; j < Columns; j++)
4133 msg_putchar('-');
4136 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4138 if (minus && i == lnum)
4140 msg_putchar('\n');
4142 for (j = 1; j < Columns; j++)
4143 msg_putchar('-');
4147 curwin->w_cursor.lnum = curs;
4148 ex_no_reprint = TRUE;
4152 * Check if the restricted flag is set.
4153 * If so, give an error message and return TRUE.
4154 * Otherwise, return FALSE.
4157 check_restricted()
4159 if (restricted)
4161 EMSG(_("E145: Shell commands not allowed in rvim"));
4162 return TRUE;
4164 return FALSE;
4168 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4169 * If so, give an error message and return TRUE.
4170 * Otherwise, return FALSE.
4173 check_secure()
4175 if (secure)
4177 secure = 2;
4178 EMSG(_(e_curdir));
4179 return TRUE;
4181 #ifdef HAVE_SANDBOX
4183 * In the sandbox more things are not allowed, including the things
4184 * disallowed in secure mode.
4186 if (sandbox != 0)
4188 EMSG(_(e_sandbox));
4189 return TRUE;
4191 #endif
4192 return FALSE;
4195 static char_u *old_sub = NULL; /* previous substitute pattern */
4196 static int global_need_beginline; /* call beginline() after ":g" */
4198 /* do_sub()
4200 * Perform a substitution from line eap->line1 to line eap->line2 using the
4201 * command pointed to by eap->arg which should be of the form:
4203 * /pattern/substitution/{flags}
4205 * The usual escapes are supported as described in the regexp docs.
4207 void
4208 do_sub(eap)
4209 exarg_T *eap;
4211 linenr_T lnum;
4212 long i = 0;
4213 regmmatch_T regmatch;
4214 static int do_all = FALSE; /* do multiple substitutions per line */
4215 static int do_ask = FALSE; /* ask for confirmation */
4216 static int do_count = FALSE; /* count only */
4217 static int do_error = TRUE; /* if false, ignore errors */
4218 static int do_print = FALSE; /* print last line with subs. */
4219 static int do_list = FALSE; /* list last line with subs. */
4220 static int do_number = FALSE; /* list last line with line nr*/
4221 static int do_ic = 0; /* ignore case flag */
4222 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4223 int delimiter;
4224 int sublen;
4225 int got_quit = FALSE;
4226 int got_match = FALSE;
4227 int temp;
4228 int which_pat;
4229 char_u *cmd;
4230 int save_State;
4231 linenr_T first_line = 0; /* first changed line */
4232 linenr_T last_line= 0; /* below last changed line AFTER the
4233 * change */
4234 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4235 linenr_T line2;
4236 long nmatch; /* number of lines in match */
4237 char_u *sub_firstline; /* allocated copy of first sub line */
4238 int endcolumn = FALSE; /* cursor in last column when done */
4239 pos_T old_cursor = curwin->w_cursor;
4241 cmd = eap->arg;
4242 if (!global_busy)
4244 sub_nsubs = 0;
4245 sub_nlines = 0;
4248 if (eap->cmdidx == CMD_tilde)
4249 which_pat = RE_LAST; /* use last used regexp */
4250 else
4251 which_pat = RE_SUBST; /* use last substitute regexp */
4253 /* new pattern and substitution */
4254 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4255 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4257 /* don't accept alphanumeric for separator */
4258 if (isalpha(*cmd))
4260 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4261 return;
4264 * undocumented vi feature:
4265 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4266 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4268 if (*cmd == '\\')
4270 ++cmd;
4271 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4273 EMSG(_(e_backslash));
4274 return;
4276 if (*cmd != '&')
4277 which_pat = RE_SEARCH; /* use last '/' pattern */
4278 pat = (char_u *)""; /* empty search pattern */
4279 delimiter = *cmd++; /* remember delimiter character */
4281 else /* find the end of the regexp */
4283 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4284 if (p_altkeymap && curwin->w_p_rl)
4285 lrF_sub(cmd);
4286 #endif
4287 which_pat = RE_LAST; /* use last used regexp */
4288 delimiter = *cmd++; /* remember delimiter character */
4289 pat = cmd; /* remember start of search pat */
4290 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4291 if (cmd[0] == delimiter) /* end delimiter found */
4292 *cmd++ = NUL; /* replace it with a NUL */
4296 * Small incompatibility: vi sees '\n' as end of the command, but in
4297 * Vim we want to use '\n' to find/substitute a NUL.
4299 sub = cmd; /* remember the start of the substitution */
4301 while (cmd[0])
4303 if (cmd[0] == delimiter) /* end delimiter found */
4305 *cmd++ = NUL; /* replace it with a NUL */
4306 break;
4308 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4309 ++cmd;
4310 mb_ptr_adv(cmd);
4313 if (!eap->skip)
4315 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4316 if (STRCMP(sub, "%") == 0
4317 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4319 if (old_sub == NULL) /* there is no previous command */
4321 EMSG(_(e_nopresub));
4322 return;
4324 sub = old_sub;
4326 else
4328 vim_free(old_sub);
4329 old_sub = vim_strsave(sub);
4333 else if (!eap->skip) /* use previous pattern and substitution */
4335 if (old_sub == NULL) /* there is no previous command */
4337 EMSG(_(e_nopresub));
4338 return;
4340 pat = NULL; /* search_regcomp() will use previous pattern */
4341 sub = old_sub;
4343 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4344 * last column after using "$". */
4345 endcolumn = (curwin->w_curswant == MAXCOL);
4349 * Find trailing options. When '&' is used, keep old options.
4351 if (*cmd == '&')
4352 ++cmd;
4353 else
4355 if (!p_ed)
4357 if (p_gd) /* default is global on */
4358 do_all = TRUE;
4359 else
4360 do_all = FALSE;
4361 do_ask = FALSE;
4363 do_error = TRUE;
4364 do_print = FALSE;
4365 do_count = FALSE;
4366 do_number = FALSE;
4367 do_ic = 0;
4369 while (*cmd)
4372 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4373 * 'r' is never inverted.
4375 if (*cmd == 'g')
4376 do_all = !do_all;
4377 else if (*cmd == 'c')
4378 do_ask = !do_ask;
4379 else if (*cmd == 'n')
4380 do_count = TRUE;
4381 else if (*cmd == 'e')
4382 do_error = !do_error;
4383 else if (*cmd == 'r') /* use last used regexp */
4384 which_pat = RE_LAST;
4385 else if (*cmd == 'p')
4386 do_print = TRUE;
4387 else if (*cmd == '#')
4389 do_print = TRUE;
4390 do_number = TRUE;
4392 else if (*cmd == 'l')
4394 do_print = TRUE;
4395 do_list = TRUE;
4397 else if (*cmd == 'i') /* ignore case */
4398 do_ic = 'i';
4399 else if (*cmd == 'I') /* don't ignore case */
4400 do_ic = 'I';
4401 else
4402 break;
4403 ++cmd;
4405 if (do_count)
4406 do_ask = FALSE;
4409 * check for a trailing count
4411 cmd = skipwhite(cmd);
4412 if (VIM_ISDIGIT(*cmd))
4414 i = getdigits(&cmd);
4415 if (i <= 0 && !eap->skip && do_error)
4417 EMSG(_(e_zerocount));
4418 return;
4420 eap->line1 = eap->line2;
4421 eap->line2 += i - 1;
4422 if (eap->line2 > curbuf->b_ml.ml_line_count)
4423 eap->line2 = curbuf->b_ml.ml_line_count;
4427 * check for trailing command or garbage
4429 cmd = skipwhite(cmd);
4430 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4432 eap->nextcmd = check_nextcmd(cmd);
4433 if (eap->nextcmd == NULL)
4435 EMSG(_(e_trailing));
4436 return;
4440 if (eap->skip) /* not executing commands, only parsing */
4441 return;
4443 if (!do_count && !curbuf->b_p_ma)
4445 /* Substitution is not allowed in non-'modifiable' buffer */
4446 EMSG(_(e_modifiable));
4447 return;
4450 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4452 if (do_error)
4453 EMSG(_(e_invcmd));
4454 return;
4457 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4458 if (do_ic == 'i')
4459 regmatch.rmm_ic = TRUE;
4460 else if (do_ic == 'I')
4461 regmatch.rmm_ic = FALSE;
4463 sub_firstline = NULL;
4466 * ~ in the substitute pattern is replaced with the old pattern.
4467 * We do it here once to avoid it to be replaced over and over again.
4468 * But don't do it when it starts with "\=", then it's an expression.
4470 if (!(sub[0] == '\\' && sub[1] == '='))
4471 sub = regtilde(sub, p_magic);
4474 * Check for a match on each line.
4476 line2 = eap->line2;
4477 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4478 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4479 || aborting()
4480 #endif
4481 ); ++lnum)
4483 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
4484 (colnr_T)0, NULL);
4485 if (nmatch)
4487 colnr_T copycol;
4488 colnr_T matchcol;
4489 colnr_T prev_matchcol = MAXCOL;
4490 char_u *new_end, *new_start = NULL;
4491 unsigned new_start_len = 0;
4492 char_u *p1;
4493 int did_sub = FALSE;
4494 int lastone;
4495 int len, copy_len, needed_len;
4496 long nmatch_tl = 0; /* nr of lines matched below lnum */
4497 int do_again; /* do it again after joining lines */
4498 int skip_match = FALSE;
4499 linenr_T sub_firstlnum; /* nr of first sub line */
4502 * The new text is build up step by step, to avoid too much
4503 * copying. There are these pieces:
4504 * sub_firstline The old text, unmodified.
4505 * copycol Column in the old text where we started
4506 * looking for a match; from here old text still
4507 * needs to be copied to the new text.
4508 * matchcol Column number of the old text where to look
4509 * for the next match. It's just after the
4510 * previous match or one further.
4511 * prev_matchcol Column just after the previous match (if any).
4512 * Mostly equal to matchcol, except for the first
4513 * match and after skipping an empty match.
4514 * regmatch.*pos Where the pattern matched in the old text.
4515 * new_start The new text, all that has been produced so
4516 * far.
4517 * new_end The new text, where to append new text.
4519 * lnum The line number where we found the start of
4520 * the match. Can be below the line we searched
4521 * when there is a \n before a \zs in the
4522 * pattern.
4523 * sub_firstlnum The line number in the buffer where to look
4524 * for a match. Can be different from "lnum"
4525 * when the pattern or substitute string contains
4526 * line breaks.
4528 * Special situations:
4529 * - When the substitute string contains a line break, the part up
4530 * to the line break is inserted in the text, but the copy of
4531 * the original line is kept. "sub_firstlnum" is adjusted for
4532 * the inserted lines.
4533 * - When the matched pattern contains a line break, the old line
4534 * is taken from the line at the end of the pattern. The lines
4535 * in the match are deleted later, "sub_firstlnum" is adjusted
4536 * accordingly.
4538 * The new text is built up in new_start[]. It has some extra
4539 * room to avoid using alloc()/free() too often. new_start_len is
4540 * the length of the allocated memory at new_start.
4542 * Make a copy of the old line, so it won't be taken away when
4543 * updating the screen or handling a multi-line match. The "old_"
4544 * pointers point into this copy.
4546 sub_firstlnum = lnum;
4547 copycol = 0;
4548 matchcol = 0;
4550 /* At first match, remember current cursor position. */
4551 if (!got_match)
4553 setpcmark();
4554 got_match = TRUE;
4558 * Loop until nothing more to replace in this line.
4559 * 1. Handle match with empty string.
4560 * 2. If do_ask is set, ask for confirmation.
4561 * 3. substitute the string.
4562 * 4. if do_all is set, find next match
4563 * 5. break if there isn't another match in this line
4565 for (;;)
4567 /* Advance "lnum" to the line where the match starts. The
4568 * match does not start in the first line when there is a line
4569 * break before \zs. */
4570 if (regmatch.startpos[0].lnum > 0)
4572 lnum += regmatch.startpos[0].lnum;
4573 sub_firstlnum += regmatch.startpos[0].lnum;
4574 nmatch -= regmatch.startpos[0].lnum;
4575 vim_free(sub_firstline);
4576 sub_firstline = NULL;
4579 if (sub_firstline == NULL)
4581 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4582 if (sub_firstline == NULL)
4584 vim_free(new_start);
4585 goto outofmem;
4589 /* Save the line number of the last change for the final
4590 * cursor position (just like Vi). */
4591 curwin->w_cursor.lnum = lnum;
4592 do_again = FALSE;
4595 * 1. Match empty string does not count, except for first
4596 * match. This reproduces the strange vi behaviour.
4597 * This also catches endless loops.
4599 if (matchcol == prev_matchcol
4600 && regmatch.endpos[0].lnum == 0
4601 && matchcol == regmatch.endpos[0].col)
4603 if (sub_firstline[matchcol] == NUL)
4604 /* We already were at the end of the line. Don't look
4605 * for a match in this line again. */
4606 skip_match = TRUE;
4607 else
4608 ++matchcol; /* search for a match at next column */
4609 goto skip;
4612 /* Normally we continue searching for a match just after the
4613 * previous match. */
4614 matchcol = regmatch.endpos[0].col;
4615 prev_matchcol = matchcol;
4618 * 2. If do_count is set only increase the counter.
4619 * If do_ask is set, ask for confirmation.
4621 if (do_count)
4623 /* For a multi-line match, put matchcol at the NUL at
4624 * the end of the line and set nmatch to one, so that
4625 * we continue looking for a match on the next line.
4626 * Avoids that ":s/\nB\@=//gc" get stuck. */
4627 if (nmatch > 1)
4629 matchcol = (colnr_T)STRLEN(sub_firstline);
4630 nmatch = 1;
4631 skip_match = TRUE;
4633 sub_nsubs++;
4634 did_sub = TRUE;
4635 goto skip;
4638 if (do_ask)
4640 int typed;
4642 /* change State to CONFIRM, so that the mouse works
4643 * properly */
4644 save_State = State;
4645 State = CONFIRM;
4646 #ifdef FEAT_MOUSE
4647 setmouse(); /* disable mouse in xterm */
4648 #endif
4649 curwin->w_cursor.col = regmatch.startpos[0].col;
4651 /* When 'cpoptions' contains "u" don't sync undo when
4652 * asking for confirmation. */
4653 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4654 ++no_u_sync;
4657 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4659 while (do_ask)
4661 if (exmode_active)
4663 char_u *resp;
4664 colnr_T sc, ec;
4666 print_line_no_prefix(lnum, FALSE, FALSE);
4668 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4669 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4670 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4671 msg_start();
4672 for (i = 0; i < (long)sc; ++i)
4673 msg_putchar(' ');
4674 for ( ; i <= (long)ec; ++i)
4675 msg_putchar('^');
4677 resp = getexmodeline('?', NULL, 0);
4678 if (resp != NULL)
4680 typed = *resp;
4681 vim_free(resp);
4684 else
4686 #ifdef FEAT_FOLDING
4687 int save_p_fen = curwin->w_p_fen;
4689 curwin->w_p_fen = FALSE;
4690 #endif
4691 /* Invert the matched string.
4692 * Remove the inversion afterwards. */
4693 temp = RedrawingDisabled;
4694 RedrawingDisabled = 0;
4696 search_match_lines = regmatch.endpos[0].lnum
4697 - regmatch.startpos[0].lnum;
4698 search_match_endcol = regmatch.endpos[0].col;
4699 highlight_match = TRUE;
4701 update_topline();
4702 validate_cursor();
4703 update_screen(SOME_VALID);
4704 highlight_match = FALSE;
4705 redraw_later(SOME_VALID);
4707 #ifdef FEAT_FOLDING
4708 curwin->w_p_fen = save_p_fen;
4709 #endif
4710 if (msg_row == Rows - 1)
4711 msg_didout = FALSE; /* avoid a scroll-up */
4712 msg_starthere();
4713 i = msg_scroll;
4714 msg_scroll = 0; /* truncate msg when
4715 needed */
4716 msg_no_more = TRUE;
4717 /* write message same highlighting as for
4718 * wait_return */
4719 smsg_attr(hl_attr(HLF_R),
4720 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4721 msg_no_more = FALSE;
4722 msg_scroll = i;
4723 showruler(TRUE);
4724 windgoto(msg_row, msg_col);
4725 RedrawingDisabled = temp;
4727 #ifdef USE_ON_FLY_SCROLL
4728 dont_scroll = FALSE; /* allow scrolling here */
4729 #endif
4730 ++no_mapping; /* don't map this key */
4731 ++allow_keys; /* allow special keys */
4732 typed = plain_vgetc();
4733 --allow_keys;
4734 --no_mapping;
4736 /* clear the question */
4737 msg_didout = FALSE; /* don't scroll up */
4738 msg_col = 0;
4739 gotocmdline(TRUE);
4742 need_wait_return = FALSE; /* no hit-return prompt */
4743 if (typed == 'q' || typed == ESC || typed == Ctrl_C
4744 #ifdef UNIX
4745 || typed == intr_char
4746 #endif
4749 got_quit = TRUE;
4750 break;
4752 if (typed == 'n')
4753 break;
4754 if (typed == 'y')
4755 break;
4756 if (typed == 'l')
4758 /* last: replace and then stop */
4759 do_all = FALSE;
4760 line2 = lnum;
4761 break;
4763 if (typed == 'a')
4765 do_ask = FALSE;
4766 break;
4768 #ifdef FEAT_INS_EXPAND
4769 if (typed == Ctrl_E)
4770 scrollup_clamp();
4771 else if (typed == Ctrl_Y)
4772 scrolldown_clamp();
4773 #endif
4775 State = save_State;
4776 #ifdef FEAT_MOUSE
4777 setmouse();
4778 #endif
4779 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4780 --no_u_sync;
4782 if (typed == 'n')
4784 /* For a multi-line match, put matchcol at the NUL at
4785 * the end of the line and set nmatch to one, so that
4786 * we continue looking for a match on the next line.
4787 * Avoids that ":%s/\nB\@=//gc" and ":%s/\n/,\r/gc"
4788 * get stuck when pressing 'n'. */
4789 if (nmatch > 1)
4791 matchcol = (colnr_T)STRLEN(sub_firstline);
4792 skip_match = TRUE;
4794 goto skip;
4796 if (got_quit)
4797 break;
4800 /* Move the cursor to the start of the match, so that we can
4801 * use "\=col("."). */
4802 curwin->w_cursor.col = regmatch.startpos[0].col;
4805 * 3. substitute the string.
4807 /* get length of substitution part */
4808 sublen = vim_regsub_multi(&regmatch,
4809 sub_firstlnum - regmatch.startpos[0].lnum,
4810 sub, sub_firstline, FALSE, p_magic, TRUE);
4812 /* When the match included the "$" of the last line it may
4813 * go beyond the last line of the buffer. */
4814 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4816 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4817 skip_match = TRUE;
4820 /* Need room for:
4821 * - result so far in new_start (not for first sub in line)
4822 * - original text up to match
4823 * - length of substituted part
4824 * - original text after match
4826 if (nmatch == 1)
4827 p1 = sub_firstline;
4828 else
4830 p1 = ml_get(sub_firstlnum + nmatch - 1);
4831 nmatch_tl += nmatch - 1;
4833 copy_len = regmatch.startpos[0].col - copycol;
4834 needed_len = copy_len + ((unsigned)STRLEN(p1)
4835 - regmatch.endpos[0].col) + sublen + 1;
4836 if (new_start == NULL)
4839 * Get some space for a temporary buffer to do the
4840 * substitution into (and some extra space to avoid
4841 * too many calls to alloc()/free()).
4843 new_start_len = needed_len + 50;
4844 if ((new_start = alloc_check(new_start_len)) == NULL)
4845 goto outofmem;
4846 *new_start = NUL;
4847 new_end = new_start;
4849 else
4852 * Check if the temporary buffer is long enough to do the
4853 * substitution into. If not, make it larger (with a bit
4854 * extra to avoid too many calls to alloc()/free()).
4856 len = (unsigned)STRLEN(new_start);
4857 needed_len += len;
4858 if (needed_len > (int)new_start_len)
4860 new_start_len = needed_len + 50;
4861 if ((p1 = alloc_check(new_start_len)) == NULL)
4863 vim_free(new_start);
4864 goto outofmem;
4866 mch_memmove(p1, new_start, (size_t)(len + 1));
4867 vim_free(new_start);
4868 new_start = p1;
4870 new_end = new_start + len;
4874 * copy the text up to the part that matched
4876 mch_memmove(new_end, sub_firstline + copycol, (size_t)copy_len);
4877 new_end += copy_len;
4879 (void)vim_regsub_multi(&regmatch,
4880 sub_firstlnum - regmatch.startpos[0].lnum,
4881 sub, new_end, TRUE, p_magic, TRUE);
4882 sub_nsubs++;
4883 did_sub = TRUE;
4885 /* Move the cursor to the start of the line, to avoid that it
4886 * is beyond the end of the line after the substitution. */
4887 curwin->w_cursor.col = 0;
4889 /* For a multi-line match, make a copy of the last matched
4890 * line and continue in that one. */
4891 if (nmatch > 1)
4893 sub_firstlnum += nmatch - 1;
4894 vim_free(sub_firstline);
4895 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4896 /* When going beyond the last line, stop substituting. */
4897 if (sub_firstlnum <= line2)
4898 do_again = TRUE;
4899 else
4900 do_all = FALSE;
4903 /* Remember next character to be copied. */
4904 copycol = regmatch.endpos[0].col;
4906 if (skip_match)
4908 /* Already hit end of the buffer, sub_firstlnum is one
4909 * less than what it ought to be. */
4910 vim_free(sub_firstline);
4911 sub_firstline = vim_strsave((char_u *)"");
4912 copycol = 0;
4916 * Now the trick is to replace CTRL-M chars with a real line
4917 * break. This would make it impossible to insert a CTRL-M in
4918 * the text. The line break can be avoided by preceding the
4919 * CTRL-M with a backslash. To be able to insert a backslash,
4920 * they must be doubled in the string and are halved here.
4921 * That is Vi compatible.
4923 for (p1 = new_end; *p1; ++p1)
4925 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4926 STRMOVE(p1, p1 + 1);
4927 else if (*p1 == CAR)
4929 if (u_inssub(lnum) == OK) /* prepare for undo */
4931 *p1 = NUL; /* truncate up to the CR */
4932 ml_append(lnum - 1, new_start,
4933 (colnr_T)(p1 - new_start + 1), FALSE);
4934 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4935 if (do_ask)
4936 appended_lines(lnum - 1, 1L);
4937 else
4939 if (first_line == 0)
4940 first_line = lnum;
4941 last_line = lnum + 1;
4943 /* All line numbers increase. */
4944 ++sub_firstlnum;
4945 ++lnum;
4946 ++line2;
4947 /* move the cursor to the new line, like Vi */
4948 ++curwin->w_cursor.lnum;
4949 /* copy the rest */
4950 STRMOVE(new_start, p1 + 1);
4951 p1 = new_start - 1;
4954 #ifdef FEAT_MBYTE
4955 else if (has_mbyte)
4956 p1 += (*mb_ptr2len)(p1) - 1;
4957 #endif
4961 * 4. If do_all is set, find next match.
4962 * Prevent endless loop with patterns that match empty
4963 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4964 * But ":s/\n/#/" is OK.
4966 skip:
4967 /* We already know that we did the last subst when we are at
4968 * the end of the line, except that a pattern like
4969 * "bar\|\nfoo" may match at the NUL. "lnum" can be below
4970 * "line2" when there is a \zs in the pattern after a line
4971 * break. */
4972 lastone = (skip_match
4973 || got_int
4974 || got_quit
4975 || lnum > line2
4976 || !(do_all || do_again)
4977 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4978 && !re_multiline(regmatch.regprog)));
4979 nmatch = -1;
4982 * Replace the line in the buffer when needed. This is
4983 * skipped when there are more matches.
4984 * The check for nmatch_tl is needed for when multi-line
4985 * matching must replace the lines before trying to do another
4986 * match, otherwise "\@<=" won't work.
4987 * When asking the user we like to show the already replaced
4988 * text, but don't do it when "\<@=" or "\<@!" is used, it
4989 * changes what matches.
4990 * When the match starts below where we start searching also
4991 * need to replace the line first (using \zs after \n).
4993 if (lastone
4994 || (do_ask && !re_lookbehind(regmatch.regprog))
4995 || nmatch_tl > 0
4996 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4997 curbuf, sub_firstlnum,
4998 matchcol, NULL)) == 0
4999 || regmatch.startpos[0].lnum > 0)
5001 if (new_start != NULL)
5004 * Copy the rest of the line, that didn't match.
5005 * "matchcol" has to be adjusted, we use the end of
5006 * the line as reference, because the substitute may
5007 * have changed the number of characters. Same for
5008 * "prev_matchcol".
5010 STRCAT(new_start, sub_firstline + copycol);
5011 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5012 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5013 - prev_matchcol;
5015 if (u_savesub(lnum) != OK)
5016 break;
5017 ml_replace(lnum, new_start, TRUE);
5019 if (nmatch_tl > 0)
5022 * Matched lines have now been substituted and are
5023 * useless, delete them. The part after the match
5024 * has been appended to new_start, we don't need
5025 * it in the buffer.
5027 ++lnum;
5028 if (u_savedel(lnum, nmatch_tl) != OK)
5029 break;
5030 for (i = 0; i < nmatch_tl; ++i)
5031 ml_delete(lnum, (int)FALSE);
5032 mark_adjust(lnum, lnum + nmatch_tl - 1,
5033 (long)MAXLNUM, -nmatch_tl);
5034 if (do_ask)
5035 deleted_lines(lnum, nmatch_tl);
5036 --lnum;
5037 line2 -= nmatch_tl; /* nr of lines decreases */
5038 nmatch_tl = 0;
5041 /* When asking, undo is saved each time, must also set
5042 * changed flag each time. */
5043 if (do_ask)
5044 changed_bytes(lnum, 0);
5045 else
5047 if (first_line == 0)
5048 first_line = lnum;
5049 last_line = lnum + 1;
5052 sub_firstlnum = lnum;
5053 vim_free(sub_firstline); /* free the temp buffer */
5054 sub_firstline = new_start;
5055 new_start = NULL;
5056 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
5057 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
5058 - prev_matchcol;
5059 copycol = 0;
5061 if (nmatch == -1 && !lastone)
5062 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
5063 sub_firstlnum, matchcol, NULL);
5066 * 5. break if there isn't another match in this line
5068 if (nmatch <= 0)
5070 /* If the match found didn't start where we were
5071 * searching, do the next search in the line where we
5072 * found the match. */
5073 if (nmatch == -1)
5074 lnum -= regmatch.startpos[0].lnum;
5075 break;
5079 line_breakcheck();
5082 if (did_sub)
5083 ++sub_nlines;
5084 vim_free(new_start); /* for when substitute was cancelled */
5085 vim_free(sub_firstline); /* free the copy of the original line */
5086 sub_firstline = NULL;
5089 line_breakcheck();
5092 if (first_line != 0)
5094 /* Need to subtract the number of added lines from "last_line" to get
5095 * the line number before the change (same as adding the number of
5096 * deleted lines). */
5097 i = curbuf->b_ml.ml_line_count - old_line_count;
5098 changed_lines(first_line, 0, last_line - i, i);
5101 outofmem:
5102 vim_free(sub_firstline); /* may have to free allocated copy of the line */
5104 /* ":s/pat//n" doesn't move the cursor */
5105 if (do_count)
5106 curwin->w_cursor = old_cursor;
5108 if (sub_nsubs)
5110 /* Set the '[ and '] marks. */
5111 curbuf->b_op_start.lnum = eap->line1;
5112 curbuf->b_op_end.lnum = line2;
5113 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
5115 if (!global_busy)
5117 if (endcolumn)
5118 coladvance((colnr_T)MAXCOL);
5119 else
5120 beginline(BL_WHITE | BL_FIX);
5121 if (!do_sub_msg(do_count) && do_ask)
5122 MSG("");
5124 else
5125 global_need_beginline = TRUE;
5126 if (do_print)
5127 print_line(curwin->w_cursor.lnum, do_number, do_list);
5129 else if (!global_busy)
5131 if (got_int) /* interrupted */
5132 EMSG(_(e_interr));
5133 else if (got_match) /* did find something but nothing substituted */
5134 MSG("");
5135 else if (do_error) /* nothing found */
5136 EMSG2(_(e_patnotf2), get_search_pat());
5139 vim_free(regmatch.regprog);
5143 * Give message for number of substitutions.
5144 * Can also be used after a ":global" command.
5145 * Return TRUE if a message was given.
5148 do_sub_msg(count_only)
5149 int count_only; /* used 'n' flag for ":s" */
5151 int len = 0;
5154 * Only report substitutions when:
5155 * - more than 'report' substitutions
5156 * - command was typed by user, or number of changed lines > 'report'
5157 * - giving messages is not disabled by 'lazyredraw'
5159 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5160 || count_only)
5161 && messaging())
5163 if (got_int)
5165 STRCPY(msg_buf, _("(Interrupted) "));
5166 len = (int)STRLEN(msg_buf);
5168 if (sub_nsubs == 1)
5169 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5170 "%s", count_only ? _("1 match") : _("1 substitution"));
5171 else
5172 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5173 count_only ? _("%ld matches") : _("%ld substitutions"),
5174 sub_nsubs);
5175 len = (int)STRLEN(msg_buf);
5176 if (sub_nlines == 1)
5177 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5178 "%s", _(" on 1 line"));
5179 else
5180 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5181 _(" on %ld lines"), (long)sub_nlines);
5182 if (msg(msg_buf))
5183 /* save message to display it after redraw */
5184 set_keep_msg(msg_buf, 0);
5185 return TRUE;
5187 if (got_int)
5189 EMSG(_(e_interr));
5190 return TRUE;
5192 return FALSE;
5196 * Execute a global command of the form:
5198 * g/pattern/X : execute X on all lines where pattern matches
5199 * v/pattern/X : execute X on all lines where pattern does not match
5201 * where 'X' is an EX command
5203 * The command character (as well as the trailing slash) is optional, and
5204 * is assumed to be 'p' if missing.
5206 * This is implemented in two passes: first we scan the file for the pattern and
5207 * set a mark for each line that (not) matches. secondly we execute the command
5208 * for each line that has a mark. This is required because after deleting
5209 * lines we do not know where to search for the next match.
5211 void
5212 ex_global(eap)
5213 exarg_T *eap;
5215 linenr_T lnum; /* line number according to old situation */
5216 int ndone = 0;
5217 int type; /* first char of cmd: 'v' or 'g' */
5218 char_u *cmd; /* command argument */
5220 char_u delim; /* delimiter, normally '/' */
5221 char_u *pat;
5222 regmmatch_T regmatch;
5223 int match;
5224 int which_pat;
5226 if (global_busy)
5228 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5229 return;
5232 if (eap->forceit) /* ":global!" is like ":vglobal" */
5233 type = 'v';
5234 else
5235 type = *eap->cmd;
5236 cmd = eap->arg;
5237 which_pat = RE_LAST; /* default: use last used regexp */
5238 sub_nsubs = 0;
5239 sub_nlines = 0;
5242 * undocumented vi feature:
5243 * "\/" and "\?": use previous search pattern.
5244 * "\&": use previous substitute pattern.
5246 if (*cmd == '\\')
5248 ++cmd;
5249 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5251 EMSG(_(e_backslash));
5252 return;
5254 if (*cmd == '&')
5255 which_pat = RE_SUBST; /* use previous substitute pattern */
5256 else
5257 which_pat = RE_SEARCH; /* use previous search pattern */
5258 ++cmd;
5259 pat = (char_u *)"";
5261 else if (*cmd == NUL)
5263 EMSG(_("E148: Regular expression missing from global"));
5264 return;
5266 else
5268 delim = *cmd; /* get the delimiter */
5269 if (delim)
5270 ++cmd; /* skip delimiter if there is one */
5271 pat = cmd; /* remember start of pattern */
5272 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5273 if (cmd[0] == delim) /* end delimiter found */
5274 *cmd++ = NUL; /* replace it with a NUL */
5277 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5278 if (p_altkeymap && curwin->w_p_rl)
5279 lrFswap(pat,0);
5280 #endif
5282 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5284 EMSG(_(e_invcmd));
5285 return;
5289 * pass 1: set marks for each (not) matching line
5291 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5293 /* a match on this line? */
5294 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum,
5295 (colnr_T)0, NULL);
5296 if ((type == 'g' && match) || (type == 'v' && !match))
5298 ml_setmarked(lnum);
5299 ndone++;
5301 line_breakcheck();
5305 * pass 2: execute the command for each line that has been marked
5307 if (got_int)
5308 MSG(_(e_interr));
5309 else if (ndone == 0)
5311 if (type == 'v')
5312 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5313 else
5314 smsg((char_u *)_(e_patnotf2), pat);
5316 else
5317 global_exe(cmd);
5319 ml_clearmarked(); /* clear rest of the marks */
5320 vim_free(regmatch.regprog);
5324 * Execute "cmd" on lines marked with ml_setmarked().
5326 void
5327 global_exe(cmd)
5328 char_u *cmd;
5330 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5331 linenr_T lnum; /* line number according to old situation */
5334 * Set current position only once for a global command.
5335 * If global_busy is set, setpcmark() will not do anything.
5336 * If there is an error, global_busy will be incremented.
5338 setpcmark();
5340 /* When the command writes a message, don't overwrite the command. */
5341 msg_didout = TRUE;
5343 global_need_beginline = FALSE;
5344 global_busy = 1;
5345 old_lcount = curbuf->b_ml.ml_line_count;
5346 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5348 curwin->w_cursor.lnum = lnum;
5349 curwin->w_cursor.col = 0;
5350 if (*cmd == NUL || *cmd == '\n')
5351 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5352 else
5353 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5354 ui_breakcheck();
5357 global_busy = 0;
5358 if (global_need_beginline)
5359 beginline(BL_WHITE | BL_FIX);
5360 else
5361 check_cursor(); /* cursor may be beyond the end of the line */
5363 /* the cursor may not have moved in the text but a change in a previous
5364 * line may move it on the screen */
5365 changed_line_abv_curs();
5367 /* If it looks like no message was written, allow overwriting the
5368 * command with the report for number of changes. */
5369 if (msg_col == 0 && msg_scrolled == 0)
5370 msg_didout = FALSE;
5372 /* If substitutes done, report number of substitutes, otherwise report
5373 * number of extra or deleted lines. */
5374 if (!do_sub_msg(FALSE))
5375 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5378 #ifdef FEAT_VIMINFO
5380 read_viminfo_sub_string(virp, force)
5381 vir_T *virp;
5382 int force;
5384 if (old_sub != NULL && force)
5385 vim_free(old_sub);
5386 if (force || old_sub == NULL)
5387 old_sub = viminfo_readstring(virp, 1, TRUE);
5388 return viminfo_readline(virp);
5391 void
5392 write_viminfo_sub_string(fp)
5393 FILE *fp;
5395 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5397 fprintf(fp, _("\n# Last Substitute String:\n$"));
5398 viminfo_writestring(fp, old_sub);
5401 #endif /* FEAT_VIMINFO */
5403 #if defined(EXITFREE) || defined(PROTO)
5404 void
5405 free_old_sub()
5407 vim_free(old_sub);
5409 #endif
5411 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5413 * Set up for a tagpreview.
5414 * Return TRUE when it was created.
5417 prepare_tagpreview(undo_sync)
5418 int undo_sync; /* sync undo when leaving the window */
5420 win_T *wp;
5422 # ifdef FEAT_GUI
5423 need_mouse_correct = TRUE;
5424 # endif
5427 * If there is already a preview window open, use that one.
5429 if (!curwin->w_p_pvw)
5431 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5432 if (wp->w_p_pvw)
5433 break;
5434 if (wp != NULL)
5435 win_enter(wp, undo_sync);
5436 else
5439 * There is no preview window open yet. Create one.
5441 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5442 == FAIL)
5443 return FALSE;
5444 curwin->w_p_pvw = TRUE;
5445 curwin->w_p_wfh = TRUE;
5446 # ifdef FEAT_SCROLLBIND
5447 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5448 # endif
5449 # ifdef FEAT_DIFF
5450 curwin->w_p_diff = FALSE; /* no 'diff' */
5451 # endif
5452 # ifdef FEAT_FOLDING
5453 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5454 # endif
5455 return TRUE;
5458 return FALSE;
5461 #endif
5465 * ":help": open a read-only window on a help file
5467 void
5468 ex_help(eap)
5469 exarg_T *eap;
5471 char_u *arg;
5472 char_u *tag;
5473 FILE *helpfd; /* file descriptor of help file */
5474 int n;
5475 int i;
5476 #ifdef FEAT_WINDOWS
5477 win_T *wp;
5478 #endif
5479 int num_matches;
5480 char_u **matches;
5481 char_u *p;
5482 int empty_fnum = 0;
5483 int alt_fnum = 0;
5484 buf_T *buf;
5485 #ifdef FEAT_MULTI_LANG
5486 int len;
5487 char_u *lang;
5488 #endif
5490 if (eap != NULL)
5493 * A ":help" command ends at the first LF, or at a '|' that is
5494 * followed by some text. Set nextcmd to the following command.
5496 for (arg = eap->arg; *arg; ++arg)
5498 if (*arg == '\n' || *arg == '\r'
5499 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5501 *arg++ = NUL;
5502 eap->nextcmd = arg;
5503 break;
5506 arg = eap->arg;
5508 if (eap->forceit && *arg == NUL)
5510 EMSG(_("E478: Don't panic!"));
5511 return;
5514 if (eap->skip) /* not executing commands */
5515 return;
5517 else
5518 arg = (char_u *)"";
5520 /* remove trailing blanks */
5521 p = arg + STRLEN(arg) - 1;
5522 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5523 *p-- = NUL;
5525 #ifdef FEAT_MULTI_LANG
5526 /* Check for a specified language */
5527 lang = check_help_lang(arg);
5528 #endif
5530 /* When no argument given go to the index. */
5531 if (*arg == NUL)
5532 arg = (char_u *)"help.txt";
5535 * Check if there is a match for the argument.
5537 n = find_help_tags(arg, &num_matches, &matches,
5538 eap != NULL && eap->forceit);
5540 i = 0;
5541 #ifdef FEAT_MULTI_LANG
5542 if (n != FAIL && lang != NULL)
5543 /* Find first item with the requested language. */
5544 for (i = 0; i < num_matches; ++i)
5546 len = (int)STRLEN(matches[i]);
5547 if (len > 3 && matches[i][len - 3] == '@'
5548 && STRICMP(matches[i] + len - 2, lang) == 0)
5549 break;
5551 #endif
5552 if (i >= num_matches || n == FAIL)
5554 #ifdef FEAT_MULTI_LANG
5555 if (lang != NULL)
5556 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5557 else
5558 #endif
5559 EMSG2(_("E149: Sorry, no help for %s"), arg);
5560 if (n != FAIL)
5561 FreeWild(num_matches, matches);
5562 return;
5565 /* The first match (in the requested language) is the best match. */
5566 tag = vim_strsave(matches[i]);
5567 FreeWild(num_matches, matches);
5569 #ifdef FEAT_GUI
5570 need_mouse_correct = TRUE;
5571 #endif
5574 * Re-use an existing help window or open a new one.
5575 * Always open a new one for ":tab help".
5577 if (!curwin->w_buffer->b_help
5578 #ifdef FEAT_WINDOWS
5579 || cmdmod.tab != 0
5580 #endif
5583 #ifdef FEAT_WINDOWS
5584 if (cmdmod.tab != 0)
5585 wp = NULL;
5586 else
5587 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5588 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5589 break;
5590 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5591 win_enter(wp, TRUE);
5592 else
5593 #endif
5596 * There is no help window yet.
5597 * Try to open the file specified by the "helpfile" option.
5599 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5601 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5602 goto erret;
5604 fclose(helpfd);
5606 #ifdef FEAT_WINDOWS
5607 /* Split off help window; put it at far top if no position
5608 * specified, the current window is vertically split and
5609 * narrow. */
5610 n = WSP_HELP;
5611 # ifdef FEAT_VERTSPLIT
5612 if (cmdmod.split == 0 && curwin->w_width != Columns
5613 && curwin->w_width < 80)
5614 n |= WSP_TOP;
5615 # endif
5616 if (win_split(0, n) == FAIL)
5617 goto erret;
5618 #else
5619 /* use current window */
5620 if (!can_abandon(curbuf, FALSE))
5621 goto erret;
5622 #endif
5624 #ifdef FEAT_WINDOWS
5625 if (curwin->w_height < p_hh)
5626 win_setheight((int)p_hh);
5627 #endif
5630 * Open help file (do_ecmd() will set b_help flag, readfile() will
5631 * set b_p_ro flag).
5632 * Set the alternate file to the previously edited file.
5634 alt_fnum = curbuf->b_fnum;
5635 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5636 ECMD_HIDE + ECMD_SET_HELP,
5637 #ifdef FEAT_WINDOWS
5638 NULL /* buffer is still open, don't store info */
5639 #else
5640 curwin
5641 #endif
5643 if (!cmdmod.keepalt)
5644 curwin->w_alt_fnum = alt_fnum;
5645 empty_fnum = curbuf->b_fnum;
5649 if (!p_im)
5650 restart_edit = 0; /* don't want insert mode in help file */
5652 if (tag != NULL)
5653 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5655 /* Delete the empty buffer if we're not using it. Careful: autocommands
5656 * may have jumped to another window, check that the buffer is not in a
5657 * window. */
5658 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5660 buf = buflist_findnr(empty_fnum);
5661 if (buf != NULL && buf->b_nwindows == 0)
5662 wipe_buffer(buf, TRUE);
5665 /* keep the previous alternate file */
5666 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5667 curwin->w_alt_fnum = alt_fnum;
5669 erret:
5670 vim_free(tag);
5674 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5676 * In an argument search for a language specifiers in the form "@xx".
5677 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5678 * Returns NULL if not found.
5680 char_u *
5681 check_help_lang(arg)
5682 char_u *arg;
5684 int len = (int)STRLEN(arg);
5686 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5687 && ASCII_ISALPHA(arg[len - 1]))
5689 arg[len - 3] = NUL; /* remove the '@' */
5690 return arg + len - 2;
5692 return NULL;
5694 #endif
5697 * Return a heuristic indicating how well the given string matches. The
5698 * smaller the number, the better the match. This is the order of priorities,
5699 * from best match to worst match:
5700 * - Match with least alpha-numeric characters is better.
5701 * - Match with least total characters is better.
5702 * - Match towards the start is better.
5703 * - Match starting with "+" is worse (feature instead of command)
5704 * Assumption is made that the matched_string passed has already been found to
5705 * match some string for which help is requested. webb.
5708 help_heuristic(matched_string, offset, wrong_case)
5709 char_u *matched_string;
5710 int offset; /* offset for match */
5711 int wrong_case; /* no matching case */
5713 int num_letters;
5714 char_u *p;
5716 num_letters = 0;
5717 for (p = matched_string; *p; p++)
5718 if (ASCII_ISALNUM(*p))
5719 num_letters++;
5722 * Multiply the number of letters by 100 to give it a much bigger
5723 * weighting than the number of characters.
5724 * If there only is a match while ignoring case, add 5000.
5725 * If the match starts in the middle of a word, add 10000 to put it
5726 * somewhere in the last half.
5727 * If the match is more than 2 chars from the start, multiply by 200 to
5728 * put it after matches at the start.
5730 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5731 && ASCII_ISALNUM(matched_string[offset - 1]))
5732 offset += 10000;
5733 else if (offset > 2)
5734 offset *= 200;
5735 if (wrong_case)
5736 offset += 5000;
5737 /* Features are less interesting than the subjects themselves, but "+"
5738 * alone is not a feature. */
5739 if (matched_string[0] == '+' && matched_string[1] != NUL)
5740 offset += 100;
5741 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5745 * Compare functions for qsort() below, that checks the help heuristics number
5746 * that has been put after the tagname by find_tags().
5748 static int
5749 #ifdef __BORLANDC__
5750 _RTLENTRYF
5751 #endif
5752 help_compare(s1, s2)
5753 const void *s1;
5754 const void *s2;
5756 char *p1;
5757 char *p2;
5759 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5760 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5761 return strcmp(p1, p2);
5765 * Find all help tags matching "arg", sort them and return in matches[], with
5766 * the number of matches in num_matches.
5767 * The matches will be sorted with a "best" match algorithm.
5768 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5771 find_help_tags(arg, num_matches, matches, keep_lang)
5772 char_u *arg;
5773 int *num_matches;
5774 char_u ***matches;
5775 int keep_lang;
5777 char_u *s, *d;
5778 int i;
5779 #ifdef S_SPLINT_S /* splint doesn't understand array of pointers */
5780 static char **mtable;
5781 static char **rtable;
5782 #else
5783 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5784 "/*", "/\\*", "\"*", "**",
5785 "/\\(\\)",
5786 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5787 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5788 "[count]", "[quotex]", "[range]",
5789 "[pattern]", "\\|", "\\%$"};
5790 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5791 "/star", "/\\\\star", "quotestar", "starstar",
5792 "/\\\\(\\\\)",
5793 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5794 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5795 "\\[count]", "\\[quotex]", "\\[range]",
5796 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5797 #endif
5798 int flags;
5800 d = IObuff; /* assume IObuff is long enough! */
5803 * Recognize a few exceptions to the rule. Some strings that contain '*'
5804 * with "star". Otherwise '*' is recognized as a wildcard.
5806 for (i = (int)(sizeof(mtable) / sizeof(char *)); --i >= 0; )
5807 if (STRCMP(arg, mtable[i]) == 0)
5809 STRCPY(d, rtable[i]);
5810 break;
5813 if (i < 0) /* no match in table */
5815 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5816 * Also replace "\%^" and "\%(", they match every tag too.
5817 * Also "\zs", "\z1", etc.
5818 * Also "\@<", "\@=", "\@<=", etc.
5819 * And also "\_$" and "\_^". */
5820 if (arg[0] == '\\'
5821 && ((arg[1] != NUL && arg[2] == NUL)
5822 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5823 && arg[2] != NUL)))
5825 STRCPY(d, "/\\\\");
5826 STRCPY(d + 3, arg + 1);
5827 /* Check for "/\\_$", should be "/\\_\$" */
5828 if (d[3] == '_' && d[4] == '$')
5829 STRCPY(d + 4, "\\$");
5831 else
5833 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5834 if (arg[0] == '[' && (arg[1] == ':'
5835 || (arg[1] == '+' && arg[2] == '+')))
5836 *d++ = '\\';
5838 for (s = arg; *s; ++s)
5841 * Replace "|" with "bar" and '"' with "quote" to match the name of
5842 * the tags for these commands.
5843 * Replace "*" with ".*" and "?" with "." to match command line
5844 * completion.
5845 * Insert a backslash before '~', '$' and '.' to avoid their
5846 * special meaning.
5848 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5849 break;
5850 switch (*s)
5852 case '|': STRCPY(d, "bar");
5853 d += 3;
5854 continue;
5855 case '"': STRCPY(d, "quote");
5856 d += 5;
5857 continue;
5858 case '*': *d++ = '.';
5859 break;
5860 case '?': *d++ = '.';
5861 continue;
5862 case '$':
5863 case '.':
5864 case '~': *d++ = '\\';
5865 break;
5869 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5870 * ":help i_^_CTRL-D" work.
5871 * Insert '-' before and after "CTRL-X" when applicable.
5873 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5874 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5876 if (d > IObuff && d[-1] != '_')
5877 *d++ = '_'; /* prepend a '_' */
5878 STRCPY(d, "CTRL-");
5879 d += 5;
5880 if (*s < ' ')
5882 #ifdef EBCDIC
5883 *d++ = CtrlChar(*s);
5884 #else
5885 *d++ = *s + '@';
5886 #endif
5887 if (d[-1] == '\\')
5888 *d++ = '\\'; /* double a backslash */
5890 else
5891 *d++ = *++s;
5892 if (s[1] != NUL && s[1] != '_')
5893 *d++ = '_'; /* append a '_' */
5894 continue;
5896 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5897 *d++ = '\\';
5900 * Insert a backslash before a backslash after a slash, for search
5901 * pattern tags: "/\|" --> "/\\|".
5903 else if (s[0] == '\\' && s[1] != '\\'
5904 && *arg == '/' && s == arg + 1)
5905 *d++ = '\\';
5907 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5908 * "CTRL-\_CTRL-N" */
5909 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5911 STRCPY(d, "CTRL-\\\\");
5912 d += 7;
5913 s += 6;
5916 *d++ = *s;
5919 * If tag starts with ', toss everything after a second '. Fixes
5920 * CTRL-] on 'option'. (would include the trailing '.').
5922 if (*s == '\'' && s > arg && *arg == '\'')
5923 break;
5925 *d = NUL;
5929 *matches = (char_u **)"";
5930 *num_matches = 0;
5931 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5932 if (keep_lang)
5933 flags |= TAG_KEEP_LANG;
5934 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5935 && *num_matches > 0)
5937 /* Sort the matches found on the heuristic number that is after the
5938 * tag name. */
5939 qsort((void *)*matches, (size_t)*num_matches,
5940 sizeof(char_u *), help_compare);
5941 /* Delete more than TAG_MANY to reduce the size of the listing. */
5942 while (*num_matches > TAG_MANY)
5943 vim_free((*matches)[--*num_matches]);
5945 return OK;
5949 * After reading a help file: May cleanup a help buffer when syntax
5950 * highlighting is not used.
5952 void
5953 fix_help_buffer()
5955 linenr_T lnum;
5956 char_u *line;
5957 int in_example = FALSE;
5958 int len;
5959 char_u *p;
5960 char_u *rt;
5961 int mustfree;
5963 /* set filetype to "help". */
5964 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5966 #ifdef FEAT_SYN_HL
5967 if (!syntax_present(curbuf))
5968 #endif
5970 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5972 line = ml_get_buf(curbuf, lnum, FALSE);
5973 len = (int)STRLEN(line);
5974 if (in_example && len > 0 && !vim_iswhite(line[0]))
5976 /* End of example: non-white or '<' in first column. */
5977 if (line[0] == '<')
5979 /* blank-out a '<' in the first column */
5980 line = ml_get_buf(curbuf, lnum, TRUE);
5981 line[0] = ' ';
5983 in_example = FALSE;
5985 if (!in_example && len > 0)
5987 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5989 /* blank-out a '>' in the last column (start of example) */
5990 line = ml_get_buf(curbuf, lnum, TRUE);
5991 line[len - 1] = ' ';
5992 in_example = TRUE;
5994 else if (line[len - 1] == '~')
5996 /* blank-out a '~' at the end of line (header marker) */
5997 line = ml_get_buf(curbuf, lnum, TRUE);
5998 line[len - 1] = ' ';
6005 * In the "help.txt" file, add the locally added help files.
6006 * This uses the very first line in the help file.
6008 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
6010 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
6012 line = ml_get_buf(curbuf, lnum, FALSE);
6013 if (strstr((char *)line, "*local-additions*") != NULL)
6015 /* Go through all directories in 'runtimepath', skipping
6016 * $VIMRUNTIME. */
6017 p = p_rtp;
6018 while (*p != NUL)
6020 copy_option_part(&p, NameBuff, MAXPATHL, ",");
6021 mustfree = FALSE;
6022 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
6023 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
6025 int fcount;
6026 char_u **fnames;
6027 FILE *fd;
6028 char_u *s;
6029 int fi;
6030 #ifdef FEAT_MBYTE
6031 vimconv_T vc;
6032 char_u *cp;
6033 #endif
6035 /* Find all "doc/ *.txt" files in this directory. */
6036 add_pathsep(NameBuff);
6037 STRCAT(NameBuff, "doc/*.txt");
6038 if (gen_expand_wildcards(1, &NameBuff, &fcount,
6039 &fnames, EW_FILE|EW_SILENT) == OK
6040 && fcount > 0)
6042 for (fi = 0; fi < fcount; ++fi)
6044 fd = mch_fopen((char *)fnames[fi], "r");
6045 if (fd != NULL)
6047 vim_fgets(IObuff, IOSIZE, fd);
6048 if (IObuff[0] == '*'
6049 && (s = vim_strchr(IObuff + 1, '*'))
6050 != NULL)
6052 #ifdef FEAT_MBYTE
6053 int this_utf = MAYBE;
6054 #endif
6055 /* Change tag definition to a
6056 * reference and remove <CR>/<NL>. */
6057 IObuff[0] = '|';
6058 *s = '|';
6059 while (*s != NUL)
6061 if (*s == '\r' || *s == '\n')
6062 *s = NUL;
6063 #ifdef FEAT_MBYTE
6064 /* The text is utf-8 when a byte
6065 * above 127 is found and no
6066 * illegal byte sequence is found.
6068 if (*s >= 0x80 && this_utf != FALSE)
6070 int l;
6072 this_utf = TRUE;
6073 l = utf_ptr2len(s);
6074 if (l == 1)
6075 this_utf = FALSE;
6076 s += l - 1;
6078 #endif
6079 ++s;
6081 #ifdef FEAT_MBYTE
6082 /* The help file is latin1 or utf-8;
6083 * conversion to the current
6084 * 'encoding' may be required. */
6085 vc.vc_type = CONV_NONE;
6086 convert_setup(&vc, (char_u *)(
6087 this_utf == TRUE ? "utf-8"
6088 : "latin1"), p_enc);
6089 if (vc.vc_type == CONV_NONE)
6090 /* No conversion needed. */
6091 cp = IObuff;
6092 else
6094 /* Do the conversion. If it fails
6095 * use the unconverted text. */
6096 cp = string_convert(&vc, IObuff,
6097 NULL);
6098 if (cp == NULL)
6099 cp = IObuff;
6101 convert_setup(&vc, NULL, NULL);
6103 ml_append(lnum, cp, (colnr_T)0, FALSE);
6104 if (cp != IObuff)
6105 vim_free(cp);
6106 #else
6107 ml_append(lnum, IObuff, (colnr_T)0,
6108 FALSE);
6109 #endif
6110 ++lnum;
6112 fclose(fd);
6115 FreeWild(fcount, fnames);
6118 if (mustfree)
6119 vim_free(rt);
6121 break;
6128 * ":exusage"
6130 /*ARGSUSED*/
6131 void
6132 ex_exusage(eap)
6133 exarg_T *eap;
6135 do_cmdline_cmd((char_u *)"help ex-cmd-index");
6139 * ":viusage"
6141 /*ARGSUSED*/
6142 void
6143 ex_viusage(eap)
6144 exarg_T *eap;
6146 do_cmdline_cmd((char_u *)"help normal-index");
6149 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
6150 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang, int add_help_tags));
6153 * ":helptags"
6155 void
6156 ex_helptags(eap)
6157 exarg_T *eap;
6159 garray_T ga;
6160 int i, j;
6161 int len;
6162 #ifdef FEAT_MULTI_LANG
6163 char_u lang[2];
6164 #endif
6165 expand_T xpc;
6166 char_u *dirname;
6167 char_u ext[5];
6168 char_u fname[8];
6169 int filecount;
6170 char_u **files;
6171 int add_help_tags = FALSE;
6173 /* Check for ":helptags ++t {dir}". */
6174 if (STRNCMP(eap->arg, "++t", 3) == 0 && vim_iswhite(eap->arg[3]))
6176 add_help_tags = TRUE;
6177 eap->arg = skipwhite(eap->arg + 3);
6180 ExpandInit(&xpc);
6181 xpc.xp_context = EXPAND_DIRECTORIES;
6182 dirname = ExpandOne(&xpc, eap->arg, NULL,
6183 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
6184 if (dirname == NULL || !mch_isdir(dirname))
6186 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6187 return;
6190 #ifdef FEAT_MULTI_LANG
6191 /* Get a list of all files in the directory. */
6192 STRCPY(NameBuff, dirname);
6193 add_pathsep(NameBuff);
6194 STRCAT(NameBuff, "*");
6195 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6196 EW_FILE|EW_SILENT) == FAIL
6197 || filecount == 0)
6199 EMSG2("E151: No match: %s", NameBuff);
6200 vim_free(dirname);
6201 return;
6204 /* Go over all files in the directory to find out what languages are
6205 * present. */
6206 ga_init2(&ga, 1, 10);
6207 for (i = 0; i < filecount; ++i)
6209 len = (int)STRLEN(files[i]);
6210 if (len > 4)
6212 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6214 /* ".txt" -> language "en" */
6215 lang[0] = 'e';
6216 lang[1] = 'n';
6218 else if (files[i][len - 4] == '.'
6219 && ASCII_ISALPHA(files[i][len - 3])
6220 && ASCII_ISALPHA(files[i][len - 2])
6221 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6223 /* ".abx" -> language "ab" */
6224 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6225 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6227 else
6228 continue;
6230 /* Did we find this language already? */
6231 for (j = 0; j < ga.ga_len; j += 2)
6232 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6233 break;
6234 if (j == ga.ga_len)
6236 /* New language, add it. */
6237 if (ga_grow(&ga, 2) == FAIL)
6238 break;
6239 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6240 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6246 * Loop over the found languages to generate a tags file for each one.
6248 for (j = 0; j < ga.ga_len; j += 2)
6250 STRCPY(fname, "tags-xx");
6251 fname[5] = ((char_u *)ga.ga_data)[j];
6252 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6253 if (fname[5] == 'e' && fname[6] == 'n')
6255 /* English is an exception: use ".txt" and "tags". */
6256 fname[4] = NUL;
6257 STRCPY(ext, ".txt");
6259 else
6261 /* Language "ab" uses ".abx" and "tags-ab". */
6262 STRCPY(ext, ".xxx");
6263 ext[1] = fname[5];
6264 ext[2] = fname[6];
6266 helptags_one(dirname, ext, fname, add_help_tags);
6269 ga_clear(&ga);
6270 FreeWild(filecount, files);
6272 #else
6273 /* No language support, just use "*.txt" and "tags". */
6274 helptags_one(dirname, (char_u *)".txt", (char_u *)"tags", add_help_tags);
6275 #endif
6276 vim_free(dirname);
6279 static void
6280 helptags_one(dir, ext, tagfname, add_help_tags)
6281 char_u *dir; /* doc directory */
6282 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6283 char_u *tagfname; /* "tags" for English, "tags-fr" for French. */
6284 int add_help_tags; /* add "help-tags" tag */
6286 FILE *fd_tags;
6287 FILE *fd;
6288 garray_T ga;
6289 int filecount;
6290 char_u **files;
6291 char_u *p1, *p2;
6292 int fi;
6293 char_u *s;
6294 int i;
6295 char_u *fname;
6296 # ifdef FEAT_MBYTE
6297 int utf8 = MAYBE;
6298 int this_utf8;
6299 int firstline;
6300 int mix = FALSE; /* detected mixed encodings */
6301 # endif
6304 * Find all *.txt files.
6306 STRCPY(NameBuff, dir);
6307 add_pathsep(NameBuff);
6308 STRCAT(NameBuff, "*");
6309 STRCAT(NameBuff, ext);
6310 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6311 EW_FILE|EW_SILENT) == FAIL
6312 || filecount == 0)
6314 if (!got_int)
6315 EMSG2("E151: No match: %s", NameBuff);
6316 return;
6320 * Open the tags file for writing.
6321 * Do this before scanning through all the files.
6323 STRCPY(NameBuff, dir);
6324 add_pathsep(NameBuff);
6325 STRCAT(NameBuff, tagfname);
6326 fd_tags = mch_fopen((char *)NameBuff, "w");
6327 if (fd_tags == NULL)
6329 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6330 FreeWild(filecount, files);
6331 return;
6335 * If using the "++t" argument or generating tags for "$VIMRUNTIME/doc"
6336 * add the "help-tags" tag.
6338 ga_init2(&ga, (int)sizeof(char_u *), 100);
6339 if (add_help_tags || fullpathcmp((char_u *)"$VIMRUNTIME/doc",
6340 dir, FALSE) == FPC_SAME)
6342 if (ga_grow(&ga, 1) == FAIL)
6343 got_int = TRUE;
6344 else
6346 s = alloc(18 + (unsigned)STRLEN(tagfname));
6347 if (s == NULL)
6348 got_int = TRUE;
6349 else
6351 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6352 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6353 ++ga.ga_len;
6359 * Go over all the files and extract the tags.
6361 for (fi = 0; fi < filecount && !got_int; ++fi)
6363 fd = mch_fopen((char *)files[fi], "r");
6364 if (fd == NULL)
6366 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6367 continue;
6369 fname = gettail(files[fi]);
6371 # ifdef FEAT_MBYTE
6372 firstline = TRUE;
6373 # endif
6374 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6376 # ifdef FEAT_MBYTE
6377 if (firstline)
6379 /* Detect utf-8 file by a non-ASCII char in the first line. */
6380 this_utf8 = MAYBE;
6381 for (s = IObuff; *s != NUL; ++s)
6382 if (*s >= 0x80)
6384 int l;
6386 this_utf8 = TRUE;
6387 l = utf_ptr2len(s);
6388 if (l == 1)
6390 /* Illegal UTF-8 byte sequence. */
6391 this_utf8 = FALSE;
6392 break;
6394 s += l - 1;
6396 if (this_utf8 == MAYBE) /* only ASCII characters found */
6397 this_utf8 = FALSE;
6398 if (utf8 == MAYBE) /* first file */
6399 utf8 = this_utf8;
6400 else if (utf8 != this_utf8)
6402 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6403 mix = !got_int;
6404 got_int = TRUE;
6406 firstline = FALSE;
6408 # endif
6409 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6410 while (p1 != NULL)
6412 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6413 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6415 for (s = p1 + 1; s < p2; ++s)
6416 if (*s == ' ' || *s == '\t' || *s == '|')
6417 break;
6420 * Only accept a *tag* when it consists of valid
6421 * characters, there is white space before it and is
6422 * followed by a white character or end-of-line.
6424 if (s == p2
6425 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6426 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6427 || s[1] == '\0'))
6429 *p2 = '\0';
6430 ++p1;
6431 if (ga_grow(&ga, 1) == FAIL)
6433 got_int = TRUE;
6434 break;
6436 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6437 if (s == NULL)
6439 got_int = TRUE;
6440 break;
6442 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6443 ++ga.ga_len;
6444 sprintf((char *)s, "%s\t%s", p1, fname);
6446 /* find next '*' */
6447 p2 = vim_strchr(p2 + 1, '*');
6450 p1 = p2;
6452 line_breakcheck();
6455 fclose(fd);
6458 FreeWild(filecount, files);
6460 if (!got_int)
6463 * Sort the tags.
6465 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6468 * Check for duplicates.
6470 for (i = 1; i < ga.ga_len; ++i)
6472 p1 = ((char_u **)ga.ga_data)[i - 1];
6473 p2 = ((char_u **)ga.ga_data)[i];
6474 while (*p1 == *p2)
6476 if (*p2 == '\t')
6478 *p2 = NUL;
6479 vim_snprintf((char *)NameBuff, MAXPATHL,
6480 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6481 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6482 EMSG(NameBuff);
6483 *p2 = '\t';
6484 break;
6486 ++p1;
6487 ++p2;
6491 # ifdef FEAT_MBYTE
6492 if (utf8 == TRUE)
6493 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6494 # endif
6497 * Write the tags into the file.
6499 for (i = 0; i < ga.ga_len; ++i)
6501 s = ((char_u **)ga.ga_data)[i];
6502 if (STRNCMP(s, "help-tags\t", 10) == 0)
6503 /* help-tags entry was added in formatted form */
6504 fputs((char *)s, fd_tags);
6505 else
6507 fprintf(fd_tags, "%s\t/*", s);
6508 for (p1 = s; *p1 != '\t'; ++p1)
6510 /* insert backslash before '\\' and '/' */
6511 if (*p1 == '\\' || *p1 == '/')
6512 putc('\\', fd_tags);
6513 putc(*p1, fd_tags);
6515 fprintf(fd_tags, "*\n");
6519 #ifdef FEAT_MBYTE
6520 if (mix)
6521 got_int = FALSE; /* continue with other languages */
6522 #endif
6524 for (i = 0; i < ga.ga_len; ++i)
6525 vim_free(((char_u **)ga.ga_data)[i]);
6526 ga_clear(&ga);
6527 fclose(fd_tags); /* there is no check for an error... */
6529 #endif
6531 #if defined(FEAT_SIGNS) || defined(PROTO)
6534 * Struct to hold the sign properties.
6536 typedef struct sign sign_T;
6538 struct sign
6540 sign_T *sn_next; /* next sign in list */
6541 int sn_typenr; /* type number of sign (negative if not equal
6542 to name) */
6543 char_u *sn_name; /* name of sign */
6544 char_u *sn_icon; /* name of pixmap */
6545 #ifdef FEAT_SIGN_ICONS
6546 void *sn_image; /* icon image */
6547 #endif
6548 char_u *sn_text; /* text used instead of pixmap */
6549 int sn_line_hl; /* highlight ID for line */
6550 int sn_text_hl; /* highlight ID for text */
6553 static sign_T *first_sign = NULL;
6554 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6556 static void sign_list_defined __ARGS((sign_T *sp));
6557 static void sign_undefine __ARGS((sign_T *sp, sign_T *sp_prev));
6559 static char *cmds[] = {
6560 "define",
6561 #define SIGNCMD_DEFINE 0
6562 "undefine",
6563 #define SIGNCMD_UNDEFINE 1
6564 "list",
6565 #define SIGNCMD_LIST 2
6566 "place",
6567 #define SIGNCMD_PLACE 3
6568 "unplace",
6569 #define SIGNCMD_UNPLACE 4
6570 "jump",
6571 #define SIGNCMD_JUMP 5
6572 NULL
6573 #define SIGNCMD_LAST 6
6577 * Find index of a ":sign" subcmd from its name.
6578 * "*end_cmd" must be writable.
6580 static int
6581 sign_cmd_idx(begin_cmd, end_cmd)
6582 char *begin_cmd; /* begin of sign subcmd */
6583 char *end_cmd; /* just after sign subcmd */
6585 int idx;
6586 char save = *end_cmd;
6588 *end_cmd = NUL;
6589 for (idx = 0; ; ++idx)
6590 if (cmds[idx] == NULL || STRCMP(begin_cmd, cmds[idx]) == 0)
6591 break;
6592 *end_cmd = save;
6593 return idx;
6597 * ":sign" command
6599 void
6600 ex_sign(eap)
6601 exarg_T *eap;
6603 char_u *arg = eap->arg;
6604 char_u *p;
6605 int idx;
6606 sign_T *sp;
6607 sign_T *sp_prev;
6608 buf_T *buf;
6610 /* Parse the subcommand. */
6611 p = skiptowhite(arg);
6612 idx = sign_cmd_idx(arg, p);
6613 if (idx == SIGNCMD_LAST)
6615 EMSG2(_("E160: Unknown sign command: %s"), arg);
6616 return;
6618 arg = skipwhite(p);
6620 if (idx <= SIGNCMD_LIST)
6623 * Define, undefine or list signs.
6625 if (idx == SIGNCMD_LIST && *arg == NUL)
6627 /* ":sign list": list all defined signs */
6628 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6629 sign_list_defined(sp);
6631 else if (*arg == NUL)
6632 EMSG(_("E156: Missing sign name"));
6633 else
6635 p = skiptowhite(arg);
6636 if (*p != NUL)
6637 *p++ = NUL;
6638 sp_prev = NULL;
6639 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6641 if (STRCMP(sp->sn_name, arg) == 0)
6642 break;
6643 sp_prev = sp;
6645 if (idx == SIGNCMD_DEFINE)
6647 /* ":sign define {name} ...": define a sign */
6648 if (sp == NULL)
6650 /* Allocate a new sign. */
6651 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6652 if (sp == NULL)
6653 return;
6654 if (sp_prev == NULL)
6655 first_sign = sp;
6656 else
6657 sp_prev->sn_next = sp;
6658 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6660 /* If the name is a number use that for the typenr,
6661 * otherwise use a negative number. */
6662 if (VIM_ISDIGIT(*arg))
6663 sp->sn_typenr = atoi((char *)arg);
6664 else
6666 sign_T *lp;
6667 int start = last_sign_typenr;
6669 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6671 if (lp->sn_typenr == last_sign_typenr)
6673 --last_sign_typenr;
6674 if (last_sign_typenr == 0)
6675 last_sign_typenr = MAX_TYPENR;
6676 if (last_sign_typenr == start)
6678 EMSG(_("E612: Too many signs defined"));
6679 return;
6681 lp = first_sign;
6682 continue;
6686 sp->sn_typenr = last_sign_typenr--;
6687 if (last_sign_typenr == 0)
6688 last_sign_typenr = MAX_TYPENR; /* wrap around */
6692 /* set values for a defined sign. */
6693 for (;;)
6695 arg = skipwhite(p);
6696 if (*arg == NUL)
6697 break;
6698 p = skiptowhite_esc(arg);
6699 if (STRNCMP(arg, "icon=", 5) == 0)
6701 arg += 5;
6702 vim_free(sp->sn_icon);
6703 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6704 backslash_halve(sp->sn_icon);
6705 #ifdef FEAT_SIGN_ICONS
6706 if (gui.in_use)
6708 out_flush();
6709 if (sp->sn_image != NULL)
6710 gui_mch_destroy_sign(sp->sn_image);
6711 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6713 #endif
6715 else if (STRNCMP(arg, "text=", 5) == 0)
6717 char_u *s;
6718 int cells;
6719 int len;
6721 arg += 5;
6722 #ifdef FEAT_MBYTE
6723 /* Count cells and check for non-printable chars */
6724 if (has_mbyte)
6726 cells = 0;
6727 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6729 if (!vim_isprintc((*mb_ptr2char)(s)))
6730 break;
6731 cells += (*mb_ptr2cells)(s);
6734 else
6735 #endif
6737 for (s = arg; s < p; ++s)
6738 if (!vim_isprintc(*s))
6739 break;
6740 cells = (int)(s - arg);
6742 /* Currently must be one or two display cells */
6743 if (s != p || cells < 1 || cells > 2)
6745 *p = NUL;
6746 EMSG2(_("E239: Invalid sign text: %s"), arg);
6747 return;
6750 vim_free(sp->sn_text);
6751 /* Allocate one byte more if we need to pad up
6752 * with a space. */
6753 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6754 sp->sn_text = vim_strnsave(arg, len);
6756 if (sp->sn_text != NULL && cells == 1)
6757 STRCPY(sp->sn_text + len - 1, " ");
6759 else if (STRNCMP(arg, "linehl=", 7) == 0)
6761 arg += 7;
6762 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6764 else if (STRNCMP(arg, "texthl=", 7) == 0)
6766 arg += 7;
6767 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6769 else
6771 EMSG2(_(e_invarg2), arg);
6772 return;
6776 else if (sp == NULL)
6777 EMSG2(_("E155: Unknown sign: %s"), arg);
6778 else if (idx == SIGNCMD_LIST)
6779 /* ":sign list {name}" */
6780 sign_list_defined(sp);
6781 else
6782 /* ":sign undefine {name}" */
6783 sign_undefine(sp, sp_prev);
6786 else
6788 int id = -1;
6789 linenr_T lnum = -1;
6790 char_u *sign_name = NULL;
6791 char_u *arg1;
6793 if (*arg == NUL)
6795 if (idx == SIGNCMD_PLACE)
6797 /* ":sign place": list placed signs in all buffers */
6798 sign_list_placed(NULL);
6800 else if (idx == SIGNCMD_UNPLACE)
6802 /* ":sign unplace": remove placed sign at cursor */
6803 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6804 if (id > 0)
6806 buf_delsign(curwin->w_buffer, id);
6807 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6809 else
6810 EMSG(_("E159: Missing sign number"));
6812 else
6813 EMSG(_(e_argreq));
6814 return;
6817 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6819 /* ":sign unplace *": remove all placed signs */
6820 buf_delete_all_signs();
6821 return;
6824 /* first arg could be placed sign id */
6825 arg1 = arg;
6826 if (VIM_ISDIGIT(*arg))
6828 id = getdigits(&arg);
6829 if (!vim_iswhite(*arg) && *arg != NUL)
6831 id = -1;
6832 arg = arg1;
6834 else
6836 arg = skipwhite(arg);
6837 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6839 /* ":sign unplace {id}": remove placed sign by number */
6840 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6841 if ((lnum = buf_delsign(buf, id)) != 0)
6842 update_debug_sign(buf, lnum);
6843 return;
6849 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6850 * Leave "arg" pointing to {fname}.
6852 for (;;)
6854 if (STRNCMP(arg, "line=", 5) == 0)
6856 arg += 5;
6857 lnum = atoi((char *)arg);
6858 arg = skiptowhite(arg);
6860 else if (STRNCMP(arg, "name=", 5) == 0)
6862 arg += 5;
6863 sign_name = arg;
6864 arg = skiptowhite(arg);
6865 if (*arg != NUL)
6866 *arg++ = NUL;
6868 else if (STRNCMP(arg, "file=", 5) == 0)
6870 arg += 5;
6871 buf = buflist_findname(arg);
6872 break;
6874 else if (STRNCMP(arg, "buffer=", 7) == 0)
6876 arg += 7;
6877 buf = buflist_findnr((int)getdigits(&arg));
6878 if (*skipwhite(arg) != NUL)
6879 EMSG(_(e_trailing));
6880 break;
6882 else
6884 EMSG(_(e_invarg));
6885 return;
6887 arg = skipwhite(arg);
6890 if (buf == NULL)
6892 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6894 else if (id <= 0)
6896 if (lnum >= 0 || sign_name != NULL)
6897 EMSG(_(e_invarg));
6898 else
6899 /* ":sign place file={fname}": list placed signs in one file */
6900 sign_list_placed(buf);
6902 else if (idx == SIGNCMD_JUMP)
6904 /* ":sign jump {id} file={fname}" */
6905 if (lnum >= 0 || sign_name != NULL)
6906 EMSG(_(e_invarg));
6907 else if ((lnum = buf_findsign(buf, id)) > 0)
6908 { /* goto a sign ... */
6909 if (buf_jump_open_win(buf) != NULL)
6910 { /* ... in a current window */
6911 curwin->w_cursor.lnum = lnum;
6912 check_cursor_lnum();
6913 beginline(BL_WHITE);
6915 else
6916 { /* ... not currently in a window */
6917 char_u *cmd;
6919 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6920 if (cmd == NULL)
6921 return;
6922 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6923 do_cmdline_cmd(cmd);
6924 vim_free(cmd);
6926 #ifdef FEAT_FOLDING
6927 foldOpenCursor();
6928 #endif
6930 else
6931 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6933 else if (idx == SIGNCMD_UNPLACE)
6935 /* ":sign unplace {id} file={fname}" */
6936 if (lnum >= 0 || sign_name != NULL)
6937 EMSG(_(e_invarg));
6938 else
6940 lnum = buf_delsign(buf, id);
6941 update_debug_sign(buf, lnum);
6944 /* idx == SIGNCMD_PLACE */
6945 else if (sign_name != NULL)
6947 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6948 if (STRCMP(sp->sn_name, sign_name) == 0)
6949 break;
6950 if (sp == NULL)
6952 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6953 return;
6955 if (lnum > 0)
6956 /* ":sign place {id} line={lnum} name={name} file={fname}":
6957 * place a sign */
6958 buf_addsign(buf, id, lnum, sp->sn_typenr);
6959 else
6960 /* ":sign place {id} file={fname}": change sign type */
6961 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6962 update_debug_sign(buf, lnum);
6964 else
6965 EMSG(_(e_invarg));
6969 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6971 * Allocate the icons. Called when the GUI has started. Allows defining
6972 * signs before it starts.
6974 void
6975 sign_gui_started()
6977 sign_T *sp;
6979 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6980 if (sp->sn_icon != NULL)
6981 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6983 #endif
6986 * List one sign.
6988 static void
6989 sign_list_defined(sp)
6990 sign_T *sp;
6992 char_u *p;
6994 smsg((char_u *)"sign %s", sp->sn_name);
6995 if (sp->sn_icon != NULL)
6997 MSG_PUTS(" icon=");
6998 msg_outtrans(sp->sn_icon);
6999 #ifdef FEAT_SIGN_ICONS
7000 if (sp->sn_image == NULL)
7001 MSG_PUTS(_(" (NOT FOUND)"));
7002 #else
7003 MSG_PUTS(_(" (not supported)"));
7004 #endif
7006 if (sp->sn_text != NULL)
7008 MSG_PUTS(" text=");
7009 msg_outtrans(sp->sn_text);
7011 if (sp->sn_line_hl > 0)
7013 MSG_PUTS(" linehl=");
7014 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
7015 if (p == NULL)
7016 MSG_PUTS("NONE");
7017 else
7018 msg_puts(p);
7020 if (sp->sn_text_hl > 0)
7022 MSG_PUTS(" texthl=");
7023 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
7024 if (p == NULL)
7025 MSG_PUTS("NONE");
7026 else
7027 msg_puts(p);
7032 * Undefine a sign and free its memory.
7034 static void
7035 sign_undefine(sp, sp_prev)
7036 sign_T *sp;
7037 sign_T *sp_prev;
7039 vim_free(sp->sn_name);
7040 vim_free(sp->sn_icon);
7041 #ifdef FEAT_SIGN_ICONS
7042 if (sp->sn_image != NULL)
7044 out_flush();
7045 gui_mch_destroy_sign(sp->sn_image);
7047 #endif
7048 vim_free(sp->sn_text);
7049 if (sp_prev == NULL)
7050 first_sign = sp->sn_next;
7051 else
7052 sp_prev->sn_next = sp->sn_next;
7053 vim_free(sp);
7057 * Get highlighting attribute for sign "typenr".
7058 * If "line" is TRUE: line highl, if FALSE: text highl.
7061 sign_get_attr(typenr, line)
7062 int typenr;
7063 int line;
7065 sign_T *sp;
7067 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7068 if (sp->sn_typenr == typenr)
7070 if (line)
7072 if (sp->sn_line_hl > 0)
7073 return syn_id2attr(sp->sn_line_hl);
7075 else
7077 if (sp->sn_text_hl > 0)
7078 return syn_id2attr(sp->sn_text_hl);
7080 break;
7082 return 0;
7086 * Get text mark for sign "typenr".
7087 * Returns NULL if there isn't one.
7089 char_u *
7090 sign_get_text(typenr)
7091 int typenr;
7093 sign_T *sp;
7095 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7096 if (sp->sn_typenr == typenr)
7097 return sp->sn_text;
7098 return NULL;
7101 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
7102 void *
7103 sign_get_image(typenr)
7104 int typenr; /* the attribute which may have a sign */
7106 sign_T *sp;
7108 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7109 if (sp->sn_typenr == typenr)
7110 return sp->sn_image;
7111 return NULL;
7113 #endif
7116 * Get the name of a sign by its typenr.
7118 char_u *
7119 sign_typenr2name(typenr)
7120 int typenr;
7122 sign_T *sp;
7124 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7125 if (sp->sn_typenr == typenr)
7126 return sp->sn_name;
7127 return (char_u *)_("[Deleted]");
7130 #if defined(EXITFREE) || defined(PROTO)
7132 * Undefine/free all signs.
7134 void
7135 free_signs()
7137 while (first_sign != NULL)
7138 sign_undefine(first_sign, NULL);
7140 #endif
7142 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
7143 static enum
7145 EXP_SUBCMD, /* expand :sign sub-commands */
7146 EXP_DEFINE, /* expand :sign define {name} args */
7147 EXP_PLACE, /* expand :sign place {id} args */
7148 EXP_UNPLACE, /* expand :sign unplace" */
7149 EXP_SIGN_NAMES /* expand with name of placed signs */
7150 } expand_what;
7153 * Function given to ExpandGeneric() to obtain the sign command
7154 * expansion.
7156 /*ARGSUSED*/
7157 char_u *
7158 get_sign_name(xp, idx)
7159 expand_T *xp;
7160 int idx;
7162 sign_T *sp;
7163 int current_idx;
7165 switch (expand_what)
7167 case EXP_SUBCMD:
7168 return (char_u *)cmds[idx];
7169 case EXP_DEFINE:
7171 char *define_arg[] =
7173 "icon=", "linehl=", "text=", "texthl=", NULL
7175 return (char_u *)define_arg[idx];
7177 case EXP_PLACE:
7179 char *place_arg[] =
7181 "line=", "name=", "file=", "buffer=", NULL
7183 return (char_u *)place_arg[idx];
7185 case EXP_UNPLACE:
7187 char *unplace_arg[] = { "file=", "buffer=", NULL };
7188 return (char_u *)unplace_arg[idx];
7190 case EXP_SIGN_NAMES:
7191 /* Complete with name of signs already defined */
7192 current_idx = 0;
7193 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
7194 if (current_idx++ == idx)
7195 return sp->sn_name;
7196 return NULL;
7197 default:
7198 return NULL;
7203 * Handle command line completion for :sign command.
7205 void
7206 set_context_in_sign_cmd(xp, arg)
7207 expand_T *xp;
7208 char_u *arg;
7210 char_u *p;
7211 char_u *end_subcmd;
7212 char_u *last;
7213 int cmd_idx;
7214 char_u *begin_subcmd_args;
7216 /* Default: expand subcommands. */
7217 xp->xp_context = EXPAND_SIGN;
7218 expand_what = EXP_SUBCMD;
7219 xp->xp_pattern = arg;
7221 end_subcmd = skiptowhite(arg);
7222 if (*end_subcmd == NUL)
7223 /* expand subcmd name
7224 * :sign {subcmd}<CTRL-D>*/
7225 return;
7227 cmd_idx = sign_cmd_idx(arg, end_subcmd);
7229 /* :sign {subcmd} {subcmd_args}
7231 * begin_subcmd_args */
7232 begin_subcmd_args = skipwhite(end_subcmd);
7233 p = skiptowhite(begin_subcmd_args);
7234 if (*p == NUL)
7237 * Expand first argument of subcmd when possible.
7238 * For ":jump {id}" and ":unplace {id}", we could
7239 * possibly expand the ids of all signs already placed.
7241 xp->xp_pattern = begin_subcmd_args;
7242 switch (cmd_idx)
7244 case SIGNCMD_LIST:
7245 case SIGNCMD_UNDEFINE:
7246 /* :sign list <CTRL-D>
7247 * :sign undefine <CTRL-D> */
7248 expand_what = EXP_SIGN_NAMES;
7249 break;
7250 default:
7251 xp->xp_context = EXPAND_NOTHING;
7253 return;
7256 /* expand last argument of subcmd */
7258 /* :sign define {name} {args}...
7260 * p */
7262 /* Loop until reaching last argument. */
7265 p = skipwhite(p);
7266 last = p;
7267 p = skiptowhite(p);
7268 } while (*p != NUL);
7270 p = vim_strchr(last, '=');
7272 /* :sign define {name} {args}... {last}=
7273 * | |
7274 * last p */
7275 if (p == NUL)
7277 /* Expand last argument name (before equal sign). */
7278 xp->xp_pattern = last;
7279 switch (cmd_idx)
7281 case SIGNCMD_DEFINE:
7282 expand_what = EXP_DEFINE;
7283 break;
7284 case SIGNCMD_PLACE:
7285 expand_what = EXP_PLACE;
7286 break;
7287 case SIGNCMD_JUMP:
7288 case SIGNCMD_UNPLACE:
7289 expand_what = EXP_UNPLACE;
7290 break;
7291 default:
7292 xp->xp_context = EXPAND_NOTHING;
7295 else
7297 /* Expand last argument value (after equal sign). */
7298 xp->xp_pattern = p + 1;
7299 switch (cmd_idx)
7301 case SIGNCMD_DEFINE:
7302 if (STRNCMP(last, "texthl", p - last) == 0 ||
7303 STRNCMP(last, "linehl", p - last) == 0)
7304 xp->xp_context = EXPAND_HIGHLIGHT;
7305 else if (STRNCMP(last, "icon", p - last) == 0)
7306 xp->xp_context = EXPAND_FILES;
7307 else
7308 xp->xp_context = EXPAND_NOTHING;
7309 break;
7310 case SIGNCMD_PLACE:
7311 if (STRNCMP(last, "name", p - last) == 0)
7312 expand_what = EXP_SIGN_NAMES;
7313 else
7314 xp->xp_context = EXPAND_NOTHING;
7315 break;
7316 default:
7317 xp->xp_context = EXPAND_NOTHING;
7321 #endif
7322 #endif
7324 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
7326 * ":drop"
7327 * Opens the first argument in a window. When there are two or more arguments
7328 * the argument list is redefined.
7330 void
7331 ex_drop(eap)
7332 exarg_T *eap;
7334 int split = FALSE;
7335 win_T *wp;
7336 buf_T *buf;
7337 # ifdef FEAT_WINDOWS
7338 tabpage_T *tp;
7339 # endif
7342 * Check if the first argument is already being edited in a window. If
7343 * so, jump to that window.
7344 * We would actually need to check all arguments, but that's complicated
7345 * and mostly only one file is dropped.
7346 * This also ignores wildcards, since it is very unlikely the user is
7347 * editing a file name with a wildcard character.
7349 set_arglist(eap->arg);
7352 * Expanding wildcards may result in an empty argument list. E.g. when
7353 * editing "foo.pyc" and ".pyc" is in 'wildignore'. Assume that we
7354 * already did an error message for this.
7356 if (ARGCOUNT == 0)
7357 return;
7359 # ifdef FEAT_WINDOWS
7360 if (cmdmod.tab)
7362 /* ":tab drop file ...": open a tab for each argument that isn't
7363 * edited in a window yet. It's like ":tab all" but without closing
7364 * windows or tabs. */
7365 ex_all(eap);
7367 else
7368 # endif
7370 /* ":drop file ...": Edit the first argument. Jump to an existing
7371 * window if possible, edit in current window if the current buffer
7372 * can be abandoned, otherwise open a new window. */
7373 buf = buflist_findnr(ARGLIST[0].ae_fnum);
7375 FOR_ALL_TAB_WINDOWS(tp, wp)
7377 if (wp->w_buffer == buf)
7379 # ifdef FEAT_WINDOWS
7380 goto_tabpage_win(tp, wp);
7381 # endif
7382 curwin->w_arg_idx = 0;
7383 return;
7388 * Check whether the current buffer is changed. If so, we will need
7389 * to split the current window or data could be lost.
7390 * Skip the check if the 'hidden' option is set, as in this case the
7391 * buffer won't be lost.
7393 if (!P_HID(curbuf))
7395 # ifdef FEAT_WINDOWS
7396 ++emsg_off;
7397 # endif
7398 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7399 # ifdef FEAT_WINDOWS
7400 --emsg_off;
7401 # else
7402 if (split)
7403 return;
7404 # endif
7407 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7408 if (split)
7410 eap->cmdidx = CMD_sfirst;
7411 eap->cmd[0] = 's';
7413 else
7414 eap->cmdidx = CMD_first;
7415 ex_rewind(eap);
7418 #endif