Patch 7.0.070
[MacVim/jjgod.git] / src / ex_cmds.c
blob70440735ccfe2f3a00d4932f69e55a23287998bd
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
11 * ex_cmds.c: some functions for command line commands
14 #include "vim.h"
15 #ifdef HAVE_FCNTL_H
16 # include <fcntl.h>
17 #endif
18 #include "version.h"
20 #ifdef FEAT_EX_EXTRA
21 static int linelen __ARGS((int *has_tab));
22 #endif
23 static void do_filter __ARGS((linenr_T line1, linenr_T line2, exarg_T *eap, char_u *cmd, int do_in, int do_out));
24 #ifdef FEAT_VIMINFO
25 static char_u *viminfo_filename __ARGS((char_u *));
26 static void do_viminfo __ARGS((FILE *fp_in, FILE *fp_out, int want_info, int want_marks, int force_read));
27 static int viminfo_encoding __ARGS((vir_T *virp));
28 static int read_viminfo_up_to_marks __ARGS((vir_T *virp, int forceit, int writing));
29 #endif
31 static int check_overwrite __ARGS((exarg_T *eap, buf_T *buf, char_u *fname, char_u *ffname, int other));
32 static int check_readonly __ARGS((int *forceit, buf_T *buf));
33 #ifdef FEAT_AUTOCMD
34 static void delbuf_msg __ARGS((char_u *name));
35 #endif
36 static int
37 #ifdef __BORLANDC__
38 _RTLENTRYF
39 #endif
40 help_compare __ARGS((const void *s1, const void *s2));
43 * ":ascii" and "ga".
45 /*ARGSUSED*/
46 void
47 do_ascii(eap)
48 exarg_T *eap;
50 int c;
51 char buf1[20];
52 char buf2[20];
53 char_u buf3[7];
54 #ifdef FEAT_MBYTE
55 int cc[MAX_MCO];
56 int ci = 0;
57 int len;
59 if (enc_utf8)
60 c = utfc_ptr2char(ml_get_cursor(), cc);
61 else
62 #endif
63 c = gchar_cursor();
64 if (c == NUL)
66 MSG("NUL");
67 return;
70 #ifdef FEAT_MBYTE
71 IObuff[0] = NUL;
72 if (!has_mbyte || (enc_dbcs != 0 && c < 0x100) || c < 0x80)
73 #endif
75 if (c == NL) /* NUL is stored as NL */
76 c = NUL;
77 if (vim_isprintc_strict(c) && (c < ' '
78 #ifndef EBCDIC
79 || c > '~'
80 #endif
83 transchar_nonprint(buf3, c);
84 sprintf(buf1, " <%s>", (char *)buf3);
86 else
87 buf1[0] = NUL;
88 #ifndef EBCDIC
89 if (c >= 0x80)
90 sprintf(buf2, " <M-%s>", transchar(c & 0x7f));
91 else
92 #endif
93 buf2[0] = NUL;
94 vim_snprintf((char *)IObuff, IOSIZE,
95 _("<%s>%s%s %d, Hex %02x, Octal %03o"),
96 transchar(c), buf1, buf2, c, c, c);
97 #ifdef FEAT_MBYTE
98 c = cc[ci++];
99 #endif
102 #ifdef FEAT_MBYTE
103 /* Repeat for combining characters. */
104 while (has_mbyte && (c >= 0x100 || (enc_utf8 && c >= 0x80)))
106 len = (int)STRLEN(IObuff);
107 /* This assumes every multi-byte char is printable... */
108 if (len > 0)
109 IObuff[len++] = ' ';
110 IObuff[len++] = '<';
111 if (utf_iscomposing(c)
112 # ifdef USE_GUI
113 && !gui.in_use
114 # endif
116 IObuff[len++] = ' '; /* draw composing char on top of a space */
117 len += (*mb_char2bytes)(c, IObuff + len);
118 vim_snprintf((char *)IObuff + len, IOSIZE - len,
119 c < 0x10000 ? _("> %d, Hex %04x, Octal %o")
120 : _("> %d, Hex %08x, Octal %o"), c, c, c);
121 if (ci == MAX_MCO)
122 break;
123 c = cc[ci++];
125 #endif
127 msg(IObuff);
130 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
132 * ":left", ":center" and ":right": align text.
134 void
135 ex_align(eap)
136 exarg_T *eap;
138 pos_T save_curpos;
139 int len;
140 int indent = 0;
141 int new_indent;
142 int has_tab;
143 int width;
145 #ifdef FEAT_RIGHTLEFT
146 if (curwin->w_p_rl)
148 /* switch left and right aligning */
149 if (eap->cmdidx == CMD_right)
150 eap->cmdidx = CMD_left;
151 else if (eap->cmdidx == CMD_left)
152 eap->cmdidx = CMD_right;
154 #endif
156 width = atoi((char *)eap->arg);
157 save_curpos = curwin->w_cursor;
158 if (eap->cmdidx == CMD_left) /* width is used for new indent */
160 if (width >= 0)
161 indent = width;
163 else
166 * if 'textwidth' set, use it
167 * else if 'wrapmargin' set, use it
168 * if invalid value, use 80
170 if (width <= 0)
171 width = curbuf->b_p_tw;
172 if (width == 0 && curbuf->b_p_wm > 0)
173 width = W_WIDTH(curwin) - curbuf->b_p_wm;
174 if (width <= 0)
175 width = 80;
178 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
179 return;
181 for (curwin->w_cursor.lnum = eap->line1;
182 curwin->w_cursor.lnum <= eap->line2; ++curwin->w_cursor.lnum)
184 if (eap->cmdidx == CMD_left) /* left align */
185 new_indent = indent;
186 else
188 has_tab = FALSE; /* avoid uninit warnings */
189 len = linelen(eap->cmdidx == CMD_right ? &has_tab
190 : NULL) - get_indent();
192 if (len <= 0) /* skip blank lines */
193 continue;
195 if (eap->cmdidx == CMD_center)
196 new_indent = (width - len) / 2;
197 else
199 new_indent = width - len; /* right align */
202 * Make sure that embedded TABs don't make the text go too far
203 * to the right.
205 if (has_tab)
206 while (new_indent > 0)
208 (void)set_indent(new_indent, 0);
209 if (linelen(NULL) <= width)
212 * Now try to move the line as much as possible to
213 * the right. Stop when it moves too far.
216 (void)set_indent(++new_indent, 0);
217 while (linelen(NULL) <= width);
218 --new_indent;
219 break;
221 --new_indent;
225 if (new_indent < 0)
226 new_indent = 0;
227 (void)set_indent(new_indent, 0); /* set indent */
229 changed_lines(eap->line1, 0, eap->line2 + 1, 0L);
230 curwin->w_cursor = save_curpos;
231 beginline(BL_WHITE | BL_FIX);
235 * Get the length of the current line, excluding trailing white space.
237 static int
238 linelen(has_tab)
239 int *has_tab;
241 char_u *line;
242 char_u *first;
243 char_u *last;
244 int save;
245 int len;
247 /* find the first non-blank character */
248 line = ml_get_curline();
249 first = skipwhite(line);
251 /* find the character after the last non-blank character */
252 for (last = first + STRLEN(first);
253 last > first && vim_iswhite(last[-1]); --last)
255 save = *last;
256 *last = NUL;
257 len = linetabsize(line); /* get line length */
258 if (has_tab != NULL) /* check for embedded TAB */
259 *has_tab = (vim_strrchr(first, TAB) != NULL);
260 *last = save;
262 return len;
265 /* Buffer for two lines used during sorting. They are allocated to
266 * contain the longest line being sorted. */
267 static char_u *sortbuf1;
268 static char_u *sortbuf2;
270 static int sort_ic; /* ignore case */
271 static int sort_nr; /* sort on number */
272 static int sort_rx; /* sort on regex instead of skipping it */
274 static int sort_abort; /* flag to indicate if sorting has been interrupted */
276 /* Struct to store info to be sorted. */
277 typedef struct
279 linenr_T lnum; /* line number */
280 long start_col_nr; /* starting column number or number */
281 long end_col_nr; /* ending column number */
282 } sorti_T;
284 static int
285 #ifdef __BORLANDC__
286 _RTLENTRYF
287 #endif
288 sort_compare __ARGS((const void *s1, const void *s2));
290 static int
291 #ifdef __BORLANDC__
292 _RTLENTRYF
293 #endif
294 sort_compare(s1, s2)
295 const void *s1;
296 const void *s2;
298 sorti_T l1 = *(sorti_T *)s1;
299 sorti_T l2 = *(sorti_T *)s2;
300 int result = 0;
302 /* If the user interrupts, there's no way to stop qsort() immediately, but
303 * if we return 0 every time, qsort will assume it's done sorting and
304 * exit. */
305 if (sort_abort)
306 return 0;
307 fast_breakcheck();
308 if (got_int)
309 sort_abort = TRUE;
311 /* When sorting numbers "start_col_nr" is the number, not the column
312 * number. */
313 if (sort_nr)
314 result = l1.start_col_nr - l2.start_col_nr;
315 else
317 /* We need to copy one line into "sortbuf1", because there is no
318 * guarantee that the first pointer becomes invalid when obtaining the
319 * second one. */
320 STRNCPY(sortbuf1, ml_get(l1.lnum) + l1.start_col_nr,
321 l1.end_col_nr - l1.start_col_nr + 1);
322 sortbuf1[l1.end_col_nr - l1.start_col_nr] = 0;
323 STRNCPY(sortbuf2, ml_get(l2.lnum) + l2.start_col_nr,
324 l2.end_col_nr - l2.start_col_nr + 1);
325 sortbuf2[l2.end_col_nr - l2.start_col_nr] = 0;
327 result = sort_ic ? STRICMP(sortbuf1, sortbuf2)
328 : STRCMP(sortbuf1, sortbuf2);
331 /* If two lines have the same value, preserve the original line order. */
332 if (result == 0)
333 return (int)(l1.lnum - l2.lnum);
334 return result;
338 * ":sort".
340 void
341 ex_sort(eap)
342 exarg_T *eap;
344 regmatch_T regmatch;
345 int len;
346 linenr_T lnum;
347 long maxlen = 0;
348 sorti_T *nrs;
349 size_t count = eap->line2 - eap->line1 + 1;
350 size_t i;
351 char_u *p;
352 char_u *s;
353 char_u *s2;
354 char_u c; /* temporary character storage */
355 int unique = FALSE;
356 long deleted;
357 colnr_T start_col;
358 colnr_T end_col;
359 int sort_oct; /* sort on octal number */
360 int sort_hex; /* sort on hex number */
362 if (u_save((linenr_T)(eap->line1 - 1), (linenr_T)(eap->line2 + 1)) == FAIL)
363 return;
364 sortbuf1 = NULL;
365 sortbuf2 = NULL;
366 regmatch.regprog = NULL;
367 nrs = (sorti_T *)lalloc((long_u)(count * sizeof(sorti_T)), TRUE);
368 if (nrs == NULL)
369 goto sortend;
371 sort_abort = sort_ic = sort_rx = sort_nr = sort_oct = sort_hex = 0;
373 for (p = eap->arg; *p != NUL; ++p)
375 if (vim_iswhite(*p))
377 else if (*p == 'i')
378 sort_ic = TRUE;
379 else if (*p == 'r')
380 sort_rx = TRUE;
381 else if (*p == 'n')
382 sort_nr = 2;
383 else if (*p == 'o')
384 sort_oct = 2;
385 else if (*p == 'x')
386 sort_hex = 2;
387 else if (*p == 'u')
388 unique = TRUE;
389 else if (*p == '"') /* comment start */
390 break;
391 else if (check_nextcmd(p) != NULL)
393 eap->nextcmd = check_nextcmd(p);
394 break;
396 else if (!ASCII_ISALPHA(*p) && regmatch.regprog == NULL)
398 s = skip_regexp(p + 1, *p, TRUE, NULL);
399 if (*s != *p)
401 EMSG(_(e_invalpat));
402 goto sortend;
404 *s = NUL;
405 regmatch.regprog = vim_regcomp(p + 1, RE_MAGIC);
406 if (regmatch.regprog == NULL)
407 goto sortend;
408 p = s; /* continue after the regexp */
409 regmatch.rm_ic = p_ic;
411 else
413 EMSG2(_(e_invarg2), p);
414 goto sortend;
418 /* Can only have one of 'n', 'o' and 'x'. */
419 if (sort_nr + sort_oct + sort_hex > 2)
421 EMSG(_(e_invarg));
422 goto sortend;
425 /* From here on "sort_nr" is used as a flag for any number sorting. */
426 sort_nr += sort_oct + sort_hex;
429 * Make an array with all line numbers. This avoids having to copy all
430 * the lines into allocated memory.
431 * When sorting on strings "start_col_nr" is the offset in the line, for
432 * numbers sorting it's the number to sort on. This means the pattern
433 * matching and number conversion only has to be done once per line.
434 * Also get the longest line length for allocating "sortbuf".
436 for (lnum = eap->line1; lnum <= eap->line2; ++lnum)
438 s = ml_get(lnum);
439 len = (int)STRLEN(s);
440 if (maxlen < len)
441 maxlen = len;
443 start_col = 0;
444 end_col = len;
445 if (regmatch.regprog != NULL && vim_regexec(&regmatch, s, 0))
447 if (sort_rx)
449 start_col = (colnr_T)(regmatch.startp[0] - s);
450 end_col = (colnr_T)(regmatch.endp[0] - s);
452 else
453 start_col = (colnr_T)(regmatch.endp[0] - s);
455 else
456 if (regmatch.regprog != NULL)
457 end_col = 0;
459 if (sort_nr)
461 /* Make sure vim_str2nr doesn't read any digits past the end
462 * of the match, by temporarily terminating the string there */
463 s2 = s + end_col;
464 c = *s2;
465 (*s2) = 0;
466 /* Sorting on number: Store the number itself. */
467 if (sort_hex)
468 s = skiptohex(s + start_col);
469 else
470 s = skiptodigit(s + start_col);
471 vim_str2nr(s, NULL, NULL, sort_oct, sort_hex,
472 &nrs[lnum - eap->line1].start_col_nr, NULL);
473 (*s2) = c;
475 else
477 /* Store the column to sort at. */
478 nrs[lnum - eap->line1].start_col_nr = start_col;
479 nrs[lnum - eap->line1].end_col_nr = end_col;
482 nrs[lnum - eap->line1].lnum = lnum;
484 if (regmatch.regprog != NULL)
485 fast_breakcheck();
486 if (got_int)
487 goto sortend;
490 /* Allocate a buffer that can hold the longest line. */
491 sortbuf1 = alloc((unsigned)maxlen + 1);
492 if (sortbuf1 == NULL)
493 goto sortend;
494 sortbuf2 = alloc((unsigned)maxlen + 1);
495 if (sortbuf2 == NULL)
496 goto sortend;
498 /* Sort the array of line numbers. Note: can't be interrupted! */
499 qsort((void *)nrs, count, sizeof(sorti_T), sort_compare);
501 if (sort_abort)
502 goto sortend;
504 /* Insert the lines in the sorted order below the last one. */
505 lnum = eap->line2;
506 for (i = 0; i < count; ++i)
508 s = ml_get(nrs[eap->forceit ? count - i - 1 : i].lnum);
509 if (!unique || i == 0
510 || (sort_ic ? STRICMP(s, sortbuf1) : STRCMP(s, sortbuf1)) != 0)
512 if (ml_append(lnum++, s, (colnr_T)0, FALSE) == FAIL)
513 break;
514 if (unique)
515 STRCPY(sortbuf1, s);
517 fast_breakcheck();
518 if (got_int)
519 goto sortend;
522 /* delete the original lines if appending worked */
523 if (i == count)
524 for (i = 0; i < count; ++i)
525 ml_delete(eap->line1, FALSE);
526 else
527 count = 0;
529 /* Adjust marks for deleted (or added) lines and prepare for displaying. */
530 deleted = (long)(count - (lnum - eap->line2));
531 if (deleted > 0)
532 mark_adjust(eap->line2 - deleted, eap->line2, (long)MAXLNUM, -deleted);
533 else if (deleted < 0)
534 mark_adjust(eap->line2, MAXLNUM, -deleted, 0L);
535 changed_lines(eap->line1, 0, eap->line2 + 1, -deleted);
537 curwin->w_cursor.lnum = eap->line1;
538 beginline(BL_WHITE | BL_FIX);
540 sortend:
541 vim_free(nrs);
542 vim_free(sortbuf1);
543 vim_free(sortbuf2);
544 vim_free(regmatch.regprog);
545 if (got_int)
546 EMSG(_(e_interr));
550 * ":retab".
552 void
553 ex_retab(eap)
554 exarg_T *eap;
556 linenr_T lnum;
557 int got_tab = FALSE;
558 long num_spaces = 0;
559 long num_tabs;
560 long len;
561 long col;
562 long vcol;
563 long start_col = 0; /* For start of white-space string */
564 long start_vcol = 0; /* For start of white-space string */
565 int temp;
566 long old_len;
567 char_u *ptr;
568 char_u *new_line = (char_u *)1; /* init to non-NULL */
569 int did_undo; /* called u_save for current line */
570 int new_ts;
571 int save_list;
572 linenr_T first_line = 0; /* first changed line */
573 linenr_T last_line = 0; /* last changed line */
575 save_list = curwin->w_p_list;
576 curwin->w_p_list = 0; /* don't want list mode here */
578 new_ts = getdigits(&(eap->arg));
579 if (new_ts < 0)
581 EMSG(_(e_positive));
582 return;
584 if (new_ts == 0)
585 new_ts = curbuf->b_p_ts;
586 for (lnum = eap->line1; !got_int && lnum <= eap->line2; ++lnum)
588 ptr = ml_get(lnum);
589 col = 0;
590 vcol = 0;
591 did_undo = FALSE;
592 for (;;)
594 if (vim_iswhite(ptr[col]))
596 if (!got_tab && num_spaces == 0)
598 /* First consecutive white-space */
599 start_vcol = vcol;
600 start_col = col;
602 if (ptr[col] == ' ')
603 num_spaces++;
604 else
605 got_tab = TRUE;
607 else
609 if (got_tab || (eap->forceit && num_spaces > 1))
611 /* Retabulate this string of white-space */
613 /* len is virtual length of white string */
614 len = num_spaces = vcol - start_vcol;
615 num_tabs = 0;
616 if (!curbuf->b_p_et)
618 temp = new_ts - (start_vcol % new_ts);
619 if (num_spaces >= temp)
621 num_spaces -= temp;
622 num_tabs++;
624 num_tabs += num_spaces / new_ts;
625 num_spaces -= (num_spaces / new_ts) * new_ts;
627 if (curbuf->b_p_et || got_tab ||
628 (num_spaces + num_tabs < len))
630 if (did_undo == FALSE)
632 did_undo = TRUE;
633 if (u_save((linenr_T)(lnum - 1),
634 (linenr_T)(lnum + 1)) == FAIL)
636 new_line = NULL; /* flag out-of-memory */
637 break;
641 /* len is actual number of white characters used */
642 len = num_spaces + num_tabs;
643 old_len = (long)STRLEN(ptr);
644 new_line = lalloc(old_len - col + start_col + len + 1,
645 TRUE);
646 if (new_line == NULL)
647 break;
648 if (start_col > 0)
649 mch_memmove(new_line, ptr, (size_t)start_col);
650 mch_memmove(new_line + start_col + len,
651 ptr + col, (size_t)(old_len - col + 1));
652 ptr = new_line + start_col;
653 for (col = 0; col < len; col++)
654 ptr[col] = (col < num_tabs) ? '\t' : ' ';
655 ml_replace(lnum, new_line, FALSE);
656 if (first_line == 0)
657 first_line = lnum;
658 last_line = lnum;
659 ptr = new_line;
660 col = start_col + len;
663 got_tab = FALSE;
664 num_spaces = 0;
666 if (ptr[col] == NUL)
667 break;
668 vcol += chartabsize(ptr + col, (colnr_T)vcol);
669 #ifdef FEAT_MBYTE
670 if (has_mbyte)
671 col += (*mb_ptr2len)(ptr + col);
672 else
673 #endif
674 ++col;
676 if (new_line == NULL) /* out of memory */
677 break;
678 line_breakcheck();
680 if (got_int)
681 EMSG(_(e_interr));
683 if (curbuf->b_p_ts != new_ts)
684 redraw_curbuf_later(NOT_VALID);
685 if (first_line != 0)
686 changed_lines(first_line, 0, last_line + 1, 0L);
688 curwin->w_p_list = save_list; /* restore 'list' */
690 curbuf->b_p_ts = new_ts;
691 coladvance(curwin->w_curswant);
693 u_clearline();
695 #endif
698 * :move command - move lines line1-line2 to line dest
700 * return FAIL for failure, OK otherwise
703 do_move(line1, line2, dest)
704 linenr_T line1;
705 linenr_T line2;
706 linenr_T dest;
708 char_u *str;
709 linenr_T l;
710 linenr_T extra; /* Num lines added before line1 */
711 linenr_T num_lines; /* Num lines moved */
712 linenr_T last_line; /* Last line in file after adding new text */
714 if (dest >= line1 && dest < line2)
716 EMSG(_("E134: Move lines into themselves"));
717 return FAIL;
720 num_lines = line2 - line1 + 1;
723 * First we copy the old text to its new location -- webb
724 * Also copy the flag that ":global" command uses.
726 if (u_save(dest, dest + 1) == FAIL)
727 return FAIL;
728 for (extra = 0, l = line1; l <= line2; l++)
730 str = vim_strsave(ml_get(l + extra));
731 if (str != NULL)
733 ml_append(dest + l - line1, str, (colnr_T)0, FALSE);
734 vim_free(str);
735 if (dest < line1)
736 extra++;
741 * Now we must be careful adjusting our marks so that we don't overlap our
742 * mark_adjust() calls.
744 * We adjust the marks within the old text so that they refer to the
745 * last lines of the file (temporarily), because we know no other marks
746 * will be set there since these line numbers did not exist until we added
747 * our new lines.
749 * Then we adjust the marks on lines between the old and new text positions
750 * (either forwards or backwards).
752 * And Finally we adjust the marks we put at the end of the file back to
753 * their final destination at the new text position -- webb
755 last_line = curbuf->b_ml.ml_line_count;
756 mark_adjust(line1, line2, last_line - line2, 0L);
757 if (dest >= line2)
759 mark_adjust(line2 + 1, dest, -num_lines, 0L);
760 curbuf->b_op_start.lnum = dest - num_lines + 1;
761 curbuf->b_op_end.lnum = dest;
763 else
765 mark_adjust(dest + 1, line1 - 1, num_lines, 0L);
766 curbuf->b_op_start.lnum = dest + 1;
767 curbuf->b_op_end.lnum = dest + num_lines;
769 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
770 mark_adjust(last_line - num_lines + 1, last_line,
771 -(last_line - dest - extra), 0L);
774 * Now we delete the original text -- webb
776 if (u_save(line1 + extra - 1, line2 + extra + 1) == FAIL)
777 return FAIL;
779 for (l = line1; l <= line2; l++)
780 ml_delete(line1 + extra, TRUE);
782 if (!global_busy && num_lines > p_report)
784 if (num_lines == 1)
785 MSG(_("1 line moved"));
786 else
787 smsg((char_u *)_("%ld lines moved"), num_lines);
791 * Leave the cursor on the last of the moved lines.
793 if (dest >= line1)
794 curwin->w_cursor.lnum = dest;
795 else
796 curwin->w_cursor.lnum = dest + (line2 - line1) + 1;
798 if (line1 < dest)
799 changed_lines(line1, 0, dest + num_lines + 1, 0L);
800 else
801 changed_lines(dest + 1, 0, line1 + num_lines, 0L);
803 return OK;
807 * ":copy"
809 void
810 ex_copy(line1, line2, n)
811 linenr_T line1;
812 linenr_T line2;
813 linenr_T n;
815 linenr_T count;
816 char_u *p;
818 count = line2 - line1 + 1;
819 curbuf->b_op_start.lnum = n + 1;
820 curbuf->b_op_end.lnum = n + count;
821 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
824 * there are three situations:
825 * 1. destination is above line1
826 * 2. destination is between line1 and line2
827 * 3. destination is below line2
829 * n = destination (when starting)
830 * curwin->w_cursor.lnum = destination (while copying)
831 * line1 = start of source (while copying)
832 * line2 = end of source (while copying)
834 if (u_save(n, n + 1) == FAIL)
835 return;
837 curwin->w_cursor.lnum = n;
838 while (line1 <= line2)
840 /* need to use vim_strsave() because the line will be unlocked within
841 * ml_append() */
842 p = vim_strsave(ml_get(line1));
843 if (p != NULL)
845 ml_append(curwin->w_cursor.lnum, p, (colnr_T)0, FALSE);
846 vim_free(p);
848 /* situation 2: skip already copied lines */
849 if (line1 == n)
850 line1 = curwin->w_cursor.lnum;
851 ++line1;
852 if (curwin->w_cursor.lnum < line1)
853 ++line1;
854 if (curwin->w_cursor.lnum < line2)
855 ++line2;
856 ++curwin->w_cursor.lnum;
859 appended_lines_mark(n, count);
861 msgmore((long)count);
864 static char_u *prevcmd = NULL; /* the previous command */
866 #if defined(EXITFREE) || defined(PROTO)
867 void
868 free_prev_shellcmd()
870 vim_free(prevcmd);
872 #endif
875 * Handle the ":!cmd" command. Also for ":r !cmd" and ":w !cmd"
876 * Bangs in the argument are replaced with the previously entered command.
877 * Remember the argument.
879 * RISCOS: Bangs only replaced when followed by a space, since many
880 * pathnames contain one.
882 void
883 do_bang(addr_count, eap, forceit, do_in, do_out)
884 int addr_count;
885 exarg_T *eap;
886 int forceit;
887 int do_in, do_out;
889 char_u *arg = eap->arg; /* command */
890 linenr_T line1 = eap->line1; /* start of range */
891 linenr_T line2 = eap->line2; /* end of range */
892 char_u *newcmd = NULL; /* the new command */
893 int free_newcmd = FALSE; /* need to free() newcmd */
894 int ins_prevcmd;
895 char_u *t;
896 char_u *p;
897 char_u *trailarg;
898 int len;
899 int scroll_save = msg_scroll;
902 * Disallow shell commands for "rvim".
903 * Disallow shell commands from .exrc and .vimrc in current directory for
904 * security reasons.
906 if (check_restricted() || check_secure())
907 return;
909 if (addr_count == 0) /* :! */
911 msg_scroll = FALSE; /* don't scroll here */
912 autowrite_all();
913 msg_scroll = scroll_save;
917 * Try to find an embedded bang, like in :!<cmd> ! [args]
918 * (:!! is indicated by the 'forceit' variable)
920 ins_prevcmd = forceit;
921 trailarg = arg;
924 len = (int)STRLEN(trailarg) + 1;
925 if (newcmd != NULL)
926 len += (int)STRLEN(newcmd);
927 if (ins_prevcmd)
929 if (prevcmd == NULL)
931 EMSG(_(e_noprev));
932 vim_free(newcmd);
933 return;
935 len += (int)STRLEN(prevcmd);
937 if ((t = alloc(len)) == NULL)
939 vim_free(newcmd);
940 return;
942 *t = NUL;
943 if (newcmd != NULL)
944 STRCAT(t, newcmd);
945 if (ins_prevcmd)
946 STRCAT(t, prevcmd);
947 p = t + STRLEN(t);
948 STRCAT(t, trailarg);
949 vim_free(newcmd);
950 newcmd = t;
953 * Scan the rest of the argument for '!', which is replaced by the
954 * previous command. "\!" is replaced by "!" (this is vi compatible).
956 trailarg = NULL;
957 while (*p)
959 if (*p == '!'
960 #ifdef RISCOS
961 && (p[1] == ' ' || p[1] == NUL)
962 #endif
965 if (p > newcmd && p[-1] == '\\')
966 mch_memmove(p - 1, p, (size_t)(STRLEN(p) + 1));
967 else
969 trailarg = p;
970 *trailarg++ = NUL;
971 ins_prevcmd = TRUE;
972 break;
975 ++p;
977 } while (trailarg != NULL);
979 vim_free(prevcmd);
980 prevcmd = newcmd;
982 if (bangredo) /* put cmd in redo buffer for ! command */
984 AppendToRedobuffLit(prevcmd, -1);
985 AppendToRedobuff((char_u *)"\n");
986 bangredo = FALSE;
989 * Add quotes around the command, for shells that need them.
991 if (*p_shq != NUL)
993 newcmd = alloc((unsigned)(STRLEN(prevcmd) + 2 * STRLEN(p_shq) + 1));
994 if (newcmd == NULL)
995 return;
996 STRCPY(newcmd, p_shq);
997 STRCAT(newcmd, prevcmd);
998 STRCAT(newcmd, p_shq);
999 free_newcmd = TRUE;
1001 if (addr_count == 0) /* :! */
1003 /* echo the command */
1004 msg_start();
1005 msg_putchar(':');
1006 msg_putchar('!');
1007 msg_outtrans(newcmd);
1008 msg_clr_eos();
1009 windgoto(msg_row, msg_col);
1011 do_shell(newcmd, 0);
1013 else /* :range! */
1015 /* Careful: This may recursively call do_bang() again! (because of
1016 * autocommands) */
1017 do_filter(line1, line2, eap, newcmd, do_in, do_out);
1018 #ifdef FEAT_AUTOCMD
1019 apply_autocmds(EVENT_SHELLFILTERPOST, NULL, NULL, FALSE, curbuf);
1020 #endif
1022 if (free_newcmd)
1023 vim_free(newcmd);
1027 * do_filter: filter lines through a command given by the user
1029 * We mostly use temp files and the call_shell() routine here. This would
1030 * normally be done using pipes on a UNIX machine, but this is more portable
1031 * to non-unix machines. The call_shell() routine needs to be able
1032 * to deal with redirection somehow, and should handle things like looking
1033 * at the PATH env. variable, and adding reasonable extensions to the
1034 * command name given by the user. All reasonable versions of call_shell()
1035 * do this.
1036 * Alternatively, if on Unix and redirecting input or output, but not both,
1037 * and the 'shelltemp' option isn't set, use pipes.
1038 * We use input redirection if do_in is TRUE.
1039 * We use output redirection if do_out is TRUE.
1041 static void
1042 do_filter(line1, line2, eap, cmd, do_in, do_out)
1043 linenr_T line1, line2;
1044 exarg_T *eap; /* for forced 'ff' and 'fenc' */
1045 char_u *cmd;
1046 int do_in, do_out;
1048 char_u *itmp = NULL;
1049 char_u *otmp = NULL;
1050 linenr_T linecount;
1051 linenr_T read_linecount;
1052 pos_T cursor_save;
1053 char_u *cmd_buf;
1054 #ifdef FEAT_AUTOCMD
1055 buf_T *old_curbuf = curbuf;
1056 #endif
1057 int shell_flags = 0;
1059 if (*cmd == NUL) /* no filter command */
1060 return;
1062 #ifdef WIN3264
1064 * Check if external commands are allowed now.
1066 if (can_end_termcap_mode(TRUE) == FALSE)
1067 return;
1068 #endif
1070 cursor_save = curwin->w_cursor;
1071 linecount = line2 - line1 + 1;
1072 curwin->w_cursor.lnum = line1;
1073 curwin->w_cursor.col = 0;
1074 changed_line_abv_curs();
1075 invalidate_botline();
1078 * When using temp files:
1079 * 1. * Form temp file names
1080 * 2. * Write the lines to a temp file
1081 * 3. Run the filter command on the temp file
1082 * 4. * Read the output of the command into the buffer
1083 * 5. * Delete the original lines to be filtered
1084 * 6. * Remove the temp files
1086 * When writing the input with a pipe or when catching the output with a
1087 * pipe only need to do 3.
1090 if (do_out)
1091 shell_flags |= SHELL_DOOUT;
1093 #if !defined(USE_SYSTEM) && defined(UNIX)
1094 if (!do_in && do_out && !p_stmp)
1096 /* Use a pipe to fetch stdout of the command, do not use a temp file. */
1097 shell_flags |= SHELL_READ;
1098 curwin->w_cursor.lnum = line2;
1100 else if (do_in && !do_out && !p_stmp)
1102 /* Use a pipe to write stdin of the command, do not use a temp file. */
1103 shell_flags |= SHELL_WRITE;
1104 curbuf->b_op_start.lnum = line1;
1105 curbuf->b_op_end.lnum = line2;
1107 else if (do_in && do_out && !p_stmp)
1109 /* Use a pipe to write stdin and fetch stdout of the command, do not
1110 * use a temp file. */
1111 shell_flags |= SHELL_READ|SHELL_WRITE;
1112 curbuf->b_op_start.lnum = line1;
1113 curbuf->b_op_end.lnum = line2;
1114 curwin->w_cursor.lnum = line2;
1116 else
1117 #endif
1118 if ((do_in && (itmp = vim_tempname('i')) == NULL)
1119 || (do_out && (otmp = vim_tempname('o')) == NULL))
1121 EMSG(_(e_notmp));
1122 goto filterend;
1126 * The writing and reading of temp files will not be shown.
1127 * Vi also doesn't do this and the messages are not very informative.
1129 ++no_wait_return; /* don't call wait_return() while busy */
1130 if (itmp != NULL && buf_write(curbuf, itmp, NULL, line1, line2, eap,
1131 FALSE, FALSE, FALSE, TRUE) == FAIL)
1133 msg_putchar('\n'); /* keep message from buf_write() */
1134 --no_wait_return;
1135 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1136 if (!aborting())
1137 #endif
1138 (void)EMSG2(_(e_notcreate), itmp); /* will call wait_return */
1139 goto filterend;
1141 #ifdef FEAT_AUTOCMD
1142 if (curbuf != old_curbuf)
1143 goto filterend;
1144 #endif
1146 if (!do_out)
1147 msg_putchar('\n');
1149 cmd_buf = make_filter_cmd(cmd, itmp, otmp);
1150 if (cmd_buf == NULL)
1151 goto filterend;
1153 windgoto((int)Rows - 1, 0);
1154 cursor_on();
1157 * When not redirecting the output the command can write anything to the
1158 * screen. If 'shellredir' is equal to ">", screen may be messed up by
1159 * stderr output of external command. Clear the screen later.
1160 * If do_in is FALSE, this could be something like ":r !cat", which may
1161 * also mess up the screen, clear it later.
1163 if (!do_out || STRCMP(p_srr, ">") == 0 || !do_in)
1164 redraw_later_clear();
1166 if (do_out)
1168 if (u_save((linenr_T)(line2), (linenr_T)(line2 + 1)) == FAIL)
1169 goto error;
1170 redraw_curbuf_later(VALID);
1172 read_linecount = curbuf->b_ml.ml_line_count;
1175 * When call_shell() fails wait_return() is called to give the user a
1176 * chance to read the error messages. Otherwise errors are ignored, so you
1177 * can see the error messages from the command that appear on stdout; use
1178 * 'u' to fix the text
1179 * Switch to cooked mode when not redirecting stdin, avoids that something
1180 * like ":r !cat" hangs.
1181 * Pass on the SHELL_DOOUT flag when the output is being redirected.
1183 if (call_shell(cmd_buf, SHELL_FILTER | SHELL_COOKED | shell_flags))
1185 redraw_later_clear();
1186 wait_return(FALSE);
1188 vim_free(cmd_buf);
1190 did_check_timestamps = FALSE;
1191 need_check_timestamps = TRUE;
1193 /* When interrupting the shell command, it may still have produced some
1194 * useful output. Reset got_int here, so that readfile() won't cancel
1195 * reading. */
1196 ui_breakcheck();
1197 got_int = FALSE;
1199 if (do_out)
1201 if (otmp != NULL)
1203 if (readfile(otmp, NULL, line2, (linenr_T)0, (linenr_T)MAXLNUM,
1204 eap, READ_FILTER) == FAIL)
1206 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
1207 if (!aborting())
1208 #endif
1210 msg_putchar('\n');
1211 EMSG2(_(e_notread), otmp);
1213 goto error;
1215 #ifdef FEAT_AUTOCMD
1216 if (curbuf != old_curbuf)
1217 goto filterend;
1218 #endif
1221 read_linecount = curbuf->b_ml.ml_line_count - read_linecount;
1223 if (shell_flags & SHELL_READ)
1225 curbuf->b_op_start.lnum = line2 + 1;
1226 curbuf->b_op_end.lnum = curwin->w_cursor.lnum;
1227 appended_lines_mark(line2, read_linecount);
1230 if (do_in)
1232 if (cmdmod.keepmarks || vim_strchr(p_cpo, CPO_REMMARK) == NULL)
1234 if (read_linecount >= linecount)
1235 /* move all marks from old lines to new lines */
1236 mark_adjust(line1, line2, linecount, 0L);
1237 else
1239 /* move marks from old lines to new lines, delete marks
1240 * that are in deleted lines */
1241 mark_adjust(line1, line1 + read_linecount - 1,
1242 linecount, 0L);
1243 mark_adjust(line1 + read_linecount, line2, MAXLNUM, 0L);
1248 * Put cursor on first filtered line for ":range!cmd".
1249 * Adjust '[ and '] (set by buf_write()).
1251 curwin->w_cursor.lnum = line1;
1252 del_lines(linecount, TRUE);
1253 curbuf->b_op_start.lnum -= linecount; /* adjust '[ */
1254 curbuf->b_op_end.lnum -= linecount; /* adjust '] */
1255 write_lnum_adjust(-linecount); /* adjust last line
1256 for next write */
1257 #ifdef FEAT_FOLDING
1258 foldUpdate(curwin, curbuf->b_op_start.lnum, curbuf->b_op_end.lnum);
1259 #endif
1261 else
1264 * Put cursor on last new line for ":r !cmd".
1266 linecount = curbuf->b_op_end.lnum - curbuf->b_op_start.lnum + 1;
1267 curwin->w_cursor.lnum = curbuf->b_op_end.lnum;
1270 beginline(BL_WHITE | BL_FIX); /* cursor on first non-blank */
1271 --no_wait_return;
1273 if (linecount > p_report)
1275 if (do_in)
1277 vim_snprintf((char *)msg_buf, sizeof(msg_buf),
1278 _("%ld lines filtered"), (long)linecount);
1279 if (msg(msg_buf) && !msg_scroll)
1280 /* save message to display it after redraw */
1281 set_keep_msg(msg_buf, 0);
1283 else
1284 msgmore((long)linecount);
1287 else
1289 error:
1290 /* put cursor back in same position for ":w !cmd" */
1291 curwin->w_cursor = cursor_save;
1292 --no_wait_return;
1293 wait_return(FALSE);
1296 filterend:
1298 #ifdef FEAT_AUTOCMD
1299 if (curbuf != old_curbuf)
1301 --no_wait_return;
1302 EMSG(_("E135: *Filter* Autocommands must not change current buffer"));
1304 #endif
1305 if (itmp != NULL)
1306 mch_remove(itmp);
1307 if (otmp != NULL)
1308 mch_remove(otmp);
1309 vim_free(itmp);
1310 vim_free(otmp);
1314 * Call a shell to execute a command.
1315 * When "cmd" is NULL start an interactive shell.
1317 void
1318 do_shell(cmd, flags)
1319 char_u *cmd;
1320 int flags; /* may be SHELL_DOOUT when output is redirected */
1322 buf_T *buf;
1323 #ifndef FEAT_GUI_MSWIN
1324 int save_nwr;
1325 #endif
1326 #ifdef MSWIN
1327 int winstart = FALSE;
1328 #endif
1331 * Disallow shell commands for "rvim".
1332 * Disallow shell commands from .exrc and .vimrc in current directory for
1333 * security reasons.
1335 if (check_restricted() || check_secure())
1337 msg_end();
1338 return;
1341 #ifdef MSWIN
1343 * Check if external commands are allowed now.
1345 if (can_end_termcap_mode(TRUE) == FALSE)
1346 return;
1349 * Check if ":!start" is used.
1351 if (cmd != NULL)
1352 winstart = (STRNICMP(cmd, "start ", 6) == 0);
1353 #endif
1356 * For autocommands we want to get the output on the current screen, to
1357 * avoid having to type return below.
1359 msg_putchar('\r'); /* put cursor at start of line */
1360 #ifdef FEAT_AUTOCMD
1361 if (!autocmd_busy)
1362 #endif
1364 #ifdef MSWIN
1365 if (!winstart)
1366 #endif
1367 stoptermcap();
1369 #ifdef MSWIN
1370 if (!winstart)
1371 #endif
1372 msg_putchar('\n'); /* may shift screen one line up */
1374 /* warning message before calling the shell */
1375 if (p_warn
1376 #ifdef FEAT_AUTOCMD
1377 && !autocmd_busy
1378 #endif
1379 && msg_silent == 0)
1380 for (buf = firstbuf; buf; buf = buf->b_next)
1381 if (bufIsChanged(buf))
1383 #ifdef FEAT_GUI_MSWIN
1384 if (!winstart)
1385 starttermcap(); /* don't want a message box here */
1386 #endif
1387 MSG_PUTS(_("[No write since last change]\n"));
1388 #ifdef FEAT_GUI_MSWIN
1389 if (!winstart)
1390 stoptermcap();
1391 #endif
1392 break;
1395 /* This windgoto is required for when the '\n' resulted in a "delete line
1396 * 1" command to the terminal. */
1397 if (!swapping_screen())
1398 windgoto(msg_row, msg_col);
1399 cursor_on();
1400 (void)call_shell(cmd, SHELL_COOKED | flags);
1401 did_check_timestamps = FALSE;
1402 need_check_timestamps = TRUE;
1405 * put the message cursor at the end of the screen, avoids wait_return()
1406 * to overwrite the text that the external command showed
1408 if (!swapping_screen())
1410 msg_row = Rows - 1;
1411 msg_col = 0;
1414 #ifdef FEAT_AUTOCMD
1415 if (autocmd_busy)
1417 if (msg_silent == 0)
1418 redraw_later_clear();
1420 else
1421 #endif
1424 * For ":sh" there is no need to call wait_return(), just redraw.
1425 * Also for the Win32 GUI (the output is in a console window).
1426 * Otherwise there is probably text on the screen that the user wants
1427 * to read before redrawing, so call wait_return().
1429 #ifndef FEAT_GUI_MSWIN
1430 if (cmd == NULL
1431 # ifdef WIN3264
1432 || (winstart && !need_wait_return)
1433 # endif
1436 if (msg_silent == 0)
1437 redraw_later_clear();
1438 need_wait_return = FALSE;
1440 else
1443 * If we switch screens when starttermcap() is called, we really
1444 * want to wait for "hit return to continue".
1446 save_nwr = no_wait_return;
1447 if (swapping_screen())
1448 no_wait_return = FALSE;
1449 # ifdef AMIGA
1450 wait_return(term_console ? -1 : msg_silent == 0); /* see below */
1451 # else
1452 wait_return(msg_silent == 0);
1453 # endif
1454 no_wait_return = save_nwr;
1456 #endif /* FEAT_GUI_W32 */
1458 #ifdef MSWIN
1459 if (!winstart) /* if winstart==TRUE, never stopped termcap! */
1460 #endif
1461 starttermcap(); /* start termcap if not done by wait_return() */
1464 * In an Amiga window redrawing is caused by asking the window size.
1465 * If we got an interrupt this will not work. The chance that the
1466 * window size is wrong is very small, but we need to redraw the
1467 * screen. Don't do this if ':' hit in wait_return(). THIS IS UGLY
1468 * but it saves an extra redraw.
1470 #ifdef AMIGA
1471 if (skip_redraw) /* ':' hit in wait_return() */
1473 if (msg_silent == 0)
1474 redraw_later_clear();
1476 else if (term_console)
1478 OUT_STR(IF_EB("\033[0 q", ESC_STR "[0 q")); /* get window size */
1479 if (got_int && msg_silent == 0)
1480 redraw_later_clear(); /* if got_int is TRUE, redraw needed */
1481 else
1482 must_redraw = 0; /* no extra redraw needed */
1484 #endif
1487 /* display any error messages now */
1488 display_errors();
1490 #ifdef FEAT_AUTOCMD
1491 apply_autocmds(EVENT_SHELLCMDPOST, NULL, NULL, FALSE, curbuf);
1492 #endif
1496 * Create a shell command from a command string, input redirection file and
1497 * output redirection file.
1498 * Returns an allocated string with the shell command, or NULL for failure.
1500 char_u *
1501 make_filter_cmd(cmd, itmp, otmp)
1502 char_u *cmd; /* command */
1503 char_u *itmp; /* NULL or name of input file */
1504 char_u *otmp; /* NULL or name of output file */
1506 char_u *buf;
1507 long_u len;
1509 len = (long_u)STRLEN(cmd) + 3; /* "()" + NUL */
1510 if (itmp != NULL)
1511 len += (long_u)STRLEN(itmp) + 9; /* " { < " + " } " */
1512 if (otmp != NULL)
1513 len += (long_u)STRLEN(otmp) + (long_u)STRLEN(p_srr) + 2; /* " " */
1514 buf = lalloc(len, TRUE);
1515 if (buf == NULL)
1516 return NULL;
1518 #if (defined(UNIX) && !defined(ARCHIE)) || defined(OS2)
1520 * Put braces around the command (for concatenated commands) when
1521 * redirecting input and/or output.
1523 if (itmp != NULL || otmp != NULL)
1524 sprintf((char *)buf, "(%s)", (char *)cmd);
1525 else
1526 STRCPY(buf, cmd);
1527 if (itmp != NULL)
1529 STRCAT(buf, " < ");
1530 STRCAT(buf, itmp);
1532 #else
1534 * for shells that don't understand braces around commands, at least allow
1535 * the use of commands in a pipe.
1537 STRCPY(buf, cmd);
1538 if (itmp != NULL)
1540 char_u *p;
1543 * If there is a pipe, we have to put the '<' in front of it.
1544 * Don't do this when 'shellquote' is not empty, otherwise the
1545 * redirection would be inside the quotes.
1547 if (*p_shq == NUL)
1549 p = vim_strchr(buf, '|');
1550 if (p != NULL)
1551 *p = NUL;
1553 # ifdef RISCOS
1554 STRCAT(buf, " { < "); /* Use RISC OS notation for input. */
1555 STRCAT(buf, itmp);
1556 STRCAT(buf, " } ");
1557 # else
1558 STRCAT(buf, " <"); /* " < " causes problems on Amiga */
1559 STRCAT(buf, itmp);
1560 # endif
1561 if (*p_shq == NUL)
1563 p = vim_strchr(cmd, '|');
1564 if (p != NULL)
1566 STRCAT(buf, " "); /* insert a space before the '|' for DOS */
1567 STRCAT(buf, p);
1571 #endif
1572 if (otmp != NULL)
1573 append_redir(buf, p_srr, otmp);
1575 return buf;
1579 * Append output redirection for file "fname" to the end of string buffer "buf"
1580 * Works with the 'shellredir' and 'shellpipe' options.
1581 * The caller should make sure that there is enough room:
1582 * STRLEN(opt) + STRLEN(fname) + 3
1584 void
1585 append_redir(buf, opt, fname)
1586 char_u *buf;
1587 char_u *opt;
1588 char_u *fname;
1590 char_u *p;
1592 buf += STRLEN(buf);
1593 /* find "%s", skipping "%%" */
1594 for (p = opt; (p = vim_strchr(p, '%')) != NULL; ++p)
1595 if (p[1] == 's')
1596 break;
1597 if (p != NULL)
1599 *buf = ' '; /* not really needed? Not with sh, ksh or bash */
1600 sprintf((char *)buf + 1, (char *)opt, (char *)fname);
1602 else
1603 sprintf((char *)buf,
1604 #ifdef FEAT_QUICKFIX
1605 # ifndef RISCOS
1606 opt != p_sp ? " %s%s" :
1607 # endif
1608 " %s %s",
1609 #else
1610 # ifndef RISCOS
1611 " %s%s", /* " > %s" causes problems on Amiga */
1612 # else
1613 " %s %s", /* But is needed for 'shellpipe' and RISC OS */
1614 # endif
1615 #endif
1616 (char *)opt, (char *)fname);
1619 #ifdef FEAT_VIMINFO
1621 static int no_viminfo __ARGS((void));
1622 static int viminfo_errcnt;
1624 static int
1625 no_viminfo()
1627 /* "vim -i NONE" does not read or write a viminfo file */
1628 return (use_viminfo != NULL && STRCMP(use_viminfo, "NONE") == 0);
1632 * Report an error for reading a viminfo file.
1633 * Count the number of errors. When there are more than 10, return TRUE.
1636 viminfo_error(errnum, message, line)
1637 char *errnum;
1638 char *message;
1639 char_u *line;
1641 vim_snprintf((char *)IObuff, IOSIZE, _("%sviminfo: %s in line: "),
1642 errnum, message);
1643 STRNCAT(IObuff, line, IOSIZE - STRLEN(IObuff));
1644 if (IObuff[STRLEN(IObuff) - 1] == '\n')
1645 IObuff[STRLEN(IObuff) - 1] = NUL;
1646 emsg(IObuff);
1647 if (++viminfo_errcnt >= 10)
1649 EMSG(_("E136: viminfo: Too many errors, skipping rest of file"));
1650 return TRUE;
1652 return FALSE;
1656 * read_viminfo() -- Read the viminfo file. Registers etc. which are already
1657 * set are not over-written unless force is TRUE. -- webb
1660 read_viminfo(file, want_info, want_marks, forceit)
1661 char_u *file;
1662 int want_info;
1663 int want_marks;
1664 int forceit;
1666 FILE *fp;
1667 char_u *fname;
1669 if (no_viminfo())
1670 return FAIL;
1672 fname = viminfo_filename(file); /* may set to default if NULL */
1673 if (fname == NULL)
1674 return FAIL;
1675 fp = mch_fopen((char *)fname, READBIN);
1677 if (p_verbose > 0)
1679 verbose_enter();
1680 smsg((char_u *)_("Reading viminfo file \"%s\"%s%s%s"),
1681 fname,
1682 want_info ? _(" info") : "",
1683 want_marks ? _(" marks") : "",
1684 fp == NULL ? _(" FAILED") : "");
1685 verbose_leave();
1688 vim_free(fname);
1689 if (fp == NULL)
1690 return FAIL;
1692 viminfo_errcnt = 0;
1693 do_viminfo(fp, NULL, want_info, want_marks, forceit);
1695 fclose(fp);
1697 return OK;
1701 * write_viminfo() -- Write the viminfo file. The old one is read in first so
1702 * that effectively a merge of current info and old info is done. This allows
1703 * multiple vims to run simultaneously, without losing any marks etc. If
1704 * forceit is TRUE, then the old file is not read in, and only internal info is
1705 * written to the file. -- webb
1707 void
1708 write_viminfo(file, forceit)
1709 char_u *file;
1710 int forceit;
1712 char_u *fname;
1713 FILE *fp_in = NULL; /* input viminfo file, if any */
1714 FILE *fp_out = NULL; /* output viminfo file */
1715 char_u *tempname = NULL; /* name of temp viminfo file */
1716 struct stat st_new; /* mch_stat() of potential new file */
1717 char_u *wp;
1718 #if defined(UNIX) || defined(VMS)
1719 mode_t umask_save;
1720 #endif
1721 #ifdef UNIX
1722 int shortname = FALSE; /* use 8.3 file name */
1723 struct stat st_old; /* mch_stat() of existing viminfo file */
1724 #endif
1725 #ifdef WIN3264
1726 long perm = -1;
1727 #endif
1729 if (no_viminfo())
1730 return;
1732 fname = viminfo_filename(file); /* may set to default if NULL */
1733 if (fname == NULL)
1734 return;
1736 fp_in = mch_fopen((char *)fname, READBIN);
1737 if (fp_in == NULL)
1739 /* if it does exist, but we can't read it, don't try writing */
1740 if (mch_stat((char *)fname, &st_new) == 0)
1741 goto end;
1742 #if defined(UNIX) || defined(VMS)
1744 * For Unix we create the .viminfo non-accessible for others,
1745 * because it may contain text from non-accessible documents.
1747 umask_save = umask(077);
1748 #endif
1749 fp_out = mch_fopen((char *)fname, WRITEBIN);
1750 #if defined(UNIX) || defined(VMS)
1751 (void)umask(umask_save);
1752 #endif
1754 else
1757 * There is an existing viminfo file. Create a temporary file to
1758 * write the new viminfo into, in the same directory as the
1759 * existing viminfo file, which will be renamed later.
1761 #ifdef UNIX
1763 * For Unix we check the owner of the file. It's not very nice to
1764 * overwrite a user's viminfo file after a "su root", with a
1765 * viminfo file that the user can't read.
1767 st_old.st_dev = st_old.st_ino = 0;
1768 st_old.st_mode = 0600;
1769 if (mch_stat((char *)fname, &st_old) == 0 && getuid()
1770 && !(st_old.st_uid == getuid()
1771 ? (st_old.st_mode & 0200)
1772 : (st_old.st_gid == getgid()
1773 ? (st_old.st_mode & 0020)
1774 : (st_old.st_mode & 0002))))
1776 int tt = msg_didany;
1778 /* avoid a wait_return for this message, it's annoying */
1779 EMSG2(_("E137: Viminfo file is not writable: %s"), fname);
1780 msg_didany = tt;
1781 fclose(fp_in);
1782 goto end;
1784 #endif
1785 #ifdef WIN3264
1786 /* Get the file attributes of the existing viminfo file. */
1787 perm = mch_getperm(fname);
1788 #endif
1791 * Make tempname.
1792 * May try twice: Once normal and once with shortname set, just in
1793 * case somebody puts his viminfo file in an 8.3 filesystem.
1795 for (;;)
1797 tempname = buf_modname(
1798 #ifdef UNIX
1799 shortname,
1800 #else
1801 # ifdef SHORT_FNAME
1802 TRUE,
1803 # else
1804 # ifdef FEAT_GUI_W32
1805 gui_is_win32s(),
1806 # else
1807 FALSE,
1808 # endif
1809 # endif
1810 #endif
1811 fname,
1812 #ifdef VMS
1813 (char_u *)"-tmp",
1814 #else
1815 # ifdef RISCOS
1816 (char_u *)"/tmp",
1817 # else
1818 (char_u *)".tmp",
1819 # endif
1820 #endif
1821 FALSE);
1822 if (tempname == NULL) /* out of memory */
1823 break;
1826 * Check if tempfile already exists. Never overwrite an
1827 * existing file!
1829 if (mch_stat((char *)tempname, &st_new) == 0)
1831 #ifdef UNIX
1833 * Check if tempfile is same as original file. May happen
1834 * when modname() gave the same file back. E.g. silly
1835 * link, or file name-length reached. Try again with
1836 * shortname set.
1838 if (!shortname && st_new.st_dev == st_old.st_dev
1839 && st_new.st_ino == st_old.st_ino)
1841 vim_free(tempname);
1842 tempname = NULL;
1843 shortname = TRUE;
1844 continue;
1846 #endif
1848 * Try another name. Change one character, just before
1849 * the extension. This should also work for an 8.3
1850 * file name, when after adding the extension it still is
1851 * the same file as the original.
1853 wp = tempname + STRLEN(tempname) - 5;
1854 if (wp < gettail(tempname)) /* empty file name? */
1855 wp = gettail(tempname);
1856 for (*wp = 'z'; mch_stat((char *)tempname, &st_new) == 0;
1857 --*wp)
1860 * They all exist? Must be something wrong! Don't
1861 * write the viminfo file then.
1863 if (*wp == 'a')
1865 vim_free(tempname);
1866 tempname = NULL;
1867 break;
1871 break;
1874 if (tempname != NULL)
1876 #ifdef VMS
1877 /* fdopen() fails for some reason */
1878 umask_save = umask(077);
1879 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1880 (void)umask(umask_save);
1881 #else
1882 int fd;
1884 /* Use mch_open() to be able to use O_NOFOLLOW and set file
1885 * protection:
1886 * Unix: same as original file, but strip s-bit. Reset umask to
1887 * avoid it getting in the way.
1888 * Others: r&w for user only. */
1889 # ifdef UNIX
1890 umask_save = umask(0);
1891 fd = mch_open((char *)tempname,
1892 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW,
1893 (int)((st_old.st_mode & 0777) | 0600));
1894 (void)umask(umask_save);
1895 # else
1896 fd = mch_open((char *)tempname,
1897 O_CREAT|O_EXTRA|O_EXCL|O_WRONLY|O_NOFOLLOW, 0600);
1898 # endif
1899 if (fd < 0)
1900 fp_out = NULL;
1901 else
1902 fp_out = fdopen(fd, WRITEBIN);
1903 #endif /* VMS */
1906 * If we can't create in the same directory, try creating a
1907 * "normal" temp file.
1909 if (fp_out == NULL)
1911 vim_free(tempname);
1912 if ((tempname = vim_tempname('o')) != NULL)
1913 fp_out = mch_fopen((char *)tempname, WRITEBIN);
1916 #if defined(UNIX) && defined(HAVE_FCHOWN)
1918 * Make sure the owner can read/write it. This only works for
1919 * root.
1921 if (fp_out != NULL)
1922 (void)fchown(fileno(fp_out), st_old.st_uid, st_old.st_gid);
1923 #endif
1928 * Check if the new viminfo file can be written to.
1930 if (fp_out == NULL)
1932 EMSG2(_("E138: Can't write viminfo file %s!"),
1933 (fp_in == NULL || tempname == NULL) ? fname : tempname);
1934 if (fp_in != NULL)
1935 fclose(fp_in);
1936 goto end;
1939 if (p_verbose > 0)
1941 verbose_enter();
1942 smsg((char_u *)_("Writing viminfo file \"%s\""), fname);
1943 verbose_leave();
1946 viminfo_errcnt = 0;
1947 do_viminfo(fp_in, fp_out, !forceit, !forceit, FALSE);
1949 fclose(fp_out); /* errors are ignored !? */
1950 if (fp_in != NULL)
1952 fclose(fp_in);
1955 * In case of an error keep the original viminfo file.
1956 * Otherwise rename the newly written file.
1958 if (viminfo_errcnt || vim_rename(tempname, fname) == -1)
1959 mch_remove(tempname);
1961 #ifdef WIN3264
1962 /* If the viminfo file was hidden then also hide the new file. */
1963 if (perm > 0 && (perm & FILE_ATTRIBUTE_HIDDEN))
1964 mch_hide(fname);
1965 #endif
1968 end:
1969 vim_free(fname);
1970 vim_free(tempname);
1974 * Get the viminfo file name to use.
1975 * If "file" is given and not empty, use it (has already been expanded by
1976 * cmdline functions).
1977 * Otherwise use "-i file_name", value from 'viminfo' or the default, and
1978 * expand environment variables.
1979 * Returns an allocated string. NULL when out of memory.
1981 static char_u *
1982 viminfo_filename(file)
1983 char_u *file;
1985 if (file == NULL || *file == NUL)
1987 if (use_viminfo != NULL)
1988 file = use_viminfo;
1989 else if ((file = find_viminfo_parameter('n')) == NULL || *file == NUL)
1991 #ifdef VIMINFO_FILE2
1992 /* don't use $HOME when not defined (turned into "c:/"!). */
1993 # ifdef VMS
1994 if (mch_getenv((char_u *)"SYS$LOGIN") == NULL)
1995 # else
1996 if (mch_getenv((char_u *)"HOME") == NULL)
1997 # endif
1999 /* don't use $VIM when not available. */
2000 expand_env((char_u *)"$VIM", NameBuff, MAXPATHL);
2001 if (STRCMP("$VIM", NameBuff) != 0) /* $VIM was expanded */
2002 file = (char_u *)VIMINFO_FILE2;
2003 else
2004 file = (char_u *)VIMINFO_FILE;
2006 else
2007 #endif
2008 file = (char_u *)VIMINFO_FILE;
2010 expand_env(file, NameBuff, MAXPATHL);
2011 file = NameBuff;
2013 return vim_strsave(file);
2017 * do_viminfo() -- Should only be called from read_viminfo() & write_viminfo().
2019 static void
2020 do_viminfo(fp_in, fp_out, want_info, want_marks, force_read)
2021 FILE *fp_in;
2022 FILE *fp_out;
2023 int want_info;
2024 int want_marks;
2025 int force_read;
2027 int count = 0;
2028 int eof = FALSE;
2029 vir_T vir;
2031 if ((vir.vir_line = alloc(LSIZE)) == NULL)
2032 return;
2033 vir.vir_fd = fp_in;
2034 #ifdef FEAT_MBYTE
2035 vir.vir_conv.vc_type = CONV_NONE;
2036 #endif
2038 if (fp_in != NULL)
2040 if (want_info)
2041 eof = read_viminfo_up_to_marks(&vir, force_read, fp_out != NULL);
2042 else
2043 /* Skip info, find start of marks */
2044 while (!(eof = viminfo_readline(&vir))
2045 && vir.vir_line[0] != '>')
2048 if (fp_out != NULL)
2050 /* Write the info: */
2051 fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
2052 VIM_VERSION_MEDIUM);
2053 fprintf(fp_out, _("# You may edit it if you're careful!\n\n"));
2054 #ifdef FEAT_MBYTE
2055 fprintf(fp_out, _("# Value of 'encoding' when this file was written\n"));
2056 fprintf(fp_out, "*encoding=%s\n\n", p_enc);
2057 #endif
2058 write_viminfo_search_pattern(fp_out);
2059 write_viminfo_sub_string(fp_out);
2060 #ifdef FEAT_CMDHIST
2061 write_viminfo_history(fp_out);
2062 #endif
2063 write_viminfo_registers(fp_out);
2064 #ifdef FEAT_EVAL
2065 write_viminfo_varlist(fp_out);
2066 #endif
2067 write_viminfo_filemarks(fp_out);
2068 write_viminfo_bufferlist(fp_out);
2069 count = write_viminfo_marks(fp_out);
2071 if (fp_in != NULL && want_marks)
2072 copy_viminfo_marks(&vir, fp_out, count, eof);
2074 vim_free(vir.vir_line);
2075 #ifdef FEAT_MBYTE
2076 if (vir.vir_conv.vc_type != CONV_NONE)
2077 convert_setup(&vir.vir_conv, NULL, NULL);
2078 #endif
2082 * read_viminfo_up_to_marks() -- Only called from do_viminfo(). Reads in the
2083 * first part of the viminfo file which contains everything but the marks that
2084 * are local to a file. Returns TRUE when end-of-file is reached. -- webb
2086 static int
2087 read_viminfo_up_to_marks(virp, forceit, writing)
2088 vir_T *virp;
2089 int forceit;
2090 int writing;
2092 int eof;
2093 buf_T *buf;
2095 #ifdef FEAT_CMDHIST
2096 prepare_viminfo_history(forceit ? 9999 : 0);
2097 #endif
2098 eof = viminfo_readline(virp);
2099 while (!eof && virp->vir_line[0] != '>')
2101 switch (virp->vir_line[0])
2103 /* Characters reserved for future expansion, ignored now */
2104 case '+': /* "+40 /path/dir file", for running vim without args */
2105 case '|': /* to be defined */
2106 case '^': /* to be defined */
2107 case '<': /* long line - ignored */
2108 /* A comment or empty line. */
2109 case NUL:
2110 case '\r':
2111 case '\n':
2112 case '#':
2113 eof = viminfo_readline(virp);
2114 break;
2115 case '*': /* "*encoding=value" */
2116 eof = viminfo_encoding(virp);
2117 break;
2118 case '!': /* global variable */
2119 #ifdef FEAT_EVAL
2120 eof = read_viminfo_varlist(virp, writing);
2121 #else
2122 eof = viminfo_readline(virp);
2123 #endif
2124 break;
2125 case '%': /* entry for buffer list */
2126 eof = read_viminfo_bufferlist(virp, writing);
2127 break;
2128 case '"':
2129 eof = read_viminfo_register(virp, forceit);
2130 break;
2131 case '/': /* Search string */
2132 case '&': /* Substitute search string */
2133 case '~': /* Last search string, followed by '/' or '&' */
2134 eof = read_viminfo_search_pattern(virp, forceit);
2135 break;
2136 case '$':
2137 eof = read_viminfo_sub_string(virp, forceit);
2138 break;
2139 case ':':
2140 case '?':
2141 case '=':
2142 case '@':
2143 #ifdef FEAT_CMDHIST
2144 eof = read_viminfo_history(virp);
2145 #else
2146 eof = viminfo_readline(virp);
2147 #endif
2148 break;
2149 case '-':
2150 case '\'':
2151 eof = read_viminfo_filemark(virp, forceit);
2152 break;
2153 default:
2154 if (viminfo_error("E575: ", _("Illegal starting char"),
2155 virp->vir_line))
2156 eof = TRUE;
2157 else
2158 eof = viminfo_readline(virp);
2159 break;
2163 #ifdef FEAT_CMDHIST
2164 /* Finish reading history items. */
2165 finish_viminfo_history();
2166 #endif
2168 /* Change file names to buffer numbers for fmarks. */
2169 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2170 fmarks_check_names(buf);
2172 return eof;
2176 * Compare the 'encoding' value in the viminfo file with the current value of
2177 * 'encoding'. If different and the 'c' flag is in 'viminfo', setup for
2178 * conversion of text with iconv() in viminfo_readstring().
2180 static int
2181 viminfo_encoding(virp)
2182 vir_T *virp;
2184 #ifdef FEAT_MBYTE
2185 char_u *p;
2186 int i;
2188 if (get_viminfo_parameter('c') != 0)
2190 p = vim_strchr(virp->vir_line, '=');
2191 if (p != NULL)
2193 /* remove trailing newline */
2194 ++p;
2195 for (i = 0; vim_isprintc(p[i]); ++i)
2197 p[i] = NUL;
2199 convert_setup(&virp->vir_conv, p, p_enc);
2202 #endif
2203 return viminfo_readline(virp);
2207 * Read a line from the viminfo file.
2208 * Returns TRUE for end-of-file;
2211 viminfo_readline(virp)
2212 vir_T *virp;
2214 return vim_fgets(virp->vir_line, LSIZE, virp->vir_fd);
2218 * check string read from viminfo file
2219 * remove '\n' at the end of the line
2220 * - replace CTRL-V CTRL-V with CTRL-V
2221 * - replace CTRL-V 'n' with '\n'
2223 * Check for a long line as written by viminfo_writestring().
2225 * Return the string in allocated memory (NULL when out of memory).
2227 /*ARGSUSED*/
2228 char_u *
2229 viminfo_readstring(virp, off, convert)
2230 vir_T *virp;
2231 int off; /* offset for virp->vir_line */
2232 int convert; /* convert the string */
2234 char_u *retval;
2235 char_u *s, *d;
2236 long len;
2238 if (virp->vir_line[off] == Ctrl_V && vim_isdigit(virp->vir_line[off + 1]))
2240 len = atol((char *)virp->vir_line + off + 1);
2241 retval = lalloc(len, TRUE);
2242 if (retval == NULL)
2244 /* Line too long? File messed up? Skip next line. */
2245 (void)vim_fgets(virp->vir_line, 10, virp->vir_fd);
2246 return NULL;
2248 (void)vim_fgets(retval, (int)len, virp->vir_fd);
2249 s = retval + 1; /* Skip the leading '<' */
2251 else
2253 retval = vim_strsave(virp->vir_line + off);
2254 if (retval == NULL)
2255 return NULL;
2256 s = retval;
2259 /* Change CTRL-V CTRL-V to CTRL-V and CTRL-V n to \n in-place. */
2260 d = retval;
2261 while (*s != NUL && *s != '\n')
2263 if (s[0] == Ctrl_V && s[1] != NUL)
2265 if (s[1] == 'n')
2266 *d++ = '\n';
2267 else
2268 *d++ = Ctrl_V;
2269 s += 2;
2271 else
2272 *d++ = *s++;
2274 *d = NUL;
2276 #ifdef FEAT_MBYTE
2277 if (convert && virp->vir_conv.vc_type != CONV_NONE && *retval != NUL)
2279 d = string_convert(&virp->vir_conv, retval, NULL);
2280 if (d != NULL)
2282 vim_free(retval);
2283 retval = d;
2286 #endif
2288 return retval;
2292 * write string to viminfo file
2293 * - replace CTRL-V with CTRL-V CTRL-V
2294 * - replace '\n' with CTRL-V 'n'
2295 * - add a '\n' at the end
2297 * For a long line:
2298 * - write " CTRL-V <length> \n " in first line
2299 * - write " < <string> \n " in second line
2301 void
2302 viminfo_writestring(fd, p)
2303 FILE *fd;
2304 char_u *p;
2306 int c;
2307 char_u *s;
2308 int len = 0;
2310 for (s = p; *s != NUL; ++s)
2312 if (*s == Ctrl_V || *s == '\n')
2313 ++len;
2314 ++len;
2317 /* If the string will be too long, write its length and put it in the next
2318 * line. Take into account that some room is needed for what comes before
2319 * the string (e.g., variable name). Add something to the length for the
2320 * '<', NL and trailing NUL. */
2321 if (len > LSIZE / 2)
2322 fprintf(fd, IF_EB("\026%d\n<", CTRL_V_STR "%d\n<"), len + 3);
2324 while ((c = *p++) != NUL)
2326 if (c == Ctrl_V || c == '\n')
2328 putc(Ctrl_V, fd);
2329 if (c == '\n')
2330 c = 'n';
2332 putc(c, fd);
2334 putc('\n', fd);
2336 #endif /* FEAT_VIMINFO */
2339 * Implementation of ":fixdel", also used by get_stty().
2340 * <BS> resulting <Del>
2341 * ^? ^H
2342 * not ^? ^?
2344 /*ARGSUSED*/
2345 void
2346 do_fixdel(eap)
2347 exarg_T *eap;
2349 char_u *p;
2351 p = find_termcode((char_u *)"kb");
2352 add_termcode((char_u *)"kD", p != NULL
2353 && *p == DEL ? (char_u *)CTRL_H_STR : DEL_STR, FALSE);
2356 void
2357 print_line_no_prefix(lnum, use_number, list)
2358 linenr_T lnum;
2359 int use_number;
2360 int list;
2362 char_u numbuf[30];
2364 if (curwin->w_p_nu || use_number)
2366 sprintf((char *)numbuf, "%*ld ", number_width(curwin), (long)lnum);
2367 msg_puts_attr(numbuf, hl_attr(HLF_N)); /* Highlight line nrs */
2369 msg_prt_line(ml_get(lnum), list);
2373 * Print a text line. Also in silent mode ("ex -s").
2375 void
2376 print_line(lnum, use_number, list)
2377 linenr_T lnum;
2378 int use_number;
2379 int list;
2381 int save_silent = silent_mode;
2383 msg_start();
2384 silent_mode = FALSE;
2385 info_message = TRUE; /* use mch_msg(), not mch_errmsg() */
2386 print_line_no_prefix(lnum, use_number, list);
2387 if (save_silent)
2389 msg_putchar('\n');
2390 cursor_on(); /* msg_start() switches it off */
2391 out_flush();
2392 silent_mode = save_silent;
2393 info_message = FALSE;
2398 * ":file[!] [fname]".
2400 void
2401 ex_file(eap)
2402 exarg_T *eap;
2404 char_u *fname, *sfname, *xfname;
2405 buf_T *buf;
2407 /* ":0file" removes the file name. Check for illegal uses ":3file",
2408 * "0file name", etc. */
2409 if (eap->addr_count > 0
2410 && (*eap->arg != NUL
2411 || eap->line2 > 0
2412 || eap->addr_count > 1))
2414 EMSG(_(e_invarg));
2415 return;
2418 if (*eap->arg != NUL || eap->addr_count == 1)
2420 #ifdef FEAT_AUTOCMD
2421 buf = curbuf;
2422 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2423 /* buffer changed, don't change name now */
2424 if (buf != curbuf)
2425 return;
2426 # ifdef FEAT_EVAL
2427 if (aborting()) /* autocmds may abort script processing */
2428 return;
2429 # endif
2430 #endif
2432 * The name of the current buffer will be changed.
2433 * A new (unlisted) buffer entry needs to be made to hold the old file
2434 * name, which will become the alternate file name.
2435 * But don't set the alternate file name if the buffer didn't have a
2436 * name.
2438 fname = curbuf->b_ffname;
2439 sfname = curbuf->b_sfname;
2440 xfname = curbuf->b_fname;
2441 curbuf->b_ffname = NULL;
2442 curbuf->b_sfname = NULL;
2443 if (setfname(curbuf, eap->arg, NULL, TRUE) == FAIL)
2445 curbuf->b_ffname = fname;
2446 curbuf->b_sfname = sfname;
2447 return;
2449 curbuf->b_flags |= BF_NOTEDITED;
2450 if (xfname != NULL && *xfname != NUL)
2452 buf = buflist_new(fname, xfname, curwin->w_cursor.lnum, 0);
2453 if (buf != NULL && !cmdmod.keepalt)
2454 curwin->w_alt_fnum = buf->b_fnum;
2456 vim_free(fname);
2457 vim_free(sfname);
2458 #ifdef FEAT_AUTOCMD
2459 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2460 #endif
2462 /* print full file name if :cd used */
2463 fileinfo(FALSE, FALSE, eap->forceit);
2467 * ":update".
2469 void
2470 ex_update(eap)
2471 exarg_T *eap;
2473 if (curbufIsChanged())
2474 (void)do_write(eap);
2478 * ":write" and ":saveas".
2480 void
2481 ex_write(eap)
2482 exarg_T *eap;
2484 if (eap->usefilter) /* input lines to shell command */
2485 do_bang(1, eap, FALSE, TRUE, FALSE);
2486 else
2487 (void)do_write(eap);
2491 * write current buffer to file 'eap->arg'
2492 * if 'eap->append' is TRUE, append to the file
2494 * if *eap->arg == NUL write to current file
2496 * return FAIL for failure, OK otherwise
2499 do_write(eap)
2500 exarg_T *eap;
2502 int other;
2503 char_u *fname = NULL; /* init to shut up gcc */
2504 char_u *ffname;
2505 int retval = FAIL;
2506 char_u *free_fname = NULL;
2507 #ifdef FEAT_BROWSE
2508 char_u *browse_file = NULL;
2509 #endif
2510 buf_T *alt_buf = NULL;
2512 if (not_writing()) /* check 'write' option */
2513 return FAIL;
2515 ffname = eap->arg;
2516 #ifdef FEAT_BROWSE
2517 if (cmdmod.browse)
2519 browse_file = do_browse(BROWSE_SAVE, (char_u *)_("Save As"), ffname,
2520 NULL, NULL, NULL, curbuf);
2521 if (browse_file == NULL)
2522 goto theend;
2523 ffname = browse_file;
2525 #endif
2526 if (*ffname == NUL)
2528 if (eap->cmdidx == CMD_saveas)
2530 EMSG(_(e_argreq));
2531 goto theend;
2533 other = FALSE;
2535 else
2537 fname = ffname;
2538 free_fname = fix_fname(ffname);
2540 * When out-of-memory, keep unexpanded file name, because we MUST be
2541 * able to write the file in this situation.
2543 if (free_fname != NULL)
2544 ffname = free_fname;
2545 other = otherfile(ffname);
2549 * If we have a new file, put its name in the list of alternate file names.
2551 if (other)
2553 if (vim_strchr(p_cpo, CPO_ALTWRITE) != NULL
2554 || eap->cmdidx == CMD_saveas)
2555 alt_buf = setaltfname(ffname, fname, (linenr_T)1);
2556 else
2557 alt_buf = buflist_findname(ffname);
2558 if (alt_buf != NULL && alt_buf->b_ml.ml_mfp != NULL)
2560 /* Overwriting a file that is loaded in another buffer is not a
2561 * good idea. */
2562 EMSG(_(e_bufloaded));
2563 goto theend;
2568 * Writing to the current file is not allowed in readonly mode
2569 * and a file name is required.
2570 * "nofile" and "nowrite" buffers cannot be written implicitly either.
2572 if (!other && (
2573 #ifdef FEAT_QUICKFIX
2574 bt_dontwrite_msg(curbuf) ||
2575 #endif
2576 check_fname() == FAIL || check_readonly(&eap->forceit, curbuf)))
2577 goto theend;
2579 if (!other)
2581 ffname = curbuf->b_ffname;
2582 fname = curbuf->b_fname;
2584 * Not writing the whole file is only allowed with '!'.
2586 if ( (eap->line1 != 1
2587 || eap->line2 != curbuf->b_ml.ml_line_count)
2588 && !eap->forceit
2589 && !eap->append
2590 && !p_wa)
2592 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2593 if (p_confirm || cmdmod.confirm)
2595 if (vim_dialog_yesno(VIM_QUESTION, NULL,
2596 (char_u *)_("Write partial file?"), 2) != VIM_YES)
2597 goto theend;
2598 eap->forceit = TRUE;
2600 else
2601 #endif
2603 EMSG(_("E140: Use ! to write partial buffer"));
2604 goto theend;
2609 if (check_overwrite(eap, curbuf, fname, ffname, other) == OK)
2611 if (eap->cmdidx == CMD_saveas && alt_buf != NULL)
2613 #ifdef FEAT_AUTOCMD
2614 buf_T *was_curbuf = curbuf;
2616 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, curbuf);
2617 apply_autocmds(EVENT_BUFFILEPRE, NULL, NULL, FALSE, alt_buf);
2618 # ifdef FEAT_EVAL
2619 if (curbuf != was_curbuf || aborting())
2620 # else
2621 if (curbuf != was_curbuf)
2622 # endif
2624 /* buffer changed, don't change name now */
2625 retval = FAIL;
2626 goto theend;
2628 #endif
2629 /* Exchange the file names for the current and the alternate
2630 * buffer. This makes it look like we are now editing the buffer
2631 * under the new name. Must be done before buf_write(), because
2632 * if there is no file name and 'cpo' contains 'F', it will set
2633 * the file name. */
2634 fname = alt_buf->b_fname;
2635 alt_buf->b_fname = curbuf->b_fname;
2636 curbuf->b_fname = fname;
2637 fname = alt_buf->b_ffname;
2638 alt_buf->b_ffname = curbuf->b_ffname;
2639 curbuf->b_ffname = fname;
2640 fname = alt_buf->b_sfname;
2641 alt_buf->b_sfname = curbuf->b_sfname;
2642 curbuf->b_sfname = fname;
2643 buf_name_changed(curbuf);
2644 #ifdef FEAT_AUTOCMD
2645 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, curbuf);
2646 apply_autocmds(EVENT_BUFFILEPOST, NULL, NULL, FALSE, alt_buf);
2647 if (!alt_buf->b_p_bl)
2649 alt_buf->b_p_bl = TRUE;
2650 apply_autocmds(EVENT_BUFADD, NULL, NULL, FALSE, alt_buf);
2652 # ifdef FEAT_EVAL
2653 if (curbuf != was_curbuf || aborting())
2654 # else
2655 if (curbuf != was_curbuf)
2656 # endif
2658 /* buffer changed, don't write the file */
2659 retval = FAIL;
2660 goto theend;
2663 /* If 'filetype' was empty try detecting it now. */
2664 if (*curbuf->b_p_ft == NUL)
2666 if (au_has_group((char_u *)"filetypedetect"))
2667 (void)do_doautocmd((char_u *)"filetypedetect BufRead",
2668 TRUE);
2669 do_modelines(0);
2671 #endif
2674 retval = buf_write(curbuf, ffname, fname, eap->line1, eap->line2,
2675 eap, eap->append, eap->forceit, TRUE, FALSE);
2677 /* After ":saveas fname" reset 'readonly'. */
2678 if (eap->cmdidx == CMD_saveas && retval == OK)
2679 curbuf->b_p_ro = FALSE;
2682 theend:
2683 #ifdef FEAT_BROWSE
2684 vim_free(browse_file);
2685 #endif
2686 vim_free(free_fname);
2687 return retval;
2691 * Check if it is allowed to overwrite a file. If b_flags has BF_NOTEDITED,
2692 * BF_NEW or BF_READERR, check for overwriting current file.
2693 * May set eap->forceit if a dialog says it's OK to overwrite.
2694 * Return OK if it's OK, FAIL if it is not.
2696 /*ARGSUSED*/
2697 static int
2698 check_overwrite(eap, buf, fname, ffname, other)
2699 exarg_T *eap;
2700 buf_T *buf;
2701 char_u *fname; /* file name to be used (can differ from
2702 buf->ffname) */
2703 char_u *ffname; /* full path version of fname */
2704 int other; /* writing under other name */
2707 * write to other file or b_flags set or not writing the whole file:
2708 * overwriting only allowed with '!'
2710 if ( (other
2711 || (buf->b_flags & BF_NOTEDITED)
2712 || ((buf->b_flags & BF_NEW)
2713 && vim_strchr(p_cpo, CPO_OVERNEW) == NULL)
2714 || (buf->b_flags & BF_READERR))
2715 && !p_wa
2716 && vim_fexists(ffname))
2718 if (!eap->forceit && !eap->append)
2720 #ifdef UNIX
2721 /* with UNIX it is possible to open a directory */
2722 if (mch_isdir(ffname))
2724 EMSG2(_(e_isadir2), ffname);
2725 return FAIL;
2727 #endif
2728 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2729 if (p_confirm || cmdmod.confirm)
2731 char_u buff[IOSIZE];
2733 dialog_msg(buff, _("Overwrite existing file \"%s\"?"), fname);
2734 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) != VIM_YES)
2735 return FAIL;
2736 eap->forceit = TRUE;
2738 else
2739 #endif
2741 EMSG(_(e_exists));
2742 return FAIL;
2746 /* For ":w! filename" check that no swap file exists for "filename". */
2747 if (other && !emsg_silent)
2749 char_u dir[MAXPATHL];
2750 char_u *p;
2751 int r;
2752 char_u *swapname;
2754 /* We only try the first entry in 'directory', without checking if
2755 * it's writable. If the "." directory is not writable the write
2756 * will probably fail anyway.
2757 * Use 'shortname' of the current buffer, since there is no buffer
2758 * for the written file. */
2759 if (*p_dir == NUL)
2760 STRCPY(dir, ".");
2761 else
2763 p = p_dir;
2764 copy_option_part(&p, dir, MAXPATHL, ",");
2766 swapname = makeswapname(fname, ffname, curbuf, dir);
2767 r = vim_fexists(swapname);
2768 if (r)
2770 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2771 if (p_confirm || cmdmod.confirm)
2773 char_u buff[IOSIZE];
2775 dialog_msg(buff,
2776 _("Swap file \"%s\" exists, overwrite anyway?"),
2777 swapname);
2778 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2)
2779 != VIM_YES)
2781 vim_free(swapname);
2782 return FAIL;
2784 eap->forceit = TRUE;
2786 else
2787 #endif
2789 EMSG2(_("E768: Swap file exists: %s (:silent! overrides)"),
2790 swapname);
2791 vim_free(swapname);
2792 return FAIL;
2795 vim_free(swapname);
2798 return OK;
2802 * Handle ":wnext", ":wNext" and ":wprevious" commands.
2804 void
2805 ex_wnext(eap)
2806 exarg_T *eap;
2808 int i;
2810 if (eap->cmd[1] == 'n')
2811 i = curwin->w_arg_idx + (int)eap->line2;
2812 else
2813 i = curwin->w_arg_idx - (int)eap->line2;
2814 eap->line1 = 1;
2815 eap->line2 = curbuf->b_ml.ml_line_count;
2816 if (do_write(eap) != FAIL)
2817 do_argfile(eap, i);
2821 * ":wall", ":wqall" and ":xall": Write all changed files (and exit).
2823 void
2824 do_wqall(eap)
2825 exarg_T *eap;
2827 buf_T *buf;
2828 int error = 0;
2829 int save_forceit = eap->forceit;
2831 if (eap->cmdidx == CMD_xall || eap->cmdidx == CMD_wqall)
2832 exiting = TRUE;
2834 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2836 if (bufIsChanged(buf))
2839 * Check if there is a reason the buffer cannot be written:
2840 * 1. if the 'write' option is set
2841 * 2. if there is no file name (even after browsing)
2842 * 3. if the 'readonly' is set (even after a dialog)
2843 * 4. if overwriting is allowed (even after a dialog)
2845 if (not_writing())
2847 ++error;
2848 break;
2850 #ifdef FEAT_BROWSE
2851 /* ":browse wall": ask for file name if there isn't one */
2852 if (buf->b_ffname == NULL && cmdmod.browse)
2853 browse_save_fname(buf);
2854 #endif
2855 if (buf->b_ffname == NULL)
2857 EMSGN(_("E141: No file name for buffer %ld"), (long)buf->b_fnum);
2858 ++error;
2860 else if (check_readonly(&eap->forceit, buf)
2861 || check_overwrite(eap, buf, buf->b_fname, buf->b_ffname,
2862 FALSE) == FAIL)
2864 ++error;
2866 else
2868 if (buf_write_all(buf, eap->forceit) == FAIL)
2869 ++error;
2870 #ifdef FEAT_AUTOCMD
2871 /* an autocommand may have deleted the buffer */
2872 if (!buf_valid(buf))
2873 buf = firstbuf;
2874 #endif
2876 eap->forceit = save_forceit; /* check_overwrite() may set it */
2879 if (exiting)
2881 if (!error)
2882 getout(0); /* exit Vim */
2883 not_exiting();
2888 * Check the 'write' option.
2889 * Return TRUE and give a message when it's not st.
2892 not_writing()
2894 if (p_write)
2895 return FALSE;
2896 EMSG(_("E142: File not written: Writing is disabled by 'write' option"));
2897 return TRUE;
2901 * Check if a buffer is read-only. Ask for overruling in a dialog.
2902 * Return TRUE and give an error message when the buffer is readonly.
2904 static int
2905 check_readonly(forceit, buf)
2906 int *forceit;
2907 buf_T *buf;
2909 if (!*forceit && buf->b_p_ro)
2911 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2912 if ((p_confirm || cmdmod.confirm) && buf->b_fname != NULL)
2914 char_u buff[IOSIZE];
2916 dialog_msg(buff, _("'readonly' option is set for \"%s\".\nDo you wish to write anyway?"),
2917 buf->b_fname);
2919 if (vim_dialog_yesno(VIM_QUESTION, NULL, buff, 2) == VIM_YES)
2921 /* Set forceit, to force the writing of a readonly file */
2922 *forceit = TRUE;
2923 return FALSE;
2925 else
2926 return TRUE;
2928 else
2929 #endif
2930 EMSG(_(e_readonly));
2931 return TRUE;
2933 return FALSE;
2937 * Try to abandon current file and edit a new or existing file.
2938 * 'fnum' is the number of the file, if zero use ffname/sfname.
2940 * Return 1 for "normal" error, 2 for "not written" error, 0 for success
2941 * -1 for succesfully opening another file.
2942 * 'lnum' is the line number for the cursor in the new file (if non-zero).
2945 getfile(fnum, ffname, sfname, setpm, lnum, forceit)
2946 int fnum;
2947 char_u *ffname;
2948 char_u *sfname;
2949 int setpm;
2950 linenr_T lnum;
2951 int forceit;
2953 int other;
2954 int retval;
2955 char_u *free_me = NULL;
2957 if (text_locked())
2958 return 1;
2959 #ifdef FEAT_AUTOCMD
2960 if (curbuf_locked())
2961 return 1;
2962 #endif
2964 if (fnum == 0)
2966 /* make ffname full path, set sfname */
2967 fname_expand(curbuf, &ffname, &sfname);
2968 other = otherfile(ffname);
2969 free_me = ffname; /* has been allocated, free() later */
2971 else
2972 other = (fnum != curbuf->b_fnum);
2974 if (other)
2975 ++no_wait_return; /* don't wait for autowrite message */
2976 if (other && !forceit && curbuf->b_nwindows == 1 && !P_HID(curbuf)
2977 && curbufIsChanged() && autowrite(curbuf, forceit) == FAIL)
2979 #if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2980 if (p_confirm && p_write)
2981 dialog_changed(curbuf, FALSE);
2982 if (curbufIsChanged())
2983 #endif
2985 if (other)
2986 --no_wait_return;
2987 EMSG(_(e_nowrtmsg));
2988 retval = 2; /* file has been changed */
2989 goto theend;
2992 if (other)
2993 --no_wait_return;
2994 if (setpm)
2995 setpcmark();
2996 if (!other)
2998 if (lnum != 0)
2999 curwin->w_cursor.lnum = lnum;
3000 check_cursor_lnum();
3001 beginline(BL_SOL | BL_FIX);
3002 retval = 0; /* it's in the same file */
3004 else if (do_ecmd(fnum, ffname, sfname, NULL, lnum,
3005 (P_HID(curbuf) ? ECMD_HIDE : 0) + (forceit ? ECMD_FORCEIT : 0)) == OK)
3006 retval = -1; /* opened another file */
3007 else
3008 retval = 1; /* error encountered */
3010 theend:
3011 vim_free(free_me);
3012 return retval;
3016 * start editing a new file
3018 * fnum: file number; if zero use ffname/sfname
3019 * ffname: the file name
3020 * - full path if sfname used,
3021 * - any file name if sfname is NULL
3022 * - empty string to re-edit with the same file name (but may be
3023 * in a different directory)
3024 * - NULL to start an empty buffer
3025 * sfname: the short file name (or NULL)
3026 * eap: contains the command to be executed after loading the file and
3027 * forced 'ff' and 'fenc'
3028 * newlnum: if > 0: put cursor on this line number (if possible)
3029 * if ECMD_LASTL: use last position in loaded file
3030 * if ECMD_LAST: use last position in all files
3031 * if ECMD_ONE: use first line
3032 * flags:
3033 * ECMD_HIDE: if TRUE don't free the current buffer
3034 * ECMD_SET_HELP: set b_help flag of (new) buffer before opening file
3035 * ECMD_OLDBUF: use existing buffer if it exists
3036 * ECMD_FORCEIT: ! used for Ex command
3037 * ECMD_ADDBUF: don't edit, just add to buffer list
3039 * return FAIL for failure, OK otherwise
3042 do_ecmd(fnum, ffname, sfname, eap, newlnum, flags)
3043 int fnum;
3044 char_u *ffname;
3045 char_u *sfname;
3046 exarg_T *eap; /* can be NULL! */
3047 linenr_T newlnum;
3048 int flags;
3050 int other_file; /* TRUE if editing another file */
3051 int oldbuf; /* TRUE if using existing buffer */
3052 #ifdef FEAT_AUTOCMD
3053 int auto_buf = FALSE; /* TRUE if autocommands brought us
3054 into the buffer unexpectedly */
3055 char_u *new_name = NULL;
3056 int did_set_swapcommand = FALSE;
3057 #endif
3058 buf_T *buf;
3059 #if defined(FEAT_AUTOCMD) || defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
3060 buf_T *old_curbuf = curbuf;
3061 #endif
3062 char_u *free_fname = NULL;
3063 #ifdef FEAT_BROWSE
3064 char_u *browse_file = NULL;
3065 #endif
3066 int retval = FAIL;
3067 long n;
3068 linenr_T lnum;
3069 linenr_T topline = 0;
3070 int newcol = -1;
3071 int solcol = -1;
3072 pos_T *pos;
3073 #ifdef FEAT_SUN_WORKSHOP
3074 char_u *cp;
3075 #endif
3076 char_u *command = NULL;
3078 if (eap != NULL)
3079 command = eap->do_ecmd_cmd;
3081 if (fnum != 0)
3083 if (fnum == curbuf->b_fnum) /* file is already being edited */
3084 return OK; /* nothing to do */
3085 other_file = TRUE;
3087 else
3089 #ifdef FEAT_BROWSE
3090 if (cmdmod.browse)
3092 if (
3093 # ifdef FEAT_GUI
3094 !gui.in_use &&
3095 # endif
3096 au_has_group((char_u *)"FileExplorer"))
3098 /* No browsing supported but we do have the file explorer:
3099 * Edit the directory. */
3100 if (ffname == NULL || !mch_isdir(ffname))
3101 ffname = (char_u *)".";
3103 else
3105 browse_file = do_browse(0, (char_u *)_("Edit File"), ffname,
3106 NULL, NULL, NULL, curbuf);
3107 if (browse_file == NULL)
3108 goto theend;
3109 ffname = browse_file;
3112 #endif
3113 /* if no short name given, use ffname for short name */
3114 if (sfname == NULL)
3115 sfname = ffname;
3116 #ifdef USE_FNAME_CASE
3117 # ifdef USE_LONG_FNAME
3118 if (USE_LONG_FNAME)
3119 # endif
3120 if (sfname != NULL)
3121 fname_case(sfname, 0); /* set correct case for sfname */
3122 #endif
3124 #ifdef FEAT_LISTCMDS
3125 if ((flags & ECMD_ADDBUF) && (ffname == NULL || *ffname == NUL))
3126 goto theend;
3127 #endif
3129 if (ffname == NULL)
3130 other_file = TRUE;
3131 /* there is no file name */
3132 else if (*ffname == NUL && curbuf->b_ffname == NULL)
3133 other_file = FALSE;
3134 else
3136 if (*ffname == NUL) /* re-edit with same file name */
3138 ffname = curbuf->b_ffname;
3139 sfname = curbuf->b_fname;
3141 free_fname = fix_fname(ffname); /* may expand to full path name */
3142 if (free_fname != NULL)
3143 ffname = free_fname;
3144 other_file = otherfile(ffname);
3145 #ifdef FEAT_SUN_WORKSHOP
3146 if (usingSunWorkShop && p_acd
3147 && (cp = vim_strrchr(sfname, '/')) != NULL)
3148 sfname = ++cp;
3149 #endif
3154 * if the file was changed we may not be allowed to abandon it
3155 * - if we are going to re-edit the same file
3156 * - or if we are the only window on this file and if ECMD_HIDE is FALSE
3158 if ( ((!other_file && !(flags & ECMD_OLDBUF))
3159 || (curbuf->b_nwindows == 1
3160 && !(flags & (ECMD_HIDE | ECMD_ADDBUF))))
3161 && check_changed(curbuf, p_awa, !other_file,
3162 (flags & ECMD_FORCEIT), FALSE))
3164 if (fnum == 0 && other_file && ffname != NULL)
3165 (void)setaltfname(ffname, sfname, newlnum < 0 ? 0 : newlnum);
3166 goto theend;
3169 #ifdef FEAT_VISUAL
3171 * End Visual mode before switching to another buffer, so the text can be
3172 * copied into the GUI selection buffer.
3174 reset_VIsual();
3175 #endif
3177 #ifdef FEAT_AUTOCMD
3178 if ((command != NULL || newlnum > (linenr_T)0)
3179 && *get_vim_var_str(VV_SWAPCOMMAND) == NUL)
3181 int len;
3182 char_u *p;
3184 /* Set v:swapcommand for the SwapExists autocommands. */
3185 if (command != NULL)
3186 len = (int)STRLEN(command) + 3;
3187 else
3188 len = 30;
3189 p = alloc((unsigned)len);
3190 if (p != NULL)
3192 if (command != NULL)
3193 vim_snprintf((char *)p, len, ":%s\r", command);
3194 else
3195 vim_snprintf((char *)p, len, "%ldG", (long)newlnum);
3196 set_vim_var_string(VV_SWAPCOMMAND, p, -1);
3197 did_set_swapcommand = TRUE;
3198 vim_free(p);
3201 #endif
3204 * If we are starting to edit another file, open a (new) buffer.
3205 * Otherwise we re-use the current buffer.
3207 if (other_file)
3209 #ifdef FEAT_LISTCMDS
3210 if (!(flags & ECMD_ADDBUF))
3211 #endif
3213 if (!cmdmod.keepalt)
3214 curwin->w_alt_fnum = curbuf->b_fnum;
3215 buflist_altfpos();
3218 if (fnum)
3219 buf = buflist_findnr(fnum);
3220 else
3222 #ifdef FEAT_LISTCMDS
3223 if (flags & ECMD_ADDBUF)
3225 linenr_T tlnum = 1L;
3227 if (command != NULL)
3229 tlnum = atol((char *)command);
3230 if (tlnum <= 0)
3231 tlnum = 1L;
3233 (void)buflist_new(ffname, sfname, tlnum, BLN_LISTED);
3234 goto theend;
3236 #endif
3237 buf = buflist_new(ffname, sfname, 0L,
3238 BLN_CURBUF | ((flags & ECMD_SET_HELP) ? 0 : BLN_LISTED));
3240 if (buf == NULL)
3241 goto theend;
3242 if (buf->b_ml.ml_mfp == NULL) /* no memfile yet */
3244 oldbuf = FALSE;
3245 buf->b_nwindows = 0;
3247 else /* existing memfile */
3249 oldbuf = TRUE;
3250 (void)buf_check_timestamp(buf, FALSE);
3251 /* Check if autocommands made buffer invalid or changed the current
3252 * buffer. */
3253 if (!buf_valid(buf)
3254 #ifdef FEAT_AUTOCMD
3255 || curbuf != old_curbuf
3256 #endif
3258 goto theend;
3259 #ifdef FEAT_EVAL
3260 if (aborting()) /* autocmds may abort script processing */
3261 goto theend;
3262 #endif
3265 /* May jump to last used line number for a loaded buffer or when asked
3266 * for explicitly */
3267 if ((oldbuf && newlnum == ECMD_LASTL) || newlnum == ECMD_LAST)
3269 pos = buflist_findfpos(buf);
3270 newlnum = pos->lnum;
3271 solcol = pos->col;
3275 * Make the (new) buffer the one used by the current window.
3276 * If the old buffer becomes unused, free it if ECMD_HIDE is FALSE.
3277 * If the current buffer was empty and has no file name, curbuf
3278 * is returned by buflist_new().
3280 if (buf != curbuf)
3282 #ifdef FEAT_AUTOCMD
3284 * Be careful: The autocommands may delete any buffer and change
3285 * the current buffer.
3286 * - If the buffer we are going to edit is deleted, give up.
3287 * - If the current buffer is deleted, prefer to load the new
3288 * buffer when loading a buffer is required. This avoids
3289 * loading another buffer which then must be closed again.
3290 * - If we ended up in the new buffer already, need to skip a few
3291 * things, set auto_buf.
3293 if (buf->b_fname != NULL)
3294 new_name = vim_strsave(buf->b_fname);
3295 au_new_curbuf = buf;
3296 apply_autocmds(EVENT_BUFLEAVE, NULL, NULL, FALSE, curbuf);
3297 if (!buf_valid(buf)) /* new buffer has been deleted */
3299 delbuf_msg(new_name); /* frees new_name */
3300 goto theend;
3302 # ifdef FEAT_EVAL
3303 if (aborting()) /* autocmds may abort script processing */
3305 vim_free(new_name);
3306 goto theend;
3308 # endif
3309 if (buf == curbuf) /* already in new buffer */
3310 auto_buf = TRUE;
3311 else
3313 if (curbuf == old_curbuf)
3314 #endif
3315 buf_copy_options(buf, BCO_ENTER);
3317 /* close the link to the current buffer */
3318 u_sync(FALSE);
3319 close_buffer(curwin, curbuf,
3320 (flags & ECMD_HIDE) ? 0 : DOBUF_UNLOAD);
3322 #ifdef FEAT_AUTOCMD
3323 # ifdef FEAT_EVAL
3324 if (aborting()) /* autocmds may abort script processing */
3326 vim_free(new_name);
3327 goto theend;
3329 # endif
3330 /* Be careful again, like above. */
3331 if (!buf_valid(buf)) /* new buffer has been deleted */
3333 delbuf_msg(new_name); /* frees new_name */
3334 goto theend;
3336 if (buf == curbuf) /* already in new buffer */
3337 auto_buf = TRUE;
3338 else
3339 #endif
3341 curwin->w_buffer = buf;
3342 curbuf = buf;
3343 ++curbuf->b_nwindows;
3344 /* set 'fileformat' */
3345 if (*p_ffs && !oldbuf)
3346 set_fileformat(default_fileformat(), OPT_LOCAL);
3349 /* May get the window options from the last time this buffer
3350 * was in this window (or another window). If not used
3351 * before, reset the local window options to the global
3352 * values. Also restores old folding stuff. */
3353 get_winopts(buf);
3355 #ifdef FEAT_AUTOCMD
3357 vim_free(new_name);
3358 au_new_curbuf = NULL;
3359 #endif
3361 else
3362 ++curbuf->b_nwindows;
3364 curwin->w_pcmark.lnum = 1;
3365 curwin->w_pcmark.col = 0;
3367 else /* !other_file */
3369 if (
3370 #ifdef FEAT_LISTCMDS
3371 (flags & ECMD_ADDBUF) ||
3372 #endif
3373 check_fname() == FAIL)
3374 goto theend;
3375 oldbuf = (flags & ECMD_OLDBUF);
3378 if ((flags & ECMD_SET_HELP) || keep_help_flag)
3380 char_u *p;
3382 curbuf->b_help = TRUE;
3383 #ifdef FEAT_QUICKFIX
3384 set_string_option_direct((char_u *)"buftype", -1,
3385 (char_u *)"help", OPT_FREE|OPT_LOCAL, 0);
3386 #endif
3389 * Always set these options after jumping to a help tag, because the
3390 * user may have an autocommand that gets in the way.
3391 * Accept all ASCII chars for keywords, except ' ', '*', '"', '|', and
3392 * latin1 word characters (for translated help files).
3393 * Only set it when needed, buf_init_chartab() is some work.
3396 #ifdef EBCDIC
3397 (char_u *)"65-255,^*,^|,^\"";
3398 #else
3399 (char_u *)"!-~,^*,^|,^\",192-255";
3400 #endif
3401 if (STRCMP(curbuf->b_p_isk, p) != 0)
3403 set_string_option_direct((char_u *)"isk", -1, p,
3404 OPT_FREE|OPT_LOCAL, 0);
3405 check_buf_options(curbuf);
3406 (void)buf_init_chartab(curbuf, FALSE);
3409 curbuf->b_p_ts = 8; /* 'tabstop' is 8 */
3410 curwin->w_p_list = FALSE; /* no list mode */
3412 curbuf->b_p_ma = FALSE; /* not modifiable */
3413 curbuf->b_p_bin = FALSE; /* reset 'bin' before reading file */
3414 curwin->w_p_nu = 0; /* no line numbers */
3415 #ifdef FEAT_SCROLLBIND
3416 curwin->w_p_scb = FALSE; /* no scroll binding */
3417 #endif
3418 #ifdef FEAT_ARABIC
3419 curwin->w_p_arab = FALSE; /* no arabic mode */
3420 #endif
3421 #ifdef FEAT_RIGHTLEFT
3422 curwin->w_p_rl = FALSE; /* help window is left-to-right */
3423 #endif
3424 #ifdef FEAT_FOLDING
3425 curwin->w_p_fen = FALSE; /* No folding in the help window */
3426 #endif
3427 #ifdef FEAT_DIFF
3428 curwin->w_p_diff = FALSE; /* No 'diff' */
3429 #endif
3430 #ifdef FEAT_SPELL
3431 curwin->w_p_spell = FALSE; /* No spell checking */
3432 #endif
3434 #ifdef FEAT_AUTOCMD
3435 buf = curbuf;
3436 #endif
3437 set_buflisted(FALSE);
3439 else
3441 #ifdef FEAT_AUTOCMD
3442 buf = curbuf;
3443 #endif
3444 /* Don't make a buffer listed if it's a help buffer. Useful when
3445 * using CTRL-O to go back to a help file. */
3446 if (!curbuf->b_help)
3447 set_buflisted(TRUE);
3450 #ifdef FEAT_AUTOCMD
3451 /* If autocommands change buffers under our fingers, forget about
3452 * editing the file. */
3453 if (buf != curbuf)
3454 goto theend;
3455 # ifdef FEAT_EVAL
3456 if (aborting()) /* autocmds may abort script processing */
3457 goto theend;
3458 # endif
3460 /* Since we are starting to edit a file, consider the filetype to be
3461 * unset. Helps for when an autocommand changes files and expects syntax
3462 * highlighting to work in the other file. */
3463 did_filetype = FALSE;
3464 #endif
3467 * other_file oldbuf
3468 * FALSE FALSE re-edit same file, buffer is re-used
3469 * FALSE TRUE re-edit same file, nothing changes
3470 * TRUE FALSE start editing new file, new buffer
3471 * TRUE TRUE start editing in existing buffer (nothing to do)
3473 if (!other_file && !oldbuf) /* re-use the buffer */
3475 set_last_cursor(curwin); /* may set b_last_cursor */
3476 if (newlnum == ECMD_LAST || newlnum == ECMD_LASTL)
3478 newlnum = curwin->w_cursor.lnum;
3479 solcol = curwin->w_cursor.col;
3481 #ifdef FEAT_AUTOCMD
3482 buf = curbuf;
3483 if (buf->b_fname != NULL)
3484 new_name = vim_strsave(buf->b_fname);
3485 else
3486 new_name = NULL;
3487 #endif
3488 buf_freeall(curbuf, FALSE, FALSE); /* free all things for buffer */
3489 #ifdef FEAT_AUTOCMD
3490 /* If autocommands deleted the buffer we were going to re-edit, give
3491 * up and jump to the end. */
3492 if (!buf_valid(buf))
3494 delbuf_msg(new_name); /* frees new_name */
3495 goto theend;
3497 vim_free(new_name);
3499 /* If autocommands change buffers under our fingers, forget about
3500 * re-editing the file. Should do the buf_clear_file(), but perhaps
3501 * the autocommands changed the buffer... */
3502 if (buf != curbuf)
3503 goto theend;
3504 # ifdef FEAT_EVAL
3505 if (aborting()) /* autocmds may abort script processing */
3506 goto theend;
3507 # endif
3508 #endif
3509 buf_clear_file(curbuf);
3510 curbuf->b_op_start.lnum = 0; /* clear '[ and '] marks */
3511 curbuf->b_op_end.lnum = 0;
3515 * If we get here we are sure to start editing
3517 /* don't redraw until the cursor is in the right line */
3518 ++RedrawingDisabled;
3520 /* Assume success now */
3521 retval = OK;
3524 * Reset cursor position, could be used by autocommands.
3526 check_cursor();
3529 * Check if we are editing the w_arg_idx file in the argument list.
3531 check_arg_idx(curwin);
3533 #ifdef FEAT_AUTOCMD
3534 if (!auto_buf)
3535 #endif
3538 * Set cursor and init window before reading the file and executing
3539 * autocommands. This allows for the autocommands to position the
3540 * cursor.
3542 curwin_init();
3544 #ifdef FEAT_FOLDING
3545 /* It's like all lines in the buffer changed. Need to update
3546 * automatic folding. */
3547 foldUpdateAll(curwin);
3548 #endif
3550 #ifdef FEAT_AUTOCHDIR
3551 if (p_acd && curbuf->b_ffname != NULL
3552 && vim_chdirfile(curbuf->b_ffname) == OK)
3553 shorten_fnames(TRUE);
3554 #endif
3556 * Careful: open_buffer() and apply_autocmds() may change the current
3557 * buffer and window.
3559 lnum = curwin->w_cursor.lnum;
3560 topline = curwin->w_topline;
3561 if (!oldbuf) /* need to read the file */
3563 #if defined(HAS_SWAP_EXISTS_ACTION)
3564 swap_exists_action = SEA_DIALOG;
3565 #endif
3566 curbuf->b_flags |= BF_CHECK_RO; /* set/reset 'ro' flag */
3569 * Open the buffer and read the file.
3571 #if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
3572 if (should_abort(open_buffer(FALSE, eap)))
3573 retval = FAIL;
3574 #else
3575 (void)open_buffer(FALSE, eap);
3576 #endif
3578 #if defined(HAS_SWAP_EXISTS_ACTION)
3579 if (swap_exists_action == SEA_QUIT)
3580 retval = FAIL;
3581 handle_swap_exists(old_curbuf);
3582 #endif
3584 #ifdef FEAT_AUTOCMD
3585 else
3587 /* Read the modelines, but only to set window-local options. Any
3588 * buffer-local options have already been set and may have been
3589 * changed by the user. */
3590 do_modelines(OPT_WINONLY);
3592 apply_autocmds_retval(EVENT_BUFENTER, NULL, NULL, FALSE, curbuf,
3593 &retval);
3594 apply_autocmds_retval(EVENT_BUFWINENTER, NULL, NULL, FALSE, curbuf,
3595 &retval);
3597 check_arg_idx(curwin);
3598 #endif
3601 * If autocommands change the cursor position or topline, we should
3602 * keep it.
3604 if (curwin->w_cursor.lnum != lnum)
3606 newlnum = curwin->w_cursor.lnum;
3607 newcol = curwin->w_cursor.col;
3609 if (curwin->w_topline == topline)
3610 topline = 0;
3612 /* Even when cursor didn't move we need to recompute topline. */
3613 changed_line_abv_curs();
3615 #ifdef FEAT_TITLE
3616 maketitle();
3617 #endif
3620 #ifdef FEAT_DIFF
3621 /* Tell the diff stuff that this buffer is new and/or needs updating.
3622 * Also needed when re-editing the same buffer, because unloading will
3623 * have removed it as a diff buffer. */
3624 if (curwin->w_p_diff)
3626 diff_buf_add(curbuf);
3627 diff_invalidate(curbuf);
3629 #endif
3631 if (command == NULL)
3633 if (newcol >= 0) /* position set by autocommands */
3635 curwin->w_cursor.lnum = newlnum;
3636 curwin->w_cursor.col = newcol;
3637 check_cursor();
3639 else if (newlnum > 0) /* line number from caller or old position */
3641 curwin->w_cursor.lnum = newlnum;
3642 check_cursor_lnum();
3643 if (solcol >= 0 && !p_sol)
3645 /* 'sol' is off: Use last known column. */
3646 curwin->w_cursor.col = solcol;
3647 check_cursor_col();
3648 #ifdef FEAT_VIRTUALEDIT
3649 curwin->w_cursor.coladd = 0;
3650 #endif
3651 curwin->w_set_curswant = TRUE;
3653 else
3654 beginline(BL_SOL | BL_FIX);
3656 else /* no line number, go to last line in Ex mode */
3658 if (exmode_active)
3659 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
3660 beginline(BL_WHITE | BL_FIX);
3664 #ifdef FEAT_WINDOWS
3665 /* Check if cursors in other windows on the same buffer are still valid */
3666 check_lnums(FALSE);
3667 #endif
3670 * Did not read the file, need to show some info about the file.
3671 * Do this after setting the cursor.
3673 if (oldbuf
3674 #ifdef FEAT_AUTOCMD
3675 && !auto_buf
3676 #endif
3679 int msg_scroll_save = msg_scroll;
3681 /* Obey the 'O' flag in 'cpoptions': overwrite any previous file
3682 * message. */
3683 if (shortmess(SHM_OVERALL) && !exiting && p_verbose == 0)
3684 msg_scroll = FALSE;
3685 if (!msg_scroll) /* wait a bit when overwriting an error msg */
3686 check_for_delay(FALSE);
3687 msg_start();
3688 msg_scroll = msg_scroll_save;
3689 msg_scrolled_ign = TRUE;
3691 fileinfo(FALSE, TRUE, FALSE);
3693 msg_scrolled_ign = FALSE;
3696 if (command != NULL)
3697 do_cmdline(command, NULL, NULL, DOCMD_VERBOSE);
3699 #ifdef FEAT_KEYMAP
3700 if (curbuf->b_kmap_state & KEYMAP_INIT)
3701 keymap_init();
3702 #endif
3704 --RedrawingDisabled;
3705 if (!skip_redraw)
3707 n = p_so;
3708 if (topline == 0 && command == NULL)
3709 p_so = 999; /* force cursor halfway the window */
3710 update_topline();
3711 #ifdef FEAT_SCROLLBIND
3712 curwin->w_scbind_pos = curwin->w_topline;
3713 #endif
3714 p_so = n;
3715 redraw_curbuf_later(NOT_VALID); /* redraw this buffer later */
3718 if (p_im)
3719 need_start_insertmode = TRUE;
3721 #ifdef FEAT_AUTOCHDIR
3722 /* Change directories when the acd option is set on. */
3723 if (p_acd && curbuf->b_ffname != NULL
3724 && vim_chdirfile(curbuf->b_ffname) == OK)
3725 shorten_fnames(TRUE);
3726 #endif
3728 #if defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG)
3729 if (gui.in_use && curbuf->b_ffname != NULL)
3731 # ifdef FEAT_SUN_WORKSHOP
3732 if (usingSunWorkShop)
3733 workshop_file_opened((char *)curbuf->b_ffname, curbuf->b_p_ro);
3734 # endif
3735 # ifdef FEAT_NETBEANS_INTG
3736 if (usingNetbeans & ((flags & ECMD_SET_HELP) != ECMD_SET_HELP))
3737 netbeans_file_opened(curbuf);
3738 # endif
3740 #endif
3742 theend:
3743 #ifdef FEAT_AUTOCMD
3744 if (did_set_swapcommand)
3745 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
3746 #endif
3747 #ifdef FEAT_BROWSE
3748 vim_free(browse_file);
3749 #endif
3750 vim_free(free_fname);
3751 return retval;
3754 #ifdef FEAT_AUTOCMD
3755 static void
3756 delbuf_msg(name)
3757 char_u *name;
3759 EMSG2(_("E143: Autocommands unexpectedly deleted new buffer %s"),
3760 name == NULL ? (char_u *)"" : name);
3761 vim_free(name);
3762 au_new_curbuf = NULL;
3764 #endif
3766 static int append_indent = 0; /* autoindent for first line */
3769 * ":insert" and ":append", also used by ":change"
3771 void
3772 ex_append(eap)
3773 exarg_T *eap;
3775 char_u *theline;
3776 int did_undo = FALSE;
3777 linenr_T lnum = eap->line2;
3778 int indent = 0;
3779 char_u *p;
3780 int vcol;
3781 int empty = (curbuf->b_ml.ml_flags & ML_EMPTY);
3783 /* the ! flag toggles autoindent */
3784 if (eap->forceit)
3785 curbuf->b_p_ai = !curbuf->b_p_ai;
3787 /* First autoindent comes from the line we start on */
3788 if (eap->cmdidx != CMD_change && curbuf->b_p_ai && lnum > 0)
3789 append_indent = get_indent_lnum(lnum);
3791 if (eap->cmdidx != CMD_append)
3792 --lnum;
3794 /* when the buffer is empty append to line 0 and delete the dummy line */
3795 if (empty && lnum == 1)
3796 lnum = 0;
3798 State = INSERT; /* behave like in Insert mode */
3799 if (curbuf->b_p_iminsert == B_IMODE_LMAP)
3800 State |= LANGMAP;
3802 for (;;)
3804 msg_scroll = TRUE;
3805 need_wait_return = FALSE;
3806 if (curbuf->b_p_ai)
3808 if (append_indent >= 0)
3810 indent = append_indent;
3811 append_indent = -1;
3813 else if (lnum > 0)
3814 indent = get_indent_lnum(lnum);
3816 ex_keep_indent = FALSE;
3817 if (eap->getline == NULL)
3819 /* No getline() function, use the lines that follow. This ends
3820 * when there is no more. */
3821 if (eap->nextcmd == NULL || *eap->nextcmd == NUL)
3822 break;
3823 p = vim_strchr(eap->nextcmd, NL);
3824 if (p == NULL)
3825 p = eap->nextcmd + STRLEN(eap->nextcmd);
3826 theline = vim_strnsave(eap->nextcmd, (int)(p - eap->nextcmd));
3827 if (*p != NUL)
3828 ++p;
3829 eap->nextcmd = p;
3831 else
3832 theline = eap->getline(
3833 #ifdef FEAT_EVAL
3834 eap->cstack->cs_looplevel > 0 ? -1 :
3835 #endif
3836 NUL, eap->cookie, indent);
3837 lines_left = Rows - 1;
3838 if (theline == NULL)
3839 break;
3841 /* Using ^ CTRL-D in getexmodeline() makes us repeat the indent. */
3842 if (ex_keep_indent)
3843 append_indent = indent;
3845 /* Look for the "." after automatic indent. */
3846 vcol = 0;
3847 for (p = theline; indent > vcol; ++p)
3849 if (*p == ' ')
3850 ++vcol;
3851 else if (*p == TAB)
3852 vcol += 8 - vcol % 8;
3853 else
3854 break;
3856 if ((p[0] == '.' && p[1] == NUL)
3857 || (!did_undo && u_save(lnum, lnum + 1 + (empty ? 1 : 0))
3858 == FAIL))
3860 vim_free(theline);
3861 break;
3864 /* don't use autoindent if nothing was typed. */
3865 if (p[0] == NUL)
3866 theline[0] = NUL;
3868 did_undo = TRUE;
3869 ml_append(lnum, theline, (colnr_T)0, FALSE);
3870 appended_lines_mark(lnum, 1L);
3872 vim_free(theline);
3873 ++lnum;
3875 if (empty)
3877 ml_delete(2L, FALSE);
3878 empty = FALSE;
3881 State = NORMAL;
3883 if (eap->forceit)
3884 curbuf->b_p_ai = !curbuf->b_p_ai;
3886 /* "start" is set to eap->line2+1 unless that position is invalid (when
3887 * eap->line2 pointed to the end of the buffer and nothig was appended)
3888 * "end" is set to lnum when something has been appended, otherwise
3889 * it is the same than "start" -- Acevedo */
3890 curbuf->b_op_start.lnum = (eap->line2 < curbuf->b_ml.ml_line_count) ?
3891 eap->line2 + 1 : curbuf->b_ml.ml_line_count;
3892 if (eap->cmdidx != CMD_append)
3893 --curbuf->b_op_start.lnum;
3894 curbuf->b_op_end.lnum = (eap->line2 < lnum)
3895 ? lnum : curbuf->b_op_start.lnum;
3896 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
3897 curwin->w_cursor.lnum = lnum;
3898 check_cursor_lnum();
3899 beginline(BL_SOL | BL_FIX);
3901 need_wait_return = FALSE; /* don't use wait_return() now */
3902 ex_no_reprint = TRUE;
3906 * ":change"
3908 void
3909 ex_change(eap)
3910 exarg_T *eap;
3912 linenr_T lnum;
3914 if (eap->line2 >= eap->line1
3915 && u_save(eap->line1 - 1, eap->line2 + 1) == FAIL)
3916 return;
3918 /* the ! flag toggles autoindent */
3919 if (eap->forceit ? !curbuf->b_p_ai : curbuf->b_p_ai)
3920 append_indent = get_indent_lnum(eap->line1);
3922 for (lnum = eap->line2; lnum >= eap->line1; --lnum)
3924 if (curbuf->b_ml.ml_flags & ML_EMPTY) /* nothing to delete */
3925 break;
3926 ml_delete(eap->line1, FALSE);
3928 deleted_lines_mark(eap->line1, (long)(eap->line2 - lnum));
3930 /* ":append" on the line above the deleted lines. */
3931 eap->line2 = eap->line1;
3932 ex_append(eap);
3935 void
3936 ex_z(eap)
3937 exarg_T *eap;
3939 char_u *x;
3940 int bigness;
3941 char_u *kind;
3942 int minus = 0;
3943 linenr_T start, end, curs, i;
3944 int j;
3945 linenr_T lnum = eap->line2;
3947 /* Vi compatible: ":z!" uses display height, without a count uses
3948 * 'scroll' */
3949 if (eap->forceit)
3950 bigness = curwin->w_height;
3951 else if (firstwin == lastwin)
3952 bigness = curwin->w_p_scr * 2;
3953 else
3954 bigness = curwin->w_height - 3;
3955 if (bigness < 1)
3956 bigness = 1;
3958 x = eap->arg;
3959 kind = x;
3960 if (*kind == '-' || *kind == '+' || *kind == '='
3961 || *kind == '^' || *kind == '.')
3962 ++x;
3963 while (*x == '-' || *x == '+')
3964 ++x;
3966 if (*x != 0)
3968 if (!VIM_ISDIGIT(*x))
3970 EMSG(_("E144: non-numeric argument to :z"));
3971 return;
3973 else
3975 bigness = atoi((char *)x);
3976 p_window = bigness;
3977 if (*kind == '=')
3978 bigness += 2;
3982 /* the number of '-' and '+' multiplies the distance */
3983 if (*kind == '-' || *kind == '+')
3984 for (x = kind + 1; *x == *kind; ++x)
3987 switch (*kind)
3989 case '-':
3990 start = lnum - bigness * (linenr_T)(x - kind);
3991 end = start + bigness;
3992 curs = end;
3993 break;
3995 case '=':
3996 start = lnum - (bigness + 1) / 2 + 1;
3997 end = lnum + (bigness + 1) / 2 - 1;
3998 curs = lnum;
3999 minus = 1;
4000 break;
4002 case '^':
4003 start = lnum - bigness * 2;
4004 end = lnum - bigness;
4005 curs = lnum - bigness;
4006 break;
4008 case '.':
4009 start = lnum - (bigness + 1) / 2 + 1;
4010 end = lnum + (bigness + 1) / 2 - 1;
4011 curs = end;
4012 break;
4014 default: /* '+' */
4015 start = lnum;
4016 if (*kind == '+')
4017 start += bigness * (linenr_T)(x - kind - 1) + 1;
4018 else if (eap->addr_count == 0)
4019 ++start;
4020 end = start + bigness - 1;
4021 curs = end;
4022 break;
4025 if (start < 1)
4026 start = 1;
4028 if (end > curbuf->b_ml.ml_line_count)
4029 end = curbuf->b_ml.ml_line_count;
4031 if (curs > curbuf->b_ml.ml_line_count)
4032 curs = curbuf->b_ml.ml_line_count;
4034 for (i = start; i <= end; i++)
4036 if (minus && i == lnum)
4038 msg_putchar('\n');
4040 for (j = 1; j < Columns; j++)
4041 msg_putchar('-');
4044 print_line(i, eap->flags & EXFLAG_NR, eap->flags & EXFLAG_LIST);
4046 if (minus && i == lnum)
4048 msg_putchar('\n');
4050 for (j = 1; j < Columns; j++)
4051 msg_putchar('-');
4055 curwin->w_cursor.lnum = curs;
4056 ex_no_reprint = TRUE;
4060 * Check if the restricted flag is set.
4061 * If so, give an error message and return TRUE.
4062 * Otherwise, return FALSE.
4065 check_restricted()
4067 if (restricted)
4069 EMSG(_("E145: Shell commands not allowed in rvim"));
4070 return TRUE;
4072 return FALSE;
4076 * Check if the secure flag is set (.exrc or .vimrc in current directory).
4077 * If so, give an error message and return TRUE.
4078 * Otherwise, return FALSE.
4081 check_secure()
4083 if (secure)
4085 secure = 2;
4086 EMSG(_(e_curdir));
4087 return TRUE;
4089 #ifdef HAVE_SANDBOX
4091 * In the sandbox more things are not allowed, including the things
4092 * disallowed in secure mode.
4094 if (sandbox != 0)
4096 EMSG(_(e_sandbox));
4097 return TRUE;
4099 #endif
4100 return FALSE;
4103 static char_u *old_sub = NULL; /* previous substitute pattern */
4104 static int global_need_beginline; /* call beginline() after ":g" */
4106 /* do_sub()
4108 * Perform a substitution from line eap->line1 to line eap->line2 using the
4109 * command pointed to by eap->arg which should be of the form:
4111 * /pattern/substitution/{flags}
4113 * The usual escapes are supported as described in the regexp docs.
4115 void
4116 do_sub(eap)
4117 exarg_T *eap;
4119 linenr_T lnum;
4120 long i = 0;
4121 regmmatch_T regmatch;
4122 static int do_all = FALSE; /* do multiple substitutions per line */
4123 static int do_ask = FALSE; /* ask for confirmation */
4124 static int do_count = FALSE; /* count only */
4125 static int do_error = TRUE; /* if false, ignore errors */
4126 static int do_print = FALSE; /* print last line with subs. */
4127 static int do_list = FALSE; /* list last line with subs. */
4128 static int do_number = FALSE; /* list last line with line nr*/
4129 static int do_ic = 0; /* ignore case flag */
4130 char_u *pat = NULL, *sub = NULL; /* init for GCC */
4131 int delimiter;
4132 int sublen;
4133 int got_quit = FALSE;
4134 int got_match = FALSE;
4135 int temp;
4136 int which_pat;
4137 char_u *cmd;
4138 int save_State;
4139 linenr_T first_line = 0; /* first changed line */
4140 linenr_T last_line= 0; /* below last changed line AFTER the
4141 * change */
4142 linenr_T old_line_count = curbuf->b_ml.ml_line_count;
4143 linenr_T line2;
4144 long nmatch; /* number of lines in match */
4145 linenr_T sub_firstlnum; /* nr of first sub line */
4146 char_u *sub_firstline; /* allocated copy of first sub line */
4147 int endcolumn = FALSE; /* cursor in last column when done */
4148 pos_T old_cursor = curwin->w_cursor;
4150 cmd = eap->arg;
4151 if (!global_busy)
4153 sub_nsubs = 0;
4154 sub_nlines = 0;
4157 #ifdef FEAT_FKMAP /* reverse the flow of the Farsi characters */
4158 if (p_altkeymap && curwin->w_p_rl)
4159 lrF_sub(cmd);
4160 #endif
4162 if (eap->cmdidx == CMD_tilde)
4163 which_pat = RE_LAST; /* use last used regexp */
4164 else
4165 which_pat = RE_SUBST; /* use last substitute regexp */
4167 /* new pattern and substitution */
4168 if (eap->cmd[0] == 's' && *cmd != NUL && !vim_iswhite(*cmd)
4169 && vim_strchr((char_u *)"0123456789cegriIp|\"", *cmd) == NULL)
4171 /* don't accept alphanumeric for separator */
4172 if (isalpha(*cmd))
4174 EMSG(_("E146: Regular expressions can't be delimited by letters"));
4175 return;
4178 * undocumented vi feature:
4179 * "\/sub/" and "\?sub?" use last used search pattern (almost like
4180 * //sub/r). "\&sub&" use last substitute pattern (like //sub/).
4182 if (*cmd == '\\')
4184 ++cmd;
4185 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
4187 EMSG(_(e_backslash));
4188 return;
4190 if (*cmd != '&')
4191 which_pat = RE_SEARCH; /* use last '/' pattern */
4192 pat = (char_u *)""; /* empty search pattern */
4193 delimiter = *cmd++; /* remember delimiter character */
4195 else /* find the end of the regexp */
4197 which_pat = RE_LAST; /* use last used regexp */
4198 delimiter = *cmd++; /* remember delimiter character */
4199 pat = cmd; /* remember start of search pat */
4200 cmd = skip_regexp(cmd, delimiter, p_magic, &eap->arg);
4201 if (cmd[0] == delimiter) /* end delimiter found */
4202 *cmd++ = NUL; /* replace it with a NUL */
4206 * Small incompatibility: vi sees '\n' as end of the command, but in
4207 * Vim we want to use '\n' to find/substitute a NUL.
4209 sub = cmd; /* remember the start of the substitution */
4211 while (cmd[0])
4213 if (cmd[0] == delimiter) /* end delimiter found */
4215 *cmd++ = NUL; /* replace it with a NUL */
4216 break;
4218 if (cmd[0] == '\\' && cmd[1] != 0) /* skip escaped characters */
4219 ++cmd;
4220 mb_ptr_adv(cmd);
4223 if (!eap->skip)
4225 /* In POSIX vi ":s/pat/%/" uses the previous subst. string. */
4226 if (STRCMP(sub, "%") == 0
4227 && vim_strchr(p_cpo, CPO_SUBPERCENT) != NULL)
4229 if (old_sub == NULL) /* there is no previous command */
4231 EMSG(_(e_nopresub));
4232 return;
4234 sub = old_sub;
4236 else
4238 vim_free(old_sub);
4239 old_sub = vim_strsave(sub);
4243 else if (!eap->skip) /* use previous pattern and substitution */
4245 if (old_sub == NULL) /* there is no previous command */
4247 EMSG(_(e_nopresub));
4248 return;
4250 pat = NULL; /* search_regcomp() will use previous pattern */
4251 sub = old_sub;
4253 /* Vi compatibility quirk: repeating with ":s" keeps the cursor in the
4254 * last column after using "$". */
4255 endcolumn = (curwin->w_curswant == MAXCOL);
4259 * Find trailing options. When '&' is used, keep old options.
4261 if (*cmd == '&')
4262 ++cmd;
4263 else
4265 if (!p_ed)
4267 if (p_gd) /* default is global on */
4268 do_all = TRUE;
4269 else
4270 do_all = FALSE;
4271 do_ask = FALSE;
4273 do_error = TRUE;
4274 do_print = FALSE;
4275 do_count = FALSE;
4276 do_ic = 0;
4278 while (*cmd)
4281 * Note that 'g' and 'c' are always inverted, also when p_ed is off.
4282 * 'r' is never inverted.
4284 if (*cmd == 'g')
4285 do_all = !do_all;
4286 else if (*cmd == 'c')
4287 do_ask = !do_ask;
4288 else if (*cmd == 'n')
4289 do_count = TRUE;
4290 else if (*cmd == 'e')
4291 do_error = !do_error;
4292 else if (*cmd == 'r') /* use last used regexp */
4293 which_pat = RE_LAST;
4294 else if (*cmd == 'p')
4295 do_print = TRUE;
4296 else if (*cmd == '#')
4298 do_print = TRUE;
4299 do_number = TRUE;
4301 else if (*cmd == 'l')
4303 do_print = TRUE;
4304 do_list = TRUE;
4306 else if (*cmd == 'i') /* ignore case */
4307 do_ic = 'i';
4308 else if (*cmd == 'I') /* don't ignore case */
4309 do_ic = 'I';
4310 else
4311 break;
4312 ++cmd;
4314 if (do_count)
4315 do_ask = FALSE;
4318 * check for a trailing count
4320 cmd = skipwhite(cmd);
4321 if (VIM_ISDIGIT(*cmd))
4323 i = getdigits(&cmd);
4324 if (i <= 0 && !eap->skip && do_error)
4326 EMSG(_(e_zerocount));
4327 return;
4329 eap->line1 = eap->line2;
4330 eap->line2 += i - 1;
4331 if (eap->line2 > curbuf->b_ml.ml_line_count)
4332 eap->line2 = curbuf->b_ml.ml_line_count;
4336 * check for trailing command or garbage
4338 cmd = skipwhite(cmd);
4339 if (*cmd && *cmd != '"') /* if not end-of-line or comment */
4341 eap->nextcmd = check_nextcmd(cmd);
4342 if (eap->nextcmd == NULL)
4344 EMSG(_(e_trailing));
4345 return;
4349 if (eap->skip) /* not executing commands, only parsing */
4350 return;
4352 if (!do_count && !curbuf->b_p_ma)
4354 /* Substitution is not allowed in non-'modifiable' buffer */
4355 EMSG(_(e_modifiable));
4356 return;
4359 if (search_regcomp(pat, RE_SUBST, which_pat, SEARCH_HIS, &regmatch) == FAIL)
4361 if (do_error)
4362 EMSG(_(e_invcmd));
4363 return;
4366 /* the 'i' or 'I' flag overrules 'ignorecase' and 'smartcase' */
4367 if (do_ic == 'i')
4368 regmatch.rmm_ic = TRUE;
4369 else if (do_ic == 'I')
4370 regmatch.rmm_ic = FALSE;
4372 sub_firstline = NULL;
4375 * ~ in the substitute pattern is replaced with the old pattern.
4376 * We do it here once to avoid it to be replaced over and over again.
4377 * But don't do it when it starts with "\=", then it's an expression.
4379 if (!(sub[0] == '\\' && sub[1] == '='))
4380 sub = regtilde(sub, p_magic);
4383 * Check for a match on each line.
4385 line2 = eap->line2;
4386 for (lnum = eap->line1; lnum <= line2 && !(got_quit
4387 #if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
4388 || aborting()
4389 #endif
4390 ); ++lnum)
4392 sub_firstlnum = lnum;
4393 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
4394 if (nmatch)
4396 colnr_T copycol;
4397 colnr_T matchcol;
4398 colnr_T prev_matchcol = MAXCOL;
4399 char_u *new_end, *new_start = NULL;
4400 unsigned new_start_len = 0;
4401 char_u *p1;
4402 int did_sub = FALSE;
4403 int lastone;
4404 unsigned len, needed_len;
4405 long nmatch_tl = 0; /* nr of lines matched below lnum */
4406 int do_again; /* do it again after joining lines */
4407 int skip_match = FALSE;
4410 * The new text is build up step by step, to avoid too much
4411 * copying. There are these pieces:
4412 * sub_firstline The old text, unmodifed.
4413 * copycol Column in the old text where we started
4414 * looking for a match; from here old text still
4415 * needs to be copied to the new text.
4416 * matchcol Column number of the old text where to look
4417 * for the next match. It's just after the
4418 * previous match or one further.
4419 * prev_matchcol Column just after the previous match (if any).
4420 * Mostly equal to matchcol, except for the first
4421 * match and after skipping an empty match.
4422 * regmatch.*pos Where the pattern matched in the old text.
4423 * new_start The new text, all that has been produced so
4424 * far.
4425 * new_end The new text, where to append new text.
4427 * lnum The line number where we were looking for the
4428 * first match in the old line.
4429 * sub_firstlnum The line number in the buffer where to look
4430 * for a match. Can be different from "lnum"
4431 * when the pattern or substitute string contains
4432 * line breaks.
4434 * Special situations:
4435 * - When the substitute string contains a line break, the part up
4436 * to the line break is inserted in the text, but the copy of
4437 * the original line is kept. "sub_firstlnum" is adjusted for
4438 * the inserted lines.
4439 * - When the matched pattern contains a line break, the old line
4440 * is taken from the line at the end of the pattern. The lines
4441 * in the match are deleted later, "sub_firstlnum" is adjusted
4442 * accordingly.
4444 * The new text is built up in new_start[]. It has some extra
4445 * room to avoid using alloc()/free() too often. new_start_len is
4446 * the lenght of the allocated memory at new_start.
4448 * Make a copy of the old line, so it won't be taken away when
4449 * updating the screen or handling a multi-line match. The "old_"
4450 * pointers point into this copy.
4452 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4453 if (sub_firstline == NULL)
4455 vim_free(new_start);
4456 goto outofmem;
4458 copycol = 0;
4459 matchcol = 0;
4461 /* At first match, remember current cursor position. */
4462 if (!got_match)
4464 setpcmark();
4465 got_match = TRUE;
4469 * Loop until nothing more to replace in this line.
4470 * 1. Handle match with empty string.
4471 * 2. If do_ask is set, ask for confirmation.
4472 * 3. substitute the string.
4473 * 4. if do_all is set, find next match
4474 * 5. break if there isn't another match in this line
4476 for (;;)
4478 /* Save the line number of the last change for the final
4479 * cursor position (just like Vi). */
4480 curwin->w_cursor.lnum = lnum;
4481 do_again = FALSE;
4484 * 1. Match empty string does not count, except for first
4485 * match. This reproduces the strange vi behaviour.
4486 * This also catches endless loops.
4488 if (matchcol == prev_matchcol
4489 && regmatch.endpos[0].lnum == 0
4490 && matchcol == regmatch.endpos[0].col)
4492 if (sub_firstline[matchcol] == NUL)
4493 /* We already were at the end of the line. Don't look
4494 * for a match in this line again. */
4495 skip_match = TRUE;
4496 else
4497 ++matchcol; /* search for a match at next column */
4498 goto skip;
4501 /* Normally we continue searching for a match just after the
4502 * previous match. */
4503 matchcol = regmatch.endpos[0].col;
4504 prev_matchcol = matchcol;
4507 * 2. If do_count is set only increase the counter.
4508 * If do_ask is set, ask for confirmation.
4510 if (do_count)
4512 /* For a multi-line match, put matchcol at the NUL at
4513 * the end of the line and set nmatch to one, so that
4514 * we continue looking for a match on the next line.
4515 * Avoids that ":s/\nB\@=//gc" get stuck. */
4516 if (nmatch > 1)
4518 matchcol = (colnr_T)STRLEN(sub_firstline);
4519 nmatch = 1;
4521 sub_nsubs++;
4522 did_sub = TRUE;
4523 goto skip;
4526 if (do_ask)
4528 /* change State to CONFIRM, so that the mouse works
4529 * properly */
4530 save_State = State;
4531 State = CONFIRM;
4532 #ifdef FEAT_MOUSE
4533 setmouse(); /* disable mouse in xterm */
4534 #endif
4535 curwin->w_cursor.col = regmatch.startpos[0].col;
4537 /* When 'cpoptions' contains "u" don't sync undo when
4538 * asking for confirmation. */
4539 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4540 ++no_u_sync;
4543 * Loop until 'y', 'n', 'q', CTRL-E or CTRL-Y typed.
4545 while (do_ask)
4547 if (exmode_active)
4549 char_u *resp;
4550 colnr_T sc, ec;
4552 print_line_no_prefix(lnum, FALSE, FALSE);
4554 getvcol(curwin, &curwin->w_cursor, &sc, NULL, NULL);
4555 curwin->w_cursor.col = regmatch.endpos[0].col - 1;
4556 getvcol(curwin, &curwin->w_cursor, NULL, NULL, &ec);
4557 msg_start();
4558 for (i = 0; i < (long)sc; ++i)
4559 msg_putchar(' ');
4560 for ( ; i <= (long)ec; ++i)
4561 msg_putchar('^');
4563 resp = getexmodeline('?', NULL, 0);
4564 if (resp != NULL)
4566 i = *resp;
4567 vim_free(resp);
4570 else
4572 #ifdef FEAT_FOLDING
4573 int save_p_fen = curwin->w_p_fen;
4575 curwin->w_p_fen = FALSE;
4576 #endif
4577 /* Invert the matched string.
4578 * Remove the inversion afterwards. */
4579 temp = RedrawingDisabled;
4580 RedrawingDisabled = 0;
4582 search_match_lines = regmatch.endpos[0].lnum;
4583 search_match_endcol = regmatch.endpos[0].col;
4584 highlight_match = TRUE;
4586 update_topline();
4587 validate_cursor();
4588 update_screen(SOME_VALID);
4589 highlight_match = FALSE;
4590 redraw_later(SOME_VALID);
4592 #ifdef FEAT_FOLDING
4593 curwin->w_p_fen = save_p_fen;
4594 #endif
4595 if (msg_row == Rows - 1)
4596 msg_didout = FALSE; /* avoid a scroll-up */
4597 msg_starthere();
4598 i = msg_scroll;
4599 msg_scroll = 0; /* truncate msg when
4600 needed */
4601 msg_no_more = TRUE;
4602 /* write message same highlighting as for
4603 * wait_return */
4604 smsg_attr(hl_attr(HLF_R),
4605 (char_u *)_("replace with %s (y/n/a/q/l/^E/^Y)?"), sub);
4606 msg_no_more = FALSE;
4607 msg_scroll = i;
4608 showruler(TRUE);
4609 windgoto(msg_row, msg_col);
4610 RedrawingDisabled = temp;
4612 #ifdef USE_ON_FLY_SCROLL
4613 dont_scroll = FALSE; /* allow scrolling here */
4614 #endif
4615 ++no_mapping; /* don't map this key */
4616 ++allow_keys; /* allow special keys */
4617 i = safe_vgetc();
4618 --allow_keys;
4619 --no_mapping;
4621 /* clear the question */
4622 msg_didout = FALSE; /* don't scroll up */
4623 msg_col = 0;
4624 gotocmdline(TRUE);
4627 need_wait_return = FALSE; /* no hit-return prompt */
4628 if (i == 'q' || i == ESC || i == Ctrl_C
4629 #ifdef UNIX
4630 || i == intr_char
4631 #endif
4634 got_quit = TRUE;
4635 break;
4637 if (i == 'n')
4638 break;
4639 if (i == 'y')
4640 break;
4641 if (i == 'l')
4643 /* last: replace and then stop */
4644 do_all = FALSE;
4645 line2 = lnum;
4646 break;
4648 if (i == 'a')
4650 do_ask = FALSE;
4651 break;
4653 #ifdef FEAT_INS_EXPAND
4654 if (i == Ctrl_E)
4655 scrollup_clamp();
4656 else if (i == Ctrl_Y)
4657 scrolldown_clamp();
4658 #endif
4660 State = save_State;
4661 #ifdef FEAT_MOUSE
4662 setmouse();
4663 #endif
4664 if (vim_strchr(p_cpo, CPO_UNDO) != NULL)
4665 --no_u_sync;
4667 if (i == 'n')
4669 /* For a multi-line match, put matchcol at the NUL at
4670 * the end of the line and set nmatch to one, so that
4671 * we continue looking for a match on the next line.
4672 * Avoids that ":s/\nB\@=//gc" get stuck. */
4673 if (nmatch > 1)
4675 matchcol = (colnr_T)STRLEN(sub_firstline);
4676 nmatch = 1;
4678 goto skip;
4680 if (got_quit)
4681 break;
4684 /* Move the cursor to the start of the match, so that we can
4685 * use "\=col("."). */
4686 curwin->w_cursor.col = regmatch.startpos[0].col;
4689 * 3. substitute the string.
4691 /* get length of substitution part */
4692 sublen = vim_regsub_multi(&regmatch, sub_firstlnum,
4693 sub, sub_firstline, FALSE, p_magic, TRUE);
4695 /* When the match included the "$" of the last line it may
4696 * go beyond the last line of the buffer. */
4697 if (nmatch > curbuf->b_ml.ml_line_count - sub_firstlnum + 1)
4699 nmatch = curbuf->b_ml.ml_line_count - sub_firstlnum + 1;
4700 skip_match = TRUE;
4703 /* Need room for:
4704 * - result so far in new_start (not for first sub in line)
4705 * - original text up to match
4706 * - length of substituted part
4707 * - original text after match
4709 if (nmatch == 1)
4710 p1 = sub_firstline;
4711 else
4713 p1 = ml_get(sub_firstlnum + nmatch - 1);
4714 nmatch_tl += nmatch - 1;
4716 i = regmatch.startpos[0].col - copycol;
4717 needed_len = i + ((unsigned)STRLEN(p1) - regmatch.endpos[0].col)
4718 + sublen + 1;
4719 if (new_start == NULL)
4722 * Get some space for a temporary buffer to do the
4723 * substitution into (and some extra space to avoid
4724 * too many calls to alloc()/free()).
4726 new_start_len = needed_len + 50;
4727 if ((new_start = alloc_check(new_start_len)) == NULL)
4728 goto outofmem;
4729 *new_start = NUL;
4730 new_end = new_start;
4732 else
4735 * Check if the temporary buffer is long enough to do the
4736 * substitution into. If not, make it larger (with a bit
4737 * extra to avoid too many calls to alloc()/free()).
4739 len = (unsigned)STRLEN(new_start);
4740 needed_len += len;
4741 if (needed_len > new_start_len)
4743 new_start_len = needed_len + 50;
4744 if ((p1 = alloc_check(new_start_len)) == NULL)
4746 vim_free(new_start);
4747 goto outofmem;
4749 mch_memmove(p1, new_start, (size_t)(len + 1));
4750 vim_free(new_start);
4751 new_start = p1;
4753 new_end = new_start + len;
4757 * copy the text up to the part that matched
4759 mch_memmove(new_end, sub_firstline + copycol, (size_t)i);
4760 new_end += i;
4762 (void)vim_regsub_multi(&regmatch, sub_firstlnum,
4763 sub, new_end, TRUE, p_magic, TRUE);
4764 sub_nsubs++;
4765 did_sub = TRUE;
4767 /* Move the cursor to the start of the line, to avoid that it
4768 * is beyond the end of the line after the substitution. */
4769 curwin->w_cursor.col = 0;
4771 /* For a multi-line match, make a copy of the last matched
4772 * line and continue in that one. */
4773 if (nmatch > 1)
4775 sub_firstlnum += nmatch - 1;
4776 vim_free(sub_firstline);
4777 sub_firstline = vim_strsave(ml_get(sub_firstlnum));
4778 /* When going beyond the last line, stop substituting. */
4779 if (sub_firstlnum <= line2)
4780 do_again = TRUE;
4781 else
4782 do_all = FALSE;
4785 /* Remember next character to be copied. */
4786 copycol = regmatch.endpos[0].col;
4788 if (skip_match)
4790 /* Already hit end of the buffer, sub_firstlnum is one
4791 * less than what it ought to be. */
4792 vim_free(sub_firstline);
4793 sub_firstline = vim_strsave((char_u *)"");
4794 copycol = 0;
4798 * Now the trick is to replace CTRL-M chars with a real line
4799 * break. This would make it impossible to insert a CTRL-M in
4800 * the text. The line break can be avoided by preceding the
4801 * CTRL-M with a backslash. To be able to insert a backslash,
4802 * they must be doubled in the string and are halved here.
4803 * That is Vi compatible.
4805 for (p1 = new_end; *p1; ++p1)
4807 if (p1[0] == '\\' && p1[1] != NUL) /* remove backslash */
4808 mch_memmove(p1, p1 + 1, STRLEN(p1));
4809 else if (*p1 == CAR)
4811 if (u_inssub(lnum) == OK) /* prepare for undo */
4813 *p1 = NUL; /* truncate up to the CR */
4814 ml_append(lnum - 1, new_start,
4815 (colnr_T)(p1 - new_start + 1), FALSE);
4816 mark_adjust(lnum + 1, (linenr_T)MAXLNUM, 1L, 0L);
4817 if (do_ask)
4818 appended_lines(lnum - 1, 1L);
4819 else
4821 if (first_line == 0)
4822 first_line = lnum;
4823 last_line = lnum + 1;
4825 /* All line numbers increase. */
4826 ++sub_firstlnum;
4827 ++lnum;
4828 ++line2;
4829 /* move the cursor to the new line, like Vi */
4830 ++curwin->w_cursor.lnum;
4831 STRCPY(new_start, p1 + 1); /* copy the rest */
4832 p1 = new_start - 1;
4835 #ifdef FEAT_MBYTE
4836 else if (has_mbyte)
4837 p1 += (*mb_ptr2len)(p1) - 1;
4838 #endif
4842 * 4. If do_all is set, find next match.
4843 * Prevent endless loop with patterns that match empty
4844 * strings, e.g. :s/$/pat/g or :s/[a-z]* /(&)/g.
4845 * But ":s/\n/#/" is OK.
4847 skip:
4848 /* We already know that we did the last subst when we are at
4849 * the end of the line, except that a pattern like
4850 * "bar\|\nfoo" may match at the NUL. */
4851 lastone = (skip_match
4852 || got_int
4853 || got_quit
4854 || !(do_all || do_again)
4855 || (sub_firstline[matchcol] == NUL && nmatch <= 1
4856 && !re_multiline(regmatch.regprog)));
4857 nmatch = -1;
4860 * Replace the line in the buffer when needed. This is
4861 * skipped when there are more matches.
4862 * The check for nmatch_tl is needed for when multi-line
4863 * matching must replace the lines before trying to do another
4864 * match, otherwise "\@<=" won't work.
4865 * When asking the user we like to show the already replaced
4866 * text, but don't do it when "\<@=" or "\<@!" is used, it
4867 * changes what matches.
4869 if (lastone
4870 || (do_ask && !re_lookbehind(regmatch.regprog))
4871 || nmatch_tl > 0
4872 || (nmatch = vim_regexec_multi(&regmatch, curwin,
4873 curbuf, sub_firstlnum, matchcol)) == 0)
4875 if (new_start != NULL)
4878 * Copy the rest of the line, that didn't match.
4879 * "matchcol" has to be adjusted, we use the end of
4880 * the line as reference, because the substitute may
4881 * have changed the number of characters. Same for
4882 * "prev_matchcol".
4884 STRCAT(new_start, sub_firstline + copycol);
4885 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4886 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4887 - prev_matchcol;
4889 if (u_savesub(lnum) != OK)
4890 break;
4891 ml_replace(lnum, new_start, TRUE);
4893 if (nmatch_tl > 0)
4896 * Matched lines have now been substituted and are
4897 * useless, delete them. The part after the match
4898 * has been appended to new_start, we don't need
4899 * it in the buffer.
4901 ++lnum;
4902 if (u_savedel(lnum, nmatch_tl) != OK)
4903 break;
4904 for (i = 0; i < nmatch_tl; ++i)
4905 ml_delete(lnum, (int)FALSE);
4906 mark_adjust(lnum, lnum + nmatch_tl - 1,
4907 (long)MAXLNUM, -nmatch_tl);
4908 if (do_ask)
4909 deleted_lines(lnum, nmatch_tl);
4910 --lnum;
4911 line2 -= nmatch_tl; /* nr of lines decreases */
4912 nmatch_tl = 0;
4915 /* When asking, undo is saved each time, must also set
4916 * changed flag each time. */
4917 if (do_ask)
4918 changed_bytes(lnum, 0);
4919 else
4921 if (first_line == 0)
4922 first_line = lnum;
4923 last_line = lnum + 1;
4926 sub_firstlnum = lnum;
4927 vim_free(sub_firstline); /* free the temp buffer */
4928 sub_firstline = new_start;
4929 new_start = NULL;
4930 matchcol = (colnr_T)STRLEN(sub_firstline) - matchcol;
4931 prev_matchcol = (colnr_T)STRLEN(sub_firstline)
4932 - prev_matchcol;
4933 copycol = 0;
4935 if (nmatch == -1 && !lastone)
4936 nmatch = vim_regexec_multi(&regmatch, curwin, curbuf,
4937 sub_firstlnum, matchcol);
4940 * 5. break if there isn't another match in this line
4942 if (nmatch <= 0)
4943 break;
4946 line_breakcheck();
4949 if (did_sub)
4950 ++sub_nlines;
4951 vim_free(sub_firstline); /* free the copy of the original line */
4952 sub_firstline = NULL;
4955 line_breakcheck();
4958 if (first_line != 0)
4960 /* Need to subtract the number of added lines from "last_line" to get
4961 * the line number before the change (same as adding the number of
4962 * deleted lines). */
4963 i = curbuf->b_ml.ml_line_count - old_line_count;
4964 changed_lines(first_line, 0, last_line - i, i);
4967 outofmem:
4968 vim_free(sub_firstline); /* may have to free allocated copy of the line */
4970 /* ":s/pat//n" doesn't move the cursor */
4971 if (do_count)
4972 curwin->w_cursor = old_cursor;
4974 if (sub_nsubs)
4976 /* Set the '[ and '] marks. */
4977 curbuf->b_op_start.lnum = eap->line1;
4978 curbuf->b_op_end.lnum = line2;
4979 curbuf->b_op_start.col = curbuf->b_op_end.col = 0;
4981 if (!global_busy)
4983 if (endcolumn)
4984 coladvance((colnr_T)MAXCOL);
4985 else
4986 beginline(BL_WHITE | BL_FIX);
4987 if (!do_sub_msg(do_count) && do_ask)
4988 MSG("");
4990 else
4991 global_need_beginline = TRUE;
4992 if (do_print)
4993 print_line(curwin->w_cursor.lnum, do_number, do_list);
4995 else if (!global_busy)
4997 if (got_int) /* interrupted */
4998 EMSG(_(e_interr));
4999 else if (got_match) /* did find something but nothing substituted */
5000 MSG("");
5001 else if (do_error) /* nothing found */
5002 EMSG2(_(e_patnotf2), get_search_pat());
5005 vim_free(regmatch.regprog);
5009 * Give message for number of substitutions.
5010 * Can also be used after a ":global" command.
5011 * Return TRUE if a message was given.
5014 do_sub_msg(count_only)
5015 int count_only; /* used 'n' flag for ":s" */
5017 int len = 0;
5020 * Only report substitutions when:
5021 * - more than 'report' substitutions
5022 * - command was typed by user, or number of changed lines > 'report'
5023 * - giving messages is not disabled by 'lazyredraw'
5025 if (((sub_nsubs > p_report && (KeyTyped || sub_nlines > 1 || p_report < 1))
5026 || count_only)
5027 && messaging())
5029 if (got_int)
5031 STRCPY(msg_buf, _("(Interrupted) "));
5032 len = (int)STRLEN(msg_buf);
5034 if (sub_nsubs == 1)
5035 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5036 "%s", count_only ? _("1 match") : _("1 substitution"));
5037 else
5038 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5039 count_only ? _("%ld matches") : _("%ld substitutions"),
5040 sub_nsubs);
5041 len = (int)STRLEN(msg_buf);
5042 if (sub_nlines == 1)
5043 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5044 "%s", _(" on 1 line"));
5045 else
5046 vim_snprintf((char *)msg_buf + len, sizeof(msg_buf) - len,
5047 _(" on %ld lines"), (long)sub_nlines);
5048 if (msg(msg_buf))
5049 /* save message to display it after redraw */
5050 set_keep_msg(msg_buf, 0);
5051 return TRUE;
5053 if (got_int)
5055 EMSG(_(e_interr));
5056 return TRUE;
5058 return FALSE;
5062 * Execute a global command of the form:
5064 * g/pattern/X : execute X on all lines where pattern matches
5065 * v/pattern/X : execute X on all lines where pattern does not match
5067 * where 'X' is an EX command
5069 * The command character (as well as the trailing slash) is optional, and
5070 * is assumed to be 'p' if missing.
5072 * This is implemented in two passes: first we scan the file for the pattern and
5073 * set a mark for each line that (not) matches. secondly we execute the command
5074 * for each line that has a mark. This is required because after deleting
5075 * lines we do not know where to search for the next match.
5077 void
5078 ex_global(eap)
5079 exarg_T *eap;
5081 linenr_T lnum; /* line number according to old situation */
5082 int ndone = 0;
5083 int type; /* first char of cmd: 'v' or 'g' */
5084 char_u *cmd; /* command argument */
5086 char_u delim; /* delimiter, normally '/' */
5087 char_u *pat;
5088 regmmatch_T regmatch;
5089 int match;
5090 int which_pat;
5092 if (global_busy)
5094 EMSG(_("E147: Cannot do :global recursive")); /* will increment global_busy */
5095 return;
5098 if (eap->forceit) /* ":global!" is like ":vglobal" */
5099 type = 'v';
5100 else
5101 type = *eap->cmd;
5102 cmd = eap->arg;
5103 which_pat = RE_LAST; /* default: use last used regexp */
5104 sub_nsubs = 0;
5105 sub_nlines = 0;
5108 * undocumented vi feature:
5109 * "\/" and "\?": use previous search pattern.
5110 * "\&": use previous substitute pattern.
5112 if (*cmd == '\\')
5114 ++cmd;
5115 if (vim_strchr((char_u *)"/?&", *cmd) == NULL)
5117 EMSG(_(e_backslash));
5118 return;
5120 if (*cmd == '&')
5121 which_pat = RE_SUBST; /* use previous substitute pattern */
5122 else
5123 which_pat = RE_SEARCH; /* use previous search pattern */
5124 ++cmd;
5125 pat = (char_u *)"";
5127 else if (*cmd == NUL)
5129 EMSG(_("E148: Regular expression missing from global"));
5130 return;
5132 else
5134 delim = *cmd; /* get the delimiter */
5135 if (delim)
5136 ++cmd; /* skip delimiter if there is one */
5137 pat = cmd; /* remember start of pattern */
5138 cmd = skip_regexp(cmd, delim, p_magic, &eap->arg);
5139 if (cmd[0] == delim) /* end delimiter found */
5140 *cmd++ = NUL; /* replace it with a NUL */
5143 #ifdef FEAT_FKMAP /* when in Farsi mode, reverse the character flow */
5144 if (p_altkeymap && curwin->w_p_rl)
5145 lrFswap(pat,0);
5146 #endif
5148 if (search_regcomp(pat, RE_BOTH, which_pat, SEARCH_HIS, &regmatch) == FAIL)
5150 EMSG(_(e_invcmd));
5151 return;
5155 * pass 1: set marks for each (not) matching line
5157 for (lnum = eap->line1; lnum <= eap->line2 && !got_int; ++lnum)
5159 /* a match on this line? */
5160 match = vim_regexec_multi(&regmatch, curwin, curbuf, lnum, (colnr_T)0);
5161 if ((type == 'g' && match) || (type == 'v' && !match))
5163 ml_setmarked(lnum);
5164 ndone++;
5166 line_breakcheck();
5170 * pass 2: execute the command for each line that has been marked
5172 if (got_int)
5173 MSG(_(e_interr));
5174 else if (ndone == 0)
5176 if (type == 'v')
5177 smsg((char_u *)_("Pattern found in every line: %s"), pat);
5178 else
5179 smsg((char_u *)_(e_patnotf2), pat);
5181 else
5182 global_exe(cmd);
5184 ml_clearmarked(); /* clear rest of the marks */
5185 vim_free(regmatch.regprog);
5189 * Execute "cmd" on lines marked with ml_setmarked().
5191 void
5192 global_exe(cmd)
5193 char_u *cmd;
5195 linenr_T old_lcount; /* b_ml.ml_line_count before the command */
5196 linenr_T lnum; /* line number according to old situation */
5199 * Set current position only once for a global command.
5200 * If global_busy is set, setpcmark() will not do anything.
5201 * If there is an error, global_busy will be incremented.
5203 setpcmark();
5205 /* When the command writes a message, don't overwrite the command. */
5206 msg_didout = TRUE;
5208 global_need_beginline = FALSE;
5209 global_busy = 1;
5210 old_lcount = curbuf->b_ml.ml_line_count;
5211 while (!got_int && (lnum = ml_firstmarked()) != 0 && global_busy == 1)
5213 curwin->w_cursor.lnum = lnum;
5214 curwin->w_cursor.col = 0;
5215 if (*cmd == NUL || *cmd == '\n')
5216 do_cmdline((char_u *)"p", NULL, NULL, DOCMD_NOWAIT);
5217 else
5218 do_cmdline(cmd, NULL, NULL, DOCMD_NOWAIT);
5219 ui_breakcheck();
5222 global_busy = 0;
5223 if (global_need_beginline)
5224 beginline(BL_WHITE | BL_FIX);
5225 else
5226 check_cursor(); /* cursor may be beyond the end of the line */
5228 /* the cursor may not have moved in the text but a change in a previous
5229 * line may move it on the screen */
5230 changed_line_abv_curs();
5232 /* If it looks like no message was written, allow overwriting the
5233 * command with the report for number of changes. */
5234 if (msg_col == 0 && msg_scrolled == 0)
5235 msg_didout = FALSE;
5237 /* If subsitutes done, report number of substitues, otherwise report
5238 * number of extra or deleted lines. */
5239 if (!do_sub_msg(FALSE))
5240 msgmore(curbuf->b_ml.ml_line_count - old_lcount);
5243 #ifdef FEAT_VIMINFO
5245 read_viminfo_sub_string(virp, force)
5246 vir_T *virp;
5247 int force;
5249 if (old_sub != NULL && force)
5250 vim_free(old_sub);
5251 if (force || old_sub == NULL)
5252 old_sub = viminfo_readstring(virp, 1, TRUE);
5253 return viminfo_readline(virp);
5256 void
5257 write_viminfo_sub_string(fp)
5258 FILE *fp;
5260 if (get_viminfo_parameter('/') != 0 && old_sub != NULL)
5262 fprintf(fp, _("\n# Last Substitute String:\n$"));
5263 viminfo_writestring(fp, old_sub);
5266 #endif /* FEAT_VIMINFO */
5268 #if defined(EXITFREE) || defined(PROTO)
5269 void
5270 free_old_sub()
5272 vim_free(old_sub);
5274 #endif
5276 #if (defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)) || defined(PROTO)
5278 * Set up for a tagpreview.
5279 * Return TRUE when it was created.
5282 prepare_tagpreview(undo_sync)
5283 int undo_sync; /* sync undo when leaving the window */
5285 win_T *wp;
5287 # ifdef FEAT_GUI
5288 need_mouse_correct = TRUE;
5289 # endif
5292 * If there is already a preview window open, use that one.
5294 if (!curwin->w_p_pvw)
5296 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5297 if (wp->w_p_pvw)
5298 break;
5299 if (wp != NULL)
5300 win_enter(wp, undo_sync);
5301 else
5304 * There is no preview window open yet. Create one.
5306 if (win_split(g_do_tagpreview > 0 ? g_do_tagpreview : 0, 0)
5307 == FAIL)
5308 return FALSE;
5309 curwin->w_p_pvw = TRUE;
5310 curwin->w_p_wfh = TRUE;
5311 # ifdef FEAT_SCROLLBIND
5312 curwin->w_p_scb = FALSE; /* don't take over 'scrollbind' */
5313 # endif
5314 # ifdef FEAT_DIFF
5315 curwin->w_p_diff = FALSE; /* no 'diff' */
5316 # endif
5317 # ifdef FEAT_FOLDING
5318 curwin->w_p_fdc = 0; /* no 'foldcolumn' */
5319 # endif
5320 return TRUE;
5323 return FALSE;
5326 #endif
5330 * ":help": open a read-only window on a help file
5332 void
5333 ex_help(eap)
5334 exarg_T *eap;
5336 char_u *arg;
5337 char_u *tag;
5338 FILE *helpfd; /* file descriptor of help file */
5339 int n;
5340 int i;
5341 #ifdef FEAT_WINDOWS
5342 win_T *wp;
5343 #endif
5344 int num_matches;
5345 char_u **matches;
5346 char_u *p;
5347 int empty_fnum = 0;
5348 int alt_fnum = 0;
5349 buf_T *buf;
5350 #ifdef FEAT_MULTI_LANG
5351 int len;
5352 char_u *lang;
5353 #endif
5355 if (eap != NULL)
5358 * A ":help" command ends at the first LF, or at a '|' that is
5359 * followed by some text. Set nextcmd to the following command.
5361 for (arg = eap->arg; *arg; ++arg)
5363 if (*arg == '\n' || *arg == '\r'
5364 || (*arg == '|' && arg[1] != NUL && arg[1] != '|'))
5366 *arg++ = NUL;
5367 eap->nextcmd = arg;
5368 break;
5371 arg = eap->arg;
5373 if (eap->forceit && *arg == NUL)
5375 EMSG(_("E478: Don't panic!"));
5376 return;
5379 if (eap->skip) /* not executing commands */
5380 return;
5382 else
5383 arg = (char_u *)"";
5385 /* remove trailing blanks */
5386 p = arg + STRLEN(arg) - 1;
5387 while (p > arg && vim_iswhite(*p) && p[-1] != '\\')
5388 *p-- = NUL;
5390 #ifdef FEAT_MULTI_LANG
5391 /* Check for a specified language */
5392 lang = check_help_lang(arg);
5393 #endif
5395 /* When no argument given go to the index. */
5396 if (*arg == NUL)
5397 arg = (char_u *)"help.txt";
5400 * Check if there is a match for the argument.
5402 n = find_help_tags(arg, &num_matches, &matches,
5403 eap != NULL && eap->forceit);
5405 i = 0;
5406 #ifdef FEAT_MULTI_LANG
5407 if (n != FAIL && lang != NULL)
5408 /* Find first item with the requested language. */
5409 for (i = 0; i < num_matches; ++i)
5411 len = (int)STRLEN(matches[i]);
5412 if (len > 3 && matches[i][len - 3] == '@'
5413 && STRICMP(matches[i] + len - 2, lang) == 0)
5414 break;
5416 #endif
5417 if (i >= num_matches || n == FAIL)
5419 #ifdef FEAT_MULTI_LANG
5420 if (lang != NULL)
5421 EMSG3(_("E661: Sorry, no '%s' help for %s"), lang, arg);
5422 else
5423 #endif
5424 EMSG2(_("E149: Sorry, no help for %s"), arg);
5425 if (n != FAIL)
5426 FreeWild(num_matches, matches);
5427 return;
5430 /* The first match (in the requested language) is the best match. */
5431 tag = vim_strsave(matches[i]);
5432 FreeWild(num_matches, matches);
5434 #ifdef FEAT_GUI
5435 need_mouse_correct = TRUE;
5436 #endif
5439 * Re-use an existing help window or open a new one.
5440 * Always open a new one for ":tab help".
5442 if (!curwin->w_buffer->b_help
5443 #ifdef FEAT_WINDOWS
5444 || cmdmod.tab != 0
5445 #endif
5448 #ifdef FEAT_WINDOWS
5449 if (cmdmod.tab != 0)
5450 wp = NULL;
5451 else
5452 for (wp = firstwin; wp != NULL; wp = wp->w_next)
5453 if (wp->w_buffer != NULL && wp->w_buffer->b_help)
5454 break;
5455 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
5456 win_enter(wp, TRUE);
5457 else
5458 #endif
5461 * There is no help window yet.
5462 * Try to open the file specified by the "helpfile" option.
5464 if ((helpfd = mch_fopen((char *)p_hf, READBIN)) == NULL)
5466 smsg((char_u *)_("Sorry, help file \"%s\" not found"), p_hf);
5467 goto erret;
5469 fclose(helpfd);
5471 #ifdef FEAT_WINDOWS
5472 /* Split off help window; put it at far top if no position
5473 * specified, the current window is vertically split and
5474 * narrow. */
5475 n = WSP_HELP;
5476 # ifdef FEAT_VERTSPLIT
5477 if (cmdmod.split == 0 && curwin->w_width != Columns
5478 && curwin->w_width < 80)
5479 n |= WSP_TOP;
5480 # endif
5481 if (win_split(0, n) == FAIL)
5482 goto erret;
5483 #else
5484 /* use current window */
5485 if (!can_abandon(curbuf, FALSE))
5486 goto erret;
5487 #endif
5489 #ifdef FEAT_WINDOWS
5490 if (curwin->w_height < p_hh)
5491 win_setheight((int)p_hh);
5492 #endif
5495 * Open help file (do_ecmd() will set b_help flag, readfile() will
5496 * set b_p_ro flag).
5497 * Set the alternate file to the previously edited file.
5499 alt_fnum = curbuf->b_fnum;
5500 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_LASTL,
5501 ECMD_HIDE + ECMD_SET_HELP);
5502 if (!cmdmod.keepalt)
5503 curwin->w_alt_fnum = alt_fnum;
5504 empty_fnum = curbuf->b_fnum;
5508 if (!p_im)
5509 restart_edit = 0; /* don't want insert mode in help file */
5511 if (tag != NULL)
5512 do_tag(tag, DT_HELP, 1, FALSE, TRUE);
5514 /* Delete the empty buffer if we're not using it. Careful: autocommands
5515 * may have jumped to another window, check that the buffer is not in a
5516 * window. */
5517 if (empty_fnum != 0 && curbuf->b_fnum != empty_fnum)
5519 buf = buflist_findnr(empty_fnum);
5520 if (buf != NULL && buf->b_nwindows == 0)
5521 wipe_buffer(buf, TRUE);
5524 /* keep the previous alternate file */
5525 if (alt_fnum != 0 && curwin->w_alt_fnum == empty_fnum && !cmdmod.keepalt)
5526 curwin->w_alt_fnum = alt_fnum;
5528 erret:
5529 vim_free(tag);
5533 #if defined(FEAT_MULTI_LANG) || defined(PROTO)
5535 * In an argument search for a language specifiers in the form "@xx".
5536 * Changes the "@" to NUL if found, and returns a pointer to "xx".
5537 * Returns NULL if not found.
5539 char_u *
5540 check_help_lang(arg)
5541 char_u *arg;
5543 int len = (int)STRLEN(arg);
5545 if (len >= 3 && arg[len - 3] == '@' && ASCII_ISALPHA(arg[len - 2])
5546 && ASCII_ISALPHA(arg[len - 1]))
5548 arg[len - 3] = NUL; /* remove the '@' */
5549 return arg + len - 2;
5551 return NULL;
5553 #endif
5556 * Return a heuristic indicating how well the given string matches. The
5557 * smaller the number, the better the match. This is the order of priorities,
5558 * from best match to worst match:
5559 * - Match with least alpha-numeric characters is better.
5560 * - Match with least total characters is better.
5561 * - Match towards the start is better.
5562 * - Match starting with "+" is worse (feature instead of command)
5563 * Assumption is made that the matched_string passed has already been found to
5564 * match some string for which help is requested. webb.
5567 help_heuristic(matched_string, offset, wrong_case)
5568 char_u *matched_string;
5569 int offset; /* offset for match */
5570 int wrong_case; /* no matching case */
5572 int num_letters;
5573 char_u *p;
5575 num_letters = 0;
5576 for (p = matched_string; *p; p++)
5577 if (ASCII_ISALNUM(*p))
5578 num_letters++;
5581 * Multiply the number of letters by 100 to give it a much bigger
5582 * weighting than the number of characters.
5583 * If there only is a match while ignoring case, add 5000.
5584 * If the match starts in the middle of a word, add 10000 to put it
5585 * somewhere in the last half.
5586 * If the match is more than 2 chars from the start, multiply by 200 to
5587 * put it after matches at the start.
5589 if (ASCII_ISALNUM(matched_string[offset]) && offset > 0
5590 && ASCII_ISALNUM(matched_string[offset - 1]))
5591 offset += 10000;
5592 else if (offset > 2)
5593 offset *= 200;
5594 if (wrong_case)
5595 offset += 5000;
5596 /* Features are less interesting than the subjects themselves, but "+"
5597 * alone is not a feature. */
5598 if (matched_string[0] == '+' && matched_string[1] != NUL)
5599 offset += 100;
5600 return (int)(100 * num_letters + STRLEN(matched_string) + offset);
5604 * Compare functions for qsort() below, that checks the help heuristics number
5605 * that has been put after the tagname by find_tags().
5607 static int
5608 #ifdef __BORLANDC__
5609 _RTLENTRYF
5610 #endif
5611 help_compare(s1, s2)
5612 const void *s1;
5613 const void *s2;
5615 char *p1;
5616 char *p2;
5618 p1 = *(char **)s1 + strlen(*(char **)s1) + 1;
5619 p2 = *(char **)s2 + strlen(*(char **)s2) + 1;
5620 return strcmp(p1, p2);
5624 * Find all help tags matching "arg", sort them and return in matches[], with
5625 * the number of matches in num_matches.
5626 * The matches will be sorted with a "best" match algorithm.
5627 * When "keep_lang" is TRUE try keeping the language of the current buffer.
5630 find_help_tags(arg, num_matches, matches, keep_lang)
5631 char_u *arg;
5632 int *num_matches;
5633 char_u ***matches;
5634 int keep_lang;
5636 char_u *s, *d;
5637 int i;
5638 static char *(mtable[]) = {"*", "g*", "[*", "]*", ":*",
5639 "/*", "/\\*", "\"*", "**",
5640 "/\\(\\)",
5641 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5642 "/\\?", "/\\z(\\)", "\\=", ":s\\=",
5643 "[count]", "[quotex]", "[range]",
5644 "[pattern]", "\\|", "\\%$"};
5645 static char *(rtable[]) = {"star", "gstar", "[star", "]star", ":star",
5646 "/star", "/\\\\star", "quotestar", "starstar",
5647 "/\\\\(\\\\)",
5648 "?", ":?", "?<CR>", "g?", "g?g?", "g??", "z?",
5649 "/\\\\?", "/\\\\z(\\\\)", "\\\\=", ":s\\\\=",
5650 "\\[count]", "\\[quotex]", "\\[range]",
5651 "\\[pattern]", "\\\\bar", "/\\\\%\\$"};
5652 int flags;
5654 d = IObuff; /* assume IObuff is long enough! */
5657 * Recognize a few exceptions to the rule. Some strings that contain '*'
5658 * with "star". Otherwise '*' is recognized as a wildcard.
5660 for (i = sizeof(mtable) / sizeof(char *); --i >= 0; )
5661 if (STRCMP(arg, mtable[i]) == 0)
5663 STRCPY(d, rtable[i]);
5664 break;
5667 if (i < 0) /* no match in table */
5669 /* Replace "\S" with "/\\S", etc. Otherwise every tag is matched.
5670 * Also replace "\%^" and "\%(", they match every tag too.
5671 * Also "\zs", "\z1", etc.
5672 * Also "\@<", "\@=", "\@<=", etc.
5673 * And also "\_$" and "\_^". */
5674 if (arg[0] == '\\'
5675 && ((arg[1] != NUL && arg[2] == NUL)
5676 || (vim_strchr((char_u *)"%_z@", arg[1]) != NULL
5677 && arg[2] != NUL)))
5679 STRCPY(d, "/\\\\");
5680 STRCPY(d + 3, arg + 1);
5681 /* Check for "/\\_$", should be "/\\_\$" */
5682 if (d[3] == '_' && d[4] == '$')
5683 STRCPY(d + 4, "\\$");
5685 else
5687 /* replace "[:...:]" with "\[:...:]"; "[+...]" with "\[++...]" */
5688 if (arg[0] == '[' && (arg[1] == ':'
5689 || (arg[1] == '+' && arg[2] == '+')))
5690 *d++ = '\\';
5692 for (s = arg; *s; ++s)
5695 * Replace "|" with "bar" and '"' with "quote" to match the name of
5696 * the tags for these commands.
5697 * Replace "*" with ".*" and "?" with "." to match command line
5698 * completion.
5699 * Insert a backslash before '~', '$' and '.' to avoid their
5700 * special meaning.
5702 if (d - IObuff > IOSIZE - 10) /* getting too long!? */
5703 break;
5704 switch (*s)
5706 case '|': STRCPY(d, "bar");
5707 d += 3;
5708 continue;
5709 case '"': STRCPY(d, "quote");
5710 d += 5;
5711 continue;
5712 case '*': *d++ = '.';
5713 break;
5714 case '?': *d++ = '.';
5715 continue;
5716 case '$':
5717 case '.':
5718 case '~': *d++ = '\\';
5719 break;
5723 * Replace "^x" by "CTRL-X". Don't do this for "^_" to make
5724 * ":help i_^_CTRL-D" work.
5725 * Insert '-' before and after "CTRL-X" when applicable.
5727 if (*s < ' ' || (*s == '^' && s[1] && (ASCII_ISALPHA(s[1])
5728 || vim_strchr((char_u *)"?@[\\]^", s[1]) != NULL)))
5730 if (d > IObuff && d[-1] != '_')
5731 *d++ = '_'; /* prepend a '_' */
5732 STRCPY(d, "CTRL-");
5733 d += 5;
5734 if (*s < ' ')
5736 #ifdef EBCDIC
5737 *d++ = CtrlChar(*s);
5738 #else
5739 *d++ = *s + '@';
5740 #endif
5741 if (d[-1] == '\\')
5742 *d++ = '\\'; /* double a backslash */
5744 else
5745 *d++ = *++s;
5746 if (s[1] != NUL && s[1] != '_')
5747 *d++ = '_'; /* append a '_' */
5748 continue;
5750 else if (*s == '^') /* "^" or "CTRL-^" or "^_" */
5751 *d++ = '\\';
5754 * Insert a backslash before a backslash after a slash, for search
5755 * pattern tags: "/\|" --> "/\\|".
5757 else if (s[0] == '\\' && s[1] != '\\'
5758 && *arg == '/' && s == arg + 1)
5759 *d++ = '\\';
5761 /* "CTRL-\_" -> "CTRL-\\_" to avoid the special meaning of "\_" in
5762 * "CTRL-\_CTRL-N" */
5763 if (STRNICMP(s, "CTRL-\\_", 7) == 0)
5765 STRCPY(d, "CTRL-\\\\");
5766 d += 7;
5767 s += 6;
5770 *d++ = *s;
5773 * If tag starts with ', toss everything after a second '. Fixes
5774 * CTRL-] on 'option'. (would include the trailing '.').
5776 if (*s == '\'' && s > arg && *arg == '\'')
5777 break;
5779 *d = NUL;
5783 *matches = (char_u **)"";
5784 *num_matches = 0;
5785 flags = TAG_HELP | TAG_REGEXP | TAG_NAMES | TAG_VERBOSE;
5786 if (keep_lang)
5787 flags |= TAG_KEEP_LANG;
5788 if (find_tags(IObuff, num_matches, matches, flags, (int)MAXCOL, NULL) == OK
5789 && *num_matches > 0)
5790 /* Sort the matches found on the heuristic number that is after the
5791 * tag name. */
5792 qsort((void *)*matches, (size_t)*num_matches,
5793 sizeof(char_u *), help_compare);
5794 return OK;
5798 * After reading a help file: May cleanup a help buffer when syntax
5799 * highlighting is not used.
5801 void
5802 fix_help_buffer()
5804 linenr_T lnum;
5805 char_u *line;
5806 int in_example = FALSE;
5807 int len;
5808 char_u *p;
5809 char_u *rt;
5810 int mustfree;
5812 /* set filetype to "help". */
5813 set_option_value((char_u *)"ft", 0L, (char_u *)"help", OPT_LOCAL);
5815 #ifdef FEAT_SYN_HL
5816 if (!syntax_present(curbuf))
5817 #endif
5819 for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count; ++lnum)
5821 line = ml_get_buf(curbuf, lnum, FALSE);
5822 len = (int)STRLEN(line);
5823 if (in_example && len > 0 && !vim_iswhite(line[0]))
5825 /* End of example: non-white or '<' in first column. */
5826 if (line[0] == '<')
5828 /* blank-out a '<' in the first column */
5829 line = ml_get_buf(curbuf, lnum, TRUE);
5830 line[0] = ' ';
5832 in_example = FALSE;
5834 if (!in_example && len > 0)
5836 if (line[len - 1] == '>' && (len == 1 || line[len - 2] == ' '))
5838 /* blank-out a '>' in the last column (start of example) */
5839 line = ml_get_buf(curbuf, lnum, TRUE);
5840 line[len - 1] = ' ';
5841 in_example = TRUE;
5843 else if (line[len - 1] == '~')
5845 /* blank-out a '~' at the end of line (header marker) */
5846 line = ml_get_buf(curbuf, lnum, TRUE);
5847 line[len - 1] = ' ';
5854 * In the "help.txt" file, add the locally added help files.
5855 * This uses the very first line in the help file.
5857 if (fnamecmp(gettail(curbuf->b_fname), "help.txt") == 0)
5859 for (lnum = 1; lnum < curbuf->b_ml.ml_line_count; ++lnum)
5861 line = ml_get_buf(curbuf, lnum, FALSE);
5862 if (strstr((char *)line, "*local-additions*") != NULL)
5864 /* Go through all directories in 'runtimepath', skipping
5865 * $VIMRUNTIME. */
5866 p = p_rtp;
5867 while (*p != NUL)
5869 copy_option_part(&p, NameBuff, MAXPATHL, ",");
5870 mustfree = FALSE;
5871 rt = vim_getenv((char_u *)"VIMRUNTIME", &mustfree);
5872 if (fullpathcmp(rt, NameBuff, FALSE) != FPC_SAME)
5874 int fcount;
5875 char_u **fnames;
5876 FILE *fd;
5877 char_u *s;
5878 int fi;
5879 #ifdef FEAT_MBYTE
5880 vimconv_T vc;
5881 char_u *cp;
5882 #endif
5884 /* Find all "doc/ *.txt" files in this directory. */
5885 add_pathsep(NameBuff);
5886 STRCAT(NameBuff, "doc/*.txt");
5887 if (gen_expand_wildcards(1, &NameBuff, &fcount,
5888 &fnames, EW_FILE|EW_SILENT) == OK
5889 && fcount > 0)
5891 for (fi = 0; fi < fcount; ++fi)
5893 fd = mch_fopen((char *)fnames[fi], "r");
5894 if (fd != NULL)
5896 vim_fgets(IObuff, IOSIZE, fd);
5897 if (IObuff[0] == '*'
5898 && (s = vim_strchr(IObuff + 1, '*'))
5899 != NULL)
5901 #ifdef FEAT_MBYTE
5902 int this_utf = MAYBE;
5903 #endif
5904 /* Change tag definition to a
5905 * reference and remove <CR>/<NL>. */
5906 IObuff[0] = '|';
5907 *s = '|';
5908 while (*s != NUL)
5910 if (*s == '\r' || *s == '\n')
5911 *s = NUL;
5912 #ifdef FEAT_MBYTE
5913 /* The text is utf-8 when a byte
5914 * above 127 is found and no
5915 * illegal byte sequence is found.
5917 if (*s >= 0x80 && this_utf != FALSE)
5919 int l;
5921 this_utf = TRUE;
5922 l = utf_ptr2len(s);
5923 if (l == 1)
5924 this_utf = FALSE;
5925 s += l - 1;
5927 #endif
5928 ++s;
5930 #ifdef FEAT_MBYTE
5931 /* The help file is latin1 or utf-8;
5932 * conversion to the current
5933 * 'encoding' may be required. */
5934 vc.vc_type = CONV_NONE;
5935 convert_setup(&vc, (char_u *)(
5936 this_utf == TRUE ? "utf-8"
5937 : "latin1"), p_enc);
5938 if (vc.vc_type == CONV_NONE)
5939 /* No conversion needed. */
5940 cp = IObuff;
5941 else
5943 /* Do the conversion. If it fails
5944 * use the unconverted text. */
5945 cp = string_convert(&vc, IObuff,
5946 NULL);
5947 if (cp == NULL)
5948 cp = IObuff;
5950 convert_setup(&vc, NULL, NULL);
5952 ml_append(lnum, cp, (colnr_T)0, FALSE);
5953 if (cp != IObuff)
5954 vim_free(cp);
5955 #else
5956 ml_append(lnum, IObuff, (colnr_T)0,
5957 FALSE);
5958 #endif
5959 ++lnum;
5961 fclose(fd);
5964 FreeWild(fcount, fnames);
5967 if (mustfree)
5968 vim_free(rt);
5970 break;
5977 * ":exusage"
5979 /*ARGSUSED*/
5980 void
5981 ex_exusage(eap)
5982 exarg_T *eap;
5984 do_cmdline_cmd((char_u *)"help ex-cmd-index");
5988 * ":viusage"
5990 /*ARGSUSED*/
5991 void
5992 ex_viusage(eap)
5993 exarg_T *eap;
5995 do_cmdline_cmd((char_u *)"help normal-index");
5998 #if defined(FEAT_EX_EXTRA) || defined(PROTO)
5999 static void helptags_one __ARGS((char_u *dir, char_u *ext, char_u *lang));
6002 * ":helptags"
6004 void
6005 ex_helptags(eap)
6006 exarg_T *eap;
6008 garray_T ga;
6009 int i, j;
6010 int len;
6011 #ifdef FEAT_MULTI_LANG
6012 char_u lang[2];
6013 #endif
6014 char_u ext[5];
6015 char_u fname[8];
6016 int filecount;
6017 char_u **files;
6019 if (!mch_isdir(eap->arg))
6021 EMSG2(_("E150: Not a directory: %s"), eap->arg);
6022 return;
6025 #ifdef FEAT_MULTI_LANG
6026 /* Get a list of all files in the directory. */
6027 STRCPY(NameBuff, eap->arg);
6028 add_pathsep(NameBuff);
6029 STRCAT(NameBuff, "*");
6030 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6031 EW_FILE|EW_SILENT) == FAIL
6032 || filecount == 0)
6034 EMSG2("E151: No match: %s", NameBuff);
6035 return;
6038 /* Go over all files in the directory to find out what languages are
6039 * present. */
6040 ga_init2(&ga, 1, 10);
6041 for (i = 0; i < filecount; ++i)
6043 len = (int)STRLEN(files[i]);
6044 if (len > 4)
6046 if (STRICMP(files[i] + len - 4, ".txt") == 0)
6048 /* ".txt" -> language "en" */
6049 lang[0] = 'e';
6050 lang[1] = 'n';
6052 else if (files[i][len - 4] == '.'
6053 && ASCII_ISALPHA(files[i][len - 3])
6054 && ASCII_ISALPHA(files[i][len - 2])
6055 && TOLOWER_ASC(files[i][len - 1]) == 'x')
6057 /* ".abx" -> language "ab" */
6058 lang[0] = TOLOWER_ASC(files[i][len - 3]);
6059 lang[1] = TOLOWER_ASC(files[i][len - 2]);
6061 else
6062 continue;
6064 /* Did we find this language already? */
6065 for (j = 0; j < ga.ga_len; j += 2)
6066 if (STRNCMP(lang, ((char_u *)ga.ga_data) + j, 2) == 0)
6067 break;
6068 if (j == ga.ga_len)
6070 /* New language, add it. */
6071 if (ga_grow(&ga, 2) == FAIL)
6072 break;
6073 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[0];
6074 ((char_u *)ga.ga_data)[ga.ga_len++] = lang[1];
6080 * Loop over the found languages to generate a tags file for each one.
6082 for (j = 0; j < ga.ga_len; j += 2)
6084 STRCPY(fname, "tags-xx");
6085 fname[5] = ((char_u *)ga.ga_data)[j];
6086 fname[6] = ((char_u *)ga.ga_data)[j + 1];
6087 if (fname[5] == 'e' && fname[6] == 'n')
6089 /* English is an exception: use ".txt" and "tags". */
6090 fname[4] = NUL;
6091 STRCPY(ext, ".txt");
6093 else
6095 /* Language "ab" uses ".abx" and "tags-ab". */
6096 STRCPY(ext, ".xxx");
6097 ext[1] = fname[5];
6098 ext[2] = fname[6];
6100 helptags_one(eap->arg, ext, fname);
6103 ga_clear(&ga);
6104 FreeWild(filecount, files);
6106 #else
6107 /* No language support, just use "*.txt" and "tags". */
6108 helptags_one(eap->arg, (char_u *)".txt", (char_u *)"tags");
6109 #endif
6112 static void
6113 helptags_one(dir, ext, tagfname)
6114 char_u *dir; /* doc directory */
6115 char_u *ext; /* suffix, ".txt", ".itx", ".frx", etc. */
6116 char_u *tagfname; /* "tags" for English, "tags-it" for Italian. */
6118 FILE *fd_tags;
6119 FILE *fd;
6120 garray_T ga;
6121 int filecount;
6122 char_u **files;
6123 char_u *p1, *p2;
6124 int fi;
6125 char_u *s;
6126 int i;
6127 char_u *fname;
6128 # ifdef FEAT_MBYTE
6129 int utf8 = MAYBE;
6130 int this_utf8;
6131 int firstline;
6132 int mix = FALSE; /* detected mixed encodings */
6133 # endif
6136 * Find all *.txt files.
6138 STRCPY(NameBuff, dir);
6139 add_pathsep(NameBuff);
6140 STRCAT(NameBuff, "*");
6141 STRCAT(NameBuff, ext);
6142 if (gen_expand_wildcards(1, &NameBuff, &filecount, &files,
6143 EW_FILE|EW_SILENT) == FAIL
6144 || filecount == 0)
6146 if (!got_int)
6147 EMSG2("E151: No match: %s", NameBuff);
6148 return;
6152 * Open the tags file for writing.
6153 * Do this before scanning through all the files.
6155 STRCPY(NameBuff, dir);
6156 add_pathsep(NameBuff);
6157 STRCAT(NameBuff, tagfname);
6158 fd_tags = mch_fopen((char *)NameBuff, "w");
6159 if (fd_tags == NULL)
6161 EMSG2(_("E152: Cannot open %s for writing"), NameBuff);
6162 FreeWild(filecount, files);
6163 return;
6167 * If generating tags for "$VIMRUNTIME/doc" add the "help-tags" tag.
6169 ga_init2(&ga, (int)sizeof(char_u *), 100);
6170 if (fullpathcmp((char_u *)"$VIMRUNTIME/doc", dir, FALSE) == FPC_SAME)
6172 if (ga_grow(&ga, 1) == FAIL)
6173 got_int = TRUE;
6174 else
6176 s = alloc(18 + (unsigned)STRLEN(tagfname));
6177 if (s == NULL)
6178 got_int = TRUE;
6179 else
6181 sprintf((char *)s, "help-tags\t%s\t1\n", tagfname);
6182 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6183 ++ga.ga_len;
6189 * Go over all the files and extract the tags.
6191 for (fi = 0; fi < filecount && !got_int; ++fi)
6193 fd = mch_fopen((char *)files[fi], "r");
6194 if (fd == NULL)
6196 EMSG2(_("E153: Unable to open %s for reading"), files[fi]);
6197 continue;
6199 fname = gettail(files[fi]);
6201 # ifdef FEAT_MBYTE
6202 firstline = TRUE;
6203 # endif
6204 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
6206 # ifdef FEAT_MBYTE
6207 if (firstline)
6209 /* Detect utf-8 file by a non-ASCII char in the first line. */
6210 this_utf8 = MAYBE;
6211 for (s = IObuff; *s != NUL; ++s)
6212 if (*s >= 0x80)
6214 int l;
6216 this_utf8 = TRUE;
6217 l = utf_ptr2len(s);
6218 if (l == 1)
6220 /* Illegal UTF-8 byte sequence. */
6221 this_utf8 = FALSE;
6222 break;
6224 s += l - 1;
6226 if (this_utf8 == MAYBE) /* only ASCII characters found */
6227 this_utf8 = FALSE;
6228 if (utf8 == MAYBE) /* first file */
6229 utf8 = this_utf8;
6230 else if (utf8 != this_utf8)
6232 EMSG2(_("E670: Mix of help file encodings within a language: %s"), files[fi]);
6233 mix = !got_int;
6234 got_int = TRUE;
6236 firstline = FALSE;
6238 # endif
6239 p1 = vim_strchr(IObuff, '*'); /* find first '*' */
6240 while (p1 != NULL)
6242 p2 = vim_strchr(p1 + 1, '*'); /* find second '*' */
6243 if (p2 != NULL && p2 > p1 + 1) /* skip "*" and "**" */
6245 for (s = p1 + 1; s < p2; ++s)
6246 if (*s == ' ' || *s == '\t' || *s == '|')
6247 break;
6250 * Only accept a *tag* when it consists of valid
6251 * characters, there is white space before it and is
6252 * followed by a white character or end-of-line.
6254 if (s == p2
6255 && (p1 == IObuff || p1[-1] == ' ' || p1[-1] == '\t')
6256 && (vim_strchr((char_u *)" \t\n\r", s[1]) != NULL
6257 || s[1] == '\0'))
6259 *p2 = '\0';
6260 ++p1;
6261 if (ga_grow(&ga, 1) == FAIL)
6263 got_int = TRUE;
6264 break;
6266 s = alloc((unsigned)(p2 - p1 + STRLEN(fname) + 2));
6267 if (s == NULL)
6269 got_int = TRUE;
6270 break;
6272 ((char_u **)ga.ga_data)[ga.ga_len] = s;
6273 ++ga.ga_len;
6274 sprintf((char *)s, "%s\t%s", p1, fname);
6276 /* find next '*' */
6277 p2 = vim_strchr(p2 + 1, '*');
6280 p1 = p2;
6282 line_breakcheck();
6285 fclose(fd);
6288 FreeWild(filecount, files);
6290 if (!got_int)
6293 * Sort the tags.
6295 sort_strings((char_u **)ga.ga_data, ga.ga_len);
6298 * Check for duplicates.
6300 for (i = 1; i < ga.ga_len; ++i)
6302 p1 = ((char_u **)ga.ga_data)[i - 1];
6303 p2 = ((char_u **)ga.ga_data)[i];
6304 while (*p1 == *p2)
6306 if (*p2 == '\t')
6308 *p2 = NUL;
6309 vim_snprintf((char *)NameBuff, MAXPATHL,
6310 _("E154: Duplicate tag \"%s\" in file %s/%s"),
6311 ((char_u **)ga.ga_data)[i], dir, p2 + 1);
6312 EMSG(NameBuff);
6313 *p2 = '\t';
6314 break;
6316 ++p1;
6317 ++p2;
6321 # ifdef FEAT_MBYTE
6322 if (utf8 == TRUE)
6323 fprintf(fd_tags, "!_TAG_FILE_ENCODING\tutf-8\t//\n");
6324 # endif
6327 * Write the tags into the file.
6329 for (i = 0; i < ga.ga_len; ++i)
6331 s = ((char_u **)ga.ga_data)[i];
6332 if (STRNCMP(s, "help-tags", 9) == 0)
6333 /* help-tags entry was added in formatted form */
6334 fprintf(fd_tags, (char *)s);
6335 else
6337 fprintf(fd_tags, "%s\t/*", s);
6338 for (p1 = s; *p1 != '\t'; ++p1)
6340 /* insert backslash before '\\' and '/' */
6341 if (*p1 == '\\' || *p1 == '/')
6342 putc('\\', fd_tags);
6343 putc(*p1, fd_tags);
6345 fprintf(fd_tags, "*\n");
6349 #ifdef FEAT_MBYTE
6350 if (mix)
6351 got_int = FALSE; /* continue with other languages */
6352 #endif
6354 for (i = 0; i < ga.ga_len; ++i)
6355 vim_free(((char_u **)ga.ga_data)[i]);
6356 ga_clear(&ga);
6357 fclose(fd_tags); /* there is no check for an error... */
6359 #endif
6361 #if defined(FEAT_SIGNS) || defined(PROTO)
6364 * Struct to hold the sign properties.
6366 typedef struct sign sign_T;
6368 struct sign
6370 sign_T *sn_next; /* next sign in list */
6371 int sn_typenr; /* type number of sign (negative if not equal
6372 to name) */
6373 char_u *sn_name; /* name of sign */
6374 char_u *sn_icon; /* name of pixmap */
6375 #ifdef FEAT_SIGN_ICONS
6376 void *sn_image; /* icon image */
6377 #endif
6378 char_u *sn_text; /* text used instead of pixmap */
6379 int sn_line_hl; /* highlight ID for line */
6380 int sn_text_hl; /* highlight ID for text */
6383 static sign_T *first_sign = NULL;
6384 static int last_sign_typenr = MAX_TYPENR; /* is decremented */
6386 static void sign_list_defined __ARGS((sign_T *sp));
6389 * ":sign" command
6391 void
6392 ex_sign(eap)
6393 exarg_T *eap;
6395 char_u *arg = eap->arg;
6396 char_u *p;
6397 int idx;
6398 sign_T *sp;
6399 sign_T *sp_prev;
6400 buf_T *buf;
6401 static char *cmds[] = {
6402 "define",
6403 #define SIGNCMD_DEFINE 0
6404 "undefine",
6405 #define SIGNCMD_UNDEFINE 1
6406 "list",
6407 #define SIGNCMD_LIST 2
6408 "place",
6409 #define SIGNCMD_PLACE 3
6410 "unplace",
6411 #define SIGNCMD_UNPLACE 4
6412 "jump",
6413 #define SIGNCMD_JUMP 5
6414 #define SIGNCMD_LAST 6
6417 /* Parse the subcommand. */
6418 p = skiptowhite(arg);
6419 if (*p != NUL)
6420 *p++ = NUL;
6421 for (idx = 0; ; ++idx)
6423 if (idx == SIGNCMD_LAST)
6425 EMSG2(_("E160: Unknown sign command: %s"), arg);
6426 return;
6428 if (STRCMP(arg, cmds[idx]) == 0)
6429 break;
6431 arg = skipwhite(p);
6433 if (idx <= SIGNCMD_LIST)
6436 * Define, undefine or list signs.
6438 if (idx == SIGNCMD_LIST && *arg == NUL)
6440 /* ":sign list": list all defined signs */
6441 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6442 sign_list_defined(sp);
6444 else if (*arg == NUL)
6445 EMSG(_("E156: Missing sign name"));
6446 else
6448 p = skiptowhite(arg);
6449 if (*p != NUL)
6450 *p++ = NUL;
6451 sp_prev = NULL;
6452 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6454 if (STRCMP(sp->sn_name, arg) == 0)
6455 break;
6456 sp_prev = sp;
6458 if (idx == SIGNCMD_DEFINE)
6460 /* ":sign define {name} ...": define a sign */
6461 if (sp == NULL)
6463 /* Allocate a new sign. */
6464 sp = (sign_T *)alloc_clear((unsigned)sizeof(sign_T));
6465 if (sp == NULL)
6466 return;
6467 if (sp_prev == NULL)
6468 first_sign = sp;
6469 else
6470 sp_prev->sn_next = sp;
6471 sp->sn_name = vim_strnsave(arg, (int)(p - arg));
6473 /* If the name is a number use that for the typenr,
6474 * otherwise use a negative number. */
6475 if (VIM_ISDIGIT(*arg))
6476 sp->sn_typenr = atoi((char *)arg);
6477 else
6479 sign_T *lp;
6480 int start = last_sign_typenr;
6482 for (lp = first_sign; lp != NULL; lp = lp->sn_next)
6484 if (lp->sn_typenr == last_sign_typenr)
6486 --last_sign_typenr;
6487 if (last_sign_typenr == 0)
6488 last_sign_typenr = MAX_TYPENR;
6489 if (last_sign_typenr == start)
6491 EMSG(_("E612: Too many signs defined"));
6492 return;
6494 lp = first_sign;
6495 continue;
6499 sp->sn_typenr = last_sign_typenr--;
6500 if (last_sign_typenr == 0)
6501 last_sign_typenr = MAX_TYPENR; /* wrap around */
6505 /* set values for a defined sign. */
6506 for (;;)
6508 arg = skipwhite(p);
6509 if (*arg == NUL)
6510 break;
6511 p = skiptowhite_esc(arg);
6512 if (STRNCMP(arg, "icon=", 5) == 0)
6514 arg += 5;
6515 vim_free(sp->sn_icon);
6516 sp->sn_icon = vim_strnsave(arg, (int)(p - arg));
6517 backslash_halve(sp->sn_icon);
6518 #ifdef FEAT_SIGN_ICONS
6519 if (gui.in_use)
6521 out_flush();
6522 if (sp->sn_image != NULL)
6523 gui_mch_destroy_sign(sp->sn_image);
6524 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6526 #endif
6528 else if (STRNCMP(arg, "text=", 5) == 0)
6530 char_u *s;
6531 int cells;
6532 int len;
6534 arg += 5;
6535 #ifdef FEAT_MBYTE
6536 /* Count cells and check for non-printable chars */
6537 if (has_mbyte)
6539 cells = 0;
6540 for (s = arg; s < p; s += (*mb_ptr2len)(s))
6542 if (!vim_isprintc((*mb_ptr2char)(s)))
6543 break;
6544 cells += (*mb_ptr2cells)(s);
6547 else
6548 #endif
6550 for (s = arg; s < p; ++s)
6551 if (!vim_isprintc(*s))
6552 break;
6553 cells = (int)(s - arg);
6555 /* Currently must be one or two display cells */
6556 if (s != p || cells < 1 || cells > 2)
6558 *p = NUL;
6559 EMSG2(_("E239: Invalid sign text: %s"), arg);
6560 return;
6563 vim_free(sp->sn_text);
6564 /* Allocate one byte more if we need to pad up
6565 * with a space. */
6566 len = (int)(p - arg + ((cells == 1) ? 1 : 0));
6567 sp->sn_text = vim_strnsave(arg, len);
6569 if (sp->sn_text != NULL && cells == 1)
6570 STRCPY(sp->sn_text + len - 1, " ");
6572 else if (STRNCMP(arg, "linehl=", 7) == 0)
6574 arg += 7;
6575 sp->sn_line_hl = syn_check_group(arg, (int)(p - arg));
6577 else if (STRNCMP(arg, "texthl=", 7) == 0)
6579 arg += 7;
6580 sp->sn_text_hl = syn_check_group(arg, (int)(p - arg));
6582 else
6584 EMSG2(_(e_invarg2), arg);
6585 return;
6589 else if (sp == NULL)
6590 EMSG2(_("E155: Unknown sign: %s"), arg);
6591 else if (idx == SIGNCMD_LIST)
6592 /* ":sign list {name}" */
6593 sign_list_defined(sp);
6594 else
6596 /* ":sign undefine {name}" */
6597 vim_free(sp->sn_name);
6598 vim_free(sp->sn_icon);
6599 #ifdef FEAT_SIGN_ICONS
6600 if (sp->sn_image != NULL)
6602 out_flush();
6603 gui_mch_destroy_sign(sp->sn_image);
6605 #endif
6606 vim_free(sp->sn_text);
6607 if (sp_prev == NULL)
6608 first_sign = sp->sn_next;
6609 else
6610 sp_prev->sn_next = sp->sn_next;
6611 vim_free(sp);
6615 else
6617 int id = -1;
6618 linenr_T lnum = -1;
6619 char_u *sign_name = NULL;
6620 char_u *arg1;
6622 if (*arg == NUL)
6624 if (idx == SIGNCMD_PLACE)
6626 /* ":sign place": list placed signs in all buffers */
6627 sign_list_placed(NULL);
6629 else if (idx == SIGNCMD_UNPLACE)
6631 /* ":sign unplace": remove placed sign at cursor */
6632 id = buf_findsign_id(curwin->w_buffer, curwin->w_cursor.lnum);
6633 if (id > 0)
6635 buf_delsign(curwin->w_buffer, id);
6636 update_debug_sign(curwin->w_buffer, curwin->w_cursor.lnum);
6638 else
6639 EMSG(_("E159: Missing sign number"));
6641 else
6642 EMSG(_(e_argreq));
6643 return;
6646 if (idx == SIGNCMD_UNPLACE && arg[0] == '*' && arg[1] == NUL)
6648 /* ":sign unplace *": remove all placed signs */
6649 buf_delete_all_signs();
6650 return;
6653 /* first arg could be placed sign id */
6654 arg1 = arg;
6655 if (VIM_ISDIGIT(*arg))
6657 id = getdigits(&arg);
6658 if (!vim_iswhite(*arg) && *arg != NUL)
6660 id = -1;
6661 arg = arg1;
6663 else
6665 arg = skipwhite(arg);
6666 if (idx == SIGNCMD_UNPLACE && *arg == NUL)
6668 /* ":sign unplace {id}": remove placed sign by number */
6669 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
6670 if ((lnum = buf_delsign(buf, id)) != 0)
6671 update_debug_sign(buf, lnum);
6672 return;
6678 * Check for line={lnum} name={name} and file={fname} or buffer={nr}.
6679 * Leave "arg" pointing to {fname}.
6681 for (;;)
6683 if (STRNCMP(arg, "line=", 5) == 0)
6685 arg += 5;
6686 lnum = atoi((char *)arg);
6687 arg = skiptowhite(arg);
6689 else if (STRNCMP(arg, "name=", 5) == 0)
6691 arg += 5;
6692 sign_name = arg;
6693 arg = skiptowhite(arg);
6694 if (*arg != NUL)
6695 *arg++ = NUL;
6697 else if (STRNCMP(arg, "file=", 5) == 0)
6699 arg += 5;
6700 buf = buflist_findname(arg);
6701 break;
6703 else if (STRNCMP(arg, "buffer=", 7) == 0)
6705 arg += 7;
6706 buf = buflist_findnr((int)getdigits(&arg));
6707 if (*skipwhite(arg) != NUL)
6708 EMSG(_(e_trailing));
6709 break;
6711 else
6713 EMSG(_(e_invarg));
6714 return;
6716 arg = skipwhite(arg);
6719 if (buf == NULL)
6721 EMSG2(_("E158: Invalid buffer name: %s"), arg);
6723 else if (id <= 0)
6725 if (lnum >= 0 || sign_name != NULL)
6726 EMSG(_(e_invarg));
6727 else
6728 /* ":sign place file={fname}": list placed signs in one file */
6729 sign_list_placed(buf);
6731 else if (idx == SIGNCMD_JUMP)
6733 /* ":sign jump {id} file={fname}" */
6734 if (lnum >= 0 || sign_name != NULL)
6735 EMSG(_(e_invarg));
6736 else if ((lnum = buf_findsign(buf, id)) > 0)
6737 { /* goto a sign ... */
6738 if (buf_jump_open_win(buf) != NULL)
6739 { /* ... in a current window */
6740 curwin->w_cursor.lnum = lnum;
6741 check_cursor_lnum();
6742 beginline(BL_WHITE);
6744 else
6745 { /* ... not currently in a window */
6746 char_u *cmd;
6748 cmd = alloc((unsigned)STRLEN(buf->b_fname) + 25);
6749 if (cmd == NULL)
6750 return;
6751 sprintf((char *)cmd, "e +%ld %s", (long)lnum, buf->b_fname);
6752 do_cmdline_cmd(cmd);
6753 vim_free(cmd);
6755 #ifdef FEAT_FOLDING
6756 foldOpenCursor();
6757 #endif
6759 else
6760 EMSGN(_("E157: Invalid sign ID: %ld"), id);
6762 else if (idx == SIGNCMD_UNPLACE)
6764 /* ":sign unplace {id} file={fname}" */
6765 if (lnum >= 0 || sign_name != NULL)
6766 EMSG(_(e_invarg));
6767 else
6769 lnum = buf_delsign(buf, id);
6770 update_debug_sign(buf, lnum);
6773 /* idx == SIGNCMD_PLACE */
6774 else if (sign_name != NULL)
6776 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6777 if (STRCMP(sp->sn_name, sign_name) == 0)
6778 break;
6779 if (sp == NULL)
6781 EMSG2(_("E155: Unknown sign: %s"), sign_name);
6782 return;
6784 if (lnum > 0)
6785 /* ":sign place {id} line={lnum} name={name} file={fname}":
6786 * place a sign */
6787 buf_addsign(buf, id, lnum, sp->sn_typenr);
6788 else
6789 /* ":sign place {id} file={fname}": change sign type */
6790 lnum = buf_change_sign_type(buf, id, sp->sn_typenr);
6791 update_debug_sign(buf, lnum);
6793 else
6794 EMSG(_(e_invarg));
6798 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6800 * Allocate the icons. Called when the GUI has started. Allows defining
6801 * signs before it starts.
6803 void
6804 sign_gui_started()
6806 sign_T *sp;
6808 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6809 if (sp->sn_icon != NULL)
6810 sp->sn_image = gui_mch_register_sign(sp->sn_icon);
6812 #endif
6815 * List one sign.
6817 static void
6818 sign_list_defined(sp)
6819 sign_T *sp;
6821 char_u *p;
6823 smsg((char_u *)"sign %s", sp->sn_name);
6824 if (sp->sn_icon != NULL)
6826 MSG_PUTS(" icon=");
6827 msg_outtrans(sp->sn_icon);
6828 #ifdef FEAT_SIGN_ICONS
6829 if (sp->sn_image == NULL)
6830 MSG_PUTS(_(" (NOT FOUND)"));
6831 #else
6832 MSG_PUTS(_(" (not supported)"));
6833 #endif
6835 if (sp->sn_text != NULL)
6837 MSG_PUTS(" text=");
6838 msg_outtrans(sp->sn_text);
6840 if (sp->sn_line_hl > 0)
6842 MSG_PUTS(" linehl=");
6843 p = get_highlight_name(NULL, sp->sn_line_hl - 1);
6844 if (p == NULL)
6845 MSG_PUTS("NONE");
6846 else
6847 msg_puts(p);
6849 if (sp->sn_text_hl > 0)
6851 MSG_PUTS(" texthl=");
6852 p = get_highlight_name(NULL, sp->sn_text_hl - 1);
6853 if (p == NULL)
6854 MSG_PUTS("NONE");
6855 else
6856 msg_puts(p);
6861 * Get highlighting attribute for sign "typenr".
6862 * If "line" is TRUE: line highl, if FALSE: text highl.
6865 sign_get_attr(typenr, line)
6866 int typenr;
6867 int line;
6869 sign_T *sp;
6871 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6872 if (sp->sn_typenr == typenr)
6874 if (line)
6876 if (sp->sn_line_hl > 0)
6877 return syn_id2attr(sp->sn_line_hl);
6879 else
6881 if (sp->sn_text_hl > 0)
6882 return syn_id2attr(sp->sn_text_hl);
6884 break;
6886 return 0;
6890 * Get text mark for sign "typenr".
6891 * Returns NULL if there isn't one.
6893 char_u *
6894 sign_get_text(typenr)
6895 int typenr;
6897 sign_T *sp;
6899 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6900 if (sp->sn_typenr == typenr)
6901 return sp->sn_text;
6902 return NULL;
6905 #if defined(FEAT_SIGN_ICONS) || defined(PROTO)
6906 void *
6907 sign_get_image(typenr)
6908 int typenr; /* the attribute which may have a sign */
6910 sign_T *sp;
6912 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6913 if (sp->sn_typenr == typenr)
6914 return sp->sn_image;
6915 return NULL;
6917 #endif
6920 * Get the name of a sign by its typenr.
6922 char_u *
6923 sign_typenr2name(typenr)
6924 int typenr;
6926 sign_T *sp;
6928 for (sp = first_sign; sp != NULL; sp = sp->sn_next)
6929 if (sp->sn_typenr == typenr)
6930 return sp->sn_name;
6931 return (char_u *)_("[Deleted]");
6934 #endif
6936 #if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
6938 * ":drop"
6939 * Opens the first argument in a window. When there are two or more arguments
6940 * the argument list is redefined.
6942 void
6943 ex_drop(eap)
6944 exarg_T *eap;
6946 int split = FALSE;
6947 win_T *wp;
6948 buf_T *buf;
6949 # ifdef FEAT_WINDOWS
6950 tabpage_T *tp;
6951 # endif
6954 * Check if the first argument is already being edited in a window. If
6955 * so, jump to that window.
6956 * We would actually need to check all arguments, but that's complicated
6957 * and mostly only one file is dropped.
6958 * This also ignores wildcards, since it is very unlikely the user is
6959 * editing a file name with a wildcard character.
6961 set_arglist(eap->arg);
6963 # ifdef FEAT_WINDOWS
6964 if (cmdmod.tab)
6966 /* ":tab drop file ...": open a tab for each argument that isn't
6967 * edited in a window yet. It's like ":tab all" but without closing
6968 * windows or tabs. */
6969 ex_all(eap);
6971 else
6972 # endif
6974 /* ":drop file ...": Edit the first argument. Jump to an existing
6975 * window if possible, edit in current window if the current buffer
6976 * can be abandoned, otherwise open a new window. */
6977 buf = buflist_findnr(ARGLIST[0].ae_fnum);
6979 FOR_ALL_TAB_WINDOWS(tp, wp)
6981 if (wp->w_buffer == buf)
6983 # ifdef FEAT_WINDOWS
6984 goto_tabpage_win(tp, wp);
6985 # endif
6986 curwin->w_arg_idx = 0;
6987 return;
6992 * Check whether the current buffer is changed. If so, we will need
6993 * to split the current window or data could be lost.
6994 * Skip the check if the 'hidden' option is set, as in this case the
6995 * buffer won't be lost.
6997 if (!P_HID(curbuf))
6999 # ifdef FEAT_WINDOWS
7000 ++emsg_off;
7001 # endif
7002 split = check_changed(curbuf, TRUE, FALSE, FALSE, FALSE);
7003 # ifdef FEAT_WINDOWS
7004 --emsg_off;
7005 # else
7006 if (split)
7007 return;
7008 # endif
7011 /* Fake a ":sfirst" or ":first" command edit the first argument. */
7012 if (split)
7014 eap->cmdidx = CMD_sfirst;
7015 eap->cmd[0] = 's';
7017 else
7018 eap->cmdidx = CMD_first;
7019 ex_rewind(eap);
7022 #endif